软件文档编写指南

《计算机软件文档编写指南》

一．计算机软件文档由封面、目录、正文、注释和附录组成。

封面格式：

密级：编号：

文档名称：

项目名称：

编制：

审核：

批准：

×××××××××××××研究所

年月日

二．计算机软件文档包括：

1）软件开发计划

2）软件需求规格说明

3）接口需求规格说明

4）接口设计文档

5）软件设计文档

6）软件产品规格说明

7）版本说明文档

8）软件测试计划

9）软件测试说明

10）软件测试报告

11）计算机系统操作员手册

12）软件用户手册

13）软件程序员手册

14）计算机资源综合保障文件

软件开发计划

一．引言

1．编写目的（阐明编写软件计划的目的，指出读者对象。）

2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）

3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。）

4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述

1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性

研究报告,则应在本节给出较详细的介绍。)

2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件.

必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。）

3.产品

（1）程序（列出应交付的程序名称使用的语言及存储形式。）

（2）文档（列出应交付的文档。）

（3）运行环境（应包括硬件环境软件环境。）

4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）

5．验收标准

三．实施计划

1．任务分解（任务的划分及各项任务的负责人。）

2．进度（按阶段完成的项目,用图表说明开始时间完成时间。）

3．预算

4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）

四．人员组织及分工

五．交付期限

六．专题计划要点（如测试计划质量保证计划配置管理计划人员培训计划系统安装计划等。）

软件需求规格说明

一．引言

1．编写目的（阐明编写需求说明书的目的,指明读者对象。）

2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）

3．定义（列出文档中用到的专门术语定义和缩写词的原文。）

4．参考资料（可包括：（1）项目经核准的计划任务书,合同或上机机关的批文；（2）项目开发计划；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）

二．任务概述

1．目标

2．运行环境

3．条件与限制

三．数据描述

1．静态数据

2．动态数据（包括输入数据和输出数据。）

3．数据库描述（给出使用数据库的名称和类型。）

4．数据词典

5．数据采集

四．功能需求

1．功能划分

2．功能描述

五．性能需求

1．数据精确度

2．时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）

3．适应性（在操作方式运行环境与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。）

六．运行需求

1．用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）

2．硬件接口

3．软件接口

4．故障处理

七．其他需求（如可使用性、安全保密、可维护性、可移植性等。）

概要设计说明书

一．引言

1．编写目的（阐明编写概要设计说明书的目的，指明读者对象。）

2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）

3．定义（列出文档中用到的专门术语定义和缩写词的原意。）

4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目经核准的计划任务书，合同或上机机关的批文；（2）项目开发计划；（3）需求规格说明书；（4）测试计划（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采用的标准或规范。）

二．任务概述

1．目标

2．运行环境

3．需求概述

4．条件与限制

三．总体设计

1．处理流程

2．总体结构和模块外部设计

3．功能分配（表明各项功能与程序结构的关系。）

四．接口设计

1．外部接口（包括用户界面软件接口与硬件接口。）

2．内部接口（模块之间的接口。）

五．数据结构设计

1．逻辑结构设计

2．物理结构设计

3．数据结构与程序的关系

六．运行设计

1．运行模块的组合

2．运行控制

3．运行时间

七．出错处理设计

1．出错输出信息

2．出错处理对策（如设置后备、性能降级、恢复及再启动等。）

八．安全保密设计

九．维护设计（说明为方便维护工作的设施,如维护模块等。）

详细设计说明书

一．引言

1．编写目的（阐明编写详细设计说明书的目的,指明读者对象。）

2．项目背景（应包括项目的来源和主管部门等。）

3．定义（列出文档中用到的专门术语定义和缩写词的原意。）

