ICS25.040.40 N18 中华人民共和国国家标准 GB/T26805.3—2011 工 业控制计算机系统 软件 第3部分:文档管理指南 Industrialcontrolcomputersystem—Software— Part3:Guidelinesforthedocumentmanagement 2011-07-29发布 2011-12-01实施 中华人民共和国国家质量监督检验检疫总局 中国国家标准化管理委员会发布目 次 前言 Ⅰ ………………………………………………………………………………………………………… 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/T26805.3—2011 前 言 GB/T26805《工业控制计算机系统 软件》分为以下部分: ———第1部分:评价体系; ———第2部分:测试方法; ———第3部分:文档管理指南; ———第4部分:工程化文档规范; ———第5部分:用户软件包文档。 本部分是GB/T26805的第3部分。 本部分的附录A和附录B为规范性附录。 本部分由中国机械工业联合会提出。 本部分由全国工业过程测量和控制标准化技术委员会(SAC/TC124)归口。 本部分负责起草单位:西南大学。 本部分参加起草单位:深圳市研祥软件技术有限公司、北京研华兴业电子科技有限公司、中国计算 机学会工业控制计算机专业委员会。 本部分主要起草人:吕静、杨颂华、张为群、张渝、祁虔。 本部分参加起草人:陈志列、刘志永、刘学东、刘永池、杨孟飞。 ⅠGB/T26805.3—2011 工业控制计算机系统 软件 第3部分:文档管理指南 1 范围 GB/T26805的本部分规定了工业控制软件文档管理的基本任务和管理要点,为项目管理者实施 该类文档的管理提供指南。 本部分适用于工业控制计算机系统的软件文档管理。 2 规范性引用文件 下列文件中的条款通过GB/T26805的本部分的引用而成为本部分的条款。凡是注日期的引用文 件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本部分,然而,鼓励根据本部分达成 协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本 部分。 GB/T11457—2006 信息技术 软件工程术语 GB/T26805.4—2011 工业控制计算机系统 软件 第4部分:工程化文档规范 GB/T26805.5—2011 工业控制计算机系统 软件 第5部分:用户软件文档 3 术语和定义 GB/T11457—2006中确立的以及下列术语和定义适用于GB/T26805的本部分。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。 3.2 用户 user a) 使用软件求解某一问题的技术人员; b) 实际使用软件产品或操作运行软件的组织、单位或个人。 3.3 产品文档 productdocumentation 软件项目开发过程中,应当编制的各种技术资料或技术管理资料。 3.4 工作文档 workdocumentation 软件项目开发过程中,所填写的或使用过的各种图表或文字资料。 3.5 用户需求 userrequirement 用户所期望的软件产品的全部性能、功能和限制。它主要包括对软件产品的功能要求、性能要求, 如实时性、可靠性和可维护性要求以及安全保密要求,还包括在开发费用、时间、进度和可用资源等方面 的限制。 3.6 评审 review 软件项目开发中的一个重要环节。它是对某个开发产品或过程进行的全面检查、鉴定和认可。目 1GB/T26805.3—2011 的在于尽可能早地发现错误,将实现和要求进行统一和协调。 3.7 配置管理 configurationmanagement 标识和确定系统中配置项的过程,在系统整个生存周期内控制这些项的投放和更动,记录并报告配 置的状态和更动要求,验证配置项的完整性和正确性。 3.8 软件产品库 softwareproductionlibrary 在软件生命周期的集成与系统测试阶段结束后,用于存放作为最终产品而交付给用户运行或现场 安装的软件库。 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) 软件项目管理人员; 2GB/T26805.3—2011 b) 提出用户需求及项目要点的专家; c) 系统分析师; d) 软件项目的程序设计师; e) 提供程序代码的程序员; f) 软件测试员; g) 质量保证专家和审核人员; h) 改进操作或开发加强和扩展产品性能的维护程序员。 根据软件工程化的要求,软件文档是以上各类人员之间通信和交流的凭证,从而实现任务间的 联系。 4.2.4 提供使用须知与说明 软件文档能够提供使用须知与说明,告知系统管理人员、操作人员、用户及维护人员系统怎样工作、 如何正确使用系统去实现他们的目标,同时可实现对用户的技术培训,帮助用户尽快掌握软件产品的使 用方法。 4.2.5 提供质量保证支持 软件文档必须保证向质量保证、维护和审核人员提供执行其任务时所需要的各种质量标准以及关 于期望系统完成什么功能和系统怎样实现这些功能的清晰说明;必须制