GB/T 26805.5-2011 工业控制计算机系统 软件 第5部分：用户软件文档

　　ICS 25. 040. 40 N 18

　　中 华 人 民 共 和 国 国 家 标 准

　　GB/T 26805.5—2011

　　工业控制计算机系统 软件

　　第 5 部分 :用户软件文档

　　Industrialcontrolcomputersystem—Software—

　　Part5:Usersoftwaredocument

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

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

　　

　　发

　　

　　布

　　GB/T 26805.5—2011

　　目 次

　　前言 Ⅰ

　　1 范围 1

　　2 规范性引用文件 1

　　3 术语和定义 1

　　4 背景信息 2

　　5 用户软件文档的主要内容 2

　　5. 1 软件的标识 2

　　5. 2 用途和适用范围 3

　　5. 3 程序规格说明 3

　　5. 4 数据规格说明 4

　　5. 5 操作环境 5

　　5. 6 终端操作 5

　　5. 7 应用举例 5

　　5. 8 合同款项 6

　　5. 9 安装与支持 6

　　5. 10 置信度 6

　　5. 11 标准 6

　　5. 12 产品编号 6

　　参考文献 7

　　GB/T 26805.5—2011

　　前 言

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

　　— 第 1部分 :评价体系 ;

　　— 第 2部分 :测试方法 ;

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

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

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

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

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

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

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

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

　　本部分主要起草人 :黄巧莉 、杨颂华 、张为群 、刘枫 、吕静 、张渝 。

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

　　Ⅰ

　　GB/T 26805.5—2011

　　工业控制计算机系统 软件

　　第 5 部分 :用户软件文档

　　1 范围

　　GB/T 26805的本部分规定了工业控制软件的用户软件文档应提供的各类信息 , 以便指导该类文档的编制 。

　　本部分适应于工业控制软件的用户软件文档编制 。

　　2 规范性引用文件

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

　　GB/T 8567—2006 计算机软件文档编制规范

　　3 术语和定义

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

　　3. 1

　　工业控制软件 industrialcontrolsoftware

　　适用于工业过程测量和控制的专用软件 。 除具备数据处理软件的一般特点外 ,应具有更高的实时性 、并发性 、高可靠性和可维护性等特点 。

　　3. 2

　　工业过程 industrialprocess

　　基本完成一个或一系列物理变化或化学变化的一组运行 。

　　[GB/T 17212—1998的 P1. 0. 0. 06]

　　注 : 其他过程和物质或能量的输送和/或暂时贮存 、信息的传输可看作是工业过程的一部分 。

　　3. 3

　　过程测量 processmeasurement

　　确定各过程变量值的信息获取 。

　　[GB/T 17212—1998的 P1. 0. 0. 09] 3. 4

　　过程控制 processcontrol

　　为达到规定的目标而对影响过程状况的变量的操纵 。

　　[GB/T 17212—1998的 P1. 0. 0. 10] 3. 5

　　文档 document

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

　　[GB/T 11457—2006的 2. 495] 3. 6

　　软件文档 softwaredocumentation

　　以人们可读的形式出现的技术数据和信息 。包括计算机列表和打印输出 ,它们描述或规定软件设

　　1

　　GB/T 26805.5—2011

　　计或细节 ,说明软件具备的能力 ,或为使用软件以便从软件系统得到所期望的结果而提供的操作指令 。 [GB/T 11457—2006的 2. 1493]

　　3. 7

　　用户文档集 userdocumentation

　　一套文档 ,它为使用系统或部件以期获得所希望结果的最终用户提供系统指令方面的信息 。

　　[GB/T 11457—2006的 2. 1089] 3. 8

　　用户软件文档 usersoftwaredocumentation

　　用以提供软件的标识 、用途和适用范围 、功能规格说明 、数据规格说明 、操作环境等综合信息的一类用户文档 。

　　3. 9

　　委托单位 entrustmentcompany

　　亦称交办单位 。指为用户软件的开发提供资金 ,并且通常(但并非绝对)提出软件需求的单位 。

　　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 派生软件

　　对同时流行但又有不少差别的同类软件需提供辅助标识 ,例如说明是否运行于不同的设备或操作系统 。

　　2

　　GB/T 26805.5—2011

　　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 概述

　　逐项说明软件的全部性能 。

　　3

　　GB/T 26805.5—2011

　　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) 描述数据对特定数据媒体的依赖性 。

　　5. 4. 2 输出数据规格说明

　　5. 4. 2. 1 数据描述

　　按描述输入数据时所用的同一方法 ,对每项输出数据的内容及格式进行描述 。

　　5. 4. 2. 2 输出媒体

　　描述记录输出数据的数据媒体(打印机 、显示器 、数码显示 、网络终端等)的输出显示格式(例如采用棒图显示) 。最好给出若干打印或显示格式的实例 。

　　注 : 输入与输出数据描述可以合并编写 ,例如对交互作用的软件 。

　　5. 4. 3 中间数据

　　如果用户需要了解软件的工作情况 ,应描述中间数据的内容和格式 。

　　5. 4. 4 文卷和记录格式

　　如果用户需要了解软件的工作情况 ,应描述文卷和记录的格式 。

　　5. 4. 5 字符集或通信码

　　列出所采用的字符集或通信码 ,例如 ASC II,BCD等 。

　　5. 4. 6 对数据或文卷的约束

