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确立的术语以及下列术语适用于本部分。 3.1.1
5、非开发软件 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 item,硬件技
7、术状态项。 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 目标. ( ) 3.3 条件
9、、假定和限制 ( ) 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 对系统运行过程的影响.( ) 5
10、.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为自变量。标题上圆括号中的文字在编写文档时要用实际内容替换。例如在“可行性研究报告”文档中“6.X (可选择的系统方案
11、名称)”在实际应用时可能为: 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 正文要求及格式如下: 可行性研究报告 1 范围 1.1 标识
12、 本条应列出本文档所适用的系统以及CSCI的标识号、名称、可能有的缩写名等。 1.2 系统概述 概述本文档所适用的系统和CSCI的用途,说明: a) 所建议开发的软件系统的名称; b) 本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络; c) 该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 文档概述 概述本文档的目的、用途和内容。 2 引用文档 列出本文档引用的所有文档。 3 可行性研究的前提 说明对所建议的开发软件系统进行可行性研究的前提,如要求、目标、假定、限制等。 3.1 要求 说明对所建议开发的软件系统的基本要求,如: a) 功能; b) 性能; c)
13、输出,如报告、文件或数据,对每项输出要说明其特征,如用途、产生频度、接口以及分发对象; d) 输入,说明系统的输入,包括数据的来源、类型、数量、数据的组织以及提供的频度; e) 处理流程和数据流程,用图表的方式表示最基本的数据流程和处理流程,并辅之以叙述; f) 在安全与保密方面的要求; g) 同本软件系统相连接的其他系统; h) 完成期限。 3.2 目标 说明所建议软件系统的主要开发目标,如: a) 人力与设备费用的减少; b) 处理速度的提高; c) 控制精度或生产能力的提高; d) 管理信息服务的改进; e) 自动决策系统的改进; f) 人员利用率的改进。 3.3 条件、假定和限制 QJ
14、 1912.72003 6说明对这项开发中给出的条件、假定和所受到的限制,如: a) 所建议系统的运行寿命的最小值; b) 进行系统方案选择比较的时间; c) 经费、投资方面的来源和限制; d) 法律和政策方面的限制; e) 硬件、软件、运行环境和开发环境方面的条件和限制; f) 可利用的信息和资源; g) 系统投入使用的最晚时间。 3.4 进行可行性研究的方法 说明这项可行性研究将如何进行,将如何评价所建议的软件系统。摘要说明所使用的基本方法和策略,如调查、加权、确定模型、建立基准点或仿真等。 3.5 评价尺度 说明对系统进行评价时所使用的主要尺度,如费用的多少、各项功能的优先次序、开发时间
15、的长短及使用中的难易程度。 4 对现有系统的分析 分析现有系统的目的是为了进一步阐明建议中的开发新系统或修改现有系统的必要性。 这里的现有系统是指当前实际使用系统,这个系统可能是计算机系统,也可能是一个机械系统甚至是一个人工系统。如果不存在现有的系统,则注明“本章无条文”。 4.1 处理流程和数据流程 说明现有系统的基本的处理流程和数据流程。此流程可用图表(如流程图)的形式表示,并加以叙述。 4.2 工作负荷 列出现有系统所承担的工作及工作量。 4.3 费用开支 列出由于运行现有系统所引起的费用开支,如人力、设备、空间、支持性服务、材料等项开支,以及开支总额。 4.4 人员 列出为了现有系统的
16、运行和维护所需要的人员的专业技术类别和数量。 4.5 设备 列出现有系统所使用的各种设备。 4.6 局限性 列出本系统的主要的局限性,例如处理时间赶不上需要、响应不及时、数据存储能力不足、处理功能不够等。并且要说明,为什么对现有系统的改进性维护已经不能解决问题。 5 所建议的系统 本章将用来说明所建议系统的目标和要求将如何被满足。 5.1 对所建议系统的说明 概括地说明所建议系统,并说明在本文档第3章中列出的那些要求将如何得到满足,说明所使用的基本方法及理论根据。 QJ 1912.72003 75.2 处理流程和数据流程 给出所建议系统的处理流程和数据流程。 5.3 改进之处 按3.2条中列出
17、的目标,逐项说明所建议系统相对于现存系统所有的改进。 说明新提出的设备要求及对现存系统中尚可使用的设备须作出的修改。如果不存在现有的系统,则注明“本条无条文”。 5.4 影响分析 说明在建立所建议系统时,预期将带来的影响。如果不存在现有的系统,则注明“本条无条文”。具体的影响包括: 5.4.1 对设备的影响 说明新提出的设备要求,以及对现存系统中尚可使用的设备须作出的修改。 5.4.2 对软件的影响 说明为了使现存的应用软件和支持软件能够同所建议系统相适应,而需要对这些软件所进行的修改和补充。 5.4.3 对用户单位机构的影响 说明为了建立和运行所建议系统,对用户单位机构、人员的数量和技术水平
18、等方面的全部要求。 5.4.4 对系统运行过程的影响 说明所建议系统对运行过程的影响,如: a) 用户的操作规程; b) 运行中心的操作规程; c) 运行中心与用户之间的关系; d) 源数据的处理; e) 数据进入系统的过程; f) 对数据保存的要求,对数据存储、恢复的处理; g) 输出报告的处理过程、存储媒体和调度方法; h) 系统失效的后果及恢复的处理办法。 5.4.5 对开发的影响 说明对开发的影响,如: a) 为了支持所建议系统的开发,用户需进行的工作; b) 为了建立一个数据库所要求的数据资源; c) 为了开发和测试所建议软件系统而需要的计算机资源; d) 所涉及的保密与安全问题。
19、5.4.6 对地点和设施的影响 说明对建筑物改造的要求及对环境设施的要求。 5.4.7 对经费开支的影响 扼要说明为了所建议软件系统的开发、设计和维持运行而需要的各项经费开支。 5.5 局限性 说明所建议软件系统尚存在的局限性,以及这些问题未能消除的原因。 QJ 1912.72003 85.6 技术条件方面的可行性 本条应说明技术条件方面的可行性,如: a) 在当前的限制条件下,该系统的功能目标能否达到; b) 利用现有的技术,该系统的功能能否实现; c) 对开发人员的数量和质量的要求并说明这些要求能否满足; d) 在规定的期限内,本系统的开发能否完成。 6 可选择的其他系统方案 从6.1条开
20、始编号,扼要说明曾考虑过的每一种可选择的系统方案,包括需开发的和可从国内国外直接购买的。如果没有供选择的系统方案可考虑,则说明这一点。 6.X (可选择的系统方案名称) 参照本文档第5章的提纲,说明每一种可选择的系统方案,并说明它未被选中的理由。 7 投资及效益分析 7.1 支出 对于所选择的方案,说明所需的费用。如果已有一个现存系统,则包括该系统继续运行期间所需的费用。 7.1.1 基本建设投资 包括采购、开发和安装下列各项所需的费用,如: a) 房屋和设施; b) 自动数据处理(ADP)设备; c) 数据通讯设备; d) 环境保护设备; e) 安全与保密设备; f) ADP操作系统的和应用
21、的软件; g) 数据库管理软件。 7.1.2 其他一次性支出 包括下列各项所需的费用,如: a) 研究(需求的研究和设计的研究); b) 开发计划与测量基准的研究; c) 数据库的建立; d) ADP软件的转换; e) 检查费用和技术管理性费用; f) 培训费、旅差费以及开发安装人员所需要的一次性支出; g) 人员的退休及调动费用等。 7.1.3 非一次性支出 列出在该软件系统生命周期内,按月或按季或按年支出的用于运行和维护的费用,包括: a) 设备的租金和维护费用; b) 软件的租金和维护费用; c) 数据通讯方面的租金和维护费用; QJ 1912.72003 9d) 人员的工资、奖金; e
22、) 房屋、空间的使用开支; f) 公用设施方面的开支; g) 保密安全方面的开支; h) 其他经常性的支出等。 7.2 收益 对于所选择的方案,说明能够带来的收益。这里所说的收益,表现为开支费用减少或避免、差错的减少、灵活性的增加、动作速度的提高和管理计划方面的改进等,包括: 7.2.1 一次性收益 说明能够用人民币数目表示的一次性收益,可按数据处理、用户、管理和支持等项分类叙述,如: a) 开支的缩减。包括改进了的系统运行所引起的开支缩减,如资源要求的减少,运行效率的改进,数据进入、存贮和恢复技术的改进,系统性能的可监控,软件的转换和优化,数据压缩技术的采用,处理的集中化分布化等。 b) 价
23、值的增升。包括由于一个应用系统的使用价值的增升所引起的收益,如资源利用的改进、管理和运行效率的改进以及出错率的减少等。 c) 其他。如从多余设备出售回收的收入等。 7.2.2 非一次性收益 说明在整个软件系统生命周期内,由于运行所建议软件系统而导致的按月、按年的能用人民币数目表示的收益,包括开支的减少和避免。 7.2.3 不可定量的收益 逐项列出无法直接用人民币表示的收益,如服务的改进、由操作失误引起的风险的减少、信息掌握情况的改进、组织机构给外界形象的改善等。有些不可捉摸的收益只能大概估计或进行极值估计(按最好和最差情况估计)。 7.3 收益投资比 求出整个系统生命期的收益投资比值。 7.4
24、 投资回收周期 求出收益的累计数开始超过支出的累计数的时间。 7.5 敏感性分析 所谓敏感性分析是指一些关键性因素,如软件系统生命周期长度、软件系统的工作负荷量、工作负荷的类型与这些不同类型之间的合理搭配、处理速度要求、设备和软件的配置等变化时,对开支和收益影响最灵敏的范围的估计。在敏感性分析的基础上做出的选择当然会比单一选择的结果要好一些。 8 社会因素方面的可行性 本章用来说明对社会因素方面的可行性分析的结果,包括: 8.1 法律方面的可行性 法律方面的可行性问题很多,如合同责任、侵犯版权等方面的陷井,软件人员通常是不熟悉的,有可能陷入,务必要注意研究。 8.2 使用方面的可行性 QJ 1
25、912.72003 10例如从用户单位的行政管理、工作制度等方面来看,是否能够使用该软件系统;从用户单位的工作人员的素质来看,是否能满足使用该软件系统的要求等等,都是要考虑的。 9 结论 在进行可行性研究报告的编写时,必须有一个研究结论。结论可以是: a) 可以立即开始进行; b) 需要推迟到某些条件(例如资金、人力、设备等)落实之后才能开始进行; c) 需要对开发目标进行某些修改之后才能开始进行; d) 不能进行或不必进行(例如因技术不成熟、经济上不合算等)。 QJ 1912.72003 115.2 项目开发计划 5.2.1 目次的格式如下: 项目开发计划 目次 1 范围 ( ) 1.1 标
26、识. ( ) 1.2 系统概述. ( ) 1.3 文档概述. ( ) 1.4 与其它计划的关系 ( ) 2 引用文档 ( ) 3 软件开发管理. ( ) 3.1 项目组织与资源 ( ) 3.2 进度和里程碑 ( ) 3.3 风险管理. ( ) 3.4 安全保密. ( ) 3.5 与其它承制方的接口 ( ) 3.6 与其它软件独立验证与确认机构的接口.( ) 3.7 转承制方的管理 ( ) 3.8 正式审查. ( ) 4 软件工程 ( ) 4.1 组织和资源. ( ) 4.2 软件标准和研制程序 ( ) 4.3 非开发软件. ( ) 5 确认测试 ( ) 5.1 组织机构和资源 ( ) 5.2
27、测试方法/基本原理. ( ) 5.3 测试计划的假设条件和约束 ( ) 6 软件产品评价. ( ) 6.1 组织机构和资源 ( ) 6.2 软件产品评价规程和工具 ( ) 6.3 转承制方的产品 ( ) 6.4 软件产品评价记录 ( ) 6.5 软件开发产品的评价 ( ) 7 软件配置管理. ( ) 7.1 组织机构和资源 ( ) QJ 1912.72003 127.2 配置标识 ( ) 7.3 配置控制. ( ) 7.4 配置审计规程 ( ) 7.5 配置状况报告规程 ( ) 7.6 配置追踪规程 ( ) 7.7 配置管理支持工具 ( ) 8 软件开发的其它功能. ( ) 8.X (功能名)
28、. ( ) QJ 1912.72003 135.2.2 正文要求及格式如下: 项目开发计划 1 范围 1.1 标识 本条应列出本文档所适用的系统以及CSCI的标识号、名称、可能有的缩写名等。 1.2 系统概述 概述本文档所适用的系统和CSCI的用途。 1.3 文档概述 概述本文档的用途和内容。 1.4 与其它计划的关系 如果存在与本项目开发计划相关的项目管理计划,则描述本项目开发计划与这些项目管理计划之间的关系。 2 引用文档 列出本文档引用的所有文档。 3 软件开发管理 分条描述与软件开发管理活动相关的计划。 3.1 项目组织与资源 分条叙述承制方的项目组织和项目资源。 3.1.1 项目资源
29、 叙述为完成合同要求所需的设备、软件、服务和设施等项目资源,要醒目地标出在合同中未列出但在软件开发过程中需要的资源。标明这些资源的来源,提供一份获得所需资源的计划,并且应说明每个资源何时需要、何时就绪的详细进度表。 3.1.2 组织机构 概述承制方软件项目组织机构。标识每个组织的权限和职责,可以用图表来表示此信息。 3.1.3 人员 描述完成软件开发项目必须的人员数量,指明项目管理、软件工程、确认测试、软件产品评价、软件配置管理以及本计划标识的其它功能分别所需的人员数目及总数。 3.2 进度和里程碑 3.2.1 活动 以合同规定的主要进度表为基础,简要地叙述项目的每个软件开发活动及其相应的进度
30、。开发进度表还应指明所有的重要事件,如评审、审查、关键会议等等。进度表可以用图表提供。在进度表中应指明活动里程碑。对每一个活动,进度表应标出: a) 活动的起始时间点; b) 正式和非正式文档的草稿和最终版本的完成日期; c) 活动的完成时间点; d) 高风险区域。 QJ 1912.72003 143.2.2 活动网络 描述这些项目活动的顺序关系。对项目完成时间而言,标示出处于关键路径上的活动和关键路径之外的活动,这些信息可以用图表提供,例如采用PERT图。 3.3 风险管理 描述为成功完成项目而对风险区域进行管理的计划。包括: a) 标识项目的风险区域,并确定各风险区的优先级; b) 标识引
31、起风险的因素; c) 将监控风险因素和减少风险发生的措施和计划编写文档; d) 标识与每个风险区域有联系的规程。 3.4 安全保密 描述承制方为实现合同的安全保密性要求。 3.5 与其它承制方的接口 描述为保证与有关承制方的兼容性所作的协调设计和数据管理工作。 3.6 与其它软件独立验证与确认机构的接口 描述与其它软件独立验证与确认机构的接口。 3.7 转承制方的管理 描述对转承制方的管理。 3.8 正式审查 描述承制方准备和执行正式审查的内部程序。 4 软件工程 分条描述与软件工程相关的活动。 4.1 组织和资源 分条描述软件工程活动所必须的组织、责任和资源。 4.1.1 组织机构 描述负责
32、执行软件工程活动的组织,包括每个组织的权限和责任,以及与其它组织实体的关系,如与负责执行软件质量评价的组织的关系。如果负责执行软件工程活动的组织不止一个,则每个组织的结构、人员和资源以及他们内部之间的关系也要醒目地标出。 4.1.2 人员 描述执行软件工程活动的人员数量和技术水平(包括职务和职称),并说明特定岗位的需求,如地理位置、安全保密级别等。 4.1.3 软件工程环境 分条标识和描述执行软件工程活动所需资源(软件、固件和硬件)的建立和维护的计划。 4.1.3.1 软件项 标识执行软件工程活动所必须的软件项,如操作系统、编译程序、代码检查器、动态路径分析器、测试驱动器、预处理器、测试数据产
33、生器、后置处理器等。描述每个软件项的目的,并标识与软件项相关的分类和安全保密性问题。 4.1.3.2 硬件和固件项 标识用于软件工程环境的计算机硬件、接口设备和固件项。描述每一项的目的,并标出与硬件和QJ 1912.72003 15固件项相关的分类和安全保密性问题。 4.1.3.3 权限 标识出与软件工程环境每个项目相关的所有权和管理机构或使用者的权限。 4.1.3.4 安装、控制和维护 制定安装和测试每个软件工程环境项目的计划,以及控制和维护每个软件工程环境项目的计划。 4.2 软件标准和研制程序 分条描述计划使用的软件标准和研制程序。 4.2.1 软件开发技术和方法 标识和描述计划执行的技
34、术和方法: a) 软件需求分析; b) 概要设计; c) 详细设计; d) 编码和单元测试; e) 软件部件集成和测试; f) CSCI测试。 4.2.2 软件文档 定义承制方建立和维护软件文档的计划,包括负有责任的组织机构。定义软件文档的格式和内容,描述维护软件文档的规程,或引用合适的软件文档管理标准或规范(如QJ 1912)。 4.2.3 使用的标准 描述计划在软件开发过程中使用的有关标准。 4.3 非开发软件 标识并描述每一个准备组合到交付软件中的非开发软件,如商品软件、重用软件、管理机构或使用方提供的软件,并简要描述使用每一个非开发软件的基本原理。 5 确认测试 分条描述与确认测试活动
35、相关的计划。 5.1 组织机构和资源 分条描述确认测试所需的组织和资源。 5.1.1 组织机构 描述负责执行确认测试的组织,包括组织的权限和责任,以及与其它组织实体的关系,如与负责执行软件工程的组织的关系。如果负责执行确认测试的组织不止一个,则每个组织的结构、人员和资源以及他们内部之间的关系也要醒目地标出。 5.1.2 人员 描述执行确认测试的人员数量和技术水平(包括职务和职称),并说明特定岗位的需求,如地理位置、安全保密级别等。 5.2 测试方法/基本原理 描述执行确认测试的方法和基本原理。 5.3 测试计划的假设条件和约束 描述测试计划中所作的假设条件和签约机构对确认测试施加的约束。 QJ
36、 1912.72003 166 软件产品评价 分条描述与软件产品评价活动相关的计划。 6.1 组织机构和资源 分条描述软件产品评价所需的组织和资源。 6.1.1 组织机构 描述负责执行软件产品评价的组织,包括组织的权限和责任,以及与其它组织实体的关系,如与负责执行软件工程的组织的关系。如果负责执行软件产品评价的组织不止一个,则每个组织的结构、人员和资源以及他们内部之间的关系也要醒目地标出。 6.1.2 人员 描述执行软件产品评价人员的数量和技术水平(包括职务和职称),并说明特定岗位的需求,如地理位置、安全保密级别等。 6.2 软件产品评价规程和工具 分条描述软件产品评价的规程和在评价过程中使用
37、的工具。 6.2.1 评价规程 描述用于评价软件和相关文档的规程。 6.2.2 评价工具 标识并描述软件产品评价中使用的工具。工具的描述要说清楚该工具在评价过程中的用途。为减少重复可引用软件工程和软件测试环境中使用的工具。 6.3 转承制方的产品 描述为评价转承制方是否满足需求以及评价转承制方产品而制定的计划和规程。 6.4 软件产品评价记录 描述准备和维护每个产品评价记录的计划,标识使用的格式和每个评价记录的信息,并描述维护记录和便于管理机构审查所制定的计划。 6.5 软件开发产品的评价 描述执行每个软件开发产品评价的计划。需进行评价的软件开发产品包括:可行性研究报告、项目开发计划、软件需求
38、规格说明、概要设计说明、详细设计说明、程序维护手册、模块开发卷宗、测试计划、测试细则、测试分析报告、项目开发总结报告、软件用户手册、操作手册、源程序、执行程序和验收规则。 7 软件配置管理 分条描述与软件配置管理活动相关的计划。 7.1 组织机构和资源 分条描述软件配置管理所需的组织和资源。 7.1.1 组织机构 描述负责执行软件配置管理的组织,包括组织的权限和责任,以及与其它组织实体的关系,如与负责执行软件工程的组织的关系。如果负责执行软件配置管理的组织不止一个,则每个组织的结构、人员和资源以及他们内部之间的关系也要醒目地标出。 7.1.2 人员 描述执行软件配置管理人员的数量和技术水平(包
39、括职务和职称),并说明特定岗位的需求,如QJ 1912.72003 17地理位置、安全保密级别等。 7.2 配置标识 7.2.1 标识CSCI CSCI的代号按QJ 2858的规定执行。 7.2.2 标识基线 标识软件开发过程中应建立的基线,至少应建立功能基线、分配基线和产品基线等三条软件基线。 7.2.3 标识软件配置管理项 标识每条基线应受控的软件配置管理项。 7.2.4 标识软件部件和软件单元 描述软件部件和软件单元的标识方法,保持一个CSCI内软件部件和软件单元的标识是唯一的。 7.2.5 标识软件存储介质 描述软件存储介质的标识方法。 7.3 配置控制 7.3.1 开发库、受控库和产
40、品库的建立和管理 描述开发库、受控库和产品库的建立原则,各库的出入库管理规则。必要时应对访问各库的人员进行授权。开发库的管理重点是软件工作产品的版本,受控库的管理重点是更改控制,产品库的管理重点是产品的维护。 7.3.2 更改控制 描述对开发库、受控库和产品库各自所管理内容进行更改的控制规程。对于已进入受控库的软件配置管理项的更改控制过程可参照图1的示例制定。相对于受控库,开发库的更改控制更松一点,而产品库的更改控制更严一些。 确定更改控制过程中所使用的问题/更改报告的格式。软件文档更改申请单和软件文档更改单的具体格式和填写要求可以见QJ 1912.51999。这些报告用于记载检测到的软件及其
41、文档的问题并且记述解决这些问题需要做的纠正工作。 7.3.3 版本控制 本条描述软件配置管理项初始版本的确定方法和版本升级方法。软件配置管理项进入开发库、受控库或产品库时,应赋予一个初始版本。对于已经进入开发库、受控库或产品库的软件配置管理项的更改实施之后,应生成软件配置管理项的新版本。 7.4 配置审计规程 描述执行配置审计的规程,并描述定期执行配置审计的时间间隔和驱动配置审计的事件。完整的配置审计包含功能配置审计和物理配置审计两个方面。 7.5 配置状况报告规程 描述编写配置状况报告的规程,并描述配置状况报表的内容、格式和用途。 7.6 配置追踪规程 描述配置追踪规程,并描述配置追踪的内容
42、、格式和用途。配置追踪的内容包括版本追踪、问题追踪和配置管理项之间的依赖关系追踪。 7.7 配置管理支持工具 描述配置管理工作中将要使用的支持工具,详细描述每个支持工具的名称、版本号、生产厂家,QJ 1912.72003 18以及如何使用这些支持工具来辅助配置管理工作。 8 软件开发的其它功能 从8.1条开始编号,分条描述包括在软件开发过程中承制方的其它功能(如软件质量保证等)。 8.X (功能名) 描述要执行的一个功能。分条描述执行此功能所需的组织机构、资源以及方法与规程。 8.X.1 组织机构(功能名) 描述负责执行此功能的组织,包括组织的权限和职责,以及与其他组织实体之间的关系,如与执行
43、配置管理的组织的关系。如果负责执行此功能的组织不止一个,那么每个组织结构和资源以及他们之间的关系也要醒目地标出。 8.X.2 人员(功能名) 描述执行此功能的人员的数量和技术水平(包括职务和职称),并说明特定岗位的需求,如地理位置、安全保密级别等。 8.X.3 资源(功能名) 标识和描述执行此功能所必需的所有资源。对每个资源,要简要描述其功能。 8.X.4 方法和规程(功能名) 描述执行此功能所使用的方法和规程。 QJ 1912.72003 19软件更新 问题 软件增强 结束 分析与评估 影响 准备更改 申请 评价更改申请 入库 验证更改 实施更改 赞同 反馈给原提交者 图1 更改控制流程示例
44、 是 否 软件配置控制机 构 软件设计评审机 构 QJ 1912.72003 205.3 软件需求规格说明 5.3.1 目次的格式如下: 软件需求规格说明 目次 1 范围 ( ) 1.1 标识. ( ) 1.2 CSCI概述 ( ) 1.3 文档概述. ( ) 2 引用文档 ( ) 3 工程需求 ( ) 3.1 CSCI外部接口需求. ( ) 3.2 CSCI的功能需求. ( ) 3.3 适应性要求. ( ) 3.4 容量和时间要求 ( ) 3.5 可靠性和安全性要求 ( ) 3.6 可维护性要求 ( ) 3.7 保密要求. ( ) 3.8 设计约束. ( ) 3.9 人的特性/人的工程需求.
45、 ( ) 4 测试要求 ( ) 4.1 确认测试因素 ( ) 4.2 确认测试方法和级别 ( ) 4.3 特殊的测试要求 ( ) 5 交付准备 ( ) 6 需求可追踪性. ( ) QJ 1912.72003 215.3.2 正文要求及格式如下: 软件需求规格说明 1 范围 1.1 标识 本条应列出本文档所适用的系统以及CSCI的标识号、名称、可能有的缩写名等。 1.2 CSCI概述 标识和描述本文档适用的CSCI,简述该CSCI在系统中的作用。 1.3 文档概述 概述本文档的用途和内容。 2 引用文档 列出本文档引用的所有文档。 3 工程需求 分条详细说明必要的工程需求,确保CSCI的正确开发
46、。这里包含的各项需求是从其它相应文档所建立的需求中分配或派生出来的。 3.1 CSCI外部接口需求 分条详细描述CSCI外部接口需求。为了帮助描述,可使用外部接口框图。每个外部接口应标识其名称和项目唯一标识号,并简述每一个接口。对每个接口还应注明所有文档资料的来源。 3.1.1 外部接口示意图 标识CSCI的外部接口。为了描述这些接口,应绘制一个或多个接口示意图,每个接口应标识其名称和项目唯一标识号。 从3.1.2条开始编号。分条说明接口需求和接口之间传递数据的要求。各条要用名称和项目唯一标识号标识一个接口,并陈述它的用途。 3.1.X (外部接口名称和项目唯一标识号) 3.1.X.1 外部接
47、口需求 各条应规定: a) 与外部实体的联接是并发执行还是顺序执行;若是并发,则规定CSCI内部使用的同步方法; b) 接口使用的通信协议; c) 接口的优先级别。 3.1.X.2 数据要求 对每个跨越接口之间的数据元素,用类似于表1的形式,详细说明数据元素定义表中的下列信息: a) 数据元素的项目唯一标识号; b) 数据元素的简短描述; c) 数据元素来源于CSCI、HWCI还是关键项; d) 数据元素的目的地是CSCI、HWCI还是关键项; e) 数据元素的计量单位(s、m、km等); QJ 1912.72003 22f) 数据元素的极限值/值域; g) 数据元素的精确度; h) 用有效数
48、字表示的数据元素的精度/分辨率。 3.2 CSCI的功能需求 标识CSCI必须满足的所有功能需求,以及这些功能之间的接口。分条描述这些接口之间的相互关系、每个接口和每个功能。 3.2.1 内部接口示意图 标识这些功能之间的接口。为了描述这些接口,应绘制一个或多个内部接口示意图。可使用描述数据流、控制流和其它有关信息的内部接口图帮助说明各内部接口。 表1 接口数据元素定义表的例子 标识号 说明 来源CSCI 目标CSCI 计量单位 极限值/值域 精度 分辨率 IFA001 速度 CSCI-A CSCIB 单位符号 201000 +20 10-3 IFA002 方位角 CSCI-A CSCID 单
49、位符号 0/2 +0.05 10-3 IFA003 高度 CSCI-C CSCIA CSCIB CSCID 单位符号 01500 +10 10-2 3.2.2 内部接口需求 从3.2.2.1条开始编号。各条要用名称和项目唯一标识号标识一个内部接口,并陈述它的用途。分条说明内部接口需求和接口之间传递数据的要求。 3.2.2.X (内部接口名称和项目唯一标识号) 3.2.2.X.1 接口需求 各条应规定: a) 与各功能的联接是并发执行还是顺序执行;若是并发,则规定CSCI内部使用的同步方法; b) 接口使用的通信协议; c) 接口的优先级别。 3.2.2.X.2 数据要求 对每个跨越接口之间的数据元素,用类似于表1的形式,详细说明数据元素定义表中的下列信息: a) 数据元素的项目唯一标识号; b) 数据元素的简短描述; c) 用名字和项目唯一标识号标识数据元素的来源; d) 用名字和项目唯一标识号标识数据元素的目的地; e) 数据元素的计量单位(s、m、km等); f) 数据元素的极限值/值域; g) 数据元素的精确度; h) 用有效数字表示的数据元素的精度/分辨率。 3.2.3 功能需求 从3.2.3.1条开始编号,分条