825编号软件开发文档说明(完整流程)

《825编号软件开发文档说明(完整流程)》由会员分享，可在线阅读，更多相关《825编号软件开发文档说明(完整流程)（10页珍藏版）》请在金锄头文库上搜索。

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 需求规定 22 运行环境 23 基本设计概念和处理流程 24 结构 25 功能需求与程序的关系 26 人工处理过程 27 尚未解决的问题 3 接口设计 31 用户接口 32 外部接口 3.。3 内部接口 4 运行设计 41 运行模块的组合 42 运行控制 43 运行时间 5 系统数据结构设计 51 逻辑结构设计要点 52 物理结构设计要求 53 数

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

5、3 性能 34 输入项 35 输出项 36 算法 37 流程逻辑 38 接口 39 存储分配 310 注释设计 311 限制条件 312 测试计划 313 尚未解决的问题 4 程序 2 设计说明 . 二、软件开发管理文档：可行性研究报告、项目开发计划、开发进度月报、项 目开发总结、模块开发卷宗。 1.可行性研究报告：编写目的是，说明该软件开发项目的实现在技术、经济和 社会条件方面的可行性：评述为了合理达到开发目标而可能选择的各种方案； 说明并论证所选定的方案。 其格式要求如下： 1 引言 11 编写目的 12 背景 13 定义 14 参考资料 2 可行性研究的前提 21 要求 22 目标 23

6、 条件、假定和限制 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 可选择的系统方案 1 52 可选择的系统方案 2 6 投资及效

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

8、工作。 其格式要求如下： 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.开发进度月报：开发进度月报的编制目的是及时向有关部门汇报项目开发的 进度和情况，以便及时 发现和处理开发过程

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

10、价，总结经验和教训。项目开发总结报告的编制是为了总结本 项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方 面的评价。 其格式要求如下： 1 引言 11 编写目的 12 背景 13 定义 14 参考资料 2 实际开以结果 21 产品 22 主要功能和性能 23 基本流程 24 进度 25 费用 3 开发工作评价 31 对生产效率的评价 32 对产品质量的评价 33 对技术方法的评价 34 出错原因的分析 4 经验与教训 5.模块开发卷宗：模块开发卷宗是在模块开发过程中逐步编写出来的，每完成 一个模块或一组密切相关的模块的复制进编写一份，应该把所有的模块开发卷 宗汇集在一起。编

11、写的目的是记录和汇意低层次开发的进度和结果，经便于对 整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。 1 标题 2 模块开发情况表： 其中模块开发情况表的格式如下表： 模块标识符模块标识符 模块的描述性名称模块的描述性名称 代码设计（计划开始日期 实际开始日期）代码设计（计划开始日期 实际开始日期） 模块测试（计划开始日期 实际开始日期） 组装测试（计划开始日期 实际开始日期） 代码复查(日期/签字) 源代码行数（预计/实际） 目际模块大小（预计 实际） 项目负责人批准(日期/签字) 3 功能说明 4 设计说明 5 源代码清单 6 测试说明 7 复审的结论 三、软件开发测

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

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

14、性意见。 其格式要求如下： 1 引言 11 编写目的 12 背景 13 定义 14 参考资料 2 测试概要 3 测试结果及发现 31 测试 1 32 测试 2 4 对软件功能的结论 41 功能 1 411 能力 412 限制 42 功能 2 5 分析摘要 51 能力 52 缺陷和限制 53 建议 54 评价 6 测试资源消耗 四、用户文档：用户手册、操作手册。 1.用户手册：用户手册的编制是要使用非专门术语的语言，充分地描述该软件 系统所具有的功能及基本的使用方法，使用户（或潜在用户）通过本手册能够 了解该软件的用途，并且能够确定在什么情况下，如何使用它。 其格式要求如下： 1 引言 11 编

15、写目的 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 编写目的

16、12 背景 13 定义 14 参考资料 2 软件征述 21 软件的结构 22 程序表 23 文卷表 3 安装与初始化 4 运行说明 41 运行表 42 运行步骤 43 运行 1 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 数据备