4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格说明书；（3）概要设计说明书；（4）测试计划(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软件开发标准或规范。）

二．总体设计

1．需求概述

2．软件结构（如给出软件系统的结果图。）

三．程序描述（逐个模块给出以下的说明:：）

1．功能

2．性能

3．输入项目

4．输出项目

5．算法（模块所选用的算法。）

6．程序逻辑（详细描述模块实现的算法，可采用:：（1）标准流程图；（2）PDL语言；（3）N-S图；（4）PAD；（5）判定表等描述算法的图表。）

7．接口

8．存储分配

9．限制条件

10．测试要点（给出测试模块的主要测试要求。）

用户操作手册

一．引言

1．编写目的（阐明编写手册的目的，指明读者对象。）

2．项目背景（说明项目的来源、委托单位、开发单位及主管部门。）

3．定义（列出手册中用到的专门术语定义和缩写词的原意。）

4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书,合同或批文；（2）项目开发计划；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；（6）测试计划；（7）手册中引用的其他资料、采用的软件工程标准或软件工程规范。）

二．软件概述

1．目标

2．功能

3．性能

（1）数据精确度（包括输入、输出及处理数据的精度。）

（2）时间特性（如响应时间、处理时间、数据传输时间等。）

（3）灵活性（在操作方式、运行环境需做某些变更时软件的适应能力。）

三．运行环境

1．硬件（列出软件系统运行时所需的硬件最小配置，如：（1）计算机型号、主存容量；（2）外存储器、媒体、记录格式、设备型号及数量；（3）输入、输出设备；（4）数据传输设备及数据转换设备的型号及数量。）

2．支持软件（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称及版本号；（3）数据库管理系统的名称及版本号；（4）其他必要的支持软件。）

四．使用说明

1．安装和初始化（给出程序的存储形式、操作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件工具等。）

2．输入（给出输入数据或参数的要求。）

（1）数据背景（说明数据来源、存储媒体、出现频度、限制和质量管理等。）

（2）数据格式（如：（1）长度（2）格式基准（3）标号（4）顺序（5）分隔符（6）词汇表（7）省略和重复（8）控制。）

（3）输入举例

3．输出（给出每项输出数据的说明。）

（1）数据背景（说明输出数据的去向、使用频度、存放媒体及质量管理等。）

（2）数据格式（详细阐明每一输出数据的格式,如:首部主体和尾部的具体形式。）

（3）举例

3．出错和恢复（给出：（1）出错信息及其含义（2）用户应采取的措施，如修改、恢复、再启动。）

4．求助查询（说明如何操作。）

五．运行说明

1．运行表[列出每种可能的运行情况,说明其运行目的.]

2．运行步骤[按顺序说明每种运行的步骤,应包括:]

（1）运行控制

（2）操作信息（（1）运行目的（2）操作要求（3）启动方法（4）预计运行时间（5）操作命令格式及说明（6）其他事项。）

（3）输入/输出文件（给出建立和更新文件的有关信息，如：（1）文件的名称及编号（2）记录媒体（3）存留的目录（4）文件的支配[说明确定保留文件或废弃文件的准则，

分发文件的对象，占用硬件的优先级及保密控制等。）

（4）启动或恢复过程

六．非常规过程（提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。）

七．操作命令一览表

（按字母顺序逐个列出全部操作命令的格式功能及参数说明。）

八．程序文件（或命令文件）和数据文件一览表（按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。）

九．用户操作举例

测试计划

一、引言

1．编写目的（阐明编写测试计划的目的,指明读者对象。）

2．项目背景（说明项目的来源委托单位及主管部门。）

3．定义（列出测试计划中用到的专门术语定义和缩写词的原意。）

4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书，合同或批文；（2）项目开发计划；（3）需求规格说明书；（3）概要设计说明书；（4）详细设计说明书；（5）用户操作手册; g本测试计划中引用的其他资料采用的软件开发标准或规范。）

一．任务概述

1．目标

2．运行环境

3．需求概述

4．条件与限制

二．计划

1．测试方案（说明确定测试方法和选取测试用例的原则。）

2．测试项目（列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。）

3．测试准备

4．测试机构及人员（测试机构名称负责人和职责。）

三．测试项目说明（按顺序逐个对测试项目做出说明：）

1．测试项目名称及测试内容

2．测试用例

（1）输入（输入的数据和输入的命令。）

（2）输出（预期的输出数据。）

（3）步骤及操作

（4）允许偏差（给出实测结果与预测结果之间允许偏差的范围。）

3．进度

4．条件（给出项测试对资源的特殊要求，如设备、软件、人员等。）

5．测试资料（说明项测试所需的资料。）

四．评价

1．范围（说明所完成的各项测试说明问题的范围及其局限性。）

2．准则（说明评价测试结果的准则。）

测试分析报告

一．引言

1．编写目的（阐明编写测试分析报告的目的，指明读者对象。）

2．项目背景（说明项目的来源、委托单位及主管部门。）

3．定义（列出测试分析报告中用到的专门术语定义和缩写词的原意。）

4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书，合同或批文；（2）项目开发计划；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；（6）用户操作手册；（7）测试计划；（8）测试分析报告所引用的其他资料、采用的软件工程标准或软件工程规范。）

二．测试计划执行情况

1．测试项目（列出每一测试项目的名称、内容和目的。）

2．测试机构和人员（给出测试机构名称、负责人和参与测试人员名单。）

3．测试结果（按顺序给出每一测试项目的：（1）实测结果数据（2）与预期结果数据的偏差（3）该项测试说明的事实（4）该项测试发现的问题。）

三．软件需求测试结论（按顺序给出每一项需求测试的结论。包括：（1）证实的软件能力（2）局限性（即项需求未得到充分测试的情况及原因）。）

四．评价

1．软件能力（经过测试所表明的软件能力。）

2．缺陷和限制（说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影响。）3．建议（提出为弥补上述缺陷的建议。）

4．测试结论（说明能否通过。）

软件开发总结报告

一．引言

1．编写目的（阐明编写总结报告的目的,指明读者对象。）

2．项目背景（说明项目的来源、委托单位、开发单位及主管部门。）

3．定义（列出报告中用到的专门术语定义和缩写词的原意。）

4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目的计划任务书，合同或批文；（2）项目开发计划；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；（6）用户操作手册；（7）测试计划；（8）测试分析报告（9）本报告引用的其他资料、采用的开发标准或开发规范。）

二．开发结果

1．产品（可包括：（1）列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。）

2．主要功能及性能

3．所用工时（按人员的不同层次分别计时。）

4．所用机时（按所用计算机机型分别计时。）

5．进度（给出计划进度与实际进度的对比。）

6．费用

三．评价

1．生产率评价（如平均每人每月生产的源程序行数、文档的字数等。）

2．技术方案评价

3．产品质量评价

四．经验与教训

软件开发文档规范

附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。） 二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准

三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。） 四.人员组织及分工 五.交付期限 六.专题计划要点（如测试计划等。） 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时（按不同层次人员分别计时。） 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： （1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明

(国内标准)GB-软件开发主要文档编写规范

231 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。

[模板] 软件详细设计说明书编写指南

xxxxxx项目 详细设计说明书编写指南 编写单位

详细设计说明书编写指南变更履历

目录 第一章前言 (4) 1.1编写目的 (4) 1.2文档内容 (4) 第二章详细设计说明书的编写要求 (5) 2.1引言 (5) 2.1.1 编写目的 (5) 2.1.2 背景 (5) 2.1.3 定义 (5) 2.1.4 参考资料 (5) 2.2子系统设计 (5)

第一章前言 1.1 编写目的 本文旨在指导项目建设单位和承建单位编写详细设计说明书，详细设计是软件工程中软件开发的一个步骤，是对概要设计的细化过程。由于各承建单位采用的设计方法不尽相同，本文档提出详细设计阶段必须完成的工作内容，但不限制采用的设计方法和对详细设计成果的展现形式，各承建单位可以根据实际情况自行确定描述方法和展现形式。本文中的示例仅供参考。 1.2 文档内容 本指南主要包含以下内容： 一、描述详细设计说明书的编写要求。 二、举例说明详细设计说明书的编写方法。

第二章详细设计说明书的编写要求 本章节主要描述详细设计说明书的编写要求。详细设计说明书需满足“2.1引言”章节的内容和格式要求；详细设计说明书需满足“2.2章节”的内容要求，不限制格式。 各项目建设单位和承建单位编写详细设计说明书要满足本章的内容要求，不限制格式。 2.1 引言 2.1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。 2.1.2 背景 描述详细设计阶段的目标、作用范围以及其他应向读者说明的理解本文档所需的背景，如与公司其它软件之间的联系等。 2.1.3 定义 列出本文件中用到专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇，同时要求继承全部的先前过程中定义过的词汇。 2.1.4 参考资料 列出有关的参考资料，如： 1、本项目的经核准的计划任务书或合同、上级机关的批文； 2、属于本项目的其他已发表的文件； 3、本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。 2.2 子系统设计 本章描述详细设计阶段对每个模块的设计，包括实现算法、局部数据结构等内容。各项目可根据采用的详细设计方法，以说清楚对每个模块的设计为目的，

软件开发 软件产品开发文件编制指南

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告 可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。 表l 可行性研究报告 2、项目开发计划 编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的

负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。 表 2 项目开发计划 3、软件需求说明书 软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解， 使之成为整个软件开发工作的基础。其内容要求见表3。 表3 软件需求说明书 4、数据要求说明书 数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。 表4 数据要求说明书

5、概要设计说明书 概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。 表5 概要设计说明书 6、详细设计说明书 详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。 如果软件系统比较简单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。 表6 详细设计说明书 7、数据库设计说明书

软件开发文档说明书(完整流程)

. 在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。 1、软件需求说明书：也称为软件规格说明。该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。软件需求说明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。 其格式要求如下： 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、概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理。流程、程序系统的组织结构、模块划分、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。 其格式要求如下： 1 引言 1．1 编写目的 1．2 背景 1．3 定义 1．4 参考资料 2 总体设计 2．1 需求规定 2．2 运行环境 2．3 基本设计概念和处理流程 2．4 结构 2．5 功能需求与程序的关系

软件文档编写指南

《计算机软件文档编写指南》 一．计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式： 密级：编号： 文档名称： 项目名称： 编制： 审核： 批准： ×××××××××××××研究所 年月日

二．计算机软件文档包括： 1）软件开发计划 2）软件需求规格说明 3）接口需求规格说明 4）接口设计文档 5）软件设计文档 6）软件产品规格说明 7）版本说明文档 8）软件测试计划 9）软件测试说明 10）软件测试报告 11）计算机系统操作员手册 12）软件用户手册 13）软件程序员手册 14）计算机资源综合保障文件 软件开发计划 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述 1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性 研究报告,则应在本节给出较详细的介绍。) 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）

ISO软件开发全套文档~软件开发过程控制程序

北京易游无限科技公司 https://www.sodocs.net/doc/1d13054704.html, EUWX/QP 0714 软件开发过程控制控制程序 授控状态： 版号：A/O 分发号： 持有人： 2007年8月6日发布2007年8月6日实施

易游无限科技发布 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第1页

为保证软件产品及其文档可维护，软件开发过程得到有效控制，特制定本程序。 2适用范围 本程序文件适用于本公司有合同的所有软件开发过程的控制活动。 3定义 3．1需求分析：（引用GB/T11457-1995的2.404）研究用户要求以得到系统或软件需求定义的过程。 3．2概要设计：（引用GB/T11457-1995的2.343）分析各种设计方案和定义软件体系结构的过程。典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义，并提出时间和规模方面的估计。 3．3详细设计：（引用GB/T11457-1995的2.147）推敲并扩充概要设计，以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述，直到设计完善到足以能实现的地步。 3．4设计实现：（引用GB/T11457-1995的2.229）把设计翻译成代码，然后对此代码排除隐错的过程。它是程序的一种机器可执行形式，或者能被自动地翻译成机器可执行的形式的某种形式的程序。 4职责 4．1项目负责人：负责制订《项目计划》、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。 4．2需求分析员：作为开发方的代表，负责沟通用户和开发人员的认识和见解，明确及准确地编写《软件需求说明书》和初步的《系统指南》。 4．3系统设计员：负责把软件需求变换成可表示的可实现的软件形式，为设计实现提供可行的依据。并在设计过程中要负责编写《概要设计说明书》、《数据库设计说明书》、《详细设计说明书》，完成《系统指南》的编写。 4．4程序员：按设计要求把软件的详细设计变换成可执行的源程序，进行调试。完成相应的文档，编写《用户操作手册》。 4．5测试人员：负责制定测试计划，设计测试方案，测试用例，并实施测试。 4．6配置管理人员负责对开发库中软件配置项的管理和维护。 4工作程序 软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第2页

软件开发文档模板

软件开发文档模板 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 1 1.5.2 可选择的系统方案 2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资

1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点

系统详细设计说明书

文档标题 文档编号BH-CSD-003 版本V1.0 密级商密 A 研发生产中心项目名称全科医生专家咨询系统 项目来源 系统详细设计说明书 （V1.0 ） 南京毗邻智慧医疗科技有限公司 二○一三年十一月

文档变更记录 序号变更（ +/- ）说明作者版本号日期批准1 创建Steve.ma V1.0 2013.11.15 1 引言.......................................................................... (3) 1.1 编写目 的 ......................................................................... (3) 1.2 背 景 .......................................................................... (3) 1.3 定 义 .......................................................................... (3) 1.4 参考资 料 ......................................................................... (4) 2 平台安全体系与程序系统的结构........................................................................................ (4) 2.1 平台安全体 系 ........................................................................ (4) 2.2 程序系统结 构 ........................................................................ (5) 3 程序设计说 明 ........................................................................... (5) 3.1 程序描 述 ......................................................................... (5) 功能及其接 口 ........................................................................

软件编写指南

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

2．专案背景（应包括：（1）所建议开发的软体名称；（2）专案的任务提出者、开发者、用户及实现单位；（3）专案与其他软体或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。） 二．可行性研究的前提 1．要求（列出并说明建议开发软体的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入； （5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软体相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理资讯服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软体运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬体、软体、运行环境和开发环境的条件和限制；（6）可利用的资讯和资源；（7）建议开发软体投入使用的最迟时间。） 4．可行性研究方法 5．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什麽需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软体的影响 （3）对用户的影响 （4）对系统运行的影响 （5）对开发环境的影响 （6）对运行环境的影响 （7）对经费支出的影响 5．技术可行性评价（包括：（1）在限制条件下，功能目标是否能够达到；（2）利用现有技术，功能目标能否达到；（3）对开发人员数量和品质的要求，并说明能否满足；（4）在规定的期限内，开发能否完成。） 五．所建议系统经济可行性分析 1．指出 （1）基建投资 （2）其他一次性支出 （3）经常性支出

ISO软件开发全套文档-配置管理计划编写指南

产品/项目系统名称 配置管理计划 北京XXXX有限公司 200 年××月 1引言 1.1编写目的

编写的目的主要在于对所开发的软件系统规定各种必要的配置管理条款，以保证所开发出的软件能满足用户需求。 1.2背景 a.开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 b.开发的软件系统的最终用户或适用的领域； c.项目来源、主管部门等 1.3定义 列出本文件中涉及的专门术语定义和外文缩写的原词组。 1.4参考资料 列出涉及的参考资料。 2 管理 描述软件配置管理的机构、任务、职责和有关的接口控制。 2.1 机构 描述软件生存周期中各阶段中软件配置管理的功能和负责软件配置管理的机构。 说明项目和自项目与其他有关项目之间的关系。 指出在软件生存周期各阶段中的软件开发或维护机构与配置控制组的关系。 2.2 任务 描述在软件生存周期中各阶段的配置管理任务以及要进行的评审和检查工作，并指出各阶段的阶段产品应存放在哪一类软件库中（软件开发库、软件受控制库或软件产品库）。 2.3 职责 指出负责各项软件配置管理任务（如配置标识、配置控制、配置状态记录以及配置的评审与检查）的机构的职责； 指出上述机构与软件质量保证机构、软件开发单位、项目承办单位、项目委托单位以及用户等机构的关系。 说明软件生存周期各个阶段的评审、检查和审批过程中的用户职责以及相关的开发与维护活动。 指出与项目开发有关的各机构的代表的软件配置管理职责。 指出与其他特殊职责，例如为满足软件配置管理要求所必要的批准要求。 2.4 定义软件配置项（SCI） 包括： 1．系统约定 2．软件项目计划 3．软件需求文档 4．用户手册 5．设计文档

软件开发文档说明(又全又详细)

在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。 1.软件需求说明书：也称为软件规格说明。该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。软件需求说明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。 其格式要求如下： 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.概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理。流程、程序系统的组织结构、模块划分、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。 其格式要求如下： 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．1 出错信息6．2 补救措施6．3 系统维护设计。 3.详细设计文档：主要是把我们每个小模块，小功能的业务逻辑处理用文字的方式表达出来，让程序员在编码的时

软件需求规格说明编写指南(438B)

密级： （软件项目名称） 软件需求规格说明 标 识： 版 本： 页 数： 拟 制： SQA 审核： 审 核： 批 准： 拟制部门： 年 月 日

修改文档历史记录： 日期版本说明修改人

目录 1 范围 (1) 标识 (1) 系统概述 (1) 文档概述 (1) 2 引用文档 (2) 3 需求 (2) 要求的状态和方式 (2) CSCI能力需求 (5) （CSCI能力） (5) 6 注释 (10)

1 范围 标识 【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号及发布号。】 示例： 系统标识如下： a)已批准的标识号： b)产品名称：XXXXXX c)产品代号：XXXXXX d)版本号：XXXXX e)缩略名： 系统概述 【本条应概述本文档所适用的系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构；标识当前和计划的运行现场；列出其它有关文档。】 示例： a) 软件用途： b) 系统概述： c) 需方：XXXXX d) 开发方：软件开发组 e) 运行环境：XXXXX f) 相关文档： 以下描述相关技术数据内容: 1) 软件开发计划 2) 软件研制任务书 3) 。。。 文档概述 【本条应概述文档的用途和内容，并描述与它的使用有关的保密性方面的要求。】

