JB 5237-1991工业控制实时软件用户软件包文档.pdf

丁B中华人民共和国机械行业标准JB/T 5237--91工业控制实时软件用户软件包文档1991-07-10发布1992-07--01实施机械电子工业部发布 中华人民共和国机械行业标准JB/T 5237—91工业控制实时软件用户软件包文档1 主题内容与适用范围本标准规定了工业控制实时软件用户软件包文档应予提供的各类信息，以便指导该类文档的编制。“本标准适用于各种工业控制实时软件用户软件包文档的编制。2 术语以下术语适用于本标准。2.1工业控制实时软件适用于工业过程测量和控制的专用软件。除具备数据处理软件的一般特点外，还特别强调其实时性、在线性、并发性、高可靠性和可维护性等特点。2.2用户软件包由承办单位向用户，包括向过程工厂提供的各种专用程序包。它通常包括实现算术、逻辑运算，过程控制算法，优化以及实现输入输出格式转换的程序包，还可能包括曲子程序和应用程序组成的程序库。2.3用户软件包文档用以提供用户软件包的标识，用途和适用范围，功能规格说明、数据规格说明，操作环境等综合息的一类用户文档。注：①“工业控制实时软件用户软件包”以下简称“用户软件包”2.4 强制信息对用户软件包文档而言被认为是主要信息的一类信息。因而用户软件包文档中必须包含这类信息，凡属这类信息，均以符号（MAN）标识。2.5辅助信息对用户软件包文档而言，为说明其相关性而被认为是主要信息的一类信息。因而用户软件包文档中必须包含这类信息，凡属这类信息，均以符号（CON）标识。2.6可选信息在用户软件包文档中推荐采用的一类非主要信息。凡属这类信息，均以符号（OPT）标识。2.7委托单位亦称交办单位。指为用户软件包的开发提供资金，并且通常（但并非绝对）提出软件需求的单位。238承办单位、.3 背景信息在编制用户软件包文档时，应提供以下背景信息a。开发用户软件包的委托单位，承办单位和协作单位（如果有的话）！b：：描述用户软件包的设计层次和设计方法，指出用户软件包所具有的显著特点，以及是否法划进行修改等，机械电子工业部1991-07-10批准1992-07-0实施1 JB/T 5237--91d。，列出与用户软件包文档有关的辅助文档的清单(例如程序员指南，安装指南），列出这些文档资料的作者、标题。序号、发表日期和出版单位，并说明如何取得这些文档，.e。给出用户软件包文档中用到的、可能引起混淆的专门术语的定义，对略语和缩写词要注明原文。用户软件包文档的主要内容用户软件包的标识包括提供用户软件包名、版本和日期、派生软件包和关键字等内容。对用户软件包名、版本和日期以及派生软件包，建议进行显示。4.1.1用户软件包名(MAN)提供用以标识用户软件包的标号和名称，还要提供描述用户软件包主要功能的子标号4.1.2版本和日期4.1.2.1 版本 (MAN)提供用户软件包的版本标识（版本、修订本、出版号），还要提供版本数字序号的简要说明。用户软件包的第一版可以不提供版本标识。4.2.2日期 (MAN)3家1+3：提供源版本和现行版本的出版自期。4.1.3派生软件包(CON)对同时流行但又有不少差别的同类用户软件包需提供辅助标识，例如说明是否运行手不橱的设备或操作素统：4.1.4 关键字 (OPT)可以用来描述用户软件包的特征以及进行查寻和实现检索的描述符或关键字。4.2用途和适用范围4.2.1 用途 (MAN)1.简述用户软件包的用途。4.2.2适用范围(MAN)简述用户软件包的各种功能，以便使委托单位或用户能够决定是否满足其软件需求，因而决定是否菜角，该及在应用方面的限制。4.3程序规格说明4.3.1问题描述 (OPT)综合描述用户软件包中每二程序所要解决的问题。4.3.2问题求解4:3.2.1：药定和术语(OPT)给出用户软件包文档所用到的各项规则的细节。例如约定在求解问题时所用字符或符号的含义，“约定字符和符号组合后的特定含义，指明所使用的前缀、后缀、符号、精度、舍入、坐标系统、值域和缩写表的含义，约定各种技术规则的含义等。4.3.2.2求解问题的原理和算法(OPT)描述与指定功能有关以及与程序的结构组织有关的解题方法和算法以及参考文献。法鞍所指定的解题方法，描述程序单完的组织（例如程序、子程序、模块、程序段、公共存储区）、。表示可以按图解方式作出，例如采用树形结构图，或者也可以采用适当的文字结构的描述。必须包猪单元名，它们的入口，出口，以及它们之间的相互关系。2 JB/T 5237—914.3.4程序规模(OPT)按常用单位例如字节数，源码行数指出程序的总规模。4.3.5功能规格说明4.3.5.1 功能 (MAN)逐项说明用户软件包中每一程序所具备的各项功能及其极限范围。4.3.5.2命令或文法 (CON)为每一种程序提供一份命令或文法概要的清单。例如对扩展图表型软件(Spr