软件工程文档编写指南

《软件工程文档编写指南》由会员分享，可在线阅读，更多相关《软件工程文档编写指南（11页珍藏版）》请在金锄头文库上搜索。

1、 软件文档编写指南软件文档编写指南封面格式：封面格式：文档编号 版 本 号 文档名称： 项目名称： 项目负责人： 编写 年 月 日校对 年 月 日审核 年 月 日批准 年 月 日开发单位 系统规约说明书（系统规约说明书（System Specification）一引言 A. 文档的范围和目的 B. 概述 1目标 2约束 二功能和数据描述 A. 系统结构 1结构关系图 2结构关系图描述 三子系统描述 A. 子系统 N 的结构图规约说明 B. 结构字典 C. 结构连接图和说明 四系统建模和模拟结构 A. 用于模拟的系统模型B. 模拟结果 C. 特殊性能 五软件项目问题 A. 软件项目可行性研究报告

2、 B. 软件项目计划 六附录软件项目可行性研究报告（软件项目可行性研究报告（Report for Feasibility Study）一引言 1编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、 用户及实现单位；（3）项目与其他软件或其他系统的关系。 ） 3定义（列出文档中用到的专门术语的定义和缩略词的原文。 ） 4参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。 ） 二可行性研究的前提 1 要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出； （4）输入；（

3、5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软 件相关的其他系统；（8）完成期限。 ） 2 目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精 度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人 员工作效率的提高，等等。 ） 3 条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统 方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制； （5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源； （7）建议开发软件投入使用的最迟时间。 ） 4 可行性研究方法 5 决定

4、可行性的主要因素 三对现有系统的分析 1处理流程和数据流程 2工作负荷 3费用支出（如人力、设备、空间、支持服务、材料等项开支。 ） 4人员（列出所需人员的专业技术类别和数量。 ） 5设备 6局限性（说明现有系统存在的问题以及为什么需要开发新的系统。 ） 四所建议技术可行性分析 1对系统的简要描述 2处理流程和数据流程 3与现有系统比较的优越性 4采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响（3）对用户的影响 （4）对系统运行的影响 （5）对开发环境的影响 （6）对运行环境的影响 （7）对经费支出的影响 5技术可行性评价（包括：（1）在限制条件下，功能目标是否能够达到

5、；（2）利用现 有技术，功能目标能否达到；（3）对开发人员数量和质量的要求，并说明能否满足； （4）在规定的期限内，开发能否完成。 ） 五所建议系统经济可行性分析 1指出 （1）基建投资 （2）其他一次性支出 （3）经常性支出 2效益 （1）一次性收益 （2）经常性收益 （3）不可定量收益 3收益/投资比 4投资回收周期 5敏感性分析（指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速 度要求、设备和软件配置变化对支出和效益的影响等的分析。 ） 六社会因素可行性分析 1法律因素（如，合同责任、侵犯专利权、侵犯版权等问题的分析。 ） 2用户使用可行性（如，用户单位的行政管理、工作制度

6、、人员素质等能否满足要求。 ） 七其他可供选择的方案（逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。 ） 八结论意见（可能是：（1）可着手组织开发；（2）需待若干条件（如资金、人力设备 等）具备后才能开发；（3）需对开发目标进行某些修改；（4）不能进行或不必进行 （如技术不成熟，经济上不合算等） ；（4）其他。 ）软件项目计划（软件项目计划（Software Project Plan）一引言 1编写目的（阐明编写软件计划的目的，指出读者对象。 ） 2项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。 ） 3定义（列出本文档中用到的专门术语的定

7、义和缩略词的原文。 ） 4参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2） 文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或 资料来源。 ） 二项目概述 1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能 性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。) 2. 条件与限制（阐明为完成项目应具备的条件 开发单位已具备的条件以及尚需创造的 条件. 必要时还应说明用户及分合同承包者承担的工作 完成期限及其它条件与限制。 ） 3. 产品（1）程序（列出应交付的程序名称 使用的语言及存储形式。 ）（2）文档（列出应交付的

8、文档。 ）（3）运行环境（应包括硬件环境 软件环境。 ） 4服务（阐明开发单位可向用户提供的服务. 如人员培训 安装 保修 维护和其他运行 支持。 ） 5验收标准 三实施计划 1任务分解（任务的划分及各项任务的负责人。 ） 2进度（按阶段完成的项目,用图表说明开始时间 完成时间。 ） 3预算 4关键问题（说明可能影响项目的关键问题,如设备条件 技术难点或其他风险因素,并说 明对策。 ） 四人员组织及分工 五交付期限 六专题计划要点（如测试计划 质量保证计划 配置管理计划 人员培训计划 系统安装计 划等。 ）需求规格说明书（需求规格说明书（Requirements Specification）一

