【国家标准】 工业控制计算机系统 软件 第4部分：工程化文档规范

ICS 25.040.40
中华人民共和国国家标准
GB/T26805.4—2011
工业控制计算机系统
第4部分：工程化文档规范　
Industrial control computer systemSoftware-Part 4 : Engineering document specification2011-07-29发布
中华人民共和国国家质量监督检验检疫总局中国国家标准化管理委员会
2011-12-01实施
规范性引用文件
3术语和定义
4文档规范
附录A（规范性附录）
附录B（规范性附录）
附录C（规范性附录）
附录D（规范性附录）
附录E（规范性附录）
附录F（规范性附录）
附录G（规范性附录）
附录H（规范性附录）
附录I（规范性附录）
附录J（规范性附录）
附录K（规范性附录）
附录L（规范性附录）
附录M（规范性附录）
附录N（规范性附录）
附录O（规范性附录）
附录P（规范性附录）
可行性研究报告的编写格式
软件项目开发计划书的编写提示软件需求规格说明书的编写提示数据需求说明书的编写提示
软件概要设计说明书的编写提示·软件详细设计说明书的编写提示数据库设计说明书的编写提示
软件模块规格说明书的编写提示软件质量保证计划的编写提示
软件配置管理计划的编写提示
用户手册的编写提示
操作手册的编写提示
程序维护手册的编写提示
测试计划的编写提示
测试分析报告的编写提示
安装实施过程的编写提示
表1各阶段的质量记录
表2项目质量保证活动日程表
表3配置项命名规则表
表4配置项和配置基线列表
表5项目配置管理活动的日程表
GB/T26805.4—2011
GB/T26805《工业控制计算机系统第1部分：评价体系；
第2部分：测试方法；
第3部分：文档管理指南；
—第4部分：工程化文档规范；
一第5部分：用户软件文档。
本部分是GB/T26805的第4部分。前言
软件》分为以下几部分：
GB/T26805.4—2011
本部分的附录A、附录B、附录C、附录D、附录E、附录F、附录G、附录H、附录I、附录J、附录K、附录L、附录M、附录N、附录O和附录P均为规范性附录本部分由中国机械工业联合会提出本部分由全国工业过程测量和控制标准化技术委员会（SAC/TC124)归口。本部分负责起草单位：深圳市研祥软件技术有限公司。本部分参加起草单位：北京研华兴业电子科技有限公司、西南大学、中国计算机学会工业控制计算机专业委员会。
本部分主要起草人：陈志列、刘志永。本部分参加起草人：刘学东、刘永池、杨颂华、刘枫、张为群、吕静、杨孟飞。Ⅲ
1范围
工业控制计算机系统软件
第4部分：工程化文档规范
GB/T26805.4—2011
GB/T26805的本部分规定了工业控制软件项目，在其生命周期的各个阶段所产生的主要软件文档的内容、格式及编制要求，以便作为软件项目的开发、评审、使用与维护的基准。本部分适用于工业控制软件及其修订版本的技术文档的编制。2规范性引用文件
下列文件中的条款通过GB/T26805的本部分的引用而成为本部分的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容)或修订版均不适用于本部分，然而，鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本部分。
5文后参考文献著录规则（ISO690：1987，NEQ）GB/T7714—2005
GB/T8567一2006计算机软件文档编制规范GB/T11457—2006信息技术软件工程术语GB/T26805.3一2011工业控制计算机系统软件第3部分：文档管理指南3术语和定义
GB/T11457一2006确立的以及下列术语和定义适用于GB/T26805的本部分。3.1
系统system
除有特殊说明外，是指软件系统，3.2
敏感部位sensitiveposition
系统或某一部分对某些因素易于感受的性能的部分或部位3.3
sensitiveness
敏感度
系统或某一部分对某些因素易于感受的性能。3.4
敏感条件
sensitive condition
系统或某一部分对某些因素易于感受的性能的条件。3.5
当engineeringdocument
工程化文档
工业控制软件项目的生命周期中产生的文档。4文档规范
4.1可行性研究报告
4.1.1总则
可行性研究报告要对工业控制对象作概要的描述，根据需求和实现环境把对软件开发项目在一定1
GB/T26805.4—2011
工业、技术、经济和社会条件下实现的可行性研究结果写成文档，为管理部门决定本开发项目的进行提供依据。可行性研究报告见GB/T8567一2006中的7.1部分可行性研究报告的编写示例见附录A。4.1.2可行性研究报告的内容
4.1.2.1概述
4.1.2.1.1编写目的
对工业控制对象作概要的描述，根据需求和实现环境把对软件开发项目在一定工业、技术、经济和社会条件下实现的可行性研究结果写成文档，为管理部门决定本开发项目的进行提供依据。4.1.2.1.2背景
包括：
待开发的软件系统的名称；
b）提出者和交办单位；
c）承办单位和承办人员；
d）用户。
4.1.2.1.3参考资料
按照GB/T7714一2005格式要求，列出本文档中引用到的参考资料，包括资料的编号、作者、标题来源、出版单位、日期等
4.1.2.1.4术语与缩略语
列出本文档中专用的术语、定义或缩略语。4.1.2.2可行性研究的前提
4.1.2.2.1概述
说明开发项目进行可行性研究的前提，如需求、目标、假定、限制、进行方法和评价准则4.1.2.2.2需求
根据工业控制对象和用户的要求说明对软件开发的基本需求，如：a）
功能，如数据采集、调节控制、图形显示、组态功能等：b）
性能，如控制精度、响应时间、实时性要求、可靠性、灵活性等：c）
输出，如控制量、开关量、报告、文件或数据，对每项输出要说明其特征，如用途、产生频率、类型以及接口；
d）输人，说明来自工业控制对象和操作者的各种输人，包括数据的来源、类型、数量、数据的组织以及提供的频率；
用图表的方式表示出最基本的数据流程和处理流程，并扼要说明；在安全与保密方面的要求；
同本系统相连接的其他系统；
完成期限。
4.1.2.2.3目标
说明建议开发软件的主要开发目标，如：处理速度的提高；
控制精度的提高；
调节品质的改善；
提高工作效率和减轻劳动强度；d）
提高经济效益（提高产品质量，降低能源消耗等）；e）
提高生产自动化程度。
4.1.2.2.4条件、假定和限制
说明开发工作中作出的假定和所受到的限制，如：a）整个系统的运行寿命；
b）经费、投资方面的来源和限制；硬件、软件、运行环境和开发环境方面的条件和限制；c）
d）法律和政策方面的限制。
4.1.2.2.5可行性研究的方法
GB/T26805.4—2011
说明可行性研究的基本方法和评价准则，如调查、加权、确定模型、建立基准点或仿真等。4.1.2.2.6评价尺度
说明对系统进行评价时的主要尺度，如费用多少、各项功能的优先次序、可靠性的地位、实时性的考虑等。
4.1.2.3现有系统的分析
4.1.2.3.1定义
现有系统是指当前实际使用的系统，这个系统可能是计算机系统，也可能是一个机械系统甚至是一个人工系统。
分析现有系统的目的是为了进一步阐明开发新系统或修改现有系统的必要性。4.1.2.3.2处理流程和数据流程
说明现有系统的基本的处理流程和数据流程。4.1.2.3.3工作负荷
列出现有系统所承担的工作及工作量。4.1.2.3.4费用开支
列出由于运行现有系统所引起的费用支出，如人力、设备、空间、支持性服务、材料等项开支以及开支总额。
4.1.2.3.5局限性
列出现存系统的各种主要局限性，如处理时间不能满足需要、响应时间不及时、数据存储能力不足、处理功能不够等。
4.1.2.4建议的系统
4.1.2.4.1概述
说明建议系统的目标和要求将如何被满足，4.1.2.4.2说明
概括地说明所建议系统，说明要求将如何得到满足，说明所使用的基本方法及理论根据。4.1.2.4.3处理流程和数据流程
如用户的操作规程、源数据的处理、系统失效的后果及恢复的处理办法等。4.1.2.4.4改进之处
根据主要开发目标，逐项说明所建议系统相对于现存系统具有的改进。4.1.2.4.5影响
说明在建立所建议系统时，预期将带来的影响，包括：设备的影响。说明新提出的设备要求，对现有设备的修改。a)
b）对软件的影响。说明对现有应用软件和支持软件所作的修改和补充c）对系统运行过程的影响。如用户的操作规范、源数据的处理、系统失效的后果及恢复的处理办法等。
4.1.2.4.6局限性
说明建议的系统尚存在的局限性以及这些问题未能消除的原因。3
GB/T26805.4—2011
4.1.2.4.7其他可选择的系统
说明曾研究过的各种可选择的系统，包括需开发的和可从国内外直接购买的，若没有可供选择的系统方案，则要加以说明。
3技术条件方面的可行性
4.1.2.4.8
说明技术条件方面的可行性，如：在当前的限制条件下，该系统的目标能否达到：a)
利用现有的技术，该系统的功能能否实现；b）
对开发人员的数量和质量的要求能否满足；c）
在规定的期限内本系统的开发能否完成，d）
5投资及效益分析
4.1.2.5.1支出
说明建议系统需要的费用。
4.1.2.5.2
基本建设投资
包括采购、开发和安装下列各项所需费用，如：计算机及外围设备；
数据通讯设备；
c）支持软件；
d）其他。
4.1.2.5.3
经常性支出
经常性支出包括：
人员工资；
管理费用；
设备租金折旧费用；
d）其他。
4.1.2.5.4效益
说明所建议系统能带来的效益
4.1.2.5.5
技术效益
技术效益包括：
关键技术或新技术的使用与突破，技术的难度分析；a
b）系统的技术水平与分析。
4.1.2.5.6
经济效益
经济效益包括：
因生产能力的提高，使产量增加；a）
因系统精度的提高，使产品质量得到提高，消耗降低：b）
自动化程度的增强和工作效率的提高，使生产周期缩短，消耗减少；c）
可靠性安全性加强，减少或避免事故及其所带来的损失。d）
4.1.2.5.7社会效益
社会效益包括：
a）系统的灵活性（包括可扩展性和可移植性)分析；b）推广价值，应用面及其所产生的效益。4.1.2.6结论
根据上述分析，对所提出的软件开发项目必须作出是否可行的结论。结论可以是下列之一：可以立即开始进行；
b）需推迟至某些条件（如经费投资、人力技术等）具备之后才能开始进行；c）须对开发目标进行某些修改后才能进行；d）不能或没有必要进行（如没有实用价值、技术上不成熟、投资不合算）。4.2软件项目开发计划书
4.2.1出处
软件项目开发计划书见GB/T8567—2006中的7.2。4.2.2总则
GB/T 26805.4—2011
软件项目开发计划书是把项目开发过程中各项工作任务的负责人员、开发进度、经费预算、硬软件资源条件等问题所作的安排用文档的方式记载下来，以便依本计划开展和检查项目开发工作，保证项目开发正常进行
软件项目开发计划书的编写示例见附录B。4.2.3软件项目开发计划书的内容4.2.3.1概述
4.2.3.1.1编写目的
编写本计划的目的是把在××××（项目名称)项目开发过程中各项工作任务的负责人员、开发进度、经费预算、硬软件资源条件等问题所作的安排用文档的方式记载下来，以便依本计划开展和检查项目开发工作，保证项目开发正常进行。4.2.3.1.2背景
包括：
提出者与交办单位；
提出经过；
承办单位与承办人员；
d）软件名称；
e）用户。
4.2.3.1.3参考资料
按照GB/T7714一2005格式要求，列出本文档中引用到的参考资料，包括资料的编号、作者、标题来源、出版单位、日期等。
4.2.3.1.4术语和缩写词
列出本文档所用的专业术语、定义和缩写词。4.2.3.2项目任务概要
4.2.3.2.1前提
说明开发项目进行可行性研究的前提，如需求、目标、假定、限制、进行方法和评价准则。4.2.3.2.2工作内容Www.bzxZ.net
简要说明在本项目开发过程中须进行的各项主要工作。合理划分阶段，说明各阶段的主要任务和功能。
4.2.3.2.3主要人员
简要说明参加本项目工作的主要人员（开发人员、管理人员、测试人员、用户等）。包括人数和他们的技术水平。
4.2.3.2.4产品
包括以下几个方面：
a）程序。列出向用户移交的程序清单和数据库文件清单及存储介质，并引用有关文档要说明其作用和功能
b）文档。列出需移交给用户的每种文档的名称及内容要点，5