2 引用文档 【本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识所有不能通过正常采购活动得到的文档的来源。】 3 需求 要求的状态和方式 【如果要求CSCI在多种状态或多种方式下运行，并且不同的状态或方式具有不同的需求，则应标识和定义每一种状态和方式。状态和方式的例子包括：空闲、就绪、活动、事后分析、训练、降级、紧急情况、备份、战时和平时等。可以仅用状态描述CSCI，也可仅用方式、用方式中的状态、状态中的方式、或其他有效的方式描述CSCI。如果不需要多种状态或方式，应如实陈述，而不需要进行人为的区分；如果需要多种状态和/或方式，应使本规格说明中的每个或每组需求与这些状态和方式相对应，对应关系可以在本条或本条所引用的附录中，通过表格或其它方式加以指明，也可以在该需求出现的章条中加以声明。】 示例：

软件开发设计文档模板

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

B.模拟结果 C.特殊性能 五．软件项目问题 A.软件项目可行性研究报告 B.软件项目计划 六．附录 软件项目可行性研究报告（Report for Feasibility Study） 一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2．项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提 1．要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入使用的最迟时间。） 4．可行性研究方法 5．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什么需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响

软件架构设计说明书

架构设计说明书 版本1.0.0

目录

1.引言 [对于由多个进程构成的复杂系统，系统设计阶段可以分为：架构设计（构架设计）、组件高层设计、组件详细设计。对于由单个进程构成的简单系统，系统设计阶段可以分为：系统概要设计、系统详细设计。本文档适用于由多个进程构成的复杂系统的构架设计。] [架构设计说明书是软件产品设计中最高层次的文档，它描述了系统最高层次上的逻辑结构、物理结构以及各种指南，相关组件（粒度最粗的子系统）的内部设计由组件高层设计提供。] [系统：指待开发产品的软件与硬件整体，其软件部分由各个子系统嵌套组成，子系统之间具有明确的接口； 组件：指粒度最粗的子系统； 模块：指组成组件的各层子系统，模块由下一层模块或函数组成；] [此文档的目的是： 1）描述产品的逻辑结构，定义系统各组件（子系统）之间的接口以及每个组件（子系统）应该实现的功能； 2）定义系统的各个进程以及进程之间的通信方式； 3）描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况、节点之间 的连接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射； 4）系统的整体性能、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计； 5）定义该产品的各个设计人员应该遵循的设计原则以及设计指南，各个编程人员应该遵循的编码规范。 ] [建议架构设计工程师与组件设计工程师共同完成此文档。] [架构设计说明书的引言应提供整个文档的概述。它应包括此文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。] 1.1目的 [简要描述体系结构文档的目的。]

