APP下载

技术文件编排格式的探讨与建议

2018-11-28漆传莉深圳航天科技创新研究院

中国质量与标准导报 2018年11期
关键词:术语公式报告

漆传莉(深圳航天科技创新研究院)

公文、科技报告、标准、技术文件、产品图样这几类文件是在工作中经常编制的,这几类文件的要素各不相同,其编排格式也有差异。进行标准化审查[1]是标准化人员的工作内容之一,文件格式则是标准化审查的内容之一。本文就标准、科技报告和公文的编排格式(主要是章节条的划分等)进行比较,并探讨技术文件的层次编写规则,寻求一种比较适宜的编写格式,避免在技术文件编写过程中出现无据可依,杂乱无章的现象,解决标准化工作中的一些困惑。

1 技术文件的格式要求

在技术研究过程中、产品研制和生产过程中会形成相应的产品图样和技术文件。其中,产品图样自成一体,按照技术制图(如GB/T 19096)和机械制图(如GB/T 4457)等国家标准,或是根据不同行业,按照SJ/T 207系列标准、QB/T 1753系列标准、QJ 1714系列标准等的要求执行。

技术文件的内容,各行各业都有相应的要求,如GB/T 8567—2006[2]规定了计算机软件文档的编制内容、GJB/Z 170—2013[3]规定了军工产品设计定型文件编制的主题内容等。

技术文件的编排格式,各个企业的要求各有不同,各个项目也会有不同的要求,但一般都是参照GB/T 1.1—2009[4]给出的规则。项目策划时,标准化人员就应规定技术文件的格式。

2 公文、科技报告、标准及其参考标准

2.1 公文

公文:党政机关公文是党政机关实施领导、履行职能、处理公务的具有特定效力和规范体式的文书,是传达贯彻党和国家的方针政策,公布法规和规章,指导、布置和商洽工作,请示和答复问题,报告、通报和交流情况等的重要工具[5]。

我国公文有统一性的特点,它的格式、种类、行文规则、办理等都是全国统一的,一般按照国家标准GB/T 9704—2014[6]执行。

2.2 科技报告

科技报告:科学技术报告,是进行科研活动的组织或个人描述其从事的研究、设计、工程、试验和鉴定等活动的进展或结果,或描述一个科学或技术问题的现状和发展的文献。(GB/T 7713.3—2014[7])

科技报告的编写依据是 GB/T 7713.3—2014,在此标准中引用了CY/T 35—2001[8]。

2.3 标准

标准:通过标准化活动,按照规定的程序经协商一致制定,为各种活动或其结果提供规则、指南或特性,供共同使用和重复使用的文件。(GB/T 20000.1—2014[9])

GB/T 1.1—2009规定了标准的结构、起草表述规则和编排格式,并给出了有关表述样式。

2.4 其他

在工作过程中,有一些政府申报的项目文件,如项目可行性研究报告、工作总结报告、验收报告等,这类文件的内容属于科技报告,但在表现形式上又侧重于公文,主要体现在文件的章节条以一、(一)1.(1)的形式编排。随着要求的逐渐明确及规范,此类文件已完全纳入科技报告,明确规定按GB/T 7713.3—2014的要求执行,故在此不再赘述。

2.5 参考标准的比较

公文、科技报告和标准等文件编制的参考标准见表1。

三个参考标准要求的层次及编号规则见表2、表3和表4。

表1 参考标准

表2 公文(GB/T 9704—2012)层次及编号示例

表3 标准、规范(GB/T 1.1—2009)层次及编号示例

表4 科技报告(GB/T 7713.3—2014、CY/T 35—2001)层次及编号示例

续表 4

各项标准的差异说明:

(1)GB/T 1.1—2009和CY/T 35—2001中节、条、段的含义有所不同。

(2)层次分级不同:

a)GB/T 9704—2012规定的结构层次只分到第四层。

b)GB/T 1.1—2009的5.2.4条规定,条一直可分到第五层次(例如5.1.1.1.1.1)。

c)CY/T 35—2001规定章节的层次划分一般不超过四级(例如5.1.1.1),但可下扩条、款、项、段。

(3)引言编号不同:

a)GB/T 1.1—2009规定引言不应编号,可以对引言条编号,编为0.1、0.2等,可以参见GB/T 19001—2016[10]。

b)CY/T 35—2001规定前言、概论、引言或类似形式章节以0作为编号。

(4)附录章、图、表和公式编号不同:

a)GB/T 1.1—2009规定附录中章、图、表和公式编号重新从1开始,编号前应加上附录编号字母(A、B、C等),字母后跟下脚点。如:A.1、 图A.1、表A.1等。

