1CS01.110 L01 中华人民共和国电子行业标准 SJ/T207.3-1999 设计文件管理制度 第3部分：文字内容和表格 形式设计文件的编制方法 Management system for design documents Part 3:Preparation of design documents in the texture content and tables form 1999-08-26发布 1999-12-01实施 中华人民共和国信息产业部发布
目 次 前言 】花图 (51) 2 引用标准 (51) 3 一般要求 (52) 4 产品标准… (52) 5程序(CX) (52) 6 软件规范文本(B) (53) 7 软件需求说明(M)) (54) 8 软件设计说明(M) (54) 9 模块开发卷宗(M) (55】 10测试计划(CH) (56) II测试分析报告(CC) (56》 12维护手册(W℃)… (57) 13使用手册(SC) (57) 14项目开发总结报告(G) (58) 15软件生产操作说明(CS) (58) 16技术条件(JT) (58) 17技术说明书《S) (59) 18使用说明书《SS) 60) 9整件明细表《M) (61) 20成套设备（成套软件）明细表(MX) (64) 21成套件明细表(K》 (65) 22整件汇总表(Z) (67) 23备附件和工具汇总表(BH)… ..............-4. (67) 24成得派用文件清单(Y0》……………… (68) 25本标准附录的说明 (69) 附录A(提示的附录)电子产品和元器件产品设计文件编制示例… (71) 附录B(提示的附录)阿类型同系列产品整件明细表的简化编制示例…(10？) 附录C(提示的附录)成食备附件及工具明细表编制示例… (127) 附录D(提示的附录》软件产品设计文件编制示例… (1300 附录E《提示的附录》程序和信总处理流程图（程序流程图）编制示例 (139)
前 言 本标准是对207,4一82《设计文件的管理制度文字和表格和内容设计文件的编制 方法》、$J/Z2583一85《软件产品设计文件的组成和增制》和J/T10629.3一195《计算机 辅助设计设计文件管理制度设计文件的编制》的修订。 本标准的修订版与前版相比，主要变化如下： a)在格式上按照GB/T1,1一199仍《标准化工作导则第1单元：标准的起草与表述规 则第1部分：标准编写的基本规定》的规定进行了修订： b)在标准的内容上主要变化如下： 一"产品标准”按GB/T1.3一1997《标准化工作导则第1单元：标准的起草与表 述规则第3部分：产品标准编马规定》的规定进行编写： 增加了程序、软作规范文本、软件需求说明、软件设计说明等软件文件的构成和编 的方法： 在“技术说明书”的编制中，补充了“故障分析与接除”以及，“堆修和保养”两部 分内容。 /T207《设计文件管理制度》系列标准，目的包括以下五个部分： 第1部分：设计文件的分类和组成； 第2部分：没计文件的格式： 第3都分：文字内容和表格形式设计文件的编附方法： 第4部分：设计文件的编号： 第5部分：设计文件的更改： 本标准的附录A、附录B、附录C、附录D和附录E都是提示的附录。 本标准自实施之日起代誉并度止S207.4一82、5J/Z2583一85和)T10629.3一 1995。 本标准由中国电子技术标准化研究所归口， 本标准起草单位：中回电子技术标准化研究所、北京兆维电子（集团）有限责任公司 国营大众机械厂。 本标准主要起草人：博背、李善贞、陈明源、张钟恩，李尚厚、赵永利、张宁、张得 蜂。 本标准1956年首次发布、1996年第一次修订、1982年第二次修订，19%8年确认
中华人民共和国电子行业标准 设计文件管理制度 SJ/T207.3-1999 第3部分：文字内容和表格形式 代替5J207.4一82 设计文件的编制方法 SJ/Z2583一85 8J/T10629.3-1995 Management system for design documents Part 3:Preparation of design documents in the texture content and tables form 1范围 本标雅规定了电子产品文字内容和表格形式设计文件的编制方法。 本标准适用于电子产品文字内容和表格形式没计文件的编制，也适用于设计文件中产品 的图样、简图的文字内容。其他产品的设计文件也可参照采用。 2引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时， 所示板本均为有效。所有标准都会枝修订，使用本标准的各方应探讨使用下列标准最新版本 的可能性。 GB/T】.1一93标准化工作导则第1单元：标准的起草与表述规则 第1部分：标准编写的基本规定 GB/T1.3一997标准化工作导则第1单元：标准的起草与表述规则 第3部分：产品标准编写规定 CB1526一89信息处理数据流程图、程序流程图、系统流程图、程序网络因和系统 资源图的文件编制符号及约定(idtS05907:1985) GB3100-3102—93量和单位 GB5296.1一1997消费品使用说明总则 GB8567一88计算机款件产品开发文件编制指南 GB969.I一198工业产品使用说明书总则 GB/T14079一993软件维护指南 中华人民共和国信息产业部1999-08-26批准 1999-12-01买施 一51-
J/T207.3一1999 CB/T14691一1999技术制图字体(eS03098-1:1974) CB/T15834一1995标点符号的用法 S/T207.1一9设计文件管理制度第1都分：设计文件的分类和组成 S/T207.2一1999设计文件管理制度第2都分：设计文件的格式 3一般要求 3.1文字内容和表格形式的设计文件应力求准确、清楚、简明、通俗易懺和有逻舞性，避 免产生不易理解和不同理解的可能性。 3.2文字内容的设计文件技其内容可分成若干章、条进行叙述，输写格式及方法应符合 GB/T1.1a 3.3字体应符合GB/T1491。应采用经国务院公布的简化汉字。不允许用紫体字和异体 字。打印印刷形成的设计文件应采用规范的汉字和字符。标点符号应符合GB/T15834。 3,4各种计量单位的名称和符号应符合CB3100-3102。 3.5同一产品设计文件中的术语、符号、代号要前后统一，与其他有关标准一致。同一术 语应始终表达同一概念，同一概念始终采用引同一术语。采用的术语尚无标准规定时，应给出 定义或说明。 3.6引用的标准和文件应是现行有效的。 3.7根细需要，文字内容的设计文件可编制目次、附录和封面或副封面。 当有简图手册时，其目次应按设计文件的编号的递增顺序排列或按简图页码排列。 3.8表格形式的设计文件应按其内容分节填写，为了填写请晰、查阅醒目和更改方便，应 将节的名称（如“文件”、“外购件”节等）填写在表格的“名称”栏中间，并在其下划一粗 实线，各节之间，各行之间可根据需要空一行或数行。 4产品标准 出厂产品应有产品标准。编制方法按CB/T1.3的规定。 5 程序(CX) 程序是为实现顶期目的而设计的一系列工作步骤，是按照具体要求产生的适合于计算机 处理的指令序列。通常，一个程序由若干个程序模块构成。一般只对源程序编设计文件。 5.1程序模块文作的构成 程序模块文件一般由下列内容构成： 一文件名： 一程序/模块描述： 程序模块代码； 一程序注怀。 5.2偏制方法 -52
8J/T207,3一1999 5.2.1文件名 可参考S/T207.1-1999附录B,也可自行规定， 5.2.2程序/摸块描述 描述木程序/模块选用的语言、相关编译系统的版本、本程序的框架（体系结构）、文件 名以及运行环境。 描述的主要内容有： a)人口张件，如人口时的参数，数据值等： b)出口条件，如出口时的函数值，数据值等： ©)程序棋块的简要功能。 5.2.3程序/模块代码 列出完成指定功德的程序模块代码。程序的层次格式应该明确，程序中使用的名字应 具有可理解性并具有程序意义；程序/模块中用到的算法应该清晰；对于较复杂的算法，应 有专门的文字裤述，从而保证程序的可读性。 5.2,4程序注释 程序注释用来协助提高程序的可读性。依据具体情况，可以使用英文或中文作程序注 释，程序性释-一毅不少于程序行的35%。 5.2.5示例 程序和信总处理流程图（程序流程图）的编制示例见附录E(提示的附录)。 6软件规范文本(RB】 软件规范文本是记录软件开发过程技术信息，提供有关运行环境、使用方法、维护手段 的技术文件。 6.1软件规范文本的构成 软件规范文本一殷由下列内容构成： —概述： 软件开发： 软件内部规范： —软件运行及堆护。 根据产品具体要求也可增减或合并某些内容。 6.2编制方法 文本中内容可根据产品的实际情况进行增或。具体项目的编制方法见CB8567有关章 节。 6.2.1概述 概要说明该软件的设计原理和结构特征，并对其用途、性能、组成、安装，使用、维护 进行简要叙述。同时还应指明所米用的标准、规范、协议及采用程度和基本支持条件。 6,2,2软件开发 6.2.2.1开发环境 说明款件开发需要的各种条件和设鹿。 一53一
J/T207.3一1999 6,2.2.2语言文本（成工作文本） )符合国家标准的程序设计语言，可直接引证该标准编号： )对非国家标准的程序设计语言，应编制语言文本，其中应包括对所用语言的语句、 函数的格式、功能和使用方法等所作的说明，并复印（或说明）有关技术资料的书名、出版 者、出版日期： )其他情况可偏制工作文本。文本应说明所使用的指令系统的格式、功能、使用规侧 和机器码等，复印（或说明）有关技术贸料的名称、作者、编写日期。 6.2.3软件内部规范 a)说明该软件的结构、模块划分、功能分配； b)说明该钦件的接口设计、运行设计、处理流程，出错处理设计： ©)对数据结构、数据的采集以及对数据库的有关要求进行说明： d)其他要求。 6.2.4软件运行及维护 )说明运行该款件所的硬设备、支持软件以及接口、数据通信协议等： b)提供该软件运行的具体过程及操作方法的猫节，如：安装、初始化、输人、箍出、 运行说明、非常规过程、远程操作等： ℃)说明维护该软件所需工具，资源、设施及日程： )为保证产品正常运行所必需的检查、监视： )为使产品适应改变了的环境所进行的修改活动。如完善性细护，适应性堆护、欧正 性锥护。 7款件需求说明【汇M] 软件需求说明的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的 理解，使之成为整个开发工作的基础，同时还应提供关于被处理数据的描述和数据采集要求 的技术信息。 7.1软件需求说明一般由下列内容构成： 一引言： 一任务疑述： 需求规定： 数据逻辑描述： 一—数据采集： 运行环境规定。 根据产品具体要求也可增减或合并某些内容。 7.2软件需求说明的编制方法见CB8567一88的附录C和附录D。 8软件设计说明(1) 款件设计说明包括概委设计说明、详细设计说明和数据库设计说明。 -54
8J/T207.3-1999 8.1概要设计说明 概要设计说明又称系统设计说明。系统是指程序系统，它是用来说明对程序系统的设计 考碧，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设 计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。 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-
8J/T207.3一1999 和复审，并为将来的维护提供非常有用的技术信息。 9.1摸块开发卷宗一般由下列内容构成： 一—标题； 模块开发情况表； 功能说明： 设计说明： —源代码清单： 一一测试说明： —复审的结论。 根据产品具体要求也可增减或合并某些内容。 9,2模块开发卷宗的编制方法见GB8567一8网的附录J。 10测试计划(CH) 测试计划是指整个程序系统的组装测试和确认测试。本文件的编刷是为了提供一个对该 软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法 及评价准测。 10.1测试计别一般由下列内容构成： 一言： 一计划： 一测试设计说明： —一评价准则。 根据产品具体要求也可增减或合并某些内容。 10,2剥试计刘的编制方法见GB8567一88的附录K。 11划试分析报告【CC】 测试分析报告是指把组装测试和确认测试的结果、发现及分析写成文件加以记载。 11.1测试分析报告一般由下列内容构成： 一引言： 一测试概要： 一测试结果及发现： 一对软件功能的结论： 一分析摘要： 一测试资源消耗。 根据产品具体要求也可增减或合并某些内容。 11.2测试分析投告的编制方法见CB8567-88的附录L 一56
SJ/T207.3一1999 12维护手册(WC) 维护手册是指款件产品交付使用之后，为纠正故障，提高适应性和其他属性所进行的修 改活动的捐述文件。 12.1维护手册一般由下列内容构成： 一完善性堆护， 一适应性维护： 一改善性维护。 根据产品具体要求也可增减或合并某些内容。 12.2维护手册的编制方法见CB/T14079。 13使用手册(SC) 使用手册包括用户手册和操作手册。 13.1用户手册 用户手册是用非专门术语语言，充分地描述该软件系统所具有的功能及基本使用方法的 文件。使用户（或潜在用户）通过本乎册能够了解该软件的用途，井且能够确定在什么情况 下使用及如何使用它。 13.1.1用户手册一般由下列内容构成： 一引言： 一用途： 一运行环境； 一一使用过程。 根据产品具体要求也可增诚或合并某些内容。 13.1.2用户手册的编制方法见CB8567一88的附录H。 13,2操作手册 操作手团是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方 法的文件。 13.2.1操作手册一般由下列内容构成： —引言： 一一林件概述： 安装与初始化： —一运行说明： 一非常规过程： 一远程操作。 棍据产品具体婴求也可增减或合并某些内容。 13.2.2操作手册的编制方法见GB8567一88的附录1。 57