GB/T 26805.3-2011 工业控制计算机系统 软件 第3部分：文档管理指南

　　ICS 25. 040. 40 N 18

　　中 华 人 民 共 和 国 国 家 标 准

　　GB/T 26805.3—2011

　　工业控制计算机系统 软件

　　第 3 部分 :文档管理指南

　　Industrialcontrolcomputersystem—Software—

　　Part3:Guidelinesforthedocumentmanagement

　　2011-07-29发布 2011-12-01实施

　　中华人民共和国国家质量监督检验检疫总局中 国 国 家 标 准 化 管 理 委 员 会

　　

　　发

　　

　　布

　　GB/T 26805.3—2011

　　目 次

　　前言 Ⅰ

　　1 范围 1

　　2 规范性引用文件 1

　　3 术语和定义 1

　　4 软件文档 2

　　4. 1 概述 2

　　4. 2 主要功能 2

　　4. 3 工作文档 3

　　4. 4 产品文档 4

　　4. 5 用户软件包文档 4

　　5 软件文档的计划管理 4

　　5. 1 基本任务 4

　　5. 2 管理要点 4

　　6 软件文档的质量管理 8

　　6. 1 软件文档的质量分级及质量要求 8

　　6. 2 软件文档的复审 9

　　7 软件文档的配置管理 10

　　8 管理要点总结 10

　　附录 A (规范性附录) 软件生命周期的定义及阶段划分 12

　　A. 1 软件生命周期的定义 12

　　A. 2 软件定义阶段 12

　　A. 3 软件开发阶段 12

　　A. 4 运行维护阶段 12

　　附录 B (规范性附录) 软件生命周期各个阶段应当产生的主要软件文档 14

　　图 1 软件文档分级与对应文档 6

　　图 B. 1 软件生命周期各个阶段应当产生的重要软件文档示意 14

　　GB/T 26805.3—2011

　　前 言

　　GB/T 26805《工业控制计算机系统 软件》分为以下部分 :

　　— 第 1部分 :评价体系 ;

　　— 第 2部分 :测试方法 ;

　　— 第 3部分 :文档管理指南 ;

　　— 第 4部分 :工程化文档规范 ;

　　— 第 5部分 :用户软件包文档 。

　　本部分是 GB/T 26805的第 3部分 。

　　本部分的附录 A 和附录 B为规范性附录 。

　　本部分由中国机械工业联合会提出 。

　　本部分由全国工业过程测量和控制标准化技术委员会(SAC/TC124)归 口 。

　　本部分负责起草单位 :西南大学 。

　　本部分参加起草单位 :深圳市研祥软件技术有限公司 、北京研华兴业电子科技有限公司 、中国计算机学会工业控制计算机专业委员会 。

　　本部分主要起草人 : 吕静 、杨颂华 、张为群 、张渝 、祁虔 。

　　本部分参加起草人 : 陈志列 、刘志永 、刘学东 、刘永池 、杨孟飞 。

　　Ⅰ

　　GB/T 26805.3—2011

　　工业控制计算机系统 软件

　　第 3 部分 :文档管理指南

　　1 范围

　　GB/T 26805的本部分规定了工业控制软件文档管理的基本任务和管理要点 , 为项 目管理者实施该类文档的管理提供指南 。

　　本部分适用于工业控制计算机系统的软件文档管理 。

　　2 规范性引用文件

　　下列文件中的条款通过 GB/T 26805的本部分的引用而成为本部分的条款 。凡是注日期的引用文件 ,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本部分 ,然而 ,鼓励根据本部分达成协议的各方研究是否 可 使 用 这 些 文 件 的 最 新 版 本 。 凡 是 不 注 日 期 的 引 用 文 件 , 其 最 新 版 本 适 用 于 本部分 。

　　GB/T 11457—2006 信息技术 软件工程术语

　　GB/T 26805. 4—2011 工业控制计算机系统 软件 第 4部分 :工程化文档规范

　　GB/T 26805. 5—2011 工业控制计算机系统 软件 第 5部分 :用户软件文档

　　3 术语和定义

　　GB/T 11457—2006中确立的以及下列术语和定义适用于 GB/T 26805的本部分 。

　　3. 1

　　文档 document

