1、ICS 25.040.40 N 18 GB 中华人民共和国国家标准GB/T 26805.4-2011 工业控制计算机系统软件第4部分:工程化文档规范Industrial control computer system-Software 一Part 4: Engineering document specification 2011-07-29发布2011-12-01实施rrJl_6部K(lQ706o.1争异fT-_.s喃良减;-T._工事可式叫!.). ,如句:7中华人民共和国国家质量监督检验检疫总局中国国家标准化管理委员会发布GB/T 26805.4-20门目次前言.皿1 范围2 规范性引用
2、文件-3 术语和定义4 文档规范附录A(规范性附录)可行性研究报告的编写格式37附录B(规范性附录)软件项目开发计划书的编写提示附录c(规范性附录)软件需求规格说明书的编写提示c附录D(规范性附录)数据需求说明书的编写提示.44 附录E(规范性附录)软件概要设计说明书的编写提示. . . . . . 46 附录F(规范性附录)软件详细设计说明书的编写提示附录G(规范性附录)数据库设计说明书的编写提示.附录H(规范性附录)软件模块规格说明书的编写提示53附录1(规范性附录)软件质量保证计划的编写提示.附录J(规范性附录)软件配置管理计划的编写提示四附录K(规范性附录)用户于册的编写提示附录L(规
3、范性附录)操作手册的编写提示附录M(规范性附录)程序维护手册的编写提示附录N(规范性附录)测试计划的编写提示附录。(规范性附录)测试分析报告的编写提示.附录p(规范性附录)安装实施过程的编写提示。中9nbnb巧iq白?99表表u程程u表日日列的录动表线动记活则基活量证规置理质保名配管的量命和置段质项项配阶目置置目各项配配项TiqLnJ4&Fhd 表表表表表I 、.GB/T 26805.4-2011 前言GB/T 26805(工业控制计算机系统软件分为以下几部分z第1部分:评价体系;第2部分:测试方法;第3部分:文档管理指南;第4部分:工程化文档规范;第5部分:用户软件文档。本部分是GB/T26
4、805的第4部分。本部分的附录A、附录B、附录C、附录D、附录E、附录F、附录G、附录H、附录I、附录J、附录K、附录L、附录M、附录N、附录。和附录P均为规范性附录。本部分由中国机械工业联合会提出。本部分由全国工业过程测量和控制标准化技术委员会(SAC/TC124)归口。本部分负责起草单位:深圳市研祥软件技术有限公司。本部分参加起草单位:北京研华兴业电子科技有限公司、西南大学、中国计算机学会工业控制计算机专业委员会。本部分主要起草人:陈志列、刘志永。本部分参加起草人:刘学东、刘永池、杨颂华、刘枫、张为群、吕静、杨孟飞。E -、-一一一-一一1 范围工业控制计算机系统软件第4部分:工程化文档规
5、范GB/T 26805.4-2011 GB/T 26805的本部分规定了工业控制软件项目,在其生命周期的各个阶段所产生的主要软件文档的内容、格式及编制要求,以便作为软件项目的开发、评审、使用与维护的基准。本部分适用于工业控制软件及其修订版本的技术文档的编制。2 规范性引用文件下列文件中的条款通过GB/T26805的本部分的引用而成为本部分的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本部分,然而,鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本部分。GB/T 77142005 文后参考文献著录规则(
6、lSO690 :1 987 , NEQ) GB/T 85672006 计算机软件文档编制规范GB/T 114572006 信息技术软件工程术语GB/T 26805. 32011 工业控制计算机系统软件第3部分:文档管理指南3 术语和定义GB/T 114572006确立的以及下列术语和定义适用于GB/T26805的本部分。3. 1 系统system 除有特殊说明外,是指软件系统。3.2 敏感部位sensitive position 系统或某一部分对某些因素易于感受的性能的部分或部位。3.3 敏感度sensitiveness 系统或某一部分对某些因素易于感受的性能。3.4 敏感条件sensitiv
7、e condition 系统或某一部分对某些因素易于感受的性能的条件。3.5 工程化文档engineering document 工业控制软件项目的生命周期中产生的文档。4 文档规范4. 1 可行性研究报告4. 1. 1 总则可行性研究报告要对工业控制对象作概要的描述,根据需求和实现环境把对软件开发项目在一定一一一一一一一一一一、.GB/T 26805.4-20门工业、技术、经济和社会条件下实现的可行性研究结果写成文档,为管理部门决定本开发项目的进行提供依据。可行性研究报告见GB/T8567-2006中的7.1部分。可行性研究报告的编写示例见附录A。4. 1. 2 可行性研究报告的内容4. 1
8、. 2. 1 概述4. 1.2. 1. 1 编写目的对工业控制对象作概要的描述,根据需求和实现环境把对软件开发项目在一定工业、技术、经济和社会条件下实现的可行性研究结果写成文档,为管理部门决定本开发项目的进行提供依据。4. 1. 2. 1. 2 背景包括:a) 待开发的软件系统的名称头三-想b) 提出者和交办单位c) 承办单位和承办儿员;d) 用户。按照GB/厅T呐14一05监式里z志孔-,2i歹到!且l血Z率主u立L卫t挡当史主引l阻且至到!且l曲差鑫主主盗主组主1且括资晰、来摞、出版单位卉期秀彭i飞人I八 4. 1.2. 1. 4术与缔略语: /J J 川、L 列出本文向中铀的术语拉义精粤
9、语(777?不J 4. 1. 2. 2 可忏性研究的前提/;二/fv vq / 4. 1. 2. 2. 1 概述:二二二二气/;. , ( j 斗一/ 说明开发项目进行可行,闹剧;峙,如需求、目标脑部限制、4行方向评价准则。4. 1. 2. 2. 2 需求1 1/ 飞l / i / 根据工业控制对象和用户的要求说明对在再生革的基本需芋,如tj u a)功能,瞅瞅集、调怆制、图形显示、组态功能等;/ b) 性能,如市tl、怕在时间、如才性要求、可靠性J灵活性等;/ 量、报告、文件或数据,对每项输出要说明其特征以及接口;d) 输入,说明来自以及提供的频率;e) 用图表的方式表示出最墓。在安全与保密
10、方面的要求;g) 同本系统相连接的其他系统ph) 完成期限。和操作者的各种输入叮咬眉来源族主1、数量、数据的组织4. 1. 2. 2. 3 目标说明建议开发软件的主要开发目标,如:a) 处理速度的提高;b) 控制精度的提高;c) 调节品质的改善;d) 提高工作效率和减轻劳动强度;e) 提高经济效益(提高产品质量,降低能源消耗等hf) 提高生产自动化程度。2 GB/T 26805.4-2011 4. 1.2.2.4 条件、假定和限制说明开发工作中作出的假定和所受到的限制,如:a) 整个系统的运行寿命;b) 经费、投资方面的来源和限制;c) 硬件、软件、运行环境和开发环境方面的条件和限制;d) 法
11、律和政策方面的限制。4. 1. 2. 2. 5 可行性研究的方法说明可行性研究的基本方法和评价准则,如调查、加权、确定模型、建立基准点或仿真等。4. 1. 2. 2. 6 评价尺度说明对系统进行评价时的主要尺度,坦费用多j三、各项功能的优先次序、可靠性的地位、实时性的考虑等。卢-一 4. 1. 2. 3现有系统的批y/卢二三:三4. 1. 2. 3. 1 定义现有系统是的触时用的系统,这个系统可能是计算机褂洁性是一个机械系统甚至是一个人工系统。4. 1. 2. 4. 4 改进之处根据主要开发目标,逐项说明所建议系统相对于现存系统具有的改进。4. 1. 2. 4. 5 影响说明在建立所建议系统时
12、,预期将带来的影响,包括:a) 设备的影响。说明新提出的设备要求,对现有设备的修改。b) 对软件的影响。说明对现有应用软件和支持软件所作的修改和补充。c) 对系统运行过程的影响。如用户的操作规范、源数据的处理、系统失效的后果及恢复的处理办法等。4. 1.2.4.6 局限性说明建议的系统尚存在的局限性以及这些问题未能消除的原因。3 、.GB/T 26805.4-2011 4.1.2.4.7 其他可选择的系统说明曾研究过的各种可选择的系统,包括需开发的和可从国内外直接购买的,若没有可供选择的系统方案,则要加以说明。4. 1. 2. 4. 8 技术条件方面的可行性说明技术条件方面的可行性,如:a)
13、在当前的限制条件下,该系统的目标能否达到;b) 利用现有的技术,该系统的功能能否实现;c) 对开发人员的数量和质量的要求能否满足;d) 在规定的期限内本系统的开发能否完成。4. 1. 2. 5 投资及效益分析4.1.2.5. 1 支出说明建议系统需要的费用。4. 1. 2. 5. 2 基本建设投资包括采购、开发和安装下列各项所需费用,如:a) 计算机及外围设备;b) 数据通讯设备;c) 支持软件;d) 其他。4.- 1. 2. 5. 3 经常性支出经常性支出包括:a) 人员工资;b) 管理费用;c) 设备租金折旧费用;d) 其他。4. 1.2.5.4 效益说明所建议系统能带来的效益。4. 1.
14、 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 结论根据上述分析,对所提出的软件开发项目必须作出是否可行的结论。结论
15、可以是下列之一:a) 可以立即开始进行;4 b) 需推迟至某些条件(如经费投资、人力技术等)具备之后才能开始进行;c) 须对开发目标进行某些修改后才能进行;d) 不能或没有必要进行(如没有实用价值、技术上不成熟、投资不合算)。4.2 软件项目开发计划书4.2. 1 出处软件项目开发计划书见GB/T8567-2006中的7.20 4.2.2 总则GB/T 26805.4-2011 软件项目开发计划书是把项目开发过程中各项工作任务的负责人员、开发进度、经费预算、硬软件资源条件等问题所作的安排用文档的方式记载下来,以便依本计划开展和检查项目开发工作,保证项目开发正常进行。软件项目开发计划书的编写示例
16、见附录B。4.2.3 软件项目开发计划书的内容4.2.3.1 概述4. 2. 3. 1. 1 编写目的编写本计划的目的是把在XXXX(项目名称)项目开发过程中各项工作任务的负责人员、开发进度、经费预算、硬软件资源条件等问题所作的安排用文档的方式记载下来,以便依本计划开展和检查项目开发工作,保证项目开发正常进行。4.2.3. 1. 2 背景包括:a) 提出者与交办单位;b) 提出经过;c) 承办单位与承办人员;d) 软件名称;巳)用户。4.2.3. 1. 3 参考资料按照GB/T7714-2005格式要求,列出本文档中引用到的参考资料,包括资料的编号、作者、标题、来源、出版单位、日期等。4.2.
17、3. 1. 4 术语和缩写词列出本文档所用的专业术语、定义和缩写词。4.2.3.2 项目任务概要4.2.3.2. 1 前提说明开发项目进行可行性研究的前提,如需求、目标、假定、限制、进行方法和评价准则。4.2.3.2.2 工作内窑简要说明在本项目开发过程中须进行的各项主要工作。合理划分阶段,说明各阶段的主要任务和功能。4.2.3.2.3 主要人员简要说明参加本项目工作的主要人员(开发人员、管理人员、测试人员、用户等)。包括人数和他们的技术水平。4.2.3.2.4产品包括以下几个方面:a) 程序。列出向用户移交的程序清单和数据库文件清单及存储介质,并引用有关文档扼要说明其作用和功能。b) 文档。
18、列出需移交给用户的每种文档的名称及内容要点。5 、-GB/T 26805.4-20门c) 服务。列出需向用户提供的各项服务,如培训、安装、维护和运行支持,应逐项规定开始日期、所提供支持的级别和服务的期限。d) 非移交的产品。列出开发集体应向本单位交出但不必向用户移交的产品(文件甚至某些程序)。4.2.3.2.5 验收标准对于上述这些应交出的产品和服务,逐项说明或引用资料说明验收标准。4.2.3.2.6 完成项目的最迟期限指明项目完成的最迟期限。4.2.3.2.7 项目批准指项目的批准者和批准日期。4.2.3.3 实施总计划4.2.3.3. 1 工作任务分解对项目开发中需要完翩材/ / 种文档编
19、制等要按层l1tt行逐项列出能够骸响整项目成败的关键问题、技术难点和风险,指出这技术难点、可靠性措施、现场F拱算。4.2.3.4 支持条件4.2.3.4. 1 概述说明为支持项目的开发所需要m4.2.3.4.2 计算机系统支持、测试、安装、验收及各逐项列出所需计算机系统支持,包括计算机、输入输出设备、模拟器、编译、汇编、操作系统、数据管理程序包、数据存储能力及测试支持能力等。逐项给出有关到货日期、使用时间的要求。4.2.3.4.3 用户支持应该逐项列出由用户承担的工作和完成日期,包括由用户提供的条件及日期。4.2.3.4.4 其他单位的支持应该逐项列出由其他分合同承包者承担的工作和完成的时间,
20、包括由他们提供的条件和日期。4.2.3.5 专题计划要点说明本项目开发中需制订的各个专题计划要点,如:a) 分合同计划;b) 培训计划;6 c) 质量保证计划;d) 配置管理计划;e) 系统安装计划。4.3 软件需求规格说明书4.3. 1 出处软件需求规格说明书见GB/T8567-2006中的7.11。4.3.2 总则软件需求规格说明书是为项目的开发提供如下基础和依据:d)要肉同时叫平均为主苟且町;在占百计挝、其他标准及支持软件的文档等。4.3.3. 1.3 术语及提写wj把文档中专用的问问珩同明4.3.3.2 软件概要4.3.3.2. 1 概要说明GB/T 26805.4-2011 简要说明
21、软件开发的目的,范围及其与外界环境的相互联系,定性和定量地简述待开发软件的主要性能要求和应用目标。4.3.3.2.2 系统组成可以用方框图来表示软件系统的主要组成,相互联系和外部接口。4.3.3.2.3 用户特点简要说明生产过程的工艺流程、控制操作方法、现场条件,还有操作人员的技术水平及本系统的使用频度。4.3.3.2.4 假设和约束说明影响软件开发和运行的约束,描述影响系统能力的限制。如操作环境、运行环境、经费限制、开发期限等。7 、-GB/T 26805.4-2011 4.3.3.3 功能要求4.3.3.3. 1 概述分项详细描述软件系统的功能要求,主要包含以下部分。4.3.3.3.2 数
22、据采集说明采样信号的类型(模拟量、数字量)、采集对象数量、输入处理要求、上下限极限值、报警要求、存储要求、采样周期、量程范围、单位换算及输入处理方法(平均、滤波、解码等)等。4.3.3.3.3 调节控制说明控制类型(连续控制、顺序控制等)、控制回路数、控制方式(PID控制、串级控制等)、参数整定及失控处理等。4.3.3.3.4 画面显示说明画面种类(总体画面、回路画面、趋势显示等)、数据项目和数据数量、存储介质、数据保留时间及显示方式要求等。4.3.3.3.5 组态功能说明组态的目的和内容、组态工作方法、输入要求及输出画面要求等。4.3.3.4 性能要求4.3.3.4. 1 概述详细描述软件系
23、统的性能要求。4.3.3.4.2 具体性能要求a) 定量地描述软件的具体性能要求,主要的具体性能要求如下:精度。详细描述系统的精度要求,如:1) 数据的精度要求,如数据的输入精度(A/D)12位;2) 数字计算的精度要求,如尾数有效位15位,阶码有效位7位。b) 时间特性。详细说明系统时间特性要求,如:1) 实时性要求。执行计算机系统基本负载的时间。如要求软件系统在1s之内采集并处理完接入系统的所有信号,至少包括546个参数,每个参数长度为2个字节。2) 数据处理时间。3) 输入到输出的响应时间。的事件的数量和优先级别。c) 可靠性要求。说明软件系统的可靠性要求及所要求的保证措施。如要求对输入
24、参数的可靠性判别提供出错测点等。d) 灵活性。说明当需求发生某些变化时系统的适应能力,指出为适应这些变化而要设计的软件成分或过程。可能的变化有:1) 操作方式上的变化;2) 运行环境的变化;3) 同其他软件接口的变化;的精确和实时性要求的变化。e) 人机接口。必须描述操作者与软件系统接口的特点。例如,如果系统的用户是由显示终端操作时,就必须指定以下需求:1) 需求的各种屏幕格式;2) 菜单的格式和内容;3) 功能键的使用规定。4.3.3.4.3 输入,输出描述输入输出的每个数据元素。对每个数据元素要列出数据类型、格式、度量单位、数值范围和精8 、阳一-GB/T 26805.4-2011 度要求
25、。对于输入数据,必须说明时间要求,优先顺序和输入来源。对于输出数据,必须说明时间要求,优先级别和输出去向。4.3.3.4.4 故障处理要求列出可能出现的故障,并提出为保证系统性能而要求采取的技术措施。4.3.3.5 环境4.3.3.5. 1 设备环境列出硬件系统所需的设备种类(处理器、存储介质I/O设备,通信网络)、设备数量、型号、特性及连接方法。4.3.3.5.2 支持软件列出与开发软件相配合的、运行时的支持软件。对每个支持软件系统和子系统,程序都应提供正确的名称、版本和文档资料,以及该软件使用的语言、操作系统和数据管理系统。4.3.3.5.3 接口若软件系统包含若干子系统或与其他系统发生关
26、系,要对其接口进行如下说明:a) 数据传递方式;b) 数据传送的通信介质;c) 数据量格式,度量单位和数据代码;d) 接口类型,如人工的或自动的;e) 接口规程,如通信协议。4.3.3.6 测试纲要4.3.3.6.1 概述明确软件系统的测试范围,测试要求及测试环境,为制定软件测试计划和审查软件测试报告提供依据。4.3.3.6.2 测试环境说明软件系统进行测试运行环境,包括:a) 应交付用户的工业控制计算机硬件配置,如机箱、电源、处理器模板、显示器、键盘/鼠标、通信接口、存储器的规格和数量等;b) 应交付用户的软件配置,包括操作系统或管理程序、应用程序、诊断程序等及使用方法;c) 满足用户需求的
27、输入/输出配置;d) 系统仿真手段,包括工程系统仿真、工况仿真和工程环境仿真。4.3.3.6.3 软件系统的测试范围和要求在模拟(仿真)环境中用黑盒法、白盒法对软件系统进行测试,测试项目应覆盖软件需求并分类列出:a) 需测试的软件系统的功能,如数据采集,调节控制等;b) 需测试的软件系统的性能,如实时性,精度等;c) 需测试的系统逻辑关系,如调用关系,控制关系,制约关系等;d) 需测试的敏感度,包括敏感部位、敏感条件和敏感程度,以及对软件系统以至整个工程系统的影响;e) 需测试的软件系统的可靠性措施,包括自诊断、自恢复、联锁保护等;f) 需测试的软件系统的健壮性目标,如系统负荷能力的考核、故障
28、承受能力的考核等。4.4 数据需求说明书4.4.1 出处数据需求说明书见GB/T8567一2006中的7.12。9 、-GB/T 26805.4-2011 4.4.2 总则数据需求说明书是提供并定义软件系统必须处理的各种数据元素,并向用户传达数据采集要求。数据需求说明书的编写示例见附录D。4.4.3 数据需求说明书的内容4.4.3.1 概述4. 4. 3. 1. 1 编写目的编写数据需求说明书的目的是提供并定义xxx X(系统名称)系统必须处理的各种数据元素,并向用户传达数据采集要求。4.4.3. 1.2 参考资料按照GB/T7714一2005格式要切些本文挡中寻i用i术参考资料,包括资料的编
29、号、作者、标题、来源、出版单位、日期和保由的,按憬,只列出对用户有信息价值的那些4.4.3.2.6 数据约束、二三飞r二三乒说明对数据要求的制约。逐条蛇出对进一步扩大或使用方面的考虑而提出的数据要求的限制(容二-_-气量、文卷、记录和数据元的个数的最大值)必窥强调在系统进二步开发中将成为关键性的那些限制。4.4.3.3 数据的采集4.4.3.3. 1 概述描述用户必要的数据采集活动,以便采集该系统使用的数据值。4.4.3.3.2 要求和范围按数据元的逻辑分组来说明数据采集的要求和范围,指明数据的采集方法,说明数据采集工作的承担者(用户、开发者)。具体内容包括:的数据元素的输入源。说明输入数据元
30、素的来源是操作员,输入站还是某个专门的输入系统;b) 数据输入所用的媒体和硬设备;c) 说明输出数据的接受者;d) 列出输出数据的形式和硬设备。形式如打印输出,显示设备上的字符或图形,均应具体说明;e) 数据值的范围,要给出一个数据元素的合法值的范围;10 圃-GB/T 26805 .4-2011 f) 数据值的量纲,数据元素所使用的单位,如在工业控制现场流量所使用的单位常使用t/s和m3/s; g) 测量单位的零点(如压力测量是相对于绝对零压还是大气压力); h) 换算因子,对必须经模拟转换和数字转换处理的实测量要规定换算因子;i) 扩充因子,指出系统进行扩充时,数据元素项能增加到最大数目的
31、扩充因子。4.4.3.3.3 预处理对数据的采集和预处理过程提出专门的规定,包括适合应用的数据格式、预定的数据通信媒体和对输入的时间要求等。对于需经模拟转换或数字转换处理的数据量,要给出转换方法和转换因子等有关信息。以便软件系统使用这些数据。4.4.3.3.4数据采集方式和数据使递雪去二一二三主二飞具体说明数据获取的方在初碎细约定还冉包括其咄iJ同特性7主要包括:/ / -二/一一斗- a) 输入方式。说明所有的输卖方武,如数据采集卡、申耳之网络、光总软件模块等。b) 输出方式。J搅明所莉细输出方式,如打印机、显示器、网络:食日、软件摸块等。c) 数据库影响。说现数据库的采集和维护对设备、软件
32、、机构、运校和开没怀境的影响。还应给户和开发人员之间4.5.2. 1. 2 4.5.2. 1. 3 术语和缩写词列出本文档中专用的术语、定义和缩写词。4.5.2.2 需求4.5.2.2.1 概述本章概述系统的特性和需求,扩充软件需求规格说明书中的信息,给出增加的细节,详尽地指出对软件需求说明中有关特性和需求作出的变更。4.5.2.2.2 总体描述对软件系统进行总体描述,用图表示出软件系统的组成,相互联系和外部接口。4.5.2.2.3 功能定性地描述软件的功能需求。如数据采集、调节控制、画面显示及在线组态等。4.5.2.2.4 性能定量地描述系统的性能需求。如精度、时间特性、可靠性要求、灵活性及
33、人机接口等。11 、-GB/T 26805.4-2011 4.5.2.2.5 环境本章对软件需求规格说明书中规定的环境提供补充,反应环境的变化,并对环境作补充分析。如设备环境、支持软件及接口等。4.5.2.3 总体设计4.5.2.3. 1 系统逻辑流程用图的形式描述系统从输入经处理到输出的逻辑流程,并加以必要的解释。各图表将集中反映出系统的动态特性、入口和出口,与其他系统或程序的接口,进程的优先级别等。4.5.2.3.2 并发性如果被控对象是一个并发活动的有机实体,在若干事件同时驱动系统并要求同时响应时,系统是如何满足并发要求的,必须给予详细描述。4.5.2.3.3 在线性当系统要求在线组装或
34、在线维护时,系统是如何满足的,必须给予描述。4.5.2.3.4 系统结构用图表形式说明本系统的结构组成,并说明组成系统的系统元素(子系统、模块、子程序、公用程序等)的划分和名称。扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制关系。4.5.2.4 系统设计4.5.2.4. 1 数据结构设计数据结构设计主要包括:a) 输入输出数据。描述输入输出的每个数据元素,对每个数据元素要列出名称和标识符、数据类型、格式、量纲、数值范围和精度要求等。对于输入数据,必须说明时间特性、优先顺序和输入方式(数据采集卡、串口、网络、光盘、软件模块、键盘、其他1/0设备等)。对于输出数据,必须说明时间特
35、性、优先级别和输出方式(打印机、显示器、网络、串口、软件模块等)。b) 数据结构。主要包括:1) 系统状态数据结构;2) 系统生成(组态)数据结构;3) 采样数据数据结构;的回路参数数据结构;5) 控制数据数据结构;6) 报警数据数据结构;7) 显示数据数据结构;8) 打印数据数据结构;的操作台功能键数据数据结构;10) 通信数据数据结构;11) 诊断维护数据数据结构。4.5.2.4.2 流程设计使用图、表、文的形式描述软件系统的处理流程。说明为实现功能需求,处理流程的设计方法与过程。主要包括:a) 实时控制管理程序流程设计;b) 数据输入处理流程;c) 控制调节处理流程;d) 数据输出处理流
36、程;e) 时钟中断处理流程;f) 操作台(键盘)输入处理流程;12 、-G/T 26805.4-2011 g) 画面(总貌画面、模拟表头、回路画面、趋势画面等)处理流程方案;h) 表格生成处理流程;i) 系统生成(在线组态)处理流程;j) 系统维护处理流程,包括诊断、出错处理、恢复等。4.5.2.4.3 算法子程序库(包)算法子程序库一般包括:模拟量输入、模拟量输出、数据采集、基本PID、配比PID、算术运算、函数发生、高低选择、逻辑运算、线性化、补偿等模块。要说明算法子程序库的功能、种类、数量及数学模型等。4.5.2.4.4 数据库设计如果软件需求要求采用数据库技术,必须对数据库作如下的说明
37、:a) 概耍。包括:1) 标题和标识符;2) 内容摘要;3) 数据结构;4) 存储介质和容量;5) 数据字典及算法;的数据库管理系统的基本功能;7) 敏感程度;的文件组织,包括文件的名称和标识符,文件性质及备份。b) 数据库的数据元素。包括:1) 名称和标识符,同义名;2) 数据库中的位置;3) 定义;4) 量纲;5) 格式和值域;6) 数据项名、缩写调整和代码,包括用于数据库的规格说明;7) 敏感程度。4.5.2.5 集成测试纲要4.5.2.5. 1 概述对本系统中各程序(子系统)逐个明确集成测试纲要,说明集成测试环境、测试范围和要求,为制定集成测试计划和审查测试报告提供依据。4.5.2.5
38、.2 子系统1的集成测试纲要主要包括:a) 集成测试环境。包括:1) 子系统名称;2) 子系统进行集成测试所需的硬件环境;3) 子系统进行集成测试所需的系统软件及接口;4) 与子系统相关的软件子系统或模块。b) 测试范围和要求。包括:1) 需测试的功能和性能指标;2) 需测试的逻辑关系,如调用关系、控制关系、制约关系等;3) 需测试的敏感度,包括敏感部位、敏感条件、敏感程度,以及对被测子系统及其他子系统的影响;13 、-GB/T 26805.4一2011的可靠性、健壮性有关的成分,如诊断措施和诊断信息、联锁保护及其状态、负荷分析和统计等。4.5.2.5.3 子系统2的集成测试纲要按照4.5.
39、2. 5. 2同样格式,说明子系统2到子系统N的集成测试纲要。4.6 软件详细设计说明书4.6. 1 总则软件详细设计说明书要尽可能详细地说明每个程序的设计思想,以利于制作软件模块规格说明书和编码。4.6.2.2.4 环境详细说明系统运行所需的环境。如设备环境、支持软件和接口等。4.6.2.3 程序系统结构4.6.2.3. 1 系统逻辑流程用图的形式描述系统从输入经处理到输出的逻辑流程,并加以必要的解释。各图表将集中反映出系统的动态特性、入口和出口、与其他系统或程序的接口、进程的优先级别等。4.6.2.3.2 组织结构用图表的形式列出软件系统各层模块和程序单元的名称、标识符和它们之间的层次结构
40、、调用关系、通信方式等。4.6.2.3.3 程序运行过程说明该程序的装载、启动、停止、恢复和再启动的过程,并说明该程序和操作人员之间的交互。14 、圃-一GB/T 26805.4-2011 4.6.2.4 程序1(名称)设计说明4.6.2.4. 1 概述从本节开始,逐个地描述各个层次中每个程序的设计考虑。4.6.2.4.2 程序描述对该程序进行简要描述,说明设计本程序的目的、意义,还要说明本程序的特点,如:a) 常驻内存;b) 可重入运行;c) 并发处理。4.6.2.4.3 功能a) 接口类型;b) 数据传送说日a) 说明并图示内存分配;b) 说明程序所要求的外存类型及限制条件,并指明是永久性
41、的还是暂时性的存储。4. 6. 2. 4. 11 注释说明准备在本程序中安排的注释,如:a) 加在程序首部的注释;b) 加在程序各分枝点的注释;c) 对各变量的功能、范围、缺省条件等所加的注释。4.6.2.4.12 限制j说明本程序运行中所受到的限制条件。15 、-GB/T 26805.4-2011 4.6.2.4.13 测试纲要对程序规定测试纲要,说明测试范围和要求,为制定测试计划和审查测试报告提供依据。主要包括:a) 测试环境。包括:1) 被测程序的名称;2) 被测程序在系统或子系统中的逻辑地位;3) 与被测程序有关的程序或模块名称及相互关系。b) 测试范围和要求。包括:1) 需测试的功能
42、和性能指标;2) 需测试的逻辑关系,如调用关系、控制关系、制约关系等;3) 需测试的敏感度,包括敏感程度以及对程序或系统的影响;4) 需测试的与可靠性、健壮性有关的成分。4.6.2.5 程序2C名称)设计说明按4.6.2.4格式,说明程序2到程序N的设计说明和测试纲要。4. 7 数据库设计说明书4. 7. 1 出处数据库设计说明书见GB/T8567-2006中的7.14。4.7.2 总则数据库设计说明书要描述软件项目中的存储分配和数据库组织,为构造系统文件、表、宇典和目录提供基本设计依据。数据库设计说明书的编写示例见附录G。4.7.3 数据库设计说明书的内窑4.7.3.1 概述4.7.3.1.
43、 1 编写目的编写本说明书的目的是描述xxx xC项目名称)中的存储分配和数据库组织,为构造系统文件、表、字典和目录提供基本设计依据。4. 7. 3. 1. 2 参考资料按照GB/T7714-2005格式要求,列出本文档中引用到的参考资料,包括资料的编号、作者、标题、来惊、出版单位、日期等。4.7.3. 1. 3 术语和缩写词列出本文档用到的专业术语和缩写词。4.7.3.2 数据库描述4.7.3.2.1 标识给出用来唯一标识数据库的代码、名称或标识符。还要说明附加的描述性信息。4.7.3.2.2 功能详细描述数据库的下述功能:的数据库生成,包括建立过程子库、组定义、过程点信息输入;b) 数据库
44、修改,包括过程子库修改、组定义修改、过程点信息修改;c) 数据库检索,包括过程子库列表及打印、组定义检索、过程参数信息检索。4.7.3.2.3 数据流图给出数据库的数据流图。4.7.3.2.4 使用系统列出使用该数据库的系统、子系统和程序。包括名称、代码和版本。16 -一一-GB/T 26805.4-2011 4.7.3.2.5 存储要求给出数据库的存储要求和限制条件。4.7.3.2.6 约定叙述为了能更好地使用数据库而事先确定的有关标号和标记的使用约定。如:用于更新版本的标识约定,用于标识库内各个文件、记录、数据项的命名约定等。4.7.3.2.7 数据压缩技术应对数据存储采用的压缩算法给出详
45、细的描述。4.7.3.2.8 特别说明为数据库生成、测试和操作提供特别的说明。包括检查进入该数据库的数据准则;数据进入数据库要遵循的准则和过程;数据控制操作的标识;数据说明表的格式;用于生成修改,更新该数据库文件的说明。4.7.3.2.9 安全保密叙述与整个系统的数据有关的安全保密措施。如通过对不同的访问者、不同的访问类型和不同的数据对象,进行分别对待的设计考虑即为安全措施之一。4.7.3.3 数据库组织为设计数据库管理系统提供信息,促进物理数据库文件组织与操作设计的一致性,对数据库组织要进行如下描述:a) 一般文件设计;b) 设计原理;c) 数据库管理功能流程;d) 数据宇典。4.7.3.4
46、 数据定义4.7.3.4.1 概述详细说明系统使用的全部数据的定义,包括物理数据的信息和表示物理数据的逻辑数据的信息。4.7.3.4.2 数据项数据项包括:a) 标识符或标号;b) 用途;c) 格式、值域、量纲;d) 项所在表的类型;e) 在表中的位置;f) 项的使用说明,如表控制项、关键字项、串控制项、数据项等;g) 项类型说明(如宇符、整数、小数、混合数、串、状态码等)及与类型有关的代码;h) 指出可以加快项存取或修改的机器指令;i) 项的敏感程度。4.7.3.4.3 记录记录是数据文件的基本单位,应像定义表那样来定义记录,除用语言描述文件结构外,还要对每个记录列出下列信息:a) 全名和用
47、途;b) 每个项的解释;c) 最大长度;d) 在文件中的图形表示。17 、-GB/T 26805.4-2011 4.7.3.4.4表表包括:a) 标识符或标号;b) 表的全名和用途;c) 包含该表的数据文件;d) 使用该表的数据文件;e) 内部表块或分表等逻辑划分及表结构(定长或不定长、固定表项或可变表项)。4.7.3.4.5 文件文件包括:4.8.2. 1. 2 参考资料按照GB/T7714-2005格式要求,列出本文档中引用到的参考资料,包括资料的编号、作者、标题、来源、出版单位、日期等。4.8.2. 1. 3 术语和缩写词列出本文档中专用的术语、定义和缩写词。4.8.2.2 系统概述4.
48、8.2.2.1 系统名称写明系统(或子系统)的名称,标识符或代码。一组相关的模块汇成一本模块卷宗时,可按主要模块的功能命名这一组模块。模块标识符和代码要符合配置标识的要求,避免重复。4.8.2.2.2 系统模块表用表格或目录形式列出本文档所描述的全部模块名称,包括标识符、代码及页码。18 、-一GB/T 26805.4-20门4.8.2.3 模块设计说明4.8.2.3. 1 概述逐个模块详细说明模块设计要求和测试、使该说明足以指导编码和制定测试计划。4.8.2.3.2 模块1(标识符或代码)设计说明包括以下几个方面:a) 模块流程与数据结构。说明程序模块的流程与数据结构。b) 设计要求。应根据软件概要设计说明书、详细设计说明书及软件需求规格说明书的有关要求说明模块设计的下述各项要求:1) 作用:说明本模块在系统(或子系统、模块组)中的作用;2) 4) 主)的要求和具体规定,说明本4.8.2.3.3 模块2(标
copyright@ 2008-2019 麦多课文库(www.mydoc123.com)网站版权所有
备案/许可证编号:苏ICP备17064731号-1