软件开发文档说明书完整流程样本.doc

在软件行业有一句话：一种软件能否顺利完毕并且功能与否完善，重要是看这个软件有多少文档，软件开发文档是一种软件支柱，如果你开发文档漏洞百出，那么你所开发出来软件也不也许会好；开发文档好坏可以直接影响到所开发出来软件成功与否。 一、软件开发设计文档：软件开发文档涉及软件需求阐明书、数据规定说有书、概要设计阐明书、详细设计阐明书。 1、软件需求阐明书：也称为软件规格阐明。 该阐明书对所开发软件功能、性能、顾客界面及运营环境等做出详细阐明。它是顾客与开发人员双方对软件需求获得共同理解基本上达到合同，也是实行开发工作基本。软件需求阐明书编制目就是为了使顾客和软件开发者双方对该软件初始规定有一种共同理解、并使之面成为整个开发工作基本。其格式规定如下：1引言11编写目。 12背景13定义2任务概述21目的22顾客特点23假定和约束3需求规定31对功能规定32对性能规定321精度322时间特性需求323灵活性33输入输出规定34数据管理能力规定35故障解决规定36其她专门规定4运营环境规定41设备42支持软件43接口44控制2、概要设计阐明书：又称系统设计阐明书，这里所说系统是指程序系统。编制目是阐明对程序系统设计考虑，涉及程序系统基本解决。流程、程序系统组织构造、模块划分、功能分派、接口设计。运河行设计、数据构造设计和出错解决设计等，为程序详细设计提供基本。其格式规定如下：1引言11编写目12背景13定义14参照资料2总体设计21需求规定22运营环境23基本设计概念和解决流程24构造25功能需求与程序关系26人工解决过程27尚未解决问题3接口设计31顾客接口32外部接口3.。3内部接口4运营设计41运营模块组合42运营控制43运营时间5系统数据构造设计51逻辑构造设计要点52物理构造设计规定53数据构造与程序关系6系统出错解决设计61出错信息62补救办法63系统维护设计。 3.详细设计文档：重要是把咱们每个小模块，小功能业务逻辑解决用文字方式表达出来，让程序员在编码时候有一种根据和参照；同步，在进行详细文档设计时候，有软件公司也会依照不同项目作出相应软件开发代码规范性文档，以保障咱们所做工作统一性。如果一种软件系比较简朴，层次很少，本文献可以不单独编写，关于内容合并入概要设计阐明书。 其格式规定如下：1引言11编写目12背景13定义14参照资料2程序设计系统构造3程序1设计阐明31程序描述32功能33性能34输入项35输出项36算法37流程逻辑38接口39存储分派310注释设计311限制条件312测试筹划313尚未解决问题4程序2设计阐明.二、软件开发管理文档：可行性研究报告、项目开发筹划、开发进度月报、项目开发总结、模块开发卷宗。 1.可行性研究报告：编写目是，阐明该软件开发项目实当前技术、经济和社会条件方面可行性：评述为了合理达到开发目的而也许选取各种方案；阐明并论证所选定方案。 其格式规定如下：1引言11编写目12背景13定义14参照资料2可行性研究前提21规定22目的23条件、假定和限制24进行可行性研究办法25评价尺度3对既有系统分析31解决流程和数据流程32工作负荷33费用开支34人员35设备36局限性4所建议系统41对所建议系统阐明42解决流程和数据流程43改进之处44影响441结设备影响442对软件影响443对顾客单位机构影响444对系统运营过程影响445对开发影响446对地点和设备影响447对经费开支影响 45局限性 46技术条件方面可行性5可选取其她系统可行性51可选取系统方案152可选取系统方案26投资及效益分析61支出611基本建设投资612其她一次性支出613非一次性支出62收益621一次性收益622非一次性收益623不可定量收益63收益投资比64投资回收周期65敏感性分析7社会因素方面可行性71法律方面可行性72使用方面可行性8结论2.项目开发筹划：是为软件项目实行方案制定出详细筹划。项目开发筹划应提前给管理部门，并作为开发阶段评审基本。编制项目开发筹划止是用文献形式，把对于在开发过程中各项工作负责人员、开发进度、所需经费预算、所需软硬条件等问题做出安排记载下来，以便依照本筹划开展和检查项目开发工作。 其格式规定如下：1引言11编写目12定义13参照资料2项目概述21工作内容22重要参加人员23产品231程序232方件233服务234非移送产品24验收原则25完毕项目最迟期限26本筹划批准者和批准日期3实行筹划31工作任务分派与人员分工32接口人员33进度34预算35核心问题4支持条件41计算机系统支持42需收顾客承担工作43由外单位提供条件5专项筹划要点3.开发进度月报：开发进度月报编制目是及时向关于部门报告项目开发进度和状况，以便及时发现和解决开发过程中浮现问题，普通开发进度月报是以项目组单位每月编写。如果被开发软件系统规模比较大，整个工程项目被划分给若干个分项目驵承担，开发进度月报将以分项目为单位搂月编写。 其格式规定如下：1标题2工程进度与状态21进度22状态3资源耗用与状态31资源耗用311工时313机时32状态4经费支出与状态41经费支出411支持性费用412设备购买费42状态5下一种月工作筹划6建议4.项目开发总结：软件项目开发完毕之后，应当与项目实行筹划对照，总结实际执行状况，如进度、成果、资源运用、成本和投入人力。此外，还需对开发工作做出评价，总结经验和教训。项目开发总结报告编制是为了总结本项目开发工作经验，阐明实际获得开发成果以及对整个开发工作各个方面评价。 其格式规定如下：1引言11编写目12背景13定义14参照资料2实际开以成果21产品22重要功能和性能23基本流程24进度25费用3开发工作评价31对生产效率评价32对产品质量评价33对技术办法评价34出错因素分析4经验与教训5.模块开发卷宗：模块开发卷宗是在模块开发过程中逐渐编写出来，每完毕一种模块或一组密切有关模块复制进编写一份，应当把所有模块开发卷宗汇集在一起。编写目是记录和汇意低层次开发进度和成果，经便于对整个模块开发工作管理和复审，并为将来维护提供非常有用技术信息。 1标题2模块开发状况表：其中模块开发状况表格式如下表：模块标记符模块描述性名称代码设计（筹划开始日期实际开始日期）模块测试（筹划开始日期实际开始日期）组装测试（筹划开始日期实际开始日期）代码复查(日期/签字)源代码行数（预测/实际）目际模块大小（预测实际）项目负责人批准(日期/签字)3功能阐明4设计阐明5源代码清单6测试阐明7复审结论三、软件开发测试文档：概要测试筹划、详细测试筹划、测试实行筹划、测试分析报告。1.概要测试筹划：是软件项目实行筹划中一项重要内容，应当在软件开发初期、即需求分析阶段制定。项筹划应当定义被测试对象和测试目的，拟定测试阶段和测试周期划分；制定测试人员、软硬件资源和测试进度等方面筹划，规定软件测试办法，测试原则以及支持环境和测试工具。2.详细测试筹划：是针对子系统在特定测试阶段所要进行测试工作制定详细筹划，它详细阐明规定了测试小组各项测试任务，测试方略、任务分派和进度安排等。3.测试实行筹划：测试人员测试实行筹划是依照详细筹划制定测试者测试详细实行筹划。它规定了测试者在每一轮测试中负责测试内容，测试强度和工作进度等。测试实行筹划是整个软件测试构成某些，是检查测试实际执行状况重要根据。其格式规定如下：1引言11编写目12背景13定义14参照资料2筹划21软件阐明22测试内容23测试231进度安排232条件233测试资料234测试培训24测试3测试设计阐明31测试311控制312输入313输出314过程32测试4评价准则41范畴42数据整顿43尺度4.测试分析报告：测试工作完毕后来，应当提交测试筹划状况阐明书，对测试成果加以分析，并提出测试结论性意见。其格式规定如下：1引言11编写目12背景13定义14参照资料2测试概要3测试成果及发现31测试132测试24对软件功能结论41功能1411能力412限制42功能25分析摘要51能力52缺陷和限制53建议54评价6测试资源消耗四、顾客文档：顾客手册、操作手册。1.顾客手册：顾客手册编制是要使用非专门术语语言，充分地描述该软件系统所具备功能及基本用法，使顾客（或潜在顾客）通过本手册可以理解该软件用途，并且可以拟定在什么状况下，如何使用它。其格式规定如下：1引言11编写目12背景13定义14参照资料2用途21功能22性能221精度222时间特性223灵活性23安全保密3运营环境31硬设备32支持软件33数据构造4使用过程41安装与初始化42输入421输入数据现实背景422输入格式423输入举例43输出431输出数据现实背景432输出格式433输出举例44文卷查询45出错解决和恢复46终端操作2.操作手册：操作手册编制是为了向操作人员提供该软件每一种运营详细过程和关于知识，涉及操作办法细节。其格式规定如下：1引言11编写目12背景13定义14参照资料2软件征述21软件构造22程序表23文卷表3安装与初始化4运营阐明41运营表42运营环节43运营1431运营控制432操作控制433输入输出文卷434输出文段435输出文段复制436恢复过程44运营2.5非常规过程6远程操作3.维护建议：软件产品投入运营之后，也许有修改、改正等问题。应当对存在问题、修改考虑以及修改影响预计等作详细描述，写成维护修改建议、提交审批。其格式规定如下：1引言11综述12术语及缩写语13参照资料2程序构造描述3维护过程31启动32系统查询及事件报告功能33硬件状态能功能描述4出错解决及非常规过程41系统重启动过程42严重故障时紧急解决43普通故障解决44数据备份工作5附录51附录一52附录二文档编制阐明：文档标题用于阐明项目名称，文档主题用于阐明本文档内容，文档编号和文档版本重要用于归档和检索。