技术文档编制管理规定.docx
- 文档编号:17602318
- 上传时间:2023-07-27
- 格式:DOCX
- 页数:18
- 大小:44.53KB
技术文档编制管理规定.docx
《技术文档编制管理规定.docx》由会员分享,可在线阅读,更多相关《技术文档编制管理规定.docx(18页珍藏版)》请在冰点文库上搜索。
技术文档编制管理规定
技术文档编制管理规定
1范围
适用于公司各类技术文件编制与管理。
2规范性引用文件
下列文件中的条款通过引用而成为本标准的条款。
GJB438B-2009军用软件开发文档通用要求
QHG-QCX-4231-2016文件控制程序
3定义
本部分所指的产品仅指硬件产品和软件产品,当产品既有硬件又有软件时,硬件和软件的设计文件分别控制。
4基本要求
5.1编制要求
技术文件的编制要求主要有:
1)技术文档编制应正确、完整、协调、统一、字体、字号、格式等符合要求。
2)技术文档的层次划分和章、条、段、列项以及图、表、公式的编排方法按照本规定执行。
3)技术文档中采用的名词、术语、符号和代号、计量单位等应全文一致,并符合国家或军队现行有效的标准规定;必要时应在技术文档中给出定义或说明。
4)技术文档中正文字体、字号应一致,采用的字号、字体、行距及排列等应满足本规定。
5.2页面设置
版面干净无底灰,自己清楚无断划,尺寸标准,版心不斜,版心尺寸为156mm*235mm。
页面设置要求为:
1)上边距32±1mm,下边距30mm±1mm;
2)左边距28mm±1mm,右边距26mm±1mm;
3)Word文档格式中“段落”缩进和间距设置为0,对其方式选“两端对其”。
5详细要求
5.1技术文档封面
每份技术文档都应有封面,封面内容包括份号、密级、项目名称、文档名称、文档编号、研制单位名称和编制日期,技术文档封面样式见附录1.
1)“份号:
XXXX”(四号黑体),应位于封面版心左上方顶格标识,标识该份技术文档的顺序号,顺序号应用三位阿拉伯数字表示。
2)“密级:
XX”(四号黑体),应位于封面版心右上方顶格标识技术文档密级依据项目签订密级确定,所有技术文档密级与所签项目密级保持一致。
3)“项目名称”(二号黑体),应位于份号下空三行(四号字,行间距设置为1.5倍行距)居中位置,当技术文档内容较多时,可分册装订,并标识技术文档分册号,如“(第一分册)”、“(第二分册)”。
4)“文档名称”(二号黑体)位于项目名称下方空三行(小四号字,行间距设置为1.5倍行距)居中标识。
5)“文档代号”(二号黑体)位于文档名称下方空一行(小四号字,行间距设置为1.5倍行距)居中标识。
文档代码和配置项代码表示规则一致。
技术文件的代号一般情况由项目标识、文档标识和版本标识组成。
其形式为:
项目标识格式为:
项目名称代码-子类代码(当存在子系统时使用子类代码)。
项目名称应以软件任务书定义为准,项目名称代码-子类代码取用项目名称特征词组汉字的首字母组合或特征字符串。
注意代码不能重复,且在一个项目中必须统一。
代码举例见表.1。
表1项目标识举例
项目名称
项目代码
仿真软件
FZ
作战推演软件
ZYTY
常用文档标识代码表如下:
表1常用文档标识举例
软件文档名称
代码
软件任务书
RRW
软件项目开发计划
RXJ
软件质量保证计划
RZJ
软件配置管理计划
RPJ
软件需求规格说明
RXQ
接口需求规格说明
RJX
软件概要设计说明
RGS
软件详细设计说明
RXS
软件设计说明
RSS
接口设计说明
RJS
数据库设计说明
RKS
单元测试
软件测试计划
RCJ-DY
组装测试
RCJ-ZZ
确认测试
RCJ-QR
单元测试
软件测试说明
RCS-DY
组装测试
RCS-ZZ
确认测试
RCS-QR
单元测试
软件测试分析报告
RCF-DY
组装测试
RCF-ZZ
确认测试
RCF-QR
软件用户手册
RYC
软件研制报告
RYB
软件质量保证报告
RZB
软件配置管理报告
RPB
软件设计更改及影响域分析报告
RGB
软件质量问题技术归零报告
RGL
说明:
软件文档标识代码可以根据实际需要自行添加,亦可修改上述代码。
注意代码不能重复,且在一个项目中必须统一。
版本标识用于对版本加以区分、检索和跟踪,以表明各个版本之间的关系,版本号为数字结构,由以圆点相隔的四位阿拉伯数字组成。
标识具体格式为:
系统工程研制阶段(定型软件时适用)/技术状态.00.00,具体内容见表3“系统工程研制阶段标识”和表4“版本号表示”。
随不同技术状态的版本变更,更新版本标识。
表3系统工程研制阶段标识
研制阶段
研制阶段标识
说明
模样(或方案)
M(或F)
对照行业标准或体系文件进行对准
初样
C
试样
S
定型
Dn
n=1,2,3…,表示不同批组
表4版本号表示
格式
00.
00
位置
左边(第一层版本号)
右边(第二层版本号)
范围
01.-99.
00-99
说明
功能或性能变化时的版本升级。
最初版本号为01.,当有功能或性能变化时版本号增加01.。
最初版本号为00,当设计变化时版本号增加01。
初始版本号
01.00
6)“单位名称”(三号宋体),应位于封面版心下方,编制日期之上居中标识(行间距设置为1.5倍行距),以单位名称全称为准。
7)“编制日期”(三号宋体),应位于封面版心最下方居中标识,技术文件编制日期应当用汉字书写,填至年、月,“零”统一用插入符号“○”表示,如“二○一六年十二月”
5.2内容的格式要求
每一份完整的技术文档应依次包括技术文档封面、辑要页、文档修改记录页、目次、正文,必要时还要包括附件等要素。
5.2.1辑要页
辑要页包括项目名称、文件名称、项目代号、总页数、完成单位、审批项、摘要七部分,以表格形式表述,具体形式见附录2。
1)“辑要页”(二号黑体)位于应位于版心正上方居中标识,两个字之间空两格(二号黑体)。
2)“项目名称”(宋体小四),与封面项目名称一致。
3)“文件名称”(宋体小四),与封面文档名称一致。
4)“项目代号”(宋体小四),立项编号。
5)“总页数”(宋体小四)。
6)“完成单位”(宋体小四)。
7)“审批项”包括“编制、审核、标审、会签、批准”手写签署审批者姓名与日期,日期书写形式“yyyymmdd”,如“20161227”。
8)“摘要”(宋体小四),概括文档主要内容。
5.2.2文档修改记录
每次修改对修改版本号、修改内容、修改人、日期进行记录。
修改信息用宋体五号字进行表示,具体形式见附录3。
5.2.3目次
每份技术文件超过15也时应该编排目次,设置1.25倍行距,样式见附录4。
目次(不是“目录”)也的编排要求为:
1)目次页置于文档修改也之后,“目次”二字之间空两字并位于版心正上方定格居中排放,段前/段后设置为1.0行,用三号黑体。
2)目次中章、条编号位于版心左端定格对其(也可以分别按章、各层次条梯次缩进一个字间距左对齐),章、条编号与标题之间空一字,条的编号一般不超过三级(即二层次条),其标题与相应页码之间用“……”连接,页码不加编号,右端定格对齐,段前/段后均设置为0行,用小四号宋体字。
5.2.4正文
技术文件的正文一般由章、条、段、列项、图、表、公式等要素组成。
正文页样式见附录5,其编排要求为:
3)正文中技术文档名称、章、条、段、列项等行间距统一设置为1.25倍行间距,图、表、公式等行间距统一设置为单倍行间距。
4)章的段前/段后设置为0.5行(或章和标题的段前/段后均设置为0.5行),其余要素均设置为0行;用小四号黑体,全套技术文档的设置方式应当一致。
5.2.4.1章
章应由章的编号和章的标题组成,编号和标题之间空一字。
每一章通常接排,若章节篇幅较大,也可另起一页编排。
5.2.4.2条
条可分为“有标题的条”(即标题条)和“无标题的条”(即正文条)两种。
在同一章下、条下,通一层次的条有无标题应该统一。
标题条编排的具体要求如下:
1)每章从一层次条(如2.1)开始编排,最多编排到五层次条(如:
2.1.1.1.1.1);
2)标题条由编号和标题组成,编号与标题之间空一字,其后没有标点符号,用小四号黑体字。
正文条编排的具体要求如下:
1)正文条一般是标题条的正文内容,也可以编排到无层次条,通常正文条在标准中应用较多,在研究报告中尽量不用,改用段;
2)正文条由编号(同标题条的编号)和正文内容组成,编号和正文之间空一字,该正文条的最后结束处一定有标点符号(句号),段前/段后设置为0行,用小四号宋体字,行间距设置为1.25倍,
5.2.4.3段
段编排的具体要求为:
1)可以有多个段,每个段使用句号结束;
2)每个段左端顶格空两字起编排,回行时文字内容左端顶格;
3)段前/段后设置为0行,用小四号宋体字,行间距设置为1.25倍。
5.2.4.4列项
列项的编排方式主要有两种见示例1和示例2.建议使用示例1的编排方式,同一套技术文档中,每份文件的列项编排形式应该一致。
列项编排的具体要求为:
1)列项一般编排在某正文条或上一层次列项的下方,用于简要罗列本条或本段或上一层次列项的概要内容。
2)当列项编排在标题条的下方时,通常宜在列项之前加引导语,并使用冒号;
3)第一层次列项左顶格空两字开始编排;第二层次列项左顶格空四字起编排,回行时与第二层次列项编号后的文字取齐;
4)段前/段后设置为0行,用小四号宋体字,行间距设置为1.25倍。
示例1
1.2.3XXXXXXX(标题条)
XXXXXXXXXXXXXXXXXXX,主要有:
(列项的引导语)
1)XXXXXXXXXXXXXXXXXX,包括(第一层次列项)
a)XXXXXXXXXXXXXXXXXXXXXXXX;(第二层次列项)
b)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
2)XXXXXXXXXXXXXXXX;
3)XXXXXXXXXXXXXXX;
4)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
示例2
1.2.3XXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
(正文条)
a)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX;(第二层次列项)
b)XXXXXXXXXXXXXXXXXX,主要有:
1)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX;
2)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
c)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX;
d)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
5.2.4.5图
图编排的具体要求为
1)图应在正文中提及,并置于本段落下方或此页(若图多或体量大也可集中排在正文最后);
2)每一幅图均应有编号和图题,编号与图题之间空一字,置于图的下方居中位置,段前/段后设置为0.5行,用五号黑体字。
3)图的编号由“图”和阿拉伯数字组成,从1开始连续编号,如图1、图2、……。
4)一个图可以有多个分图组成,各分图应按“(a)XXX”、“(b)XXX”顺序编号。
5)图中的文字、字母、数字等应采用不大于五号的宋体字。
如果图需要有图注,则:
6)图注应位于图下、图题之上,居左端空两字标注,用五号宋体字;
7)同一图中只有一个图注时,应标明“注”,若有多个图注时,应标明“注1:
”、“注2:
”等,回行时与图注内容的第一个字取齐。
如果图需要有图的脚注,则:
8)图的脚注应位于图题之上、图注之后,用五号宋体字;图的脚注编号用小写英文字母,居左端空两字从“a”开编号(上角标方式),并在图中一相同的字母上标方式标注。
9)图的脚注的编号与文字之间空半个字,回行时与脚注内容的第一个字对齐。
注1:
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXX。
注2:
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
aXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
bXXXXXXXXXXXXXXXXX。
图XXXXXXXX
5.2.4.6表
表编排的具体要求为:
1)表应在正文中提及,并置于本段落下方或此页(若表多或体量大也可集中排在正文最后),表的长度小于1页时,尽量不拆分表格;
2)表应有编号和表题,编号与表题之间空一字,置于表的上方居中位置,段前/段后设置为0.5行,用五号黑体字。
3)表的编号由“表”和阿拉伯数字组成,从1开始连续编号,如表1、表2、……。
4)表应该有表头,表头设计应简洁、明了,不应采用斜线;表头栏有单位的应予以标注,横向或纵向接排的表应重复表头;
5)表格采用全封闭式,上、下、左、右边框线及栏头线应用1磅粗实线,其余用0.5磅的细线,如示例所示;
6)如果表有需要转页接续时,表的下部应将一个横栏填完,用细线闭合,次页的续表用在续表的上方重复表的编号,空一字表明“(续)”,续表的表题可省略,如:
表1(续),续表应重复表头和单位;
7)表格中没有内容的栏目,以短横线“—”表示。
8)表中内容用五号宋体字,表头内容可加粗,表注用五号宋体。
如果有表注,则表注应置于表格中最后一栏居左端空二字起排。
同一表中,只有一个表注时,应标明“注”,若有多个表注时,应标明“注1:
”、“注2:
”等,回行时与表注内容的第一个字取齐。
示例
表XXXXXX
序号
XX
XX
XX
XX
XX
XX
XX
注1:
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
注2:
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5.2.4.7公式
公式编排的具体要求为:
1)公式应置于相应文字描述段落下方,另起一行居中编排;
2)公式应有编号,公式编号有段对齐,公式与编号之间用“……”链接,编号用带全角双圆括号的阿拉伯数字,从
(1)、
(2)、(3)、……连接编号;
3)公式应以正确的数学形式表示,公式中需要解释的符号应注释在公式下方,必要时标明符号的单位;注释时,空两字,用“式中:
”起排,符号和注释之间用破折号“——”连接,每条注释均应另起一行编排,破折号上下对齐,注释内容回行时与注释内容取齐。
示例:
…………………………………………
(1)
式中:
p——XXXXXXXX
n——XXXXXXXX
K——XXXXXXXX
m——XXXXXXXX
5.2.4.8数值
数值表示的基本要求为:
1)小于1的数值用小数形式表示时,必须在小数记号“.”前面加上定位的“0”,如:
0.001,数值的有效位数应全部写出,如:
0.0010;
2)数值相乘时,应使用乘号“×”,而不用圆点“·”表示数值相乘,如:
正确的写法:
1.8×103,不正确的写法:
1.8·103;
3)表示非物理量的数时,10以内的数字用汉字“一、二、三、……”表示,大于或等于10时,用阿拉伯数字表示。
4)表示物理量的数值必须用阿拉伯数字,后面写上法定计量单位符号,不应中文单位与法定计量单位混用,并全文一致。
5)数值应尽量避免用分数表示。
如果出现分数时,分数线一般用“/”表示,而不用“—”表示。
6)带有尺寸单位的数字相乘时,如:
外形尺寸L×B×H,应写成“100mm×50mm×30mm”或mm:
100×50×30或100×50×30mm3;
7)当整数的位数较多,且其后有三个以上“0”或当纯小数的小数点后面有三个以上的“0”时,应尽可能采用10n作为倍数(n为正、负整数)的写法,有效位数中的“0”必须全部写出。
如:
已明确50000的有效位是为两位,则应写成50×103,而不写作5×104或其它形式。
8)表示偏差范围的数值应以无歧义的方式表示。
示例1:
温度20℃±2℃或(20±2)℃,不写作“20±2℃”。
示例2:
角度
,7°±1°或(7±1)°;不写作
,7±1°。
示例3:
长度
mm,不写作
mm、
、
mm。
9)正文中如需说明习惯用的非法定计量单位和法定计量单位相应的换算关系时,可在法定计量单位后用圆括号注明。
5.2.4.9汉字和标点符号
应采用规范简体汉字,标点符号应使用全角,字母、数字和其他符号使用半角。
5.2.4.10附件
附件为可选要素(如有,应在正文中提及),位于技术文档正文之后另起一页编排:
“附件1”、“附件2”、……居于版心上方左端顶格,用小四号黑体字,附件标题另起一行居中排放,用小四号黑体;附件内容用小四号宋体字,可起始编排章条号:
附件中的图、表、公式、序号可延续正文中的图、表、编号续排,也可另行编排“附图X”、“附表X”等。
份号:
XX(四号黑体,左上方顶格)(四号黑体,右上方顶格)密级:
XX
XXXXXXXXXXX(项目名称,二号黑体)
(空三行,小四号,1.5倍行距)
XXXXX(文档名称,二号黑体)
(空一行,小四号,1.5倍行距)
项目代号-文件代号-版本号(文档代号,二号黑体)
某某科技(北京)有限公司(单位名称,三号宋体,1.5倍行距)
二○XX年XX月(编制日期,三号宋体,版心最下)
辑要页
项目名称
数据库设计开发与数据资源管理服务平台
文件名称
开发计划
项目代号
总页数
27
完成单位
某某科技(北京)有限公司
拟制
签名与日期
职务或技术职称
校对
审核
标审
批准
会签
摘要:
本文档为数据库设计开发与数据资源管理服务平台软件开发计划。
主要描述软件各阶段的开发活动计划,工作环境和进度人员安排。
主题词:
软件开发、进度划分
文档修改记录
版本号
修改内容描述
修改人
日期
备注
目次(三号黑体,上下空一行,1.25行距)
1XXXX1
2XXXXXXX2
2.1XXX3
2.2XXXXX5
2.2.1XXXXXX6
2.2.2XXXXXX
3XXXXXXxx
3.1XXXXXXXXX
3.1.1XXXXXX
3.1.2XXXXXX
3.2XXXXXXX
3.2.1XXXXXX
3.3.2XXXXXX
4XXXXXX
5.4XXXXXX
5.5XXXXXXX
5XXXXXX
……
附件1XXXXXXXX
……
(目次内容用小四号宋体字,1.25倍行间距)
1XXXXXXXXXXXXXXXXXXXXXX(章的标题)(小四号黑体,段前/段后0.5行)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
(段,小四号宋体,1.25倍行距)
1.1XXXXXXX(标题条)(条编号后空一字,小四号黑体字)
XXXXXXXXXXXXXXXXXXXXXXXXXXXX:
(段,引导语,小四号宋体字)
1)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX;(一层次列项,编号后空一字,1.25倍行距)
a)XXXXXXXXXXXXXXXXXXXXXXXX;(二层次列项,编好后空一字)
b)XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
(二层次列项结束)
2)XXXXXXXXXXXXXXXX。
(一层次列项结束)
1.1.1XXXXXXXXXXXXXXXXXX(2级标题条)(条编号后空一字,小四号黑体字)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
(段,小四号宋体,1.25倍行距)
1.1.1.1XXXXXXXXXXXXXXXXXX(3级标题条)(条编号后空一字,小四号黑体字)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX。
(段,小四号宋体,1.25倍行距)
1.1.1.1.1XXXXXXXXXXX(4级标题条)(条编号后空一字,小四号黑体字)
1.1.1.1.1.1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX(正文条)(条编号后空一字,小四号宋体,1.25倍行距)。
……
2XXXXXXXXXXXXXXXXXXXXXX(章的标题)(小四号黑体,段前/段后0.5行)
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 技术 文档 编制 管理 规定