1 一般要求
1.1 文件的构成
文件内容的一般构成和编排顺序如下:
a) 封面;
b) 签署页;
c) 文档修改记录;(需要时列出)
d) 目次(需要时列出);
e) 正文;
f) 附录(需要时列出)。
若有参考文献可列于正文的最后。
1.2 文件的幅面
一般文件的幅面大小采用A4幅面,附图可用大于A4的标准图幅,折叠成A4幅面的大小。
a)页面设置:
b)左边:25mm
c)右边:25mm
d)上边:25mm
e)下边:25mm
1.3 编写基本要求
a)文字表达应准确、简明、通俗易懂、逻辑严谨,避免产生不同理解的可能性;必须采用国家正式公布实施的简化汉字;
b)内容应完整,观点明确,论述正确,数据可靠;
c)图、表、公式等应正确无误;
d)计量单位一律用法定计量单位,并以符号表示;
e)使用的术语、符号、代号等应统一,一般应采用规范化技术术语和符号;使用新的专业术语、缩略语、习惯用语、应加以注解;若系国外新的专业术语、缩略语、应在译名后用圆括号注明原文。
2 详细要求
2.1 封 面
2.1.1 封面左上角
打印“标识:”和“版本:”字样,分两行放置。字号、字体为4号、黑体。
2.1.1.1 标识
文件标识由系统代号、分系统代号、软件标识符、文件类别、文件标识组成。系统代号统一规定为“XXX”,若系统下分有子系统,代号规定如下表所示。
分系统名称 | 分系统代号 |
XXX子系统 | 101 |
YYY子系统 | 102 |
软件标识符,为软件模块标识,由各分系统负责人设定,一般由不超过6个字母或数字组成(字母开头),要求该标识在各系统内部唯一。
文件类别,参见下表选择合适代码。
表E-8 文件类别与代码表
文件类别 | 代码 | 文件类别 | 代码 | 文件类别 | 代码 |
|
| 标准化 | BZ | 质量 | ZL |
|
| 评审 | PS | 计划 | JH |
方案 | FA | 用户资料 | YH | 管理 | GL |
设计 | SJ | 测试(试验) | CS | 总结 | ZJ |
需求 | XQ | 验收 | YS | 其它 | QT |
文件标识,应参照国军标有关标准命名,部分文档标识如下表所示。
表E-9 软件文档标识符
文件名称 | 文档标识符 |
标准化大纲 | SSO |
软件需求规格说明(含接口) | SRS |
软件概要设计说明(含接口) | SSDD |
软件详细设计说明(含接 ) | SPDD |
软件开发计划 | SDP |
软件配置管理计划 | SCP |
软件设计说明 | SDD |
数据库设计说明 | DBDD |
软件版本说明 | SVD |
软件用户手册 | SUM |
软件安装手册 | SAZM |
软件程序员手册 | SPM |
软件运行程序和源程序说明 | SRSP |
源代码 | YDM |
软件运行程序 | EX |
软件配置项测试计划 | STP |
软件配置项测试说明 | STD |
软件配置项测试报告 | STR |
单元测试计划 | SUTP |
单元测试说明 | SUTD |
单元测试报告 | SUTR |
软件质量保证计划 | SQA |
软件研制总结报告 | SDSR |
举例说明文档标识含意,如“XXX-001-JH-SDP”,标识XXX系统XXX子系统”的软件的“软件开发计划”。
2.1.1.2 版 本
Vx.y.z标识版本,软件总体的版本号从1.0.0开始编号,其中x、y和z均为不超过两位的阿拉伯数字。
2.1.2 封面右上角
打印“编号:”和“密级:”字样,分两行放置。字号、字体为4号、黑体。
2.1.2.1 编 号
编号是该文件及其复制件的顺序号,一般采用三位数字表示,如:001、002……。
2.1.2.2 密 级
各种技术文件一般都定为内部,具体密级按文件的内容和保密规定的要求确定。
2.1.3 文件名称
一般占用两行,第一行为工程名称或分系统、子系统、单元名称,第二行为文件的具体名称。位置居中,字体为1号、黑体;
4.1.4 封面底部
分两行打印文件拟制单位全称和年月,年月用中文填写,字号、字体为3号、黑体;
2.2 签署页
2.2.1 内 容
一般定稿的技术文件在上报和存档时必须有签署页。文件的签署页应包含文件名称及以下内容:
a) 拟制;
b) 审核;
c) 会签;
d) 标准化;
e) 批准。
凡需多方认可(包括单位内部及单位之间)的文件,可在“审核”与“标准化”之间增加一项“会签”栏。
2.2.2 签署程序
按Q/TX9004.303《科研技术文件和设计文件签署规定》执行。
2.2.3 要 求
拟制、审核、会签、标准化、批准要本人签名并填写日期。
不同文档签署项有所不同,不同文档签署审批权限不同,参见签署权限表。
表E-10 文档签署权限表
序号 | 软件设计文 名称 | 签 署 | ||||
拟制 | 审核 | 会签 | 标准化 | 批准 | ||
1 | 软件研制任务书 | ○ | ▲ | — | — | ★ |
2 | 软件需求规格说明 | ● | ○ | — | ◎ | ★ |
3 | 软件开发计划 | ● | ○ | ▲ | — | ★ |
4 | 软件配置管理计划 | ● | ○ | — | — | ★ |
5 | 软件设计方案 | ■ | ● | — |
| ★ |
6 | 软件测试计划及测试说明 | ● | ○ | ▲ | — | ★ |
7 | 软件测试报告 | ● | ○ | — | — | ★ |
8 | 软件用户手册 | ■ | ● | ▲ | ◎ | ★ |
9 | 软件配置管理报告 | ● | ○ | — | — | ★ |
10 | 软件研制总结报告 | ● | ○ | — | ◎ | ★ |
注 |
1)●——软件项目负责人(研制单位) 2)■——设计师(指这部分技术设计的负责人) 3)○——系统负责人(建设单位) 4)◎——标准化负责人(指对文档进行格式和所要求内容进行审查的负责人) 5)▲——软件管理部门指定代表 6)★——软件管理部门领导
|
2.3 目 次
2.3.1 目次内容
为可选要素。当技术文件内容超过15页时,宜设目次。其内容按下列次序列出:
a)章;
b)带有标题的条(需要时列出,但不宜包括第四层及以下层次的条);
c)附录(需要时列出);
d)参考文献(需要时列出)。
2.3.2 目次格式
“目次”字样位置居中,字号、字体为3号、黑体。目次的内容字号、字体为小4宋体。
目次中章、条的编号应顶格起排,章、条的编号与标题之间空一个字的间隙,章、条的编号一律左对齐,标题与页码之间用“……”连接,页码不加括号,右对齐。
若标题需换行,则第一行的尾字与应连线“……”尾取齐,换行时顶格排。
2.4 正 文
2.4.1 文件名称
文件名称位置居中,字号、字体为3号、黑体。
2.4.2 文件层次划分
文件正文的层次分为章、条、段等。其第一层次为章。章下要设条。条下可再设条,依此类推,但一般不超过五层。层次编号采用阿拉伯数字,每个层次之间加圆点“.”隔开。层次编号示例见下表。
表E-11 文件层次划分
层次名 | 编号示例 |
章 | 1 (标题) |
条 | 1.1 (标题) 1.1.1 … |
并列项 | a) b) 1) 2) |
段 |
|
2.4.3 章
应用阿拉伯数字从1开始,对章进行连续编号,顶格排。章应设标题,标题位于编号之后,并与其后的条文分行。编号与标题之间空一个字的间隙,编号与标题的字号、字体为小4、黑体。行间距:段前0.5,段后0.5,固定值21磅。
2.4.4 条
章以下有编号的层次均称为“条”。条在其所属章内或上一层次的条内用阿拉伯数字编号,顶格排。同一层次中有两个以上(含两个)的条时才可设条。
第一层次的条宜给标题。其他层次的条必要时可设标题。在某一章或条中,对于同一层次的条有无标题应统一。标题位于编号之后,并与其后的条文分行。编号与标题之间空一个字的间隙,字号、字体为小4、黑体。行间距:段前0.5,段后0.5,固定值21磅。
第二及以下各层次的条字号、字体为小4、宋体。行间距:段前0,段后0,固定值21磅。
有编号有标题的字号、字体为小4、黑体。
有编号无标题的字号、字体为小4、宋体,换行时顶格排。
2.4.5 段
段的文字空两个字起排,回行时顶格排。字号、字体为小4、宋体。行间距:段前0,段后0,固定值21磅。
2.4.6 列 项
列项前的字母编号“a)”、“b)”、“c)”、……空两个字起排。编号与文字之间空一个字的间隙,文字回行时均与编号后的第1字取齐。
字母编号下一层的数字编号(带有半园括号的阿拉伯数字)空四个字起排,数字编号与文字之间空一个字的间隙,回行时与数字编号后的第一个字取齐。
第一层次列项中的段空四个字起排,回行时与上行文字取齐。
列项中的字号、字体为小4、宋体。
2.4.7 条文的注和示例
条文的注和示例应只给出有助于技术文件的理解的附加信息,不应包含要求。
注和示例应位于相应的章、条或段的下面。
章或条中只有一个注或示例时,应在注或示例的第一行文字前标时“注:”或“示例:”。当同一章或条中有几个注或示例时,应标明“注1:”、“注2:”、“注3:”或“示例1:”、“示例2:”、“示例3:”等。
每条注另起一行空两个字起排,回行时与注的内容的第一个字取齐。
示例另起一行空两个字起排,“示例:”或“示例X:”可单独占一行,也可接排示例的内容。示例内容回行时顶格排。
条文的注和示例字号、字体为5号、宋体。
2.4.8 条文的脚注
条文的脚注应慎用。脚注不应包含要求。
脚注应用带半圆括号的阿拉伯数字从1开始在全文中连续编号,即1)、2)、3)等,并在需要注释的词或句子后以相同的上标数字1)、2)、3)等标明。必要时可用一个或多个星号,即*、**、***等代替数字及半圆括号。
脚注应放在相关页面下边(末页应在终结线的上面),并由一条左顶格的四分之一版面宽的细实线与正文分开。
每条脚注另起一行空两个字起排,编号与文字之间空半个字的间隙,回行时与编号后第一个字取齐。
条文的脚注字号、字体为5号、宋体。
2.4.9 表
表在条文中应明确提及,通常列于相应条文之后。
每个表均应有编号。正文中表的编号由“表”和阿拉伯数字组成,从1开始连续编号,例如“表1”、“表2”等。只有一个表也应标明“表1”。
每个表宜有表题,并置于表的编号之后。正文中有无表题应统一。表的编号与表题之间空一个字的间隙,两者应置于表的上方居中位置。
表必须有表头,表头设计应简单、清晰、明了。栏中使用的单位应标注在该栏表头名称的下方。表中所有计量单位相同时,应在表的右上方用一句适当的陈述代替各栏中的单位,例如“单位为毫米”。
表格采用封闭式,上、下、左、右边框线及栏头线用粗实线,其余用细实线。
表需要转页接排时,表下部应将一个横栏排完,用细实线闭合。接排的表,应在表的上方重复表的编号,并在编号后用“(续)”标明。续表的表题可以省略。续表均应重复表头和关于单位的陈述。
表的编号、标题字号、字体为5号、黑体。
2.4.10 表注
表注应位于表格中及表的脚注之前,表中只有一个注时,应在注的第一行文字前标明“注”。当同一个表中有几个注时,应标明“注1:”、“注2:”等。每个表的表注应单独编号。
表注不应包含要求。有关的要求性内容应在条文中、表的脚注里或表中的段给出。
每条表注另起一行空两个字起排,回行时与注的内容的第一个字取齐。
表注的字号、字体为5号、宋体。
2.4.11 表的脚注
表的脚注应位于表格中,列于表注之后。表注和表的脚注之间应有细实线分开。
表的脚注应用小写拉丁字母上标从“a” 开始编号,并在表中以相同的小写拉丁字母上标标在需要注释的位置上。每个表的脚注应单独编号。表的脚注可以包含要求。
表的脚注另起一行空两个字起排,脚注的编号与文字之间空半个字的间隙。回行时与注的内容的第一个字取齐。
表的脚注的字号、字体为5号、宋体。
2.4.12 图
每幅图应在条文中明确提及,一般排在相关条文之后。
每幅图均应有编号。正文中图的编号由“图”和阿拉伯数字组成,从1开始连续编号,例如“图1”、“图2”等。只有一幅图也应标明“图1”。
每一幅图宜有图题,并置于图的编号之后。正文中有无图题应统一。图的编号与图题之间空一个字的间隙,两者应置于图的下方居中位置。
编号、图题的字号、字体为5号、黑体。
2.4.13 图 注
图注应位于图的标题之上及图的脚注之前。图中只有一个注时,应在注的第一行文字前标明“注:”。当同一幅图中有几个注时,应标明“注1:”、“注2:”、“注3:”等。每一幅图中的注应单独编号。
图注不应包含要求。有关的要求性内容,应在条文中、图的脚注中或作为图和图题之间的段给出。
每条图注另起一行空两个字起排,回行时与注的内容第一个字取齐。
图注的字号、字体为5号、宋体。
2.4.14 图的脚注
图的脚注应位于图的标题之上,图注之后。
图的脚注应用小写拉丁字母上标从“a”开始编号。在图中应以相同的小写拉丁字母上标标在需要注释的位置上。每幅图中的脚注应单独编号。
图的脚注可包含要求。
图的脚注另起一行空两个字起排,脚注的编号数字之间空半个字间隙。回行时与注的内容第一个字取齐。
图的脚注的字号、字体为5号、宋体。
2.4.15 公 式
公式另起一行居中编排。较长的公式尽可能在等号处回行或在+、-符号处回行。公式中分数线的横线,长短要分清,主要的分数线应与等号取平。
公式编号时,应用带园括号的阿拉伯数字从1开始连续编号。右端对齐。公式与编号之间用“……”连接。
公式下面的“式中:”空两个字起排,单独占一行。
公式中所要注释的符号按先左后右,先上后下顺序分行空两个字起排,再用破折号与释文连接,上下行破折号对齐。释文回行时,应与破折号后面的第一个字取齐。
“式中”及注释的内容字号、字体为5号、宋体。
2.4.16 几点结构格式说明
2.4.16.1 范 围
在编写技术文件时,可能有范围这一章(如产品规范就有范围这一章)。范围的表述应确切、简练、清晰、字数宜在100字以内。
范围的典型表述形式如下:
a)“本标准规定了……
本标准适用于……。”
b)“本标准规定了……,还规定了……。
本标准适用于……,也适用于……。……可参照使用。
本标准不适用于……。”
若为规范时,则应将“本标准”改为“本规范”。
2.4.16.2 引用文件
2.4.16.2.1 概 述
在编写技术文件(如产品规范)时,可能有引用文件。有引用文件时,应列出文件中引用的文件一览表,并以下述用语为引导语:
“下列文件中的有关条款通过引用而成为本标准的条款。凡注日期或版次的引用文件,其后的任何修改单(不包括勘误的内容)或修订版本都不适用于本标准,但提倡使用本标准的各方探讨使用其最新版本的可能性。凡注日期或版次的引用文件,其最新版本适用于本标准。”
如标准为规范时,则应将上引导语中的“本标准”改为“本规范”。
引用文件应条文中提及。
2.4.16.2.2 引用文件的排列顺序
引用文件的排列顺序为:
国家标准;
国家军用标准;
行业标准;
部门军用标准;
国家和军队的法规、条例、条令和规章;
ISO标准;
IEC标准;
其他国际标准。
国家标准、国家军用标准、ISO和IEC标准按标准顺序号排列。
行业标准、部门军用标准、其他国际标准先按标准代号的拉丁字母顺序排列,再按标准顺序号排列。
2.4.16.2.3 引用文件一览表的编排
每个引用文件均左起空两个字起排,回行时顶格排,结尾不加标点符号。
标准编号和标准名称之间空一个字的间隙。标准编号中是否带版次和(或)批准年号,视引用文件的类型而定,批准年号一律用四位。
引用国家和军队的法规性文件时,应依次列出其名称(加书名号)、发布机关、发布日期、文号、每项内容之间空一个字的间隙。
2.4.16.3 术语和定义
2.4.16.3.1 概 述
在编写技术文件可能会有术语和定义,若有术语和定义时可单独设一章,并使用下述适用的引导语:
“下列术语和定义适用于本标准”。或“GJBXXXX确立的以及下列术语和定义适用于本标准。”若是规范,将“本标准”改为“本规范”。
2.4.16.3.2 编 排
每条术语的编号(只有一条时除外)、术语、外文对应词依次排列,编号顶格排,编号、术语、外文对应词之间各空一个字的间隙。外文对应词后面无标点符号,一行书写不完需回行时,应顶格排。术语的定义另起一行空两个字起排,回行时顶格排。
2.4.16.4 符号、代号和缩略语
在编写技术文件时,可能有符号、代号和缩略语。符号、代号和缩略语可单独设一章,也可与术语和定义合为一章,在适当的标题下列出理解技术文件所必要的符号、代号和缩略语清单或表。清单按符号、代号和缩略语的第一个字母顺序编排,不编号。每条空两个字起排,符号、代号或缩略语后跟一个破析号“—”,之后标明符号、代号的名称或缩略语的全称,必要时给出适当的说明。回行时顶格排。
2.5 附 录
附录按条文中提及的先后次序,用大写拉丁字母从“A”开始顺序编号。文件中只有一个附录仍应编为“附录A”。
每个附录中的章、条、表、图、和数学公式,其编号为附录的编号加下脚“.”再加顺序号。
例如附录A中章用“A.1”、“A.2”、“A.3”表示,图用“图A.1”、“图A.2”、“图A.3”表示,表用“表A.1”、“表A.2”、“表A.3”表示,公式用“(A.1)”、“(A.2)”、“(A.3)”表示。
附录编号以及附录标题,每项各占一行,置于附录条文之上居中位置。
第一个附录应另起一面,其后各个附录通常另起一面,但有多个较短的附录,也可接排。接排的附录之间距离10mm。
附录中的字号、字体与正文相关内容的字号、字体相同。
2.6 页 码
从目次到首页之前用大写罗马数字编页码。正文首页起用阿拉伯数字从1开始编页码。
若单面打印,页码编在右侧,若双面打印时,单数页码排在右侧,双数页码排在左侧。
3 说 明
技术文件编写时若有特殊问题向标准化人员咨询,以便协同解决。
4 上报文件形式要求
每份上报文件须三份(含签署页原件的)纸质文档;每次上报的所有文件一起刻录在一张光盘上,光盘上须用记号笔手写软件名称(简称)和刻录日期。