【国家标准】 工业控制计算机系统 软件 第5部分：用户软件文档

GB/T 26805.5-2011 工业控制计算机系统 软件 第5部分：用户软件文档 前言 GB/T 26805《工业控制计算机系统 软件》分为以下几部分： 第1部分：评价体系； 第2部分：测试方法； 第3部分：文档管理指南； 第4部分：工程化文档规范； 第5部分：用户软件文档。 本部分是GB/T 26805的第5部分。 本部分由中国机械工业联合会提出。本部分由全国工业过程测量和控制标准化技术委员会(SAC/TC124)归口。 本部分负责起草单位：西南大学。 本部分参加起草单位：北京研华兴业电子科技有限公司、深圳市研祥软件技术有限公司、中国计算机学会工业控制计算机专业委员会。 本部分主要起草人：黄巧莉、杨颂华、张为群、刘枫、吕静、张渝。 本部分参加起草人：刘学东、刘永池、陈志列、程剑锋、杨孟飞。 1 范围 GB/T 26805的本部分规定了工业控制软件的用户软件文档应提供的各类信息，以便指导该类文档的编制。 本部分适应于工业控制软件的用户软件文档编制。 2 规范性引用文件 下列文件中的条款通过GB/T 26805的本部分的引用而成为本部分的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本部分，然而，鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本部分。 GB/T 8567-2006 计算机软件文档编制规范 3 术语和定义 GB/T 8567-2006确立的以及下列术语和定义适用于GB/T 26805的本部分。 3.1 工业控制软件 industrial control software 适用于工业过程测量和控制的专用软件。除具备数据处理软件的一般特点外，应具有更高的实时性、并发性、高可靠性和可维护性等特点。 3.2 工业过程 industrial process 基本完成一个或一系列物理变化或化学变化的一组运行。[GB/T 17212-1998的P1.0.0.06] 注：其他过程和物质或能量的输送和/或暂时贮存、信息的传输可看作是工业过程的一部分。 3.3 过程测量 process measurement 确定各过程变量值的信息获取。[GB/T 17212-1998的P1.0.0.09] 3.4 过程控制 process control 为达到规定的目标而对影响过程状况的变量的操纵。[GB/T 17212-1998的P1.0.0.10] 3.5 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。[GB/T 11457-2006的2.495] 3.6 软件文档 software documentation 以人们可读的形式出现的技术数据和信息。包括计算机列表和打印输出，它们描述或规定软件设计或细节，说明软件具备的能力，或为使用软件以便从软件系统得到所期望的结果而提供的操作指令。[GB/T 11457-2006的2.1493] 3.7 用户文档集 user documentation 一套文档，它为使用系统或部件以期获得所希望结果的最终用户提供系统指令方面的信息。[GB/T 11457-2006的2.1089] 3.8 用户软件文档 user software documentation 用以提供软件的标识、用途和适用范围、功能规格说明、数据规格说明、操作环境等综合信息的一类用户文档。 3.9 委托单位 entrustment company 亦称交办单位。指为用户软件的开发提供资金，并且通常（但并非绝对)提出软件需求的单位。 3.10 承办单位 undertaker 从事用户软件的开发、研制的单位。 4 背景信息 在编制用户软件文档时，应提供以下背景信息： a) 开发软件的委托单位，承办单位和协作单位（如果有的话)； b) 描述软件的设计层次和设计方法，指出软件所具有的显著特点，以及是否计划进行修改等； c) 说明软件能够提供的产品形式，例如提供光盘和文档手册等； d) 列出与用户软件文档有关的辅助文档的清单(例如程序员指南，安装指南），列出这些文档资料的作者、标题、序号、发表日期和出版单位，并说明如何取得这些文档； e) 给出用户软件文档中用到的、可能引起混淆的专门术语的定义，对略语和缩写词要注明原文。 5 用户软件文档的主要内容 5.1 软件的标识 5.1.1 概述 软件的标识包括提供软件名、版本和日期、派生软件和关键字等内容。对软件名、版本和日期以及派生软件，建议进行显示。 5.1.2 软件名 提供用以标识软件的标号和名称，还要提供描述软件主要功能的子标号。 5.1.3 版本和日期 5.1.3.1 版本 提供软件的版本标识（版本、修订本、版本号和发行号），还要提供版本数字序号的简要说明。它应包括适用于这些项的保密性和私密性要求，处理它们的安全措施和关于复制和许可证条款的说明和制约。软件版本的标识应符合GB/T 8567-2006中7.22的规范性要求。 5.1.3.2 日期 提供原版本和现行版本的出版日期。 5.1.4 派生软件 对同时流行但又有不少差别的同类软件需提供辅助标识，例如说明是否运行于不同的设备或操作系统。 5.1.5 关键字 可以用来描述软件的特征以及进行查询和实现检索的描述符或关键字。 5.2 用途和适用范围 5.2.1 用途 简述软件的用途。 5.2.2 适用范围 简述软件的各种功能以及在应用方面的限制，以便使委托单位或用户能够决定是否满足其软件需求，因而决定是否采用。 5.3 程序规格说明 5.3.1 问题描述 综合描述软件中每一程序所要解决的问题。 5.3.2 问题求解 5.3.2.1 约定和术语 给出用户软件文档所用到的各项规则的细节，例如： a) 约定在求解问题时所用字符或符号的含义； b) 约定字符和符号组合后的特定含义； c) 指明所使用的前缀、后缀、符号、精度、舍入、坐标系统、值域和缩写表的含义； d) 约定各种技术规则的含义等。 5.3.2.2 求解问题的原理和算法 描述与指定功能有关以及与程序的结构组织有关的解题方法和算法以及参考文献。 5.3.3 程序结构 按所指定的解题方法，描述程序单元的组织，例如： a) 程序； b) 子程序； c) 模块； d) 程序段； e) 公共存储区。 可以按图解方式表示，例如： a) 采用树形结构图； b) 采用适当的文字结构描述； c) 必须包括单元名描述，描述它们的入口、出口，以及它们之间的相互关系。 5.3.4 程序规模 按常用单位，例如字节数或源代码行数，指出程序的总规模。 5.3.5 功能规格说明 5.3.5.1 功能 逐项说明软件中每一程序所具备的各项功能及其极限范围。 5.3.5.2 出错和恢复 a) 指出软件可能产生的出错信息的种类和采用的出错处理方法； b) 指出为确保再启动和恢复，用户必须遵循的处理规则和详细步骤。 5.3.6 性能 5.3.6.1 概述 逐项说明软件的全部性能。 5.3.6.2 时间特性 定量说明软件的时间特性，例如：实时响应时间、采样时间、调节控制周期、处理时间（更新处理时间、编译速度、通信速率、检索时间等）、数据传输与转换时间以及运行时间等。 5.3.6.3 精度 说明软件输出数据所能达到的精度，或者说明软件所能达到的控制精度。 5.3.6.4 可再入性 说明软件中的子程序能被中断并由中断它的程序再行进入，以及对中断它的程序和被中断的程序能给出正确结果的能力。 5.3.6.5 灵活性 说明用户需求(如操作方式、运行环境、结果精度和时间特性等)有某些变化时，软件的适应能力。 5.3.6.6 可靠性 说明软件在确保其可靠性时所采取的技术措施。 5.3.7 安全 说明软件在安全方面的设计考虑，即说明如何对程序和数据进行保护以拒绝对它们的未经许可的访问，还要说明在安全方面实际能达到的程度。 5.3.8 保密 描述为保证软件中数据记录的安全，能提供的保护机制和保密措施。 5.4 数据规格说明 5.4.1 输入数据规格说明 规定对输入数据的要求： a) 描述包含在每一结构单元中的输入数据的内容及逻辑结构或数据格式； b) 描述数据对特定数据媒体的依赖性。