　　一种数据媒体和其上所记录的数据 。它具有永久性并可以由人或机器阅读 。

　　3. 2

　　用户 user

　　a) 使用软件求解某一问题的技术人员 ;

　　b) 实际使用软件产品或操作运行软件的组织 、单位或个人 。

　　3. 3

　　产品文档 productdocumentation

　　软件项目开发过程中 ,应当编制的各种技术资料或技术管理资料 。

　　3. 4

　　工作文档 work documentation

　　软件项目开发过程中 ,所填写的或使用过的各种图表或文字资料 。

　　3. 5

　　用户需求 userrequirement

　　用户所期望的软件产品的全部性能 、功能和限制 。它主要包括对软件产品的功能要求 、性能要求 ,如实时性 、可靠性和可维护性要求以及安全保密要求 ,还包括在开发费用 、时间 、进度和可用资源等方面的限制 。

　　3. 6

　　评审 review

　　软件项目开发中的一个重要环节 。它是对某个开发产品或过程进行的全面检查 、鉴定和认可 。 目

　　1

　　GB/T 26805.3—2011

　　的在于尽可能早地发现错误 ,将实现和要求进行统一和协调 。

　　3. 7

　　配置管理 configuration management

　　标识和确定系统中配置项的过程 ,在系统整个生存周期内控制这些项的投放和更动 ,记录并报告配置的状态和更动要求 ,验证配置项的完整性和正确性 。

　　3. 8

　　软件产品库 softwareproduction library

　　在软件生命周期的集成与系统测试阶段结束后 ,用于存放作为最终产品而交付给用户运行或现场安装的软件库 。

　　3. 9

　　软件文档 softwaredocumentation

　　以人们可读的形式出现的技术数据和信息 ,包括计算机列表和打印输出 ,它们描述或规定软件设计或细节 ,说明软件具备的能力 ,或为使用软件以便从软件系统得到所期望的结果而提供的操作指令 。

　　4 软件文档

　　4. 1 概述

　　有关软件文档概述如下 :

　　a) 软件文档是由制造商提供的 、软件产品生命周期中的所有文档 ;

　　b) 软件文档归入工作文档和产品文档两类 ;

　　c) 软件文档是与软件产品有关的可读文件 ,用以描述和记载软件产品生命周期各阶段的活动及结果 ;

　　d) 软件文档的表现形式可以是文字 、表格 、图形和音像等 ;

　　e) 软件文档中包含描述硬件访问接口(如寄存器 、引脚定义 、端口 、组态 、中断等) 的文档 , 以及工业现场对软件产品的要求(如可靠性 、实时性 、安全性等) ;

　　f) 软件文档可以记载于多种媒体(例如光盘 、磁盘 、磁带 、非易失性存储器和纸等介质)上 ,具有持久性 ,便于保存 、修改 、传输和自动化管理 ;

　　g) 软件文档可以复制 ;软件文档可随软件升级而更新(经授权许可) 。

　　4. 2 主要功能

　　4. 2. 1 概述

　　软件文档应该具备以下主要功能 :

　　a) 实现软件管理的依据 ;

　　b) 实现任务之间联系的凭证 ;

　　c) 提供使用须知与说明 ;

　　d) 提供质量保证支持 ;

　　e) 作为历史资料 ;

　　f) 提供产权声明 。

　　4. 2. 2 实现软件管理的依据

　　软件文档记录了软件产品在生命周期内各阶段的活动情况 , 为各阶段的检查 、评审和管理提供依据 , 同时 ,软件文档记录的技术信息 ,可以为软件产品开发的技术管理提供依据 。

　　4. 2. 3 实现任务之间联系的凭证

　　软件开发项目的任务主要由以下各类人员承担 :

　　a) 软件项目管理人员 ;

　　2

　　GB/T 26805.3—2011

　　b) 提出用户需求及项目要点的专家 ;

　　c) 系统分析师 ;

　　d) 软件项目的程序设计师 ;

　　e) 提供程序代码的程序员 ;

　　f) 软件测试员 ;

　　g) 质量保证专家和审核人员 ;

　　h) 改进操作或开发加强和扩展产品性能的维护程序员 。

