1、软件文档编写指南 目 录 封面格式： .2 系统规约说明书（System Specification） .3 软件项目可行性研究报告（Report for Feasibility Study） .4 软件项目计划（Software Project Plan） .6 需求规格说明书（Requirements Specification ） .7 概要设计说明书（Architectural Design Specification）.8 详细设计说明书（Procedural Design Specificatio n） .9 用户操作手册（User Guide） .10 测试计划（Test Pla
2、n） .12 测试分析报告（Test Specification）.13 开发进度月报.14 项目开发总结报告.15 软件修改报告.16 1/16 软件文档编写指南 封面格式： 文档编号版 本 号文档名称：项目名称：项目负责人：编写 年 月 日 校对 年 月 日 审核 年 月 日 批准 年 月 日 开发单位- 2 - 软件文档编写指南 系统规约说明书（System Specification） 一引言 A. 文档的范围和目的 B. 概述 1目标 2约束 二功能和数据描述 A. 系统结构 1结构关系图 2结构关系图描述 三子系统描述 A. 子系统 N 的结构图规约说明 B. 结构字典 C. 结构
3、连接图和说明 四系统建模和模拟结构 A. 用于模拟的系统模型 B. 模拟结果 C. 特殊性能 五软件项目问题 A. 软件项目可行性研究报告 B. 软件项目计划 六附录 - 3 - 软件文档编写指南 软件项目可行性研究报告（Report for Feasibility Study） 一引言 1编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2项目背景（ ：（1） 建 开发的软件名称 （2）项目的 出者 开发者 用户 单位 （3）项目 软件 系统的关系 ） 3 （ 出文档 用 的 的 和 的 文 ） 4 （ 出关的作者 标题 编号 发日 出版单位 ） 二可行性研究的currency1 1
4、要求（ 出说明建 开发软件的“本要求，（1）功能 （2）性能 （3）出 （4） （5）“本的数据fifl和 fifl （6） 要求 （7） 软件关的 系统 （8） ） 2 目标（可 ：（1）人” 设用的 （2） 度的 （3）度和能”的 （4） 的改进 （5）系统的改进 （6）人 作的 ， ） 3 件 和（可 ：（1）建 开发软件 行的 （2）进行系统 的 （3） 和 用 （4） 和 面的 （5）件 软件 行 和开发 的 件和 （6）可 用的和 （7）建 开发软件 用的 ） 4 可行性研究 5 可行性的要 三对 系统的分析 1 fifl和数据fifl 2作负 3用 出（人” 设 性 项开 ） 4
5、人 （ 出 需人 的 和数 ） 5设 6性（说明 系统的问题 需要开发 的系统 ） 四 建 可行性分析 1对系统的简要描述 2 fifl和数据fifl 3 系统 的优越性 4采用建 系统可能带的影响 （1）对设的影响 （2）对 软件的影响 （3）对用户的影响 （4）对系统 行的影响 （5）对开发 的影响 （6）对 行 的影响 （7）对 出的影响 5 可行性评价（ ：（1） 件下，功能目标是否能够达 （2） 用 - 4 - 软件文档编写指南 ，功能目标能否达 （3）对开发人 数 和质 的要求，说明能否满足 （4）规 的内，开发能否 ） 五 建 系统 济可行性分析 1指出 （1）“建 （2） 一次
6、性 出 （3） 常性 出 2益 （1）一次性收益 （2） 常性收益 （3）不可 收益 3收益/ 4 回收周 5敏感性分析（指一些关键性 ，：系统周长 系统作负 度要求 设和软件配置变化对 出和益的影响的分析 ） 六社会 可行性分析 1 （，合同责 侵犯 权 侵犯版权问题的分析 ） 2用户 用可行性（，用户单位的行 作度 人 质能否满足要求 ） 七 可供 的 （逐个阐明 可供 的 ，重点说明未被推荐的由 ） 八结论意见（可能是：（1）可着手组织开发 （2）需待若干 件（金 人”设）具后才能开发 （3）需对开发目标进行某些修改 （4）不能进行 不必进行（ 不熟， 济上不合算） （4） ） - 5
7、- 软件文档编写指南 软件项目计划（Software Project Plan） 一引言 1编写目的（阐明编写软件计划的目的，指出读者对象 ） 2项目背景（可 ：（1）项目委托单位 开发单位和部 （2）该软件系统 系统的关系 ） 3 （ 出本文档 用 的 的 和 的 文 ） 4 （可 ：（1）项目 核准的计划 书 合同 上级机关的批文 （2）文档 引用的 规范 出的作者 标题 编号 发日 出版单位 ） 二项目概述 1. 作内容（简要说明项目的各项要作,介绍 开发软件的功能 性能. 若不编写可行性研究报告,则 本给出 详细的介绍 ) 2. 件 （阐明 项目 具的 件 开发单位已具的 件 尚需创造
8、的 件. 必要还 说明用户 分合同承 者承担的作 它 件 ） 3. 品 （1）fl序（ 出 交付的fl序名称 用的 言 储形式 ） （2）文档（ 出 交付的文档 ） （3） 行 （ 件 软件 ） 4 （阐明开发单位可向用户 供的 . 人 培训 装 修 维护和 行 ） 5验收标准 三 施计划 1 分解（ 的划分 各项 的负责人 ） 2进度（按阶段的项目,用图说明开始 ） 3预算 4关键问题（说明可能影响项目的关键问题,设 件 难点 风险 ,说明对 ） 四人 组织 分 五交付 六 题计划要点（测试计划 质 证计划 配置计划 人 培训计划 系统装计划 ） - 6 - 软件文档编写指南 需求规格说明书
9、（Requirements Specification） 一引言 1 编写目的（阐明编写需求说明书的目的,指明读者对象 ） 2 项目背景（可 ：（1）项目的委托单位,开发单位和部 （2）该软件系统 系统的关系 ） 3 （ 出文档 用 的 和 写 的 文 ） 4 （可 ：（1）项目 核准的计划 书,合同 上机机关的批文 （2）项目开发计划 （3）文档 引用的，标准和规范 出这些的作者 标题 编号 发日 出版单位 ） 二 概述 1目标 2 行 3 件 三数据描述 1 静态数据 2 动态数据（ 数据和出数据 ） 3 数据库描述（给出 用数据库的名称和型 ） 4 数据 典 5 数据采集 四功能需求 1
10、功能划分 2功能描述 五性能需求 1数据确度 2特性（响 更 数据转化 传 行 ） 3适 性（操作 式 行 软件的接 开发计划发变化， 具的适 能” ） 六 行需求 1用户 面（ 格式 报格式 单格式 出 ） 2件接 3软件接 4 七 需求（可 用性 可维护性 可 性 ） - 7 - 软件文档编写指南 概要设计说明书（Architectural Design Specification） 一引言 1编写目的（阐明编写概要设计说明书的目的，指明读者对象 ） 2项目背景（可 ：（1）项目的委托单位,开发单位和部 （2）该软件系统 系统的关系 ） 3 （ 出文档 用 的 和 写 的 意 ） 4 （
11、出这些的作者 标题 编号 发日 出版单位 ，可：（1）项目 核准的计划 书，合同 上机机关的批文 （2）项目开发计划 （3）需求规格说明书 （4）测试计划（ ） （5）用户操作手册（ ） （6）文档引用的 采用的标准 规范 ） 二 概述 1目标 2 行 3需求概述 4 件 三总 设计 1 fifl 2总 结构和模 部设计 3功能分配（明各项功能 fl序结构的关系 ） 四接 设计 1 部接 （ 用户 面 软件接 件接 ） 2内部接 （模 的接 ） 五数据结构设计 1 结构设计 2 结构设计 3 数据结构 fl序的关系 六 行设计 1 行模 的组合 2 行 3 行 七出 设计 1出 出 2出 对（
12、设置后 性能 级 动 ） 八 设计 维护设计（说明 维护作的设施,维护模 ） - 8 - 软件文档编写指南 详细设计说明书（Procedural Design Specification） 一引言 1 编写目的（阐明编写详细设计说明书的目的,指明读者对象 ） 2 项目背景（ 项目的和部 ） 3 （ 出文档 用 的 和 写 的 意 ） 4 （ 出这些的作者 标题 编号 发日 出版单位 ，可：（1）项目的计划 书,合同 批文 （2）项目开发计划 （3）需求规格说明书 （3）概要设计说明书 （4）测试计划( ) （5）用户操作手册( ) （5）文档 引用的 软件开发标准 规范 ） 二总 设计 1需求
13、概述 2软件结构（给出软件系统的结果图 ） 三fl序描述（逐个模 给出下的说明:：） 1功能 2性能 3项目 4出项目 5算 （模 用的算 ） 6fl序 （详细描述模 的算 ，可采用:：（1）标准fifl图 （2）PDL 言 （3）N-S 图 （4）PAD （5） 描述算 的图 ） 7接 8储分配 9 件 10 测试要点（给出测试模 的要测试要求 ） - 9 - 软件文档编写指南 用户操作手册（User Guide） 一引言 1编写目的（阐明编写手册的目的，指明读者对象 ） 2项目背景（说明项目的 委托单位 开发单位 部 ） 3 （ 出手册 用 的 和 写 的 意 ） 4 （ 出这些的作者 标
14、题 编号 发日 出版单位 ，可：（1）项目的计划 书,合同 批文 （2）项目开发计划 （3）需求规格说明书 （4）概要设计说明书 （5）详细设计说明书 （6）测试计划 （7）手册 引用的 采用的软件fl标准 软件fl规范 ） 二软件概述 1目标 2功能 3性能 （1）数据确度（ 出 数据的度 ） （2）特性（响 数据传 ） （3） 性（操作 式 行 需 某些变更软件的适 能” ） 三 行 1件（ 出软件系统 行 需的件 配置，：（1）计算机型号 容 （2） 储 录格式 设型号 数 （3） 出设 （4）数据传设 数据转设的型号 数 ） 2 软件（：（1）操作系统名称 版本号 （2） 言编系统 编
15、系统的名称 版本号 （3）数据库系统的名称 版本号 （4） 必要的 软件 ） 四 用说明 1装和 始化（给出fl序的储形式 操作 currency1 明装的测试 装 需的软件具 ） 2（给出数据 数的要求 ） （1）数据背景（说明数据 储 出 “度 和质 ） （2）数据格式（：（1）长度（2）格式“准（3）标号（4）序（5）分（6）（7） 和重 （8） ） （3）fi 3出（给出fl项出数据的说明 ） （1）数据背景（说明出数据的 向 用“度 质 ） （2）数据格式（详细阐明fl一出数据的格式,:部 和部的具 形式 ） （3）fi 3出 和 （给出：（1）出 currency1 （2）用户 采的 施，修改 动 ） 4求（说明操作 ） 五 行说明 1 行 出fl”可能的 行,说明 行目的. 2 行 按序说明fl” 行的 , : - 10 -
