软件开发文档规范
合集下载
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1 软件需求规格说明是需求分析的产物， 软件需求规格说明是需求分析的产物， 是一项重要的软件开发产品。 是一项重要的软件开发产品。 2 软件需求规格说明分为： 软件需求规格说明分为： * 工程需求； 工程需求； * 合格性需求； 合格性需求； * 交付准备； 交付准备； 三方面来描述。 三方面来描述。
5.3 软件需求规格说明（二） 软件需求规格说明（
3 工程需求 工程需求要求描述： 工程需求要求描述： * CSCI的外部接口需求； 的外部接口需求； 的外部接口需求 * CSCI的功能需求（按功能分节叙述）； 的功能需求（ 的功能需求 按功能分节叙述）； * CSCI的内部接口； 的内部接口； 的内部接口 * CSCI的数据元素要求； 的数据元素要求； 的数据元素要求 * 适应性需求； 适应性需求； * 容量和时间要求； 容量和时间要求；
4 软件工程描述： 软件工程描述： * 开发组织机构和资源； 开发组织机构和资源； * 软件标准和研制程序； 软件标准和研制程序； * 非开发软件的获取和使用； 非开发软件的获取和使用； 5 正式合格性测试描述： 正式合格性测试描述： * 测试组织机构和资源； 测试组织机构和资源； * 测试方法和基本原理； 测试方法和基本原理； * 测试计划的假设条件和约束。 测试计划的假设条件和约束。
5.2 软件开发计划（九） 软件开发计划（
8 其它软件开发职能 分节描述各个开发职能： 分节描述各个开发职能： 8.x 职能名 8.x.1 组织机构－职能名 组织机构－ 8.x.2 其它资源－职能名 其它资源－ 8.x.3 方法和规程－职能名 方法和规程－
5.3 软件需求规格说明（一） 软件需求规格说明（
5.3 软件需求规格说明（四） 软件需求规格说明（
4 合格性需求 合格性需求分节证明软件合格的方法和 级别和特殊的合格性需求： 级别和特殊的合格性需求： 4.1 合格性方法和级别 4.2 特殊合格性需求 5 交付准备 说明： 介质的类型和特性； 说明：CSCI介质的类型和特性； 介质的类型和特性 介质的标签、包装、处置和分类； 介质的标签、包装、处置和分类； 其它特殊的交付要求。 其它特殊的交付要求。
5.5 接口设计文档（三） 接口设计文档（
3.x.2 消息描述 标识接口间的每个消息， 标识接口间的每个消息，并描述数据元 素对消息的功用。 素对消息的功用。 3.x.3 接口优先级 规定消息通过该接口的相对优先级次序。 规定消息通过该接口的相对优先级次序。 3.x.4 通信协议 分节描述与该接口相连的通信协议。 分节描述与该接口相连的通信协议。
4. 一般要求（三） 一般要求（
4.4 文档的结构 软件文档由封面、目录、正文、 软件文档由封面、目录、正文、注释 和附录组成。 和附录组成。 详见标准。 详见标准。
5 详细要求
* 详细要求将对 个软件文档分别叙述 详细要求将对16个软件文档分别叙述 其格式、内容和要求。 其格式、内容和要求。 * 每个文档分为目录和正文两部分。 每个文档分为目录和正文两部分。
3 接口说明 3.1 接口示意图 3.x 接口名 分节描述该接口： 分节描述该接口： 3.x.1 接口需求 包括说明：并发/顺序执行 通信协议； 顺序执行； 包括说明：并发 顺序执行；通信协议； 优先级。 优先级。
5.4 接口需求规格说明（三） 接口需求规格说明（
3 接口说明 3.1 接口示意图 3.x 接口名 分节描述该接口： 分节描述该接口： 3.x.2 数据要求 详细说明跨接口数据的来源、目的、 详细说明跨接口数据的来源、目的、 度量单位、值域、精度和分辨率等。 度量单位、值域、精度和分辨率等。
4. 一般要求（一） 一般要求（
4.2 文档的产生 根据GJB 2786-产生相应的文档。详见GJB 2786-96。 而产生相应的文档。详见 。
4. 一般要求（二） 一般要求（
4.3 文档的准备 * 可用书面形式或电子多媒体形式 * 剪裁说明：种类和内容都可剪裁，内容可用 剪裁说明：种类和内容都可剪裁， 本节无内容”方式剪裁，以便保留章节号。 “本节无内容”方式剪裁，以便保留章节号。 * 页码编制：参见文档模板。 页码编制：参见文档模板。 * 文档控制号：按标准编制或自定义。 文档控制号：按标准编制或自定义。 * 自变量：例如 自变量：例如3.2.x实际可为 实际可为3.2.1、3.2.2、... 实际可为 、 、
5.2 软件开发计划（八） 软件开发计划（
7 软件配置管理： 软件配置管理： * 管理组织机构和资源； 管理组织机构和资源； * 配置标识； 配置标识； * 配置控制； 配置控制； * 配置状况报告； 配置状况报告； * 配置审核； 配置审核； * 让签约机构认可规格说明的准备工作； 让签约机构认可规格说明的准备工作； * 配置管理的主要里程碑。 配置管理的主要里程碑。
5.2 软件开发计划（一） 软件开发计划（
1 要求按 要求按GJB 2786-96《软件开发》的一般要求 《软件开发》 中叙述的五项职能： 中叙述的五项职能： * 软件开发管理； 软件开发管理； * 软件工程； 软件工程； * 正式合格性测试； 正式合格性测试； * 软件产品评价； 软件产品评价； * 软件配置管理；以及 软件配置管理； * 其它软件开发职能 六个方面来制定软件开发计划。 六个方面来制定软件开发计划。
软件开发文档规范
×××工程软件专家组 ×××工程软件专家组 何新贵 2001年8月 年 月
前言
• 本标准与 本标准与GJB 2786-96《软件开发》配套 《软件开发》 使用。 使用。 • ×××工程“白皮书”综合了 ×××工程 白皮书”综合了GJB 2786工程“ 96、GJB 438A-97和GJB/Z 115-98。 、 和 。 • 本标准允许根据实际情况进行剪裁，以 本标准允许根据实际情况进行剪裁， 适应实际需要。 适应实际需要。
4.1 文档种类（一） 文档种类（
系统和段设计文件 软件需求规格说明 接口设计文档 软件产品规格说明 软件开发计划 接口需求规格说明 软件设计文档 版本说明文档
4.1 文档种类（二） 文档种类（
软件测试计划 软件测试报告 软件用户手册 固件保障手 数据库设计 软件测试说明 计算机系统操作员手册 软件程序员手册 计算机资源综合保障手册
5.1 系统和段设计文件
1 此为一个系统设计文件，描述：系统任 此为一个系统设计文件，描述： 运行环境、支持环境、 务、运行环境、支持环境、系统体系结 运行情况、系统设计、处理资源、 构、运行情况、系统设计、处理资源、 质量因素以及需求的可追踪性等内容； 质量因素以及需求的可追踪性等内容； 2 系统设计把系统的任务分配给硬件、软 系统设计把系统的任务分配给硬件、 件和手工操作，并确定其间的内部接口； 件和手工操作，并确定其间的内部接口； 3 由此派生出对软件的要求，故它是进行 由此派生出对软件的要求， 软件需求分析的基础。 软件需求分析的基础。
5.3 软件需求规格说明（三） 软件需求规格说明（
工程需求要求描述： 工程需求要求描述： * 安全要求； 安全要求 要求； * 保密要求； 保密要求 要求； * 设计约束； 设计约束； * 软件质量因素； 软件质量因素 质量因素； * 人的特性 人的工程需求； 人的特性/人的工程需求 人的工程需求； * 需求可追踪性。 需求可追踪性。
5.2 软件开发计划（二） 软件开发计划（
2 所有软件开发工作都应按“软件开发计划”的 所有软件开发工作都应按“软件开发计划” 规定进行，若要修改， 规定进行，若要修改，必须经过严格的批准手 续。 * 不但要详细叙述本项目的开发计划，而且要 不但要详细叙述本项目的开发计划， 概述与其它有关项目（包括硬件、软件） 概述与其它有关项目（包括硬件、软件）开 发计划的关系，以便协同工作。 发计划的关系，以便协同工作。
5.2 软件开发计划（七） 软件开发计划（
6 软件产品评价： 软件产品评价： * 评价组织机构和资源； 评价组织机构和资源； * 软件产品评价的规程工具； 软件产品评价的规程工具； * 转承制方的产品； 转承制方的产品； * 软件产品评价记录的格式、内容等； 软件产品评价记录的格式、内容等； * 分节描述每个软件开发产品在各开发阶 段的产品评价计划、评价标准（ 段的产品评价计划、评价标准（若需修改 GJB 2786规定的评价标准的话）等； 规定的评价标准的话） 规定的评价标准的话
5.2 软件开发计划（三） 软件开发计划（
* 由于我国国情，开发计划中有些条目可能编 由于我国国情， 写比较困难， 写比较困难，但为了按时保质保量地完成任 应尽量编制好软件开发计划， 务，应尽量编制好软件开发计划，并严格执 行它。 行它。
5.2 软件开发计划（四） 软件开发计划（
3 软件开发管理描述： 软件开发管理描述： * 项目的组织机构和资源； 项目的组织机构和资源； * 进度和里程碑； 进度和里程碑； * 风险管理； 风险管理； * 安全保密； 安全保密； * 与其它承制方的关系和接口； 与其它承制方的关系和接口； * 与其它 与其它IV&V机构的关系和接口； 机构的关系和接口； 机构的关系和接口
5.4 接口需求规格说明（一） 接口需求规格说明（
1 本文档将描述 本文档将描述CSCI的各个外部接口 的各个外部接口 的需求。 的需求。 2 当外部接口不多，也不复杂时，也可 当外部接口不多，也不复杂时， 把此文档合并到软件需求规格说明。 把此文档合并到软件需求规格说明。
5.4 接口需求规格说明（二） 接口需求规格说明（
5.5 接口设计文档（一） 接口设计文档（
1 本文档将描述 本文档将描述CSCI的各个外部接口 的各个外部接口 的设计。 的设计。 2 当外部接口不多，也不复杂时，也 当外部接口不多，也不复杂时， 可把此文档合并到软件设计文档。 可把此文档合并到软件设计文档。
5.5 接口设计文档（二） 接口设计文档（
1. 范围
1.1 主题内容 规定应用软件开发文档编制的格式、 规定应用软件开发文档编制的格式、 内容和要求。 内容和要求。 1.2 适用范围 适用计算机软件开发过程中的文档编 特别适用于同GJB 2786-96配套使用。 配套使用。 制，特别适用于同 配套使用
2. 引用文件（略） 引用文件（ 3. 定义（略） 定义（ 4. 一般要求
5.6 软件设计文档（一） 软件设计文档（
1 本文档将描述 本文档将描述CSCI的概要设计和 的概要设计和 详细设计。 详细设计。 2 当CSCI较复杂时，也可把此文档 较复杂时， 较复杂时 分为软件概要设计文档和软件详细 设计文档。 设计文档。
5.6 软件设计文档（二） 软件设计文档（
3 概要设计 描述CSCI的概要设计。 的概要设计。 描述 的概要设计 3.1 CSCI概述 概述 3.1.1 CSCI结构 结构 用结构图描述CSCI的结构和外部接口。 的结构和外部接口。 用结构图描述 的结构和外部接口 3.1.2 系统状态和模式 除系统状态和模式外， 除系统状态和模式外，还应描述相应的 控制流和数据流。 控制流和数据流。 3.1.3 内存和进程时间分配
5.2 软件开发计划（五） 软件开发计划（
3 软件开发管理描述： 软件开发管理描述： * 转承制方的管理； 转承制方的管理； * 正式审查； 正式审查； * 软件开发库管理； 软件开发库管理； * 问题纠正过程管理； 问题纠正过程管理； * 问题 更改报告。 问题/更改报告 更改报告。
5.2 软件开发计划（六） 软件开发计划（
3 接口设计 3.1 接口示意图 3.x 接口名 分节描述该接口的设计： 分节描述该接口的设计： 3.x.1 数据元素 在数据元素定义表中对跨接口数据元 素详细提供来源、目的、度量单位、值域、 素详细提供来源、目的、度量单位、值域、 精度和分辨率、数据类型、表示格式、 精度和分辨率、数据类型、表示格式、优 先级等信息。 先级等信息。
5.3 软件需求规格说明（二） 软件需求规格说明（
3 工程需求 工程需求要求描述： 工程需求要求描述： * CSCI的外部接口需求； 的外部接口需求； 的外部接口需求 * CSCI的功能需求（按功能分节叙述）； 的功能需求（ 的功能需求 按功能分节叙述）； * CSCI的内部接口； 的内部接口； 的内部接口 * CSCI的数据元素要求； 的数据元素要求； 的数据元素要求 * 适应性需求； 适应性需求； * 容量和时间要求； 容量和时间要求；
4 软件工程描述： 软件工程描述： * 开发组织机构和资源； 开发组织机构和资源； * 软件标准和研制程序； 软件标准和研制程序； * 非开发软件的获取和使用； 非开发软件的获取和使用； 5 正式合格性测试描述： 正式合格性测试描述： * 测试组织机构和资源； 测试组织机构和资源； * 测试方法和基本原理； 测试方法和基本原理； * 测试计划的假设条件和约束。 测试计划的假设条件和约束。
5.2 软件开发计划（九） 软件开发计划（
8 其它软件开发职能 分节描述各个开发职能： 分节描述各个开发职能： 8.x 职能名 8.x.1 组织机构－职能名 组织机构－ 8.x.2 其它资源－职能名 其它资源－ 8.x.3 方法和规程－职能名 方法和规程－
5.3 软件需求规格说明（一） 软件需求规格说明（
5.3 软件需求规格说明（四） 软件需求规格说明（
4 合格性需求 合格性需求分节证明软件合格的方法和 级别和特殊的合格性需求： 级别和特殊的合格性需求： 4.1 合格性方法和级别 4.2 特殊合格性需求 5 交付准备 说明： 介质的类型和特性； 说明：CSCI介质的类型和特性； 介质的类型和特性 介质的标签、包装、处置和分类； 介质的标签、包装、处置和分类； 其它特殊的交付要求。 其它特殊的交付要求。
5.5 接口设计文档（三） 接口设计文档（
3.x.2 消息描述 标识接口间的每个消息， 标识接口间的每个消息，并描述数据元 素对消息的功用。 素对消息的功用。 3.x.3 接口优先级 规定消息通过该接口的相对优先级次序。 规定消息通过该接口的相对优先级次序。 3.x.4 通信协议 分节描述与该接口相连的通信协议。 分节描述与该接口相连的通信协议。
4. 一般要求（三） 一般要求（
4.4 文档的结构 软件文档由封面、目录、正文、 软件文档由封面、目录、正文、注释 和附录组成。 和附录组成。 详见标准。 详见标准。
5 详细要求
* 详细要求将对 个软件文档分别叙述 详细要求将对16个软件文档分别叙述 其格式、内容和要求。 其格式、内容和要求。 * 每个文档分为目录和正文两部分。 每个文档分为目录和正文两部分。
3 接口说明 3.1 接口示意图 3.x 接口名 分节描述该接口： 分节描述该接口： 3.x.1 接口需求 包括说明：并发/顺序执行 通信协议； 顺序执行； 包括说明：并发 顺序执行；通信协议； 优先级。 优先级。
5.4 接口需求规格说明（三） 接口需求规格说明（
3 接口说明 3.1 接口示意图 3.x 接口名 分节描述该接口： 分节描述该接口： 3.x.2 数据要求 详细说明跨接口数据的来源、目的、 详细说明跨接口数据的来源、目的、 度量单位、值域、精度和分辨率等。 度量单位、值域、精度和分辨率等。
4. 一般要求（一） 一般要求（
4.2 文档的产生 根据GJB 2786-产生相应的文档。详见GJB 2786-96。 而产生相应的文档。详见 。
4. 一般要求（二） 一般要求（
4.3 文档的准备 * 可用书面形式或电子多媒体形式 * 剪裁说明：种类和内容都可剪裁，内容可用 剪裁说明：种类和内容都可剪裁， 本节无内容”方式剪裁，以便保留章节号。 “本节无内容”方式剪裁，以便保留章节号。 * 页码编制：参见文档模板。 页码编制：参见文档模板。 * 文档控制号：按标准编制或自定义。 文档控制号：按标准编制或自定义。 * 自变量：例如 自变量：例如3.2.x实际可为 实际可为3.2.1、3.2.2、... 实际可为 、 、
5.2 软件开发计划（八） 软件开发计划（
7 软件配置管理： 软件配置管理： * 管理组织机构和资源； 管理组织机构和资源； * 配置标识； 配置标识； * 配置控制； 配置控制； * 配置状况报告； 配置状况报告； * 配置审核； 配置审核； * 让签约机构认可规格说明的准备工作； 让签约机构认可规格说明的准备工作； * 配置管理的主要里程碑。 配置管理的主要里程碑。
5.2 软件开发计划（一） 软件开发计划（
1 要求按 要求按GJB 2786-96《软件开发》的一般要求 《软件开发》 中叙述的五项职能： 中叙述的五项职能： * 软件开发管理； 软件开发管理； * 软件工程； 软件工程； * 正式合格性测试； 正式合格性测试； * 软件产品评价； 软件产品评价； * 软件配置管理；以及 软件配置管理； * 其它软件开发职能 六个方面来制定软件开发计划。 六个方面来制定软件开发计划。
软件开发文档规范
×××工程软件专家组 ×××工程软件专家组 何新贵 2001年8月 年 月
前言
• 本标准与 本标准与GJB 2786-96《软件开发》配套 《软件开发》 使用。 使用。 • ×××工程“白皮书”综合了 ×××工程 白皮书”综合了GJB 2786工程“ 96、GJB 438A-97和GJB/Z 115-98。 、 和 。 • 本标准允许根据实际情况进行剪裁，以 本标准允许根据实际情况进行剪裁， 适应实际需要。 适应实际需要。
4.1 文档种类（一） 文档种类（
系统和段设计文件 软件需求规格说明 接口设计文档 软件产品规格说明 软件开发计划 接口需求规格说明 软件设计文档 版本说明文档
4.1 文档种类（二） 文档种类（
软件测试计划 软件测试报告 软件用户手册 固件保障手 数据库设计 软件测试说明 计算机系统操作员手册 软件程序员手册 计算机资源综合保障手册
5.1 系统和段设计文件
1 此为一个系统设计文件，描述：系统任 此为一个系统设计文件，描述： 运行环境、支持环境、 务、运行环境、支持环境、系统体系结 运行情况、系统设计、处理资源、 构、运行情况、系统设计、处理资源、 质量因素以及需求的可追踪性等内容； 质量因素以及需求的可追踪性等内容； 2 系统设计把系统的任务分配给硬件、软 系统设计把系统的任务分配给硬件、 件和手工操作，并确定其间的内部接口； 件和手工操作，并确定其间的内部接口； 3 由此派生出对软件的要求，故它是进行 由此派生出对软件的要求， 软件需求分析的基础。 软件需求分析的基础。
5.3 软件需求规格说明（三） 软件需求规格说明（
工程需求要求描述： 工程需求要求描述： * 安全要求； 安全要求 要求； * 保密要求； 保密要求 要求； * 设计约束； 设计约束； * 软件质量因素； 软件质量因素 质量因素； * 人的特性 人的工程需求； 人的特性/人的工程需求 人的工程需求； * 需求可追踪性。 需求可追踪性。
5.2 软件开发计划（二） 软件开发计划（
2 所有软件开发工作都应按“软件开发计划”的 所有软件开发工作都应按“软件开发计划” 规定进行，若要修改， 规定进行，若要修改，必须经过严格的批准手 续。 * 不但要详细叙述本项目的开发计划，而且要 不但要详细叙述本项目的开发计划， 概述与其它有关项目（包括硬件、软件） 概述与其它有关项目（包括硬件、软件）开 发计划的关系，以便协同工作。 发计划的关系，以便协同工作。
5.2 软件开发计划（七） 软件开发计划（
6 软件产品评价： 软件产品评价： * 评价组织机构和资源； 评价组织机构和资源； * 软件产品评价的规程工具； 软件产品评价的规程工具； * 转承制方的产品； 转承制方的产品； * 软件产品评价记录的格式、内容等； 软件产品评价记录的格式、内容等； * 分节描述每个软件开发产品在各开发阶 段的产品评价计划、评价标准（ 段的产品评价计划、评价标准（若需修改 GJB 2786规定的评价标准的话）等； 规定的评价标准的话） 规定的评价标准的话
5.2 软件开发计划（三） 软件开发计划（
* 由于我国国情，开发计划中有些条目可能编 由于我国国情， 写比较困难， 写比较困难，但为了按时保质保量地完成任 应尽量编制好软件开发计划， 务，应尽量编制好软件开发计划，并严格执 行它。 行它。
5.2 软件开发计划（四） 软件开发计划（
3 软件开发管理描述： 软件开发管理描述： * 项目的组织机构和资源； 项目的组织机构和资源； * 进度和里程碑； 进度和里程碑； * 风险管理； 风险管理； * 安全保密； 安全保密； * 与其它承制方的关系和接口； 与其它承制方的关系和接口； * 与其它 与其它IV&V机构的关系和接口； 机构的关系和接口； 机构的关系和接口
5.4 接口需求规格说明（一） 接口需求规格说明（
1 本文档将描述 本文档将描述CSCI的各个外部接口 的各个外部接口 的需求。 的需求。 2 当外部接口不多，也不复杂时，也可 当外部接口不多，也不复杂时， 把此文档合并到软件需求规格说明。 把此文档合并到软件需求规格说明。
5.4 接口需求规格说明（二） 接口需求规格说明（
5.5 接口设计文档（一） 接口设计文档（
1 本文档将描述 本文档将描述CSCI的各个外部接口 的各个外部接口 的设计。 的设计。 2 当外部接口不多，也不复杂时，也 当外部接口不多，也不复杂时， 可把此文档合并到软件设计文档。 可把此文档合并到软件设计文档。
5.5 接口设计文档（二） 接口设计文档（
1. 范围
1.1 主题内容 规定应用软件开发文档编制的格式、 规定应用软件开发文档编制的格式、 内容和要求。 内容和要求。 1.2 适用范围 适用计算机软件开发过程中的文档编 特别适用于同GJB 2786-96配套使用。 配套使用。 制，特别适用于同 配套使用
2. 引用文件（略） 引用文件（ 3. 定义（略） 定义（ 4. 一般要求
5.6 软件设计文档（一） 软件设计文档（
1 本文档将描述 本文档将描述CSCI的概要设计和 的概要设计和 详细设计。 详细设计。 2 当CSCI较复杂时，也可把此文档 较复杂时， 较复杂时 分为软件概要设计文档和软件详细 设计文档。 设计文档。
5.6 软件设计文档（二） 软件设计文档（
3 概要设计 描述CSCI的概要设计。 的概要设计。 描述 的概要设计 3.1 CSCI概述 概述 3.1.1 CSCI结构 结构 用结构图描述CSCI的结构和外部接口。 的结构和外部接口。 用结构图描述 的结构和外部接口 3.1.2 系统状态和模式 除系统状态和模式外， 除系统状态和模式外，还应描述相应的 控制流和数据流。 控制流和数据流。 3.1.3 内存和进程时间分配
5.2 软件开发计划（五） 软件开发计划（
3 软件开发管理描述： 软件开发管理描述： * 转承制方的管理； 转承制方的管理； * 正式审查； 正式审查； * 软件开发库管理； 软件开发库管理； * 问题纠正过程管理； 问题纠正过程管理； * 问题 更改报告。 问题/更改报告 更改报告。
5.2 软件开发计划（六） 软件开发计划（
3 接口设计 3.1 接口示意图 3.x 接口名 分节描述该接口的设计： 分节描述该接口的设计： 3.x.1 数据元素 在数据元素定义表中对跨接口数据元 素详细提供来源、目的、度量单位、值域、 素详细提供来源、目的、度量单位、值域、 精度和分辨率、数据类型、表示格式、 精度和分辨率、数据类型、表示格式、优 先级等信息。 先级等信息。