GB 16680-1996 软件文档管理指南

GB/16680－1996软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 2 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义 本标准采用下列定义，其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 3.2 文档（集）；文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果，并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据； b) 任务之间联系的凭证； c) 质量保证； d) 培训与参考； e) 软件维护支持； f) 历史档案。 4.1 管理依据 在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的

软件开发过程和文档模板说明

软件开发过程和文档模板说明

目录 软件开发过程和文档模板说明1 1引言2 1.1目的2 1.2对象2 1.3范围2 1.4缩略语2 2软件开发流程3 3软件开发文档说明3 4附录4 1引言 1.1目的 本文档用于当前阶段的面阵热像仪软件功能学习培训文档的写作指引。目前仅包括了软件开发文档说明章节。 后续为指引正规的软件开发过程，将进行完善。 1.2对象 1.3范围 1.4缩略语

2软件开发流程 3软件开发文档说明 举例来说： Servo DSP软件功能框图如下所示： XX产品软件设计规格说明书(SD)：产品总体设计。描述为完成某个功能，上图中不同的模块如何协同工作的，输入为该功能的触发条件，输出为该功能的外部表现，处理为各个模块的工作流程。 如程序加载的功能，涉及上图的BDMA经管模块，串口经管模块，操作维护和消息经管模块等。 XX产品YY模块软件需求规格说明书(SRS)：模块总体设计。描述为完成某个需求（针对某一个模块的功能需求），模块的实现方法。输入和输出针对特定的模块，处理为模块内部的实现方法。 如针对BDMA经管模块，需求规格包括FLASH块擦除功能，FLASH写功能，FLASH读功能等。输入来自串口经管模块等，输出表现在串口经管模块和FLASH内部及内存内容的变化。 XX产品YY模块软件概要设计说明书(HLD)：模块内部设计。描述某个模块为完成功能需求，再往下一层次的分解和设计，具体到函数组级或者函数级。

