软件开发文档说明书

《软件开发文档说明书》由会员分享，可在线阅读，更多相关《软件开发文档说明书（11页珍藏版）》请在金锄头文库上搜索。

1、在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这 个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百 出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所 开发出来软件的成功与否。一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、 概要设计说明书、详细设计说明书。1、软件需求说明书：也称为软件规格说明。该说明书对所开发软件的功能、性 能、用户 界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件 需求取得共同理解基础上达成的协议，也是实施开发工作的基础。软件需求说 明书的编制目的的就是 为了使用户和软件开发

2、者双方对该软件的初始规定有 一个共同的理解、并使之面成为整个开发工作的基础。其格式要求如下：1引言1. 1编写目的。1. 2背景1. 3定义2任务概述2. 1目标2. 2用户的特点2. 3假定和约束3需求规定3. 1对功能的规定3. 2对性能的规定3. 2. 1精度3. 2. 2时间特性的需求3. 2. 3灵活性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

4、. 1出错信息6. 2补救措施6. 3系统维护设计。3. 详细设计文档：主要是把我们每个小模块，小功能的业务逻辑处理用文字的方 式表达出来，让程序员在编码的时候有一个依据和参照；同时，在进行详细文档 设计的时候，有的软件公司也会根据不同的项目作出相应的软件开发代码规范 性文档，以保障我们所做工作的统一性。如果一个软件系比较简单，层次很少， 本文件可以不单独编写，有关内容合并入概要设计说明书。其格式要求如下：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流

5、程逻辑3. 8 接口3. 9存储分配3. 10注释设计3. 11限制条件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对现有系统的分

6、析3. 1处理流程和数据流程3. 2工作负荷3. 3费用开支3. 4人员3. 5设备3. 6局限性4所建议的系统4. 1对所建议系统的说明4. 2处理流程和数据流程4. 3改进之处4. 4影响4. 4. 1结设备的影响4. 4. 2对软件的影响4. 4. 3对用户单位机构的影响4. 4. 4对系统运行过程的影响4. 4. 5对开发的影响4. 4. 6对地点和设备的影响4. 4. 7对经费开支的影响4. 5局限性4. 6技术条件方面的可行性5可选择的其他系统的可行性5. 1可选择的系统方案15. 2可选择的系统方案26投资及效益分析6. 1支出6. 1. 1基本建设投资6. 1. 2其他一次性支

7、出6. 1. 3非一次性支出6. 2收益6. 2. 1 一次性收益6. 2. 2非一次性收益6. 2. 3不可定量的收益6. 3收益投资比6. 4投资回收周期6. 5敏感性分析7社会因素方面的可行性7. 1法律方面的可行性7. 2使用方面的可行性8结论2. 项目开发计划：是为软件项目实施方案制定出的具体计划。项目开发计划应提 前给管理部门，并作为开发阶段评审的基础。编制项目开发计划的止的是用文件 的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、 所需的软硬条件等问题做出的安排记载下来，以便根据本计划开展和检查项目的 开发工作。其格式要求如下：1引言1. 1编写目的1. 2

8、定义1. 3参考资料2项目概述2. 1工作内容2. 2主要参加人员2. 3产品2. 3. 1程序2. 3. 2方件2. 3. 3服务2. 3. 4非移交的产品2. 4验收标准2. 5完成项目的最迟期限2. 6本计划的批准者和批准日期3实施计划3. 1工作任务的分配与人员分工3. 2接口人员3. 3进度3. 4预算3. 5关键问题4支持条件4. 1计算机系统支持4. 2需收用户承担的工作4. 3由外单位提供的条件5专题计划要点3. 开发进度月报:开发进度月报的编制目的是及时向有关部门汇报项目开发的进 度和情况，以便及时发现和处理开发过程中出现的问题，一般开发进度月报是 以项目组单位每月编写的。如

9、果被开发的软件系统规模比较大，整个工程项目被 划分给若干个分项目驵承担，开发进度月报将以分项目为单位搂月编写。其格 式要求如下：1 标题2工程进度与状态2.1 进度2.2 状态3资源耗用与状态3. 1资源耗用3. 1. 1 工时3. 1. 3机时3.2 状态4经费支出与状态4. 1经费支出4. 1. 1支持性费用4. 1. 2设备购置费4.2 状态5下一个月的工作计划6建议4. 项目开发总结：软件项目开发完成之后，应当与项目实施计划对照，总结实际 执行的情况，如进度、成果、资源利用、成本和投入的人力。此外，还需对开 发工作做出评价，总结经验和教训。项目开发总结报告的编制是为了总结本项目 开发工

