QJ 1912.7-2003 航天型号软件文档管理制度 软件文档编写要求.pdf

《QJ 1912.7-2003 航天型号软件文档管理制度 软件文档编写要求.pdf》由会员分享，可在线阅读，更多相关《QJ 1912.7-2003 航天型号软件文档管理制度 软件文档编写要求.pdf（65页珍藏版）》请在麦多课文档分享上搜索。

1、中华人民共和国航天行业标准FL 0137 QJ 1912.72003航天型号软件文档管理制度 第7部分：软件文档编写要求 Management system for space software documentation Part 7: Content requirement of software documentation 20030925发布 20031201实施国防科学技术工业委员会 发 布 QJ 1912.72003 I目 次 前言.II 1 范围.1 2 规范性引用文件.1 3 术语、定义和缩略语.1 3.1 术语.1 3.2 缩略语.1 4 一般要求.2 4.1 格式.2 4.

2、2 易读性.2 4.3 独立性.2 4.4 可剪裁性.2 4.5 及时性.2 5 详细要求.2 5.1 可行性研究报告.2 5.2 项目开发计划.11 5.3 软件需求规格说明.20 5.4 概要设计说明.25 5.5 详细设计说明.29 5.6 程序维护手册.32 5.7 模块开发卷宗.37 5.8 测试计划.41 5.9 测试细则.44 5.10 测试分析报告.48 5.11 项目开发总结报告.51 5.12 软件用户手册.54 5.13 操作手册.56 5.14 验收规则.59 QJ 1912.72003 II前言 QJ 1912航天型号软件文档管理制度由如下7个部分组成： 软件文档格式

3、及填写要求； 软件文档的编号； 软件文档的完整性要求； 软件文档的签署规定； 软件文档的更改控制； 软件文档归档及管理要求； 软件文档编写要求。 本部分是QJ 1912的第7部分。 本部分由中国航天科技集团公司及中国航天科工集团公司共同提出。 本部分由中国航天标准化研究所归口。 本部分起草单位：中国航天科工集团公司二院。 本部分主要起草人：邓本江、郭苑沁、程华彦。 QJ 1912.72003 1航天型号软件文档管理制度 第7部分：软件文档编写要求 1 范围 本部分规定了航天型号软件文档（以下简称软件文档）的目次和正文的编写要求。 本部分适用于航天型号软件开发过程中软件文档的编写。 2 规范性引

4、用文件 下列文件中的条款通过本部分的引用而成为本部分的条款。凡是注明日期的引用文件，其随后所有的修改单（不包含勘误的内容）或修订版均不适用于本部分，然而，鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。凡是不注明日期的引用文件，其最新版本适用于本部分。 GB/T 11457 软件工程术语 QJ 1912.11999 航天型号软件文档管理制度 软件文档格式及填写要求 QJ 1912.51999 航天型号软件文档管理制度 软件文档的更改控制 QJ 2858 航天计算机软件产品代号编制规定 3 术语、定义和缩略语 3.1 术语 GB/T 11457确立的术语以及下列术语适用于本部分。

5、3.1.1 非开发软件 non-development software 由承制方、订购方（或使用方）或第三方提供的，而不是按照合同开发的交付软件。非开发软件按其来源可分为可重用软件、订购方（或使用方）提供的软件或可用的商品软件。 3.1.2 软件工程环境 software engineering environment 软件工程工作所需的一组自动工具、固件和硬件的集合。自动工具可包括（但不局限于）编译程序、汇编程序、连接程序、装入程序、操作程序、排错器、模拟器、仿真器、测试工具、文档编写工具和数据库管理系统等。 3.1.3 软件测试环境 software test environment 测

6、试软件所需的一组自动工具、固件和硬件的集合。自动工具可以包括（但不局限于）测试工具，如模拟软件、代码分析器等，也可能包括那些用于软件工程环境的工具。 3.2 缩略语 下列缩略语适用于本部分。 ADP automated data process，自动数据处理； CSC computer softwear unit，计算机软件部件； QJ 1912.72003 2CSCI computer software configuration item，计算机软件配置项； CSU computer software unit，计算机软件单元； HWCI hardware configuration it

7、em，硬件技术状态项。 4 一般要求 4.1 格式 软件文档格式按QJ 1912.11999的规定。 4.2 易读性 文档的编写应适应具体读者的特点和要求。 4.3 独立性 每个软件文档应自成体系，尽量避免读一份文档时，还需参阅许多其它文档。一个CSCI的软件文档之间可能存在一些相互重复的内容，常见的重复内容有两类： a) 文档的概述部分； b) 文档的说明部分，如输入输出、功能、性能和系统连接设备等。 4.4 可剪裁性 在编写文档时，可以对本部分要求的文档内容进行剪裁，但任何剪裁都应事先规定并得到批准。可剪裁性表现在： a) 文档详细程度可以根据实际需要确定； b) 可以根据需要把某种文档分

8、成几份来写； c) 可以根据需要把几种文档合并成一份； d) 对本部分列举的文档规格，可根据具体情况增加或减少一些章条。 4.5 及时性 应当把每个软件开发步骤作出的决定和取得的成果及时编写文档，以免造成程序与文档的不一致和许多其它问题，使文档不能作为阶段成果和后续工作的依据。 5 详细要求 5.1 可行性研究报告 5.1.1 目次的格式如下： 可行性研究报告 目次 1 范围. （ ） 1.1 标识. （ ） 1.2 系统概述. （ ） 1.3 文档概述. （ ） 2 引用文档. （ ） 3 可行性研究的前提. （ ） QJ 1912.72003 33.1 要求. （ ） 3.2 目标. （