　　根据软件工程化的 要 求 , 软 件 文 档 是 以 上 各 类 人 员 之 间 通 信 和 交 流 的 凭 证 , 从 而 实 现 任 务 间 的联系 。

　　4. 2. 4 提供使用须知与说明

　　软件文档能够提供使用须知与说明 ,告知系统管理人员 、操作人员 、用户及维护人员系统怎样工作 、如何正确使用系统去实现他们的目标 , 同时可实现对用户的技术培训 ,帮助用户尽快掌握软件产品的使用方法 。

　　4. 2. 5 提供质量保证支持

　　软件文档必须保证向质量保证 、维护和审核人员提供执行其任务时所需要的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明 ;必须制订测试计划和测试规程 ,并报告测试结果 ;还必须说明和评估相关的控制 、计算 、检验例行程序及其他技术 。

　　4. 2. 6 作为历史资料

　　将软件文档用作将来进行项目开发的一种资源 。通常文档记载系统的开发历史 ,可使有关系统结构的基本思想和开发经验为以后的项目利用 。 良好的系统文档有助于把程序移植和转移到各种新的系统环境中 。

　　4. 2. 7 提供产权声明

　　软件文档包含软件产品的评测报告 、版权 、著作权 、知识产权等相关资料 。

　　4. 3 工作文档

　　4. 3. 1 工作文档的目的

　　工作文档的目的包括 :

　　a) 工作文档主要记录需求 、设计 、程序和测试方面有关决定的细节 ;

　　b) 工作文档明 确 划 分 全 体 开 发 人 员 的 职 责 范 围 , 规 定 每 一 个 人 应 该 做 什 么 , 使 他 们 能 够 各 司其职 ;

　　c) 工作文档明确规定检查要点和进度 ,便于项目管理者评估项目的进展情况 ;

　　d) 工作文档记录项目开发的历史 ,为开发后续项目提供参考 。

　　4. 3. 2 工作文档的内容

　　工作文档可分为开发文档和管理文档 。开发文档描述项目开发过程本身 , 以开发所涉及的工具 、方法等技术为主 ;管理文档描述开发阶段划分 ,各开发阶段的任务确定 , 以及如何实现各个阶段的衔接 ,记录进度 、变更和职责定义 、评定等管理工作 。

　　工作文档内容包括 :

　　— 可行性研究报告 ;

　　— 软件项目开发计划书 ;

　　— 软件质量保证计划书 ;

　　— 软件配置管理计划书 ;

　　— 安全与控制信息规格说明 ;

　　— 备忘录或改变控制形式的记录 。

　　3

　　GB/T 26805.3—2011

　　实际的工作文档可以包括上述文档中的部分或全部 。根据项目开发的特点 ,还可以产生新的工作文档 。

　　工作文档的内容与格式应符合 GB/T 26805. 4—2011的有关规定 。

　　4. 4 产品文档

　　4. 4. 1 产品文档的目的

　　产品文档提供有关软件产品的有效使用 、运行 、维护 、更新方面的信息 ,包括 :

　　a) 向程序员 、操作员和最终用户提供所需的文档资料 ;

　　b) 为项目管理者实现科学管理提出的各种资料 , 以监控产品的开发与应用 ;

　　c) 说明产品可用性 、为促进产品推广而具体阐述应用范围的宣传资料 ;

　　d) 向关心软件产品的人们提供的 、用以描述产品特点的信息交流资料 。

　　4. 4. 2 产品文档的范围产品文档一般包括 :

　　— 软件需求规格说明书 ;

　　— 数据需求说明书 ;

　　— 系统(子系统)设计说明书 ;

　　— 软件概要设计说明书 ;

　　— 软件详细设计说明书 ;

　　— 数据库设计说明书 ;

　　— 软件模块规格说明书 ;

　　— 技术评审 ;

　　— 测试计划 ;

　　— 测试分析报告 ;

　　— 用户手册 ;

　　— 操作手册 ;

　　— 程序维护手册 ;

　　— 安装实施过程 ;

　　— 用户培训资料及宣传资料 。

　　实际的产品文档可以包括上述文档中的部分或全部 , 根据项 目开发的特点 , 还可以产生新的产品文档 。

　　产品文档的内容与格式应符合 GB/T 26805. 4—2011的有关规定 。