9、引言 1 编写目的（阐明编写需求说明书的目的,指明读者对象。 ） 2 项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统 与其他系统的关系。 ） 3 定义（列出文档中用到的专门术语定义和缩写词的原文。 ） 4 参考资料（可包括：（1）项目经核准的计划任务书,合同或上机机关的批文；（2） 项目开发计划；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、 编号、发表日期、出版单位或资料来源。 ） 二任务概述 1目标 2运行环境 3条件与限制 三数据描述 1 静态数据 2 动态数据（包括输入数据和输出数据。 ） 3 数据库描述（给出使用数据库的名称和类型。 ）

10、4 数据词典 5 数据采集四功能需求 1功能划分 2功能描述 五性能需求 1数据精确度 2时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。 ） 3适应性（在操作方式 运行环境 与其他软件的接口以及开发计划等发生变化时，应具 有的适应能力。 ） 六运行需求 1用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。 ） 2硬件接口 3软件接口 4故障处理 七其他需求（如可使用性、安全保密、可维护性、可移植性等。 ）概要设计说明书（概要设计说明书（Architectural Design Specification）一引言 1编写目的（阐明编写概要设计说明书的目的，指明读者对

11、象。 ） 2项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统 与其他系统的关系。 ） 3定义（列出文档中用到的专门术语定义和缩写词的原意。 ） 4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可 包括：（1）项目经核准的计划任务书，合同或上机机关的批文；（2）项目开发计划； （3）需求规格说明书；（4）测试计划（初稿） ；（5）用户操作手册（初稿） ；（6） 文档所引用的资料、采用的标准或规范。 ） 二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三总体设计1处理流程2总体结构和模块外部设计3功能分配（表明各项功能与程序结构的关系

12、。 ） 四接口设计 1外部接口（包括用户界面 软件接口与硬件接口。 ） 2内部接口（模块之间的接口。 ） 五数据结构设计 1 逻辑结构设计 2 物理结构设计3 数据结构与程序的关系 六运行设计 1运行模块的组合 2运行控制 3运行时间 七出错处理设计 1出错输出信息 2出错处理对策（如设置后备、性能降级、恢复及再启动等。 ） 八安全保密设计 九维护设计（说明为方便维护工作的设施,如维护模块等。 ）详细设计说明书（详细设计说明书（Procedural Design Specification）一引言 1 编写目的（阐明编写详细设计说明书的目的,指明读者对象。 ） 2 项目背景（应包括项目的来源和

13、主管部门等。 ） 3 定义（列出文档中用到的专门术语定义和缩写词的原意。 ） 4 参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源， 可包括：（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格 说明书；（3）概要设计说明书；（4）测试计划(初稿)；（5）用户操作手册(初稿)； （5）文档所引用的其他资料、软件开发标准或规范。 ） 二总体设计 1需求概述 2软件结构（如给出软件系统的结果图。 ） 三程序描述（逐个模块给出以下的说明:：） 1功能 2性能 3输入项目 4输出项目 5算法（模块所选用的算法。 ） 6程序逻辑（详细描述模块实现的算法，可采用:：

14、（1）标准流程图；（2）PDL 语言； （3）N-S 图；（4）PAD；（5）判定表等描述算法的图表。 ） 7接口 8存储分配 9限制条件 10测试要点（给出测试模块的主要测试要求。 ）用户操作手册（用户操作手册（User Guide）一引言1编写目的（阐明编写手册的目的，指明读者对象。 ） 2项目背景（说明项目的来源、委托单位、开发单位及主管部门。 ） 3定义（列出手册中用到的专门术语定义和缩写词的原意。 ） 4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可 包括：（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格说 明书；（4）概要设计说明书

15、；（5）详细设计说明书；（6）测试计划；（7）手册中 引用的其他资料、采用的软件工程标准或软件工程规范。 ） 二软件概述 1目标 2功能 3性能 （1）数据精确度（包括输入、输出及处理数据的精度。 ） （2）时间特性（如响应时间、处理时间、数据传输时间等。 ） （3）灵活性（在操作方式、运行环境需做某些变更时软件的适应能力。 ） 三运行环境 1硬件（列出软件系统运行时所需的硬件最小配置，如：（1）计算机型号、主存容量； （2）外存储器、媒体、记录格式、设备型号及数量；（3）输入、输出设备；（4） 数据传输设备及数据转换设备的型号及数量。 ） 2支持软件（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称 及版本号；（3）数据库管理系统的名称及版本号；（4）其他必要的支持软件。 ） 四使用说明 1安装和初始化（给出程序的存储形式、操作命令、反