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

ICS 25.040.40 N18 GB/T 26805.3—2011 中华人民共和国国家标准 工业控制计算机系统 软件 第3部分：文档管理指南 Industrial control computer system software—Part 3: Guidelines for the document management 2011-07-29 发布 2011-12-01 实施 中华人民共和国国家质量监督检验检疫总局 中国国家标准化管理委员会 前言 GB/T 26805《工业控制计算机系统 软件》分为以下部分： 第1部分：评价体系； 第2部分：测试方法； 第3部分：文档管理指南； 第4部分：工程化文档规范； 第5部分：用户软件包文档。 本部分是GB/T 26805的第3部分。 本部分的附录A和附录B为规范性附录。 本部分由中国机械工业联合会提出。 本部分由全国工业过程测量和控制标准化技术委员会（SAC/TC124）归口。 本部分负责起草单位：西南大学。 本部分参加起草单位：深圳市研祥软件技术有限公司、北京研华兴业电子科技有限公司、中国计算机学会工业控制计算机专业委员会。 本部分主要起草人：吕静、杨颂华、张为群、张渝、祁虔。 本部分参加起草人：陈志列、刘志永、刘学东、刘永池、杨孟飞。 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 产品文档 product documentation 软件项目开发过程中，应当编制的各种技术资料或技术管理资料。 3.4 工作文档 work documentation 软件项目开发过程中，所填写的或使用过的各种图表或文字资料。 3.5 用户需求 user requirement 用户所期望的软件产品的全部性能、功能和限制。它主要包括对软件产品的功能要求、性能要求，如实时性、可靠性和可维护性要求以及安全保密要求，还包括在开发费用、时间、进度和可用资源等方面的限制。 3.6 评审 review 软件项目开发中的一个重要环节。它是对某个开发产品或过程进行的全面检查、鉴定和认可。目的在于尽可能早地发现错误，将实现和要求进行统一和协调。 3.7 配置管理 configuration management 标识和确定系统中配置项的过程，在系统整个生存周期内控制这些项的投放和更动，记录并报告配置的状态和更动要求，验证配置项的完整性和正确性。 3.8 软件产品库 software production library 在软件生命周期的集成与系统测试阶段结束后，用于存放作为最终产品而交付给用户运行或现场安装的软件库。 3.9 软件文档 software documentation 以人们可读的形式出现的技术数据和信息，包括计算机列表和打印输出，它们描述或规定软件设计或细节，说明软件具备的能力，或为使用软件以便从软件系统得到所期望的结果而提供的操作指令。 4 软件文档 4.1 概述 有关软件文档概述如下： a) 软件文档是由制造商提供的、软件产品生命周期中的所有文档； b) 软件文档归入工作文档和产品文档两类； c) 软件文档是与软件产品有关的可读文件，用以描述和记载软件产品生命周期各阶段的活动及结果； d) 软件文档的表现形式可以是文字、表格、图形和音像等； e) 软件文档中包含描述硬件访问接口（如寄存器、引脚定义、端口、组态、中断等）的文档，以及工业现场对软件产品的要求（如可靠性、实时性、安全性等）； f) 软件文档可以记载于多种媒体（例如光盘、磁盘、磁带、非易失性存储器和纸等介质）上，具有持久性，便于保存、修改、传输和自动化管理； g) 软件文档可以复制； h) 软件文档可随软件升级而更新（经授权许可）。 4.2 主要功能 4.2.1 概述 软件文档应该具备以下主要功能： a) 实现软件管理的依据； b) 实现任务之间联系的凭证； c) 提供使用须知与说明； d) 提供质量保证支持； e) 作为历史资料； f) 提供产权声明。 4.2.2 实现软件管理的依据 软件文档记录了软件产品在生命周期内各阶段的活动情况，为各阶段的检查、评审和管理提供依据，同时，软件文档记录的技术信息，可以为软件产品开发的技术管理提供依据。 4.2.3 实现任务之间联系的凭证 软件开发项目的任务主要由以下各类人员承担： a) 软件项目管理人员； 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 工作文档的内容 工作文档可分为开发文档和管理文档。开发文档描述项目开发过程本身，以开发所涉及的工具、方法等技术为主；管理文档描述开发阶段划分，各开发阶段的任务确定，以及如何实现各个阶段的衔接，记录进度、变更和职责定义、评定等管理工作。工作文档内容包括： - 可行性研究报告； - 软件项目开发计划书； - 软件质量保证计划书； - 软件配置管理计划书； - 安全与控制信息规格说明； - 备忘录或改变控制形式的记录。 实际的工作文档可以包括上述文档中的部分或全部。根据项目开发的特点，还可以产生新的工作文档。 工作文档的内容与格式应符合GB/T 26805.4-2011的有关规定。 4.4 产品文档 4.4.1 产品文档的目的 产品文档提供有关软件产品的有效使用、运行、维护、更新方面的信息，包括： a) 向程序员、操作员和最终用户提供所需的文档资料； b) 为项目管理者实现科学管理提出的各种资料，以监控产品的开发与应用； c) 说明产品可用性、为促进产品推广而具体阐述应用范围的宣传资料； d) 向关心软件产品的人们提供的、用以描述产品特点的信息。