　　4. 5 用户软件包文档

　　用户软件包文档见 GB/T 26805. 5—2011。

　　5 软件文档的计划管理

　　5. 1 基本任务

　　软件文档计划管理的基本任务是 :

　　a) 明确划分软件生存周期的各个阶段 ;

　　b) 确定每个阶段应当编制的软件文档 ;

　　c) 提出软件文档编制计划 ,并监督实施 。

　　5. 2 管理要点

　　5. 2. 1 软件生命周期的阶段划分

　　附录 A 给出了软件生命周期的定义及阶段划分的常用方法 。

　　4

　　GB/T 26805.3—2011

　　对于一个具体的软件开发项 目 ,软件生命周期的各个阶段应当如何划分 ,项目管理者应着重考虑以下两个因素 :

　　5. 2. 1. 1 标识阶段的名称可以改变

　　随着所用开发方法的不同 ,开发项目的不同 , 阶段名称允许有相当大的差异 。但必须坚持阶段的明确划分 , 以便分段实施 、加强管理 。

　　5. 2. 1. 2 阶段划分具有灵活性

　　阶段划分的详细程度取决于软件项目的重要性 、复杂程度 、使用频度 、软件规模 、技术水平和成败风险等诸种因素 。项目管理者应根据软件项目的实际情况进行权衡 。

　　5. 2. 2 文档编制应考虑的因素

　　5. 2. 2. 1 总则

　　坚持在软件生存周期的各个阶段必须编制对应的软件文档 ,是项 目管理者实施文档计划管理的另一个管理要点 。然而 ,一个具体的软件开发项目究竟需要编制哪些软件文档 ,是由多种因素决定的 ,项目管理者必须充分地予以考虑 。

　　5. 2. 2. 2 必要性

　　为了保证软件项目开发工作的顺利进行 ,作为软件生存周期各个阶段工作完成的重要标志 ,开发人员必须按开发阶段的要求认真编制相应的软件文档 。

　　与软件生存周期各个阶段对应的软件文档见附录 B。

　　5. 2. 2. 3 重复性

　　在确定软件文档种类时 ,应保持每种文档的独立性 ,但允许内容上存在某些重复 , 以适合不同读者的需要 。

　　5. 2. 2. 4 灵活性

　　和软件生命周期的阶段划分具有灵活性一样 ,需要编制的文档种类也具有灵活性 。一般说来 , 当软件项目的复杂程度 、软件规模和成败风险增大时 ,软件文档的种类 、详细程度将随之增加 。反之 ,可适当减少 ,为了避免在软件项目开发中文档编制的不足或过度 ,项目管理者可主要根据软件规模去确定需要编制哪些软件文档 。

　　软件规模可分为以下三级 :

　　a) 小规模软件 — 源程序行数少于 3 000行的软件 ;

　　b) 中规模软件— 源程序行数为 3 000~ 30 000行的软件 ;

　　c) 大规模软件 — 源程序行数为 30 000行以上的软件 。

　　对软件开发项目文档编制的要求亦相应地分为三级 ,如图 1 所示 。根据图 l,某些文档可以是某种文档的扩展和细分 。在最简单的情况下 ,可合并成软件需求说明与开发计划 、软件设计说明 、使用说明和项目开发总结四种文档 。而在软件规模特别庞大的情况下 ,可进一步细分为更多的软件文档 。

　　5

　　GB/T 26805.3—2011

　　图 1 软件文档分级与对应文档

　　5. 2. 3 软件文档编制计划

　　5. 2. 3. 1 总则

　　软件文档编制计划可以是整个项目计划的一部分 ,也可以是一个独立的文档 。 它作为说明文档重要性的具体资料 ,也作为项目管理者的备忘录 ,是型式检查 、复审和验收的重要依据 。

　　文档编制计划应包括对以下几个问题的陈述 :

　　— 文档内容与型式 ;

　　— 文档格式与标示 ;

　　— 文档编制的进度 ;

　　— 开发人员的职责范围 。

　　5. 2. 3. 2 文档内容与形式

　　文档内容着重于功能方面的说明 ,告诉软件开发人员本阶段 “做什么 ”。现就与产品文档有关的几个问题规定如下 。