9、） 3.3 条件、假定和限制. （ ） 3.4 进行可行性研究的方法. （ ） 3.5 评价尺度. （ ） 4 对现有系统的分析. （ ） 4.1 处理流程和数据流程. （ ） 4.2 工作负荷. （ ） 4.3 费用开支. （ ） 4.4 人员. （ ） 4.5 设备. （ ） 4.6 局限性. （ ） 5 所建议的系统. （ ） 5.1 对所建议系统的说明. （ ） 5.2 处理流程和数据流程. （ ） 5.3 改进之处. （ ） 5.4 影响分析. （ ） 5.4.1 对设备的影响. （ ） 5.4.2 对软件的影响. （ ） 5.4.3 对用户单位机构的影响.（ ） 5.4.4 对系统

10、运行过程的影响.（ ） 5.4.5 对开发的影响. （ ） 5.4.6 对地点和设施的影响. （ ） 5.4.7 对经费开支的影响. （ ） 5.5 局限性. （ ） 5.6 技术条件方面的可行性. （ ） 6 可选择的其他系统方案. （ ） 6.X （可选择的系统方案名称）1） .（ ） 7 投资及效益分析. （ ） 7.1 支出. （ ） 7.1.1 基本建设投资. （ ） 7.1.2 其他一次性支出. （ ） 7.1.3 非一次性支出. （ ） 7.2 收益. （ ） 1）各文档条目编号中的字母X和Y为自变量。标题上圆括号中的文字在编写文档时要用实际内容替换。例如在“可行性研究报告”文档

11、中“6.X （可选择的系统方案名称）”在实际应用时可能为： 6.1 全数字仿真方案 6.2 半实物仿真方案 以后各文档条目编号中的字母X和Y、标题上圆括号中的文字的含义与此相同。 QJ 1912.72003 47.2.1 一次性收益. （ ） 7.2.2 非一次性收益. （ ） 7.2.3 不可定量的收益. （ ） 7.3 收益投资比. （ ） 7.4 投资回收周期. （ ） 7.5 敏感性分析. （ ） 8 社会因素方面的可行性. （ ） 8.1 法律方面的可行性. （ ） 8.2 使用方面的可行性. （ ） 9 结论. （ ） QJ 1912.72003 55.1.2 正文要求及格式如下：

12、 可行性研究报告 1 范围 1.1 标识 本条应列出本文档所适用的系统以及CSCI的标识号、名称、可能有的缩写名等。 1.2 系统概述 概述本文档所适用的系统和CSCI的用途，说明： a) 所建议开发的软件系统的名称； b) 本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； c) 该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 文档概述 概述本文档的目的、用途和内容。 2 引用文档 列出本文档引用的所有文档。 3 可行性研究的前提 说明对所建议的开发软件系统进行可行性研究的前提，如要求、目标、假定、限制等。 3.1 要求 说明对所建议开发的软件系统的基本要求，

13、如： a) 功能； b) 性能； c) 输出，如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象； d) 输入，说明系统的输入，包括数据的来源、类型、数量、数据的组织以及提供的频度； e) 处理流程和数据流程，用图表的方式表示最基本的数据流程和处理流程，并辅之以叙述； f) 在安全与保密方面的要求； g) 同本软件系统相连接的其他系统； h) 完成期限。 3.2 目标 说明所建议软件系统的主要开发目标，如： a) 人力与设备费用的减少； b) 处理速度的提高； c) 控制精度或生产能力的提高； d) 管理信息服务的改进； e) 自动决策系统的改进； f) 人员利用率

14、的改进。 3.3 条件、假定和限制 QJ 1912.72003 6说明对这项开发中给出的条件、假定和所受到的限制，如： a) 所建议系统的运行寿命的最小值； b) 进行系统方案选择比较的时间； c) 经费、投资方面的来源和限制； d) 法律和政策方面的限制； e) 硬件、软件、运行环境和开发环境方面的条件和限制； f) 可利用的信息和资源； g) 系统投入使用的最晚时间。 3.4 进行可行性研究的方法 说明这项可行性研究将如何进行，将如何评价所建议的软件系统。摘要说明所使用的基本方法和策略，如调查、加权、确定模型、建立基准点或仿真等。 3.5 评价尺度 说明对系统进行评价时所使用的主要尺度，如

15、费用的多少、各项功能的优先次序、开发时间的长短及使用中的难易程度。 4 对现有系统的分析 分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。 这里的现有系统是指当前实际使用系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。如果不存在现有的系统，则注明“本章无条文”。 4.1 处理流程和数据流程 说明现有系统的基本的处理流程和数据流程。此流程可用图表（如流程图）的形式表示，并加以叙述。 4.2 工作负荷 列出现有系统所承担的工作及工作量。 4.3 费用开支 列出由于运行现有系统所引起的费用开支，如人力、设备、空间、支持性服务、材料等项开支，以及开支

16、总额。 4.4 人员 列出为了现有系统的运行和维护所需要的人员的专业技术类别和数量。 4.5 设备 列出现有系统所使用的各种设备。 4.6 局限性 列出本系统的主要的局限性，例如处理时间赶不上需要、响应不及时、数据存储能力不足、处理功能不够等。并且要说明，为什么对现有系统的改进性维护已经不能解决问题。 5 所建议的系统 本章将用来说明所建议系统的目标和要求将如何被满足。 5.1 对所建议系统的说明 概括地说明所建议系统，并说明在本文档第3章中列出的那些要求将如何得到满足，说明所使用的基本方法及理论根据。 QJ 1912.72003 75.2 处理流程和数据流程 给出所建议系统的处理流程和数据流程。 5.3 改进之处 按3.2条中列出的目标，逐项说明所建议系统相对于现存系统所有的改进。 说明新提出的设备要求及