10、作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评 价。其格式要求如下：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出错原因的分析4经验与教训5. 模块开发卷宗：模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一 个模块或一组密切相关的模块的复制进编写一份，应该把所有的模块开发卷宗汇 集在一起。编写的目的是记录和汇意低层次开发的进度和结果，经便于对整个模 块开发工作的管理和复审

11、，并为将来的维护提供非常有用的技术信息。1标 题2模块开发情况表：其中模块开发情况表的格式如下表:模块标识符模块的描述性名称代码设计（计划开始日期实际开始日期）模块测试（计划开始日期实际开始日期）组装测试（计划开始日期实际开始日期）代码复杳（日期/签字）源代码行数（预计/实际）目际模块大小（预计实际）项目负责人批准（日期/签字）3功能说明4设计说明5源代码清单6测试说明7复审的结论三、软件开发测试文档：概要测试计划、详细测试计划、测试实施计划、测试分 析报告。1. 概要测试计划：是软件项目实施计划中的一项重要的内容，应当在软件开发初 期、即需求分析阶段制订。项计划应当定义被测试对象和测试目标，

12、确定测试阶 段和测试周期的划分；制订测 试人员、软硬件资源和测试进度等方面的计划， 规定软件测试方法，测试标准以及支持环境和测试工具。2. 详细测试计划：是针对子系统在特定的测试阶段所要进行的测试工作制订详细 计划，它详细说明规定了测试小组的各项测试任务，测试策略、任务分配和进度 安排等。3. 测试实施计划：测试人员的测试实施计划是根据详细计划制订的测试者的测试 具体实施计划。它规定了测试者在每一轮测试中负责测试的内容，测试强度和工 作进度等。测试实施计划是整个软件测试的组成部分，是检查测试实际执行情况 的重要依据。其格式要求如下：1引言1. 1编写目的1. 2背景1. 3定义1. 4参考资料

13、2计划2. 1软件说明2. 2测试内容2.3 测试2. 3. 1进度安排2. 3. 2条件2.3.3 测试资料2. 3. 4测试培训2.4 测试3 测试设计说明3.1 测试3. 1. 1控制3. 1. 2输入3. 1. 3输出3. 1. 4过程3. 2测试4评价准则4. 1 范围4. 2数据整理4. 3尺度4. 测试分析报告：测试工作完成以后，应当提交测试计划情况说明书，对测试结 果加以分析，并提出测试的结论性意见。其格式要求如下：1引言1. 1编写目的1. 2背景1. 3定义1. 4参考资料2测试概要3测试结果及发现3.1 测试 13.2 测试 24对软件功能的结论4. 1功能14. 1.

14、1能力4. 1. 2限制4.2 功能 25分析摘要5. 1能力5. 2缺陷和限制5. 3建议5.4 评价6测试资源消耗四、用户文档：用户手册、操作手册。1. 用户手册：用户手册的编制是要使用非专门术语的语言，充分地描述该软件系 统所具有的功能及基本的使用方法，使用户（或潜在用户）通过本手册能够了解 该软件的用途，并且能够确定在什么情况下，如何使用它。其格式要求如下：1引言1. 1编写目的1. 2背景1. 3定义1. 4参考资料2用途2. 1功能2. 2性能2. 2. 1精度2. 2. 2 时间特性2. 2. 3灵活性2. 3安全保密3运行环境3. 1硬设备3. 2支持软件3. 3数据结构4使用过程4. 1安装与初始化4. 2输入4. 2. 1输入数据的现实背景4. 2. 2输入格式4. 2. 3输入举例4. 3输出4. 3. 1输出数据的现实背景4.3.2 输出格式4.3.3 输出举例4. 4文卷查询4. 5出错处理和恢复4. 6终端操作2. 操作手册:操作手册的编制是为了向操作人员提供该软件每一个运行的具体过 程和有关知识，包括操作方