　　5. 2. 3. 2. 1 程序员文档

　　主要包括以下内容 :

　　a) 总则 必须向程序员提供编码 、维护或强化现存软件所需要的全部信息 。例如有关程序逻辑 、

　　6

　　GB/T 26805.3—2011

　　数据存储规格说明与功能描述方面的图解和说明 。通过这些信息使程序员明白 :假设软件干什么 ,而当假设成立时软件怎样去干 。

　　b) 程序说明 软件的开发管理必须保证开发程序员能够应用程序设计语言的方便在编码时插入程序说明 。开发程序员应将这些说明准备好 , 以便实现程序的编码以及在修改程序时加以利用 。在程序说明中 ,每个程序模块都应包含模块在逻辑 、目 的和基本原理方面的叙述 ,还可能包括有关子程序文档和条件处理方面的叙述 。对于不常见的编码而言 ,还可能需要具体码串的具体说明 。例如为求解某一问题的算法 ,就可以将阐明算法来源 、所需数据 、计算结果以及结果怎样为程序所用方面的说明放在它的前面 。

　　c) 图示 需要对程序逻辑进行逐条描述 ,对出现在一个程序或一个系统以及出现在用以说明程序逻辑流程图中的数据流要进行描述 , 向维护程序员展示需由他们进行维护的程序段逻辑 , 以及展示这种程序段逻辑与系统中其他程序或模块有怎样的关系 。

　　d) 存储规格说明 必须向维护程序员提供数据存储在何处 , 以及按何种形式进行存储方面的信息 。

　　e) 形式系统文档 维护程序员有时需要比程序说明 、图示和存储规格说明更多的信息 。他们还需要详细的文字说明 ,更为完善的软件产品,常常需要有对系统或程序给予文字说明 的 形 式文档 。

　　5. 2. 3. 2. 2 系统事务管理员/操作员文档

　　为了运行系统的硬件和软件 ,需要了解支持系统运行的各种因素 。 系统事务管理员/操作员文档告知与此有关的各种信息 ,包括 :

　　a) 批量作业的进度和名称 、项目的运行时间 ;

　　b) 数据存储需求以及程序如何取得所存储的数据 ;

　　c) 所用设备 ;

　　d) 项目的系统联机应用时数 ;

　　e) 调试 、检修指南 。

　　5. 2. 3. 2. 3 用户培训和参考资料

　　没有足够用户信息的产品文档是不完备的 。用户至少需要两类信息 :

　　a) 培训信息 — 帮助用户迅速成为系统应用方面的专家 ;

　　b) 参考资料 — 帮助用户找到回答有关系统应用具体问题的答案 。

　　此外 ,用户可能希望知道他们在使用系统时怎样才能与系统的整个工作相适应 , 为此 ,产品文档还应提供与此有关的各种信息 。

　　满足这些信息需求的文档 ,其格式可以有所不同 ,可以是形式化 、半形式化或非形式化的 , 由项目管理者最终决定 。

　　5. 2. 3. 2. 4 宣传/信息交流文档

　　包括以下几个方面 :

　　a) 总则 这类文档的重要意义在于 :

　　— 增加系统的满意程度 ,使用户能比较容易地使用产品 ;

　　— 争取潜在用户 ,使产品获得推广应用的可能性 。

　　宣传/信息交流文档有以下几种类型 。

　　b) 产品说明 产品说明应以简短的形式去总结系统的特点 ,指出系统的硬件和软件需求 。

　　c) 情况通报 作为一种专供软件项目开发人员使用的内部文档 ,情况通报告知项目的进展情况 ,使全体开发人员作好交付产品(包括阶段产品)的准备 。

　　5. 2. 3. 3 文档格式与标识

　　文档的编制格式应符合 GB/T 26805. 4—2011的有关规定 。

　　7

　　GB/T 26805.3—2011

　　需要提供用以标识文 档 的 信 息 。 这 些 信 息 主 要 是 : 文 档 号 、修 改 日 期 、版 本 号 、作 者 、主 要 参 加 人员等 。

　　5. 2. 3. 4 文档编制的进度

　　5. 2. 3. 4. 1 文档清单

　　软件文档编制计划应列出所要编制的全部文档的清单 ,规划每种文档完成的详细进度 。坚持在下一阶段可能开始之前上一阶段的文档必须完成并符合规定 。