b)CY/T 35—2001规定附录中章、图、表和公式编号,应在阿拉伯数字前冠以附录的编号。如:A1、图A1、表A1、式(A1)等。

3 技术文件格式的探讨

3.1 章节条格式的探讨

在研制过程中的技术文件编写,基本上是以GB/T 1.1—2009为参考,因为此标准对文件的编写要求作出了比较详尽的规定,基本上涵盖了技术文件所涉及的所有要素。

技术文件的封面、签署页和更改记录页一般由企业根据各自不同的习惯与风格自定义。封面一般包括:系统及产品名称型号、文件名称、文件编号、文件版本号、编制单位、编制日期等。

技术文件正文通常都是以GB/T 1.1—2009为基础要求,适当地调整字体大小,一般是比标准要求大半号,如标准要求为五号宋体,技术文件则使用小四号宋体,以此类推。

建议的技术文件层次编号及字体要求见表5。

表5 技术文件

说明:

(1)GB/T 1.1—2009的 5.2.4条规定,条一直可分到第五层次(例如5.1.1.1.1.1)。技术文件使用WORD编制时,条是可以一直分到第八层次(例如5.1.2.3.4.5.6.7.8)。

(2)图、表、公式编号从引言开始一直连续到附录之前,并与章、条的编号无关,且图、表和公式的编号各不相关。如图1、表1、(1)等。公式的编号不是必须的,仅在需要对公式进行区分引用时,才对公式进行编号。

(3)只能对图做一个层次的细分,分图使用字母编号〔例如 a)、b)等〕。表中不能有表,且不能将表再分为次级表。公式也不能细分。

(4)建议每个图都应有图题,每个表都应有表题。

(5)图、表中的内容及公式建议均采用五号宋体。

(6)因为公式的编号与公式在同一行,如果公式用五号宋体,则公式的编号也应采用五号宋体,与图表编号不同。

3.2 其他相关格式的探讨

3.2.1 术语和定义

在GB/T 1.1中,“术语和定义”这一章是比较独特的存在,主要体现在:

(1)GB/T 1.1的 5.2.5条规定,应避免出现悬置段,但6.3.2条又要求“术语与定义”一章需要适当的引导语,这段引导语就成了悬置段[11]。

(2)术语与定义的条目编号采用的是正文的条编号(GB/T 1.1中 9.5.3),但在GB/T 1.1的 6.1.2条中规定:目次不应列出“术语和定义”一章中的术语。即目次中不应列出术语和定义的条目编号。

鉴于以上两个因素和技术文件的应用范围,建议技术文件不必编制“术语和定义”这一章。如有需要,可以增加最后一章“注释”,列出有助于了解技术文件的所有信息(包括背景、术语、缩略语或公式等,参考GB/T 8567—2006),此章内容可按正文的编排格式要求执行。

3.2.2 无标题条

GB/T 1.1—2009规定可以采用无标题条(如5.1.2.1和8.6.1等),CY/T 35—2001则要求篇、章、节、条、款、项、段都应有标题。为了保持全文的行文一致性,以及避免增加多余的格式设置,建议技术文件中所有条均应设标题,可将无标题条首句中的关键术语或短语作为条标题。

3.2.3 列项编号

GB/T 1.1—2009中规定,列项之前可以使用列项符号(“——”或“·”),也可使用字母编号,下一层使用后带半圆括号的数字编号。建议技术文件中的列项均使用字母编号,下一层使用后带半圆括号的数字编号,以保持行文统一。若数字编号需要进一步细分,则可使用带圆括号的数字编号进行标示,见示例。

示例:

产品的技术要求如下:

a)性能

1)外部接口:

(1)电源接口:1个。

(2)USB接口:2个。

2)……

b)功能

1)……

2)……

4 结语

综上所述,GB/T 9704—2012只适用于党政机关公文的规定,不适用于技术文件。而CY/T 35—2001制定时间比较久远,标准再次修订时应会考虑与GB/T 1.1—2009保持一致。

GB/T 1.1—2009作为基础性的国家标准,是全国各行业在编写标准时共同遵守的基础标准,在我国标准制修订工作中发挥了重要的指导作用。借鉴GB/T 1.1—2009的规则,结合企业实际情况制定技术文件的编排格式,是比较便捷、适宜的方法。

猜你喜欢

术语公式报告
组合数与组合数公式
排列数与排列数公式
等差数列前2n-1及2n项和公式与应用
例说:二倍角公式的巧用
报告
报告
报告
有感于几个术语的定名与应用
从术语学基本模型的演变看术语学的发展趋势