软件开发文档说明书

《软件开发文档说明书》由会员分享，可在线阅读，更多相关《软件开发文档说明书（17页珍藏版）》请在装配图网上搜索。

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

2、发者双方对该软件的初始规定有一 个共同的理解、并使之面成为 整个开发工作的基础。其格式要求如下：1 引言11 编写目的。12 背景13 定义2 任务概述21 目标22 用户的特点23 假定和约束3 需求规定31 对功能的规定32 对性能的规定321 精度322 时间特性的需求323 灵活性33 输入输出要求34 数据管理能力要求35 故障处理要求36 其他专门要求4 运行环境规定41 设备42 支持软件43 接口44 控制2、概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。编 制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理。流程、程序 系统的组织 结构、模块划分、功

3、能分配、接口设计。运河行设计、数据结构设 计和出错处理设计等，为程序的详细设计提供基础。其格式要求如下：1 引言11 编写目的12 背景13 定义14 参考资料2 总体设计21 需求规定23 基本设计概念和处理流程24 结构25 功能需求与程序的关系26 人工处理过程27 尚未解决的问题3 接口设计31 用户接口32 外部接口3.。3 内部接口4 运行设计41 运行模块的组合42 运行控制43 运行时间5 系统数据结构设计51 逻辑结构设计要点52 物理结构设计要求53 数据结构与程序的关系6 系统出错处理设计61 出错信息62 补救措施63 系统维护设计。3. 详细设计文档：主要是把我们每个

4、小模块，小功能的业务逻辑处理用文字的方 式表达出来，让程序员在编码的时候有一个依据和参照；同时，在进行详细文档 设计的时候，有的软件公司也会根据不同的项目作出相应的软件开发代码规范 性文档，以保障我们所做工作的统一性。如果一个软件系比较简单，层次很少本文件可以不单独编写，有关内容合并入概要设计说明书。其格式要求如下：1 引言11 编写目的12 背景13 定义14 参考资料2 程序设计系统的结构3 程序 1 设计说明31 程序描述32 功能33 性能34 输入项35 输出项36 算法37 流程逻辑38 接口39 存储分配310 注释设计311 限制条件312 测试计划313 尚未解决的问题4 程

5、序 2 设计说明 .二、软件开发管理文档：可行性研究报告、项目开发计划、开发进度月报、项目 开发总结、模块开发卷宗。1. 可行性研究报告：编写目的是，说明该软件开发项目的实现在技术、经济和社 会条件方面的可行性：评述为了合理达到开发目标而可能选择的各种方案；说明 并论证所选定的方案。其格式要求如下：1 引言11 编写目的12 背景13 定义14 参考资料2 可行性研究的前提21 要求22 目标23 条件、假定和限制24 进行可行性研究的方法25 评价尺度3 对现有系统的分析31 处理流程和数据流程32 工作负荷33 费用开支34 人员35 设备36 局限性4 所建议的系统41 对所建议系统的说

6、明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 使用方面

7、的可行性8 结论2. 项目开发计划：是为软件项目实施方案制定出的具体计划。项目开发计划应提 前给管理部门，并作为开发阶段评审的基础。编制项目开发计划的止的是用文件 的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、 所需的软硬条件等问题做出的安排记载下来，以便根据本计划开展和检查项目的 开发工作。其格式要求如下：1 引言11 编写目的12 定义13 参考资料2 项目概述21 工作内容22 主要参加人员23 产品231 程序232 方件233 服务234 非移交的产品24 验收标准25 完成项目的最迟期限26 本计划的批准者和批准日期3 实施计划31 工作任务的分配与人员分工