　　对以下各项工作的进度 ,项目管理者要进行时间分配 :

　　a) 提出文档计划 ;

　　b) 复审文档计划 、编制文档概要 ;

　　c) 提出文档草案 ,从技术精确性 、完备性和实用性方面对之进行复审 ;

　　d) 编辑由复审产生的综合说明 ;

　　e) 最后审核与批准 ;

　　f) 形成正式文档 ;

　　g) 分发 。

　　5. 2. 3. 4. 2 重要文档的存储

　　项目管理者应当为在不同开发阶段实现重要文档的存储分配时间并提供支持 。这种文档的存储虽然带来了人员 、设备和时间的开销 ,但在发生人为故障或自然灾害的情况下可以借助所存储的后备文档和系统图等资料去重建系统 。

　　如果文档是联机开发的 ,采用磁盘 、光盘等数据媒体都可实现重要文档的存储 ,便于需要时迅速转换为实用的形式 。

　　5. 2. 3. 4. 3 项目库管理程序

　　对于较大型的软件开发项 目 ,项 目管理者必须考虑编制一个项 目库管理程序 , 以汇总项 目开发数据 ,实现对项目文档的调整以及文档索引的调整 。此外 ,项目库管理程序还应完成以下工作 , 帮助项 目管理者实现对工作进度的有效管理 :

　　a) 编制重要事件的年谱 ;

　　b) 机时月预算记录 ;

　　c) 人时月预算记录 ;

　　d) 预算修改清单 ;

　　e) 实际耗时汇总 。

　　根据反映工作进度的 年 谱 和 其 他 一 些 例 行 检 查 结 果 , 项 目 管 理 者 能 获 悉 实 现 项 目 控 制 所 需 的信息 。

　　5. 2. 3. 5 开发人员的职责范围

　　确定软件项目开发组织的人员分工及其职责范围 。

　　6 软件文档的质量管理

　　6. 1 软件文档的质量分级及质量要求

　　6. 1. 1 总则

　　随着项目大小和所承担的风险的不同 , 以及软件文档使用范围的不同 ,对文档的质量要求也会有所不同 。根据文档内容多少和功能的差异 ,可将文档质量划分为四级 。项 目管理者必须在计划期间就确定文档的质量等级 。

　　6. 1. 2 最小信息文档(第 1 级)

　　第 1 级文档适用于单用户程序 。这种文档只包括程序清单 、开发说明 、测试数据 、程序摘要 。

　　8

　　GB/T 26805.3—2011

　　6. 1. 3 内部文档(第 2 级)

　　第 2 级文档适用于专用程序 ,这种程序很少需要与别人共享 。 或者根本没有潜在用户 。 除开应包括第 1 级文档所提供的信息外 ,还应在程序清单中加入大量说明 , 以帮助用户读懂和使用程序 。

　　6. 1. 4 工作文档(第 3 级)

　　第 3 级文档适用于供同一批开发中若干人使用的程序 ,或适用于由其他开发者使用的程序 。文档内容或编辑格式以满足工作需要为度 。

　　6. 1. 5 形式出版物(第 4 级)

　　第 4级文档适用于被正式通告为软件产品的程序 。一些重要的程序 ,例如用于工业控制的标准算法软件包 ,实现财务管理的打印工资报表等这样的程序 ,都需要这种文档 。

　　第 4级文档的内容与格式应符合 GB/T 26805. 4 的有关规定 。

　　— 对于较大型的软件开发项 目 ,项 目管理者必须考虑设立质量保证机构 , 负责软件文档的质量检查 ;

　　— 文档的质量应从内容 、结构 、实用性以及是否符合标准 、规范等方面去加以检查 ;

　　— 文档的内容可用正确性 、完备性和明确性进行评价 ;

　　— 文档的结构可从整个文档的安排是否井然有序 、方便使用和符合标准三方面进行考察 ;

　　— 文档实用性是指软件文档是否反映工业控制软件在实时性 、在线性 、高可靠性和可维护性等方面的要求 。

　　6. 2 软件文档的复审

　　6. 2. 1 总则