　　描述对数据或文卷的各种限制 ,例如规定文卷能包含的最多记录数 ,对数值大小进行限制等 。

　　5. 4. 7 数据加工

　　如果需用其他设备或软件去加工适用于软件的输入数据 ,则需列出这些需求 , 例如列出文卷生成方式 。

　　5. 4. 8 数据备份

　　描述创建和保留备份数据的过程 ,这些备份数据在发生错误 、缺陷 、故障或事故时可以用来代替主要的数据拷贝 。

　　4

　　GB/T 26805.5—2011

　　5. 5 操作环境

　　5. 5. 1 语言

　　如果用户希望能与其他软件联用或对软件所提供的源代码稍加修改 ,则需指出所用的程序设计语言 ,最好列出所参考的标准文本 ,提供文本的名称 、派生文本 、版本以及如何取得编译程序或解释程序 。还要指出与标准文本不相符合的内容 。

　　5. 5. 2 其他软件需求

　　说明为运行软件所需要的支持软件 。例如操作系统及子例程的名称 、版本 、日期 、数据库管理系统的名称和版本等 。

　　列出相应的参考文档 。

　　5. 5. 3 硬件需求

　　指出运行软件所需的最小硬件配置和布署 ,最好给出配置和布署的文档以及其他相应的参考文档 ,例如配置图 、布署图等 。

　　5. 5. 4 运行

　　5. 5. 4. 1 访问控制

　　提供用户可见的软件访问与保密性特点的概述 。访问控制应包括以下内容 :

　　a) 怎样获得和从谁哪里获得口令 ;

　　b) 如何在用户的控制下添加 、删除或变更口令 ;

　　c) 与用户生成的输出报告及其他媒体的存储和标记有关的保密性和私密性要求 。

　　5. 5. 4. 2 控制命令

　　提供一份运行软件所需的所有控制命令的清单 ,对命令的格式及功能进行说明 。

　　5. 5. 4. 3 运行方法

　　对所有可能的工作方式 ,提供实现每一程序的起动 、停止 、暂停 、中断和再起动的命令 ,包括提供对数据文卷的操作规则 。

　　5. 5. 4. 4 操作员信息

　　如果所显示的信息本身是未予解释的 ,对所有这些信息 ,包括所需的操作员工作命令 ,需要提供 一份清单并进行解释 。

　　5. 5. 4. 5 运行准备

　　提供在使用软件以前所需的工作命令 ,例如主文卷数据输入方法 ,打印机安装规格说明 。

　　5. 5. 4. 6 备用拷贝的生成

　　如果允许生成备用拷贝 ,描述如何生成程序备用拷贝的方法 。

　　5. 5. 5 通信

　　5. 5. 5. 1 与其他系统的通信

　　描述通信接 口 ,例如描述主计算机端的有关信息或网络的有关信息 ,如波特率 。

　　5. 5. 5. 2 通信协议

　　提供与所采用的通信协议有关的信息 ,例如采用二进制同步通信协议 ,高级数据链路通信协议等 。

　　5. 6 终端操作

　　5. 6. 1 操作前提

　　说明终端的配置构成 ,连接步骤 、数据和参数输入步骤以及控制规定等 。

　　5. 6. 2 操作

　　说明在终端上进行查询 、检索 、参数设定和修改数据文卷的能力与过程 。

　　5. 7 应用举例

　　提供有助于用户了解软件工作的典型示例 。在这些示例中 ,应包括对数据的列表与显示 , 以及对结果进行检查等有关内容 。

　　5

　　GB/T 26805.5—2011

　　5. 8 合同款项

　　提供有关合同款项的足够信息 ,常用的包括 :

　　a) 有关版权 、保密 、安全的法定条件和条款 ,例如是否允许软件或文档拷贝 ;

　　b) 软件能提供的产品形式 ;

　　c) 安装 ;

　　d) 培训 ;

　　e) 维护 ;

　　f) 质量保证 。

　　5. 9 安装与支持

　　5. 9. 1 安装

　　提供软件安装所需的全部技术信息 。

　　5. 9. 2 修改

　　向用户提供修改软件所需的足够信息 ,例如使软件用于其他环境或改作其他用途时所需的信息 。

　　5. 9. 3 测试

　　描述用以测试程序的方法 ,例如通过对输入进行取样测试是否能得到预期的输出 。 5. 9. 4 支持

　　提供有关支持的可用性和实现软件开发的辅助信息 。

　　5. 10 置信度

　　提供从事软件的支持 、维护和进一步开发的组织 、单位或个人的名称 、姓名及通讯地址 。

　　5. 11 标准

　　列出所遵循的标准名称 、标准号及年代号 。

　　5. 12 产品编号

　　提供软件的产品编号 。

　　6

　　GB/T 26805.5—2011

　　参 考 文 献

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

　　[2] GB/T 17212—1998 工业过程测量和控制 术语和定义[idtIEC 60902:1987]

　　GB T 26805 5 2011

　　— .

　　/

　　中 华 人 民 共 和 国

　　国 家 标 准

　　工业控制计算机系统 软件

　　第 5 部分 :用户软件文档

　　GB/T 26805. 5—2011

　　*

　　中 国 标 准 出 版 社 出 版 发 行

　　北京复兴门外三里河北街 16号

　　邮政编码 :100045

　　网址:www. gb168. cn

　　服务热线 :010-68522006

　　2011年 11月第一版

　　*

　　书号 : 155066 · 1-43726

　　版权专有 侵权必究