如BDMA经管模块针对FLASH写功能的实现，包括读取源数据，启动FLASH写过程（写命令，传送地址，传送数据），校验等等过程。 XX产品YY模块软件详细设计说明书(LLD)：函数设计。描述函数内部如何实现，通常等同于代码的函数注释。一般本文档和本阶段可以裁减。 4附录

软件设计说明编写指南(438B)

： 密级： 【 （软件项目名称） 软件设计说明 ~ 标识： 版本： 页数： 拟制：《 SQA审核： 审核： 批准： 拟制部门：& 年`月日

修改文档历史记录： 日期· 版本说明修改人 【 ` , ~ \ " （ ~ 》

目录 1 范围........................................................ 错误!未定义书签。 标识..................................................... 错误!未定义书签。 系统概述................................................. 错误!未定义书签。 文档概述................................................. 错误!未定义书签。 2 引用文档.................................................... 错误!未定义书签。 3 CSCI级设计决策.............................................. 错误!未定义书签。 4 CSCI体系结构设计............................................ 错误!未定义书签。 CSCI部件................................................. 错误!未定义书签。 CSCI结构............................................ 错误!未定义书签。 CSC描述............................................. 错误!未定义书签。 CSC名称和项目唯一标识号............................. 错误!未定义书签。 系统状态和模式....................................... 错误!未定义书签。 执行方案................................................. 错误!未定义书签。 CSC数据流与控制流图.................................. 错误!未定义书签。 系统状态与模式的数据流与控制流....................... 错误!未定义书签。 接口设计................................................. 错误!未定义书签。 接口设计准则......................................... 错误!未定义书签。 接口标识和接口图..................................... 错误!未定义书签。 （接口的项目唯一的标识符）............................ 错误!未定义书签。 5 CSCI详细设计................................................ 错误!未定义书签。 （软件单元的项目唯一的标识符，或者一组软件单元的标志符）.. 错误!未定义书签。 6 需求可追踪性................................................ 错误!未定义书签。 7 注释........................................................ 错误!未定义书签。