　　在较大型软件项目的开发中 ,必须坚持对软件文档进行形式检查和复审 , 以保证其准确性 、完备性和明确性 。描述开发企图和软件产品的全部文档都应当进行形式检查 。特别重要的是 ,一开始就应在需求和设计规格说明阶段进行复审 。

　　6. 2. 2 需求复审

　　在需求复审期间主要检查 :

　　a) 项目开发者是否了解用户需求 ;

　　b) 系统需求规格说明是否反映并满足用户需求 。

　　需求复审可能不止进行一次 ,用户代表必须参与开发活动和需求复审 ,并核准系统需求规格说明 。

　　6. 2. 3 设计复审

　　6. 2. 3. 1 概述

　　设计复审包括概要设计和详细设计这两个主要复审项 目 。

　　6. 2. 3. 2 概要设计

　　在概要设计复审期问 ,系统每一组成部分的基本设计方案和初始测试计划是复审的主要内容 。根据复审结果对系统需求规格说明进行修改 。

　　6. 2. 3. 3 详细设计

　　在详细设计复审期间 ,要对详细设计和程序每一组成部分的测试方案进行分析 。

　　设计复审的结果应在相应的文档中明记 ,用以确定为了满足业主需求已同意的设计 ,如设计 、开发和测试具体系统和程序 。

　　不管项目大小或项目管理中的工程化程度如何 , 以上复审都是十分重要的 。必须写出复审形式文件作为工作文档 ,包括所修改的内容及复审结论 。

　　6. 2. 4 其他项目的复审

　　为了确保产品文档的准确性 、完备性以及适用各类读者阅读 ,还需要对其他文档进行形式检查 。形式检查的要点如下 :

　　a) 内容的组织 ;

　　9

　　GB/T 26805.3—2011

　　b) 技术准确度 ;

　　c) 总体的完备性 ;

　　d) 对各类读者的适合程度 ;

　　e) 图表编制计划和最后用到的图表(也应接受技术准确度 、完备性及适合程度等各种分项复审) ;

　　f) 文法 、标点符号和其他技术细节的正确性要符合(工业现场)有关规定 ;

　　g) 文档格式应符合 GB/T 26805. 4—2011的有关规定 。

　　7 软件文档的配置管理

　　软件配置是指软件应当提供和完成的程序 、文档 、数据以及各种文字资料的有序集合 。其中每个独立的文本及其集合都称为一个软件配置项 ,软件配置管理的主要任务是 :

　　a) 建立软件文档标准及软件文档标识体制 ;

　　b) 评价及记录软件配置项的变动情况 ,并控制这些变动 ;

　　c) 严格跟踪并控制已确认的软件配置项 ;

　　d) 不断检查软件配置 。

　　8 管理要点总结

　　为了检查在软件项目的开发过程中是否实施软件文档的有效管理 ,项目管理者必须回答以下问题 :

　　a) 是否明确划分了软件生存周期的各个阶段? 是否确定了需要编制的软件文档的种类?

　　b) 是否指定专人负责工作文档与产品文档的准备工作? 是否列出与软件文档的编制有关的国家标准或行业标准的清单? 如果尚无相应标准 ,是否制定出规范对文档内容 、格式及标识方式作出明确规定?

　　c) 是否提出了软件文档编制计划? 对要编制的每种文档 ,承担下述工作的人员责任是否明确?

　　1) 文档的准备和起草 ;

　　2) 项目库管理程序 ;

　　3) 文档存储 ;

　　4) 文档复审 ;

　　5) 绘制图表 ;

　　6) 质量保证 。

　　d) 是否规定了文档的编制过程 ,包括什么时候完成什么文档的编制? 对以下各项工作是否已确定交付进度?

　　1) 准备草案 ;

　　2) 提出草案第一稿 ;

　　3) 修改草案 ;

　　4) 绘制图表 。

　　e) 是否确立软件文档质量评定准则? 是否建立质量保证机构或指定人员负责文档质量?

　　f) 是否建立文档复审制度? 是否考虑让分析员 、开发者 、程序员 、维护人员 、审核人员 、用户和管理人员参与复审?

　　g) 是否对软件文档按层次分类标识 , 注明项 目 、文档品种 、版本号 、页号并确定文档密级和分发范围?