8、32 接口人员33 进度34 预算35 关键问题4支持条件41 计算机系统支持42 需收用户承担的工作43 由外单位提供的条件5 专题计划要点3. 开发进度月报：开发进度月报的编制目的是及时向有关部门汇报项目开发的进 度和情况，以便及时 发现和处理开发过程中出现的问题，一般开发进度月报是 以项目组单位每月编写的。如果被开发的软件系统规模比较大，整个工程项目被 划分给若干个分项目驵承担，开发进度月报将以分项目为单位搂月编写。 其格 式要求如下：1 标题2 工程进度与状态21 进度22 状态3 资源耗用与状态31 资源耗用311 工时313 机时32 状态4 经费支出与状态41 经费支出411 支

9、持性费用412 设备购置费42 状态5 下一个月的工作计划6 建议4. 项目开发总结：软件项目开发完成之后，应当与项目实施计划对照，总结实际 执行的情况，如进度、 成果、资源利用、成本和投入的人力。此外，还需对开 发工作做出评价，总结经验和教训。项目开发总结报告的编制是为了总结本项目 开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评 价。其格式要求如下：1 引言11 编写目的12 背景14 参考资料2 实际开以结果21 产品22 主要功能和性能23 基本流程24 进度25 费用3 开发工作评价31 对生产效率的评价32 对产品质量的评价33 对技术方法的评价34 出错原因

10、的分析4 经验与教训5. 模块开发卷宗：模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一 个模块或一组密切相关的模块的复制进编写一份，应该把所有的模块开发卷宗汇 集在一起。编写的目的是记录和汇意低层次开发的进度和结果，经便于对整个模 块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。 1 标题2 模块开发情况表：其中模块开发情况表的格式如下表：模块标识符模块的描述性名称代码设计（计划开始日期实际开始日期）模块测试（计划开始日期实际开始日期）组装测试（计划开始日期实际开始日期）代码复查（日期/签字）源代码行数（预计/实际）目际模块大小（预计实际）项目负责人批准（日期/签字）3

11、功能说明4 设计说明5 源代码清单6 测试说明7 复审的结论三、软件开发测试文档：概要测试计划、详细测试计划、测试实施计划、测试分 析报告。1. 概要测试计划：是软件项目实施计划中的一项重要的内容，应当在软件开发初 期、即需求分析阶段制订。项计划应当定义被测试对象和测试目标，确定测试阶 段和测试周期的划分；制订测 试人员、软硬件资源和测试进度等方面的计划， 规定软件测试方法，测试标准以及支持环境和测试工具。2. 详细测试计划：是针对子系统在特定的测试阶段所要进行的测试工作制订详细 计划，它详细说明规定了测试小组的各项测试任务，测试策略、任务分配和进度 安排等。3. 测试实施计划：测试人员的测试

12、实施计划是根据详细计划制订的测试者的测试 具体实施计划。它规定了测试者在每一轮测试中负责测试的内容，测试强度和工 作进度等。测试实施计划是整个软件测试的组成部分，是检查测试实际执行情况 的重要依据。其格式要求如下：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. 测试分析报告：测试工作完成以后，应当提交测试计划情况说明书，对测试结 果加以分

13、析，并提 出测试的结论性意见。其格式要求如下：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 定义1

14、4 参考资料2 用途21 功能22 性能221 精度222 时间特性223 灵活性23 安全保密3 运行环境31 硬设备32 支持软件33 数据结构4 使用过程41 安装与初始化42 输入421 输入数据的现实背景422 输入格式43 输出431 输出数据的现实背景432 输出格式433 输出举例44 文卷查询45 出错处理和恢复46 终端操作2. 操作手册：操作手册的编制是为了向操作人员提供该软件每一个运行的具体过 程和有关知识，包括操作方法的细节。其格式要求如下：1 引言11 编写目的12 背景13 定义14 参考资料2 软件征述21 软件的结构22 程序表23 文卷表3 安装与初始化4

15、运行说明41 运行表42 运行步骤431 运行控制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 附录二文档编制说明：文档标题用于说明项目的名称，文档主题用于说明本文档的内容 文档编号和文档版本主要用于归档和检索。