《软件开发文档说明书》由会员分享，可在线阅读，更多相关《软件开发文档说明书（10页珍藏版）》请在金锄头文库上搜索。
1、.在软件行业有一句话： 一个软件能否顺利的完成并且功能是否完善， 重要是看这个软件有多少文档， 软件开发文档是一个软件的支柱， 如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好； 开发文档的好坏可以直接影响到所开发出来软件的成功与否。一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。1、软件需求说明书：也称为软件规格说明。 该说明书对所开发软件的功能、性能、用户 界面及运行环境等做出详细的说明。 它是用户与开发人员双方对软件需求取得共同理 解基础上达成的协议， 也是实施开发工作的基础。 软件需求说明书的编制目的的就是 为了使用户和
2、软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。其格式要求如下：1 引言1 1编写目的。1 2背景1 3定义2 任务概述2 1 目标2 2 用户的特点2 3 假定和约束3 需求规定3 1对功能的规定3 2对性能的规定321精度322时间特性的需求323灵活性3 3输入输出要求3 4数据管理能力要求3 5故障处理要求3 6其他专门要求4 运行环境规定4 1设备4 2支持软件4 3接口4 4控制2、概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑， 包括程序系统的基本处理。 流程、程序系统的组织 结构、模块划分、
3、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。.其格式要求如下：1 引言1 1编写目的1 2背景1 3定义1 4参考资料2 总体设计2 1需求规定2 2运行环境2 3基本设计概念和处理流程2 4结构2 5功能需求与程序的关系2 6人工处理过程2 7尚未解决的问题3 接口设计3 1用户接口3 2外部接口3. 。3 内部接口 4 运行设计4 1 运行模块的组合4 2 运行控制4 3 运行时间5 系统数据结构设计5 1逻辑结构设计要点5 2物理结构设计要求5 3数据结构与程序的关系6 系统出错处理设计6 1 出错信息6 2 补救措施6 3 系统维护设计。3.
4、 详细设计文档： 主要是把我们每个小模块， 小功能的业务逻辑处理用文字的方式表达出来， 让程序员在编码的时候有一个依据和参照； 同时，在进行详细文档设计的时候，有的软件公司也会根据不同的项目作出相应的 软件开发代码规范性文档，以保障我们所做工作的统一性。如果一个软件系比较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书。其格式要求如下：1 引言1 1编写目的1 2背景1 3定义1 4参考资料.2 程序设计系统的结构3 程序 1 设计说明3 1 程序描述3 2 功能3 3 性能3 4 输入项3 5输出项3 6算法3 7流程逻辑3 8接口3 9存储分配3 10注释设计3 11限制
5、条件3 12测试计划3 13尚未解决的问题4 程序2 设计说明 .二、软件开发管理文档：可行性研究报告、项目开发计划、开发进度月报、项目开发总结、模块开发卷宗。1. 可行性研究报告： 编写目的是， 说明该软件开发项目的实现在技术、 经济和社会条件方面的可行性： 评述为了合理达到开发目标而可能选择的各种方案； 说明并论证所选定的方案。其格式要求如下：1 引言1 1编写目的1 2背景1 3定义1 4参考资料2 可行性研究的前提2 1 要求2 2目标2 3条件、假定和限制2 4进行可行性研究的方法2 5评价尺度3 对现有系统的分析3 1处理流程和数据流程3 2工作负荷3 3费用开支3 4人员3 5设
6、备3 6局限性.结设备的影响对软件的影响对用户单位机构的影响对系统运行过程的影响对开发的影响对地点和设备的影响对经费开支的影响.4 所建议的系统4 1对所建议系统的说明4 2处理流程和数据流程4 3改进之处4 4影响4414424434444454464474 5局限性4 6技术条件方面的可行性5 可选择的其他系统的可行性5 1 可选择的系统方案 15 2可选择的系统方案26 投资及效益分析6 1 支出611基本建设投资612其他一次性支出613非一次性支出6 2 收益621一次性收益622非一次性收益623不可定量的收益6 3收益投资比6 4投资回收周期6 5敏感性分析7 社会因素方面的可行
7、性7 1 法律方面的可行性7 2 使用方面的可行性8 结论2. 项目开发计划： 是为软件项目实施方案制定出的具体计划。 项目开发计划应提前给管理部门， 并作为开发阶段评审的基础。 编制项目开发计划的止的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需的软硬条件等问题做出的安排记载下来， 以便根据本计划开展和检查项目的开发工作。其格式要求如下：1 引言1 1 编写目的1 2 定义1 3 参考资料.2 项目概述2 1工作内容2 2主要参加人员2 3产品231程序232方件233服务234非移交的产品2 4验收标准2 5完成项目的最迟期限2 6本计划的批准者和批准日
8、期3 实施计划3 1工作任务的分配与人员分工3 2接口人员3 3进度3 4预算3 5关键问题4 支持条件4 1计算机系统支持4 2需收用户承担的工作4 3由外单位提供的条件5 专题计划要点3. 开发进度月报：开发进度月报的编制目的是及时向有关部门汇报项目开发的进度和情况，以便及时 发现和处理开发过程中出现的问题， 一般开发进度月报是以项目组单位每月编写的。 如果被开发的软件系统规模比较大， 整个工程项目被划分给若干个分项目驵承担，开发进度月报将以分项目为单位搂月编写。 其格式要求如下：1 标题2 工程进度与状态2 1 进度2 2 状态3 资源耗用与状态3 1资源耗用311工时313机时3 2状
9、态4 经费支出与状态4 1 经费支出411 支持性费用412 设备购置费4 2 状态5 下一个月的工作计划6 建议.4. 项目开发总结： 软件项目开发完成之后， 应当与项目实施计划对照， 总结实际执行的情况，如进度、 成果、资源利用、成本和投入的人力。此外，还需对开发工作做出评价， 总结经验和教训。 项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。其格式要求如下：1 引言1 1编写目的1 2背景1 3定义1 4参考资料2 实际开以结果2 1 产品2 2主要功能和性能2 3基本流程2 4进度2 5费用3 开发工作评价3 1对生产效率
10、的评价3 2对产品质量的评价3 3对技术方法的评价3 4出错原因的分析4 经验与教训5. 模块开发卷宗： 模块开发卷宗是在模块开发过程中逐步编写出来的， 每完成一个模块或一组密切相关的模块的复制进编写一份， 应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇意低层次开发的进度和结果， 经便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。1 标题2 模块开发情况表：其中模块开发情况表的格式如下表：模块标识符模块的描述性名称代码设计（计划开始日期实际开始日期）模块测试（计划开始日期实际开始日期）组装测试（计划开始日期实际开始日期）代码复查 ( 日期 / 签字 )源代码
11、行数（预计/ 实际）目际模块大小（预计实际）.项目负责人批准( 日期 / 签字 )3 功能说明4 设计说明5 源代码清单6 测试说明7 复审的结论三、软件开发测试文档：概要测试计划、详细测试计划、测试实施计划、测试分析报告。1. 概要测试计划： 是软件项目实施计划中的一项重要的内容， 应当在软件开发初期、即需求分析阶段制订。 项计划应当定义被测试对象和测试目标， 确定测试阶段和测试周期的划分；制订测 试人员、软硬件资源和测试进度等方面的计划，规定软件测试方法，测试标准以及支持环境和测试工具。2. 详细测试计划：是针对子系统在特定的测试阶段所要进行的测试工作制订详细计划，它详细说明规定了测试小组的各项测试任务， 测试策略、任务分配和进度安排等。3. 测试实施计划：测试人员的测试实施计划是根据详细计划制订的测试者的测试具体实施计划。 它规定了测试者在每一轮测试中负责测试的内容， 测试强度和工作进度等。测试实施计划是整个软件测试的组成部分， 是检查测试实际执行情况的重要依据。其格式要求如下：1 引言1 1编写目的1 2背景1 3定义1 4参考资料2 计划2 1软件说明2 2测试内容