　　h) 是否对软件文档的修改活动进行过管理和控制 ,规定了修改活动的规程?

　　i) 是否对软件文档的修改进行过周密的控制 , 以保持文档和程序的一致性 ,文档间的一致性和安

　　10

　　GB/T 26805.3—2011

　　全性 ,并保证副本(在开发人员手中)与库存文档的一致性?

　　j) 是否确立保证软件文档先进性的办法? 为保证工业控制软件的实时性 、在线性 、高可靠性和可维护性 ,软件文档是否作了相应考虑?

　　k) 为了得到用户对文档的评价和意见 ,是否建立了相应的反馈机构?

　　l) 是否为重要文档的存储提供了便利条件? 是否已经具备开发软件文档的资料?

　　m) 是否列出软件支持工具和考虑采用自动化文档技术?

　　11

　　GB/T 26805.3—2011

　　附 录 A

　　(规范性附录)

　　软件生命周期的定义及阶段划分

　　A. 1 软件生命周期的定义

　　根据 GB/T 11457—2006,软件生命周期指的是 “从软件产品的开发设计开始到产品不能再使用时为止的时间周期 。它典型地包括需求阶段 、设计阶段 、实现阶段 、验证与测试阶段 、安装验收阶段 、运行维护阶段 ,有时还包括引退阶段 ”。

　　为使用方便 ,本标准将软件生命周期分为软件定义 、软件开发和运行维护三个阶段 。

　　A. 2 软件定义阶段

　　A. 2. 1 总则

　　软件定义阶段即是需求阶段 ,主要解决软件 “做什么 ”的问题 。需求阶段可以细化为系统需求分析 、软件规划和软件需求分析三个子阶段 。

　　A. 2. 2 系统需求分析

　　系统需求分析是软件生命周期的最初阶段 。其主要任务是收集 、理解用户需求 ,对用户需求进行可行性分析 ,将用户需求转换为系统需求 。还要对投资与效益进行评估 。

　　A. 2. 3 软件规划

　　以系统需求为依据 ,根据历史数据和实践经验 ,将系统需求转换为软件处理需求 。

　　A. 2. 4 软件需求分析

　　从软件处理需求变换出 “软件需求规格说明 ”,并进行评审 。

　　A. 3 软件开发阶段

　　A. 3. 1 总则

　　由软件设计阶段 ,实现阶段 ,验证 、测试与质量保证等阶段组成 。在这个阶段中主要解决软件 “怎样做 ”的问题 ,是对软件定义阶段定义的软件 “做什么 ”的求解过程 。

　　A. 3. 2 软件设计

　　为满足系统规定的需求 ,提出实现控制功能和规程以程序和数据存储技术的规格说明 ;还要提出确保系统完整性而采用的安全与控制技术 ,把软件需求规格说明变换成详细设计文档并进行评审 。

　　A. 3. 3 编码

　　实现程序设计的具体步骤 。它采用某种程序设计语言 ,把详细设计文档人工地或自动地变换为机器能够理解的代码 。

　　A. 3. 4 验证、测试与质量保证

　　检验软件产品是否满足用户需求 ,确保系统按设计意图工作 ,而且保证系统能满足性能 、可靠性 、完整性和安全性方面的要求 。

　　A. 4 运行维护阶段

　　A. 4. 1 总则

　　软件产品经过测试 、验收后交由用户现场运行 ,软件便进入生命周期的最后一个阶段 — 运行维护阶段 。

　　运行维护阶段是软件产品发挥其效益的阶段 ,也是历史最长 、花费最多的一个阶段 。它一般解决以

　　12

　　GB/T 26805.3—2011

　　下几种维护问题 :

　　A. 4. 2 纠错性维护

　　分析和纠正软件在开发时即已产生 ,在测试时未能检出 ,在使用后暴露的错误 。

　　A. 4. 3 完善性维护

　　满足用户对软件需求进行修改或满足其增强的需求 。

　　A. 4. 4 适应性维护

　　由于外部环境的改变(如新的操作系统 、新的硬件)而引起的需求修改 ,使软件适应于新的环境或新的系统 。

　　A. 4. 5 预防性维护

　　为改善将来的可靠性或适应将来发生的情况而进行的完善或修改 。