SJ/T 207.3-1999
基本信息
标准号:
SJ/T 207.3-1999
中文名称:设计文件管理制度 第3部分:文字内容和表格形式设计文件的编制方法
标准类别:电子行业标准(SJ)
英文名称:Management system for design documents Part 3: Preparation od design documents in the texture content and tables form
标准状态:已作废
发布日期:1999-08-26
实施日期:2002-01-01
作废日期:2018-07-01
下载格式:pdf zip
相关标签:
设计
文件
管理制度
部分
文字
内容
形式
编制
方法
标准分类号
标准ICS号:
综合、术语学、标准化、文献>>01.110技术产品文件
中标分类号:机械>>机械综合>>J01技术管理
出版信息
出版社:工业电子出版社
页数:96页
标准价格:0.0
出版日期:2002-01-01
相关单位信息
起草人:李善贞、陈明源、张钟恩等
起草单位:中国电子技术标准化研究所
归口单位:中国电子技术标准化研究所
发布部门:中华人民共和国信息产业部
标准简介
本标准规定了电子产品文字内容和表格型式设计文件的编制方法。
本标准适用于电子产品文字内容和表格型式设计文件的编制,也适用于设计文件中产品的图样、简图的文字内容。其他产品的设计文件也可参照采用。
标准内容
ICS 01.110
中华人民共和国电子行业标准
SJ/T 207.3—1999
设计文件管理制度
第3部分:文字内容和表格
形式设计文件的编制方法
Management system for design documentsPart 3: Preparation of design documents in the texturecontent and tables form
1999 - 08 - 26 发布
中华人民共和国信息产业部
1999-12-01实施
范围·
引用标
一般要求
产品标难
程序(CX)
软件规范文本(RB)
软件需求说明(XM))
软件设计说明(RM)
模块开发卷宗(M)
测试计划(CH)
测试分析报告(C)
维护手册(WC)
使用手册(SC)
项导开发总结报告(G)
软件生产操作说明(CS)
技术条件(JT)
技术说明书()
使用说明书(SS)
整件明细表(MX)
成套设备(成套软件)明细表(MX)成套件明细表(M)
整件汇总表(ZH)
备附件和工具汇总表((BH)
成套运朋文件清单(YO)
25本标准附录的说明
附录A(提示的附录)电子产品和元器件产品设计文件编制示例附录B(提示的附录)尚型同系列产晶整件明细表的简化编制示刻附录C(提示的附录)战套备附件及工明表编制示例附录(提示的附录)软件产品设计文件翁制示例附录王(提示的附录)程序和信息处理流程图(程序流程图!编制示例FTIKAONTKAca
本标准是对SI207.4一82《设计文件的管理制度文字和表格和内容设计文件的编制方法、SJ/Z258385 《软件产品设计文件的组成和编制》和SJT10629.3一199S 《计算机辅助设计设计文件管理制度设计文件的编制的修订。本标谁的修订版与前版椎比,主要变化如下:a)在格式上按照CB/T1.11993标准化工作导则第1单元:标准的起草与表述规则第1部分:标准编写的基本规定。的规定进行了修订:b)在标难的内容上主要变化如下:一产品标准按GB/T1.3一1997标推化工作导则第1单元:标推的起草与表述规则第3部分:产品标准编写规定》的规定进行编写;一增加了程序、软件规范文本、软件需求说期、软件设计说明等软件文件的构成和编制方法;
一在“技术说明书”的编制中,补充了“故障分析与排除”以及“维修和保养”两部分内容。
SJ/T207《设计文件管理制度》系列标准,目前包括以下五个部分:第1部分:设计文件的分类和组成:第2部分:设计文件的格式,
第3部分:文字内容和表格形式设计文件的编制行法:第4部分:设计文件的编号:
第5部分:设计文件的更改;
本标准的附录A、附录 B、附录C。附录D和附录E都是提示的附录。本标准自实施之日起代替并废止 S1 207.4 — 82,SJ/Z. 2583 一— 85 和 SJ/T 10629.3 —1995。
本标准由中国电子技术标雅化研究所归口:本标准起草单位:中国电子技术标推化研究所、北京兆维电子(集团)有限责任公司国营大众机械厂。
本标主要起草人:傅菁、季善贞、陈明源、张钟恩、李尚孕、赵永利,张宁、张得蜂。
本标准1956年咨次发布,1996年第一次修订,1982年第二次修订,1988年确认中华人民共和国电子行业标准
设计文件管理制度
第3部分:文字内容和表格形式
设计文件的编制方法
Martagenent system for design documentsPart 3 : Preparation of design documents in thetexture content and tables form1范围
TIKAONIKAca
SJ/T 207.31999
代替SJ 207, 4 — 82
SJ/Z 25B3 — 85
SJ/T 10629.3 — 1995
本标难规定了电子产品文内容和表格形式设计文件的编制方法。本标准适用于电产品文学内容和表格形式设计文件的编制,也适用手设计文件中产品的图样、简图的文字内容。其产品的设计文件也可参照来用。2引用标准
下列标准所包含的条文,通过在本标准中引用而构成为本标准的条文。本标准出版时,所示版本均为有效。所有标准都会被修订,使用本标推的各方应探讨使用下列标谁最新版本的可能性。
GB/T1.1一1993标准化王作导则第1单元:标准的起草与表述规则第1部分:标难编写的基本规定
GB/T1.3一1997标准化工作导则第1单元:标准的起草与表速规则第3部分:产品标推编写规定
B1526一89信息处理数据流程图、程序流程图、系统流程图、序网络图和系统资源图的文件编制符号及约定(d11S05807:1985】CB 3100 -3102—93量和单位
GB 5296.1--1997消费品使用说明总则CB8567一88计算机软件产品开发文件编制指南CB9969.1一1998工业产品使用说明书总则GB/T14079—-1993软件维护指南中华人民共和国信息产业部1999一08一26批准1999 -12 - 01 实施
SJ/T 207.3 --- 1999
GB/T 14691--1993技术制图字体 (eqv IS0 3098 -1: 1974)标点符号的用法
GB/T15834—1995
SJ/T 207. 1-1999
SJ/T 207.2---1999
3一般要求
设计文件管理制度第1部分:设计文件的分类和组成设计文件管理制度第2部分:设计文件的格式3.1文字内容和表格形式的设许文件应力求准确、清楚、简明、通俗易懂和有逻辑性,避免产生不易理解和不同理解的可能性。3.2文学内容的设计文件按其内容可分成若干章、条进行叙述,编写格式及方法应符合GB/T 1.1。
3.3字体应符合GB/T1491。应采用经国务院公布的简化汉宇。不充许用繁体字和异体字。打印印刷形成的设计文件应来用规范的汉字和字符。标点符号应符合GB/T15834。3.4各种计量单位的名称和符号应符合GB3100-3102g安.5同一产品设计文件中的术语、符号、代号要前后统一,与其他有关标准一致。同一术语应始终表达同一概念,同一概念始终采用同一术语。采用的术语尚无标准规定时,应给出定义或说明。
3.6引用的标推和文件应是现行有效的。3.7根据需要,文字内容的设计文件可编制目次、附录和封面或副封面。当有简图手册时,其目次应按设计文件的编号的递增顺序排列或按简图页码排列。3.8表格形式的设计文件应按其内容分节填写,为了填写清晰,查阅醒目和更改方便,应将节的名称(如“文件”,“外购件”节等)填写在表格的“名称”栏中间,并在其下划一粗实线,各节之间,各行之间可援据需要空一行或数行。4产品标准
出厂产品应有产品标准。编制方法按CB/T1.3的规定。5 程序 (≤)
程序是为实现预期目的而设计的一系列工作步骤,是按照具体要求产生的适合于计算机处理的指令序列。通常,一个程序由若干个程序模块构成。一般只对源程序编制设计文件。5.1程序/模块文件的构成
程序/模块文件一般由下列内容构成:—文件名:
程序/模块描述;
-程序/模块代码;
一程序注释。
5.2编制方法
5.2.1文件名
SJ/T 207 .3 — 1999
可参考 SJ/T 20,1 -1999 附录 B,也可自行规定。5.2.2程序/模块描述
TIKAONKAca
描述本程序/模块选用的语言、相关编译系统的版本、本程序的框架(体系结构)、文件名以及运行环境。
描述的主要内容有:
a)入口条件,如人口时的参数,数据值等;h)出口条件,如出口时的函数值,数据值等;C)程序/模块的简要功能。
5.2.3程序/模块代码
列出完成指定功能的程序/模块代码。程序的层次格式应该明确,程序中使用的名字应其有可理解性并具有程序意义;程序/模块中用到的算法应该清晰;对于较复杂的算法,应有专门的文字描述,从而保证程序的可读性。5.2.4程序注释
程序注释用来协助提高程序的可读性。依据具体情说,可以使用英文或中文作程序注释,程序注释一般不少于程序行的 35% 。5.2.5示例
程序和信息处理流程图(程序流程图)的编制示例见附录E(提示的附录)。6软件规范文本(RB)
软件规范文本是记录软件开发过程技术信息、提供有关运行环境、使用方法、维护手段的技术文件。
6.1软件规范文本的构成
软件规范文本一般由下列内容构成:概述;
软件开发;
软祥内部规范:
软件运行及维护。
根据产品具体要求也可增减或合并某些内容。6.2编制方法
文本中内容可根据产品的实标情说进行增减,具体项自的编制方法必讯8567有关章节。
6.2.1概述
概要说明该软件的设计原理和结构特征,并对其用途、性能,组成、安装,使用、维护进行简要叙述。同时还应指明所采用的标准、规范、协议及采用程度和基本支持条件。6.2.2软件开发
6.2.2.1开发环境
说明软件开发需要的各种条件和设施。53
6.2.2.2语言文本(或工作文本)SJ/T 207.3 — 1999
a)符合国家标准的程序设计语言,可直接引证该标准编号;b)对非国家标准的程序设计语言,应编制语言文本,其中应包括对所用语言的语句,函数的格式、功能和使用方法等所作的说明,并复印(或说明)有关技术资料的书名、出版者、出版日期;
c)其他情况可编制工作文本。文本应说明所使用的指令系统的格式、功能、使用规则和机器码等,复印(或说明)有关技术资料的名称、作者、编写日期。6.2.3软件内部规范
a)说明该软件的结构、模块划分、功能分配;b)说明该软件的接口设计、运行设计、处理流程、出错处理设计:c)对数据结构、数据的采集以及对数据库的有关要求进行说明:d)其他要求。
6.2.4软件运行及维护
a)说明运行该软件所需的硬设备,支持软件以及接口、数据通信协议等;b)提供该软件运行的具体过程及操作方法的细节,如:安装,初始化、输入、输出、运行说明、非常规过程、远程操作等;)说明维护该软件所需工其、资源、设施及日程:d)为保证产品正常运行所必需的检查,监规:e)为使产品适应改变了的环境所进行的修改活动。如完菩性维护、适应性维护、改正性维护。
7软件需求说明【X
软件需求说明的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解,使之成为整个并发工作的基础,同时还应提供关于被处理数据的描述和数据采集要求的技术信息。
7.1软件需求说明一般由下列内容构成:引言:
一任务概述;
一需求规定;
数据逻料描述:
一数据采集;
一运行环境规定。
根据产品具体要求也可增减或合并某些内容:7.2软件需求说明的编制方法现CB8567一88的附录C和附录D:8软件设计说明【R】
软件设计说明包据概要设计说明、详设计说明和数据库设计说明。 54 www.vv99.net
8.1概要设计说明
SJ/T 207.3 — 1999
HTiKAONiiKAca
概要设计说明又称系统设计说明。系统是指程序系统,它是用来说明对程序系统的设计考虑,包括程序系统的基本处理流程,程序系统的组织结构、模块划分、功能分配,接口设计,运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。8.1.1概要设计说明一般由下列内容构成:引言;
总体设计:
一接口设计;
一运行设计:
系统数据结构设计:
一系统出错处理设计,
根据产品鼻体要求也可增减或合并某些内容。8.1.2概要设计说明的编制方法见GB8567一88的附录E。8.2详细设计说明
详细设计说明又称程序设计说明。它是用来说明一个软件系统各个层次中的每个程序(每个模块或子程序)的设计考虑,如果一个软件系统比较简单,层次很少,本文件可以不单独编写,有关内容并人概要设计说明。8,2.1详细设计说明一般由下列内构成:引膏;
一程序系统的组织结构;
一程序1(标识符)设计说明;
一程序2(标识符)设计说明;
根据产品具体要求也可增减或合并某些内容。8.2.2详细设计说明的编制方法见CB8567一88的附录F。8.3数据库设计说明
数据库设计说明是对设计中的数据库的所有标识,逻辑结构和物理结构作出具体设计规定。
8.3.1数据库设计说明一般由下刻内容构成:一引言;
-外部设计;
一结构设计:
运用设计。
根据产品具体要求也可增减或台并某些内容。8.3.2数据库设计说明的编制方法见GB8567一88的附录G。9模块并发卷宗(MZ
模快开发卷宗是记录和汇.总低层次开发的进度和结采,以便于整个模块开发工作的普理— 55
SJ/T 207.3 - 1999
和复审,并为将来的维护提供非常有用的技术信息。9.1模块开发卷宗一般由下列内容构成:标题;
模块开发情况表:
功能说明;
设计说明:
一源代码清单:
测试说明;
复审的结论。
根据产品具体要求也可增减或合并某些内容。9.2模块开发卷宗的编制方法见GB856788的附录J,10试计划[CH]
测试计划是指整个程序系统的组装测试和确认测试。本文件的编制是为了提供一个对该软件的测试计划,包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。
10.1测试计划一毅街下列内容构成:引言;
一计划:
测试设计说明;
一评价谁则。
根据产品具体要求也可增减或合并某些内容。10.2测试计划的编制方法见CB856788的附录K。11测试分析报告【CC]
测试分析报告尼指把组装测试和确认测试的结果,发现及分析写成文件加以记载。11.1测试分析报告一般由下列内容构成:引言;
测试概要;
一测试结果及发现;
一对软件功能的结论;
—分析摘要;
一测试资源消耗。
根据产品具体要求也可增减或合并某些内容。11.2溯试分析报告的编制疗法见CB856788的附录Lc56
12维护手册【WC】
SJ/T 207.3 — 1999
FTIKAONTKAca
维护手册是指软件产品交付使用之后,为纠正故障,提高适应性和其他属性所进行的修改活动的满述文件。
12.1维护手册一般由下列内容构成:一完善性维护;
适应性维护;
一改替性维护。
根据产品具体要求也可增减或合并某些内容。12.2维护手册的编制方法见GB/T14079。13使用手册(SC)
使用手册包括用户手册和操作手册。13.1用户手册
用户手册是用非专门术语语言,充分地描述该软件系统所具有的功能及基本使用方法的文件。使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下使用及如何使用它。
13.1.1用户手册一般由下列内容构成:引言;
一用途;
一运行环境:
使用过程。
根据产品具体要求也可增减或合并某些内容。13.1.2用户手册的编制方法见GB8567一88的附录H。t3.2操作手册
操作手册是为了向操作人员提供该软件每一个运行的具体过程和有关知识,包括操作方法的文件。
13.2.1操作手册一般虫下列内容构成:引言;
*一软件概述;
一安装与初始化
一运行说:
一非常规过程;
一远程操作。
根据产品具体要求也可增减或合并某些内容。13.2.2操作手册的编制方法见GB8567一88的附录I。57
14项目开发总结报告【ZG】
$J/ 207.3 - 1999
项目开发总结报告是为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价文件。14,1项目开发总结报告般由下列内容构成:一引言;
一实际开发结果:
开发工作评价;
经验与教训。
根据产品真体要求也可增减或合并某些内容。14.2项目开发总结报告的缩制方法见CB 8567-88的附录N。15软件生产操作说明(S)
软件生产操作说明是对软件的生产对程,操作步撃作全面说明的文件。15.1软件生产操作说明-一般由下列内容构成:使用的硬件和软件:
生产的准备;
生产操作步骤:
—检验方法;
保管方法。
根据产品具体要求也可增减或台并某些内容。15.2编制方法
15.2.1使用的硬件和软件
列出软件生产时所需要的各种权器、设备、器材和软件等。15.2.2生产的推餐
说明生产软时,所使用的仪器、设备:软件的安装和调试以及其他的准备工作。15.2.3生产操作步骤
详细叙述将软件上的信息复制或转储到指定的媒体上的过程和方法。15,2.4检验方法
说明生产出来的软件产品的正确性和一致性及其捡验方法。15.2.5保管方法
说明教件应如何保管,并指出注意事项。注:软件生产探作说明可以不单独编制,而在媒体程序图上说明。16技术条件(JT’
技本条件是对产品组成部分的性能,参数指标、规格,检验要求和试验方法等所作的技— 58
术规定,应满足产品标难的要求。16.1技术条件的梅成
技术条件一般由下列内容构成:—概述;
外形尺寸及主要参数;
试验方法;
—检验规则:
标志、保管。
SJ/T 207.3 -- 1999
根据产品具体要求也可增减或合并某些内容,16.2编制方法
16.2.1概述
HTiKAONiiKAca
用以叙述本技术条件的用途、适用范围和编写依据以及共同使用的有关标准。概述部分一般不写标题,也不编号,如内容较多需要分条叙述时可作为第1章,并予以编号。16.2.2外形尺寸及主要参数
用以说明产品组或部分的外形尺寸、安装尺寸和主要参数。16.2.3要求
用以说明产品组成部分所必须具备的性能、指标及其充许误差等质量要求。一般应包括:外观质量的要求:在正常和恶劣环境条件下电磁性能、机械性能、可靠性、安全、寿命等方面的要求。
16.2.4用以规定对产品组成部分各项技术要求进行试验的方法。一般应包括:对试验条件的要求(包括允许误差);对检验设备、仪器、工具、材料的要求(包括精度或误差);试验步骤等。
16.2.5检验规则
检验规则是生产和检验部门判定产品组成部分质量是否达到技术条件而共同遵守的推则。一般应包括:试验类别和条件;检验项目和顺序;抽样方案和质量水平:不合格分类:复验规定,检验后产品的处理规定。16.2,6标志、保管
标志是指产品组成部分本身的标志或存敬容器上的标志。其内容一般包括产品型号和名称等。
保管是指产品对存荐环境的要求。16.3其他
产品的组成部分如不编制单独的技术条件,可将技术要求在产品图样或简图中规定。对同类产品组成部分也可采用编制通用技术条件或参数表等简化方法。17技术说明书(JS)
技术说明书是对产品用途、性能、组成、工作原理、调整和使用维方法等的技术说明。供使用、维修本产品之用。17.1技术说明书的构成
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。