技术文件编写基本规则企业标准.docx
《技术文件编写基本规则企业标准.docx》由会员分享，可在线阅读，更多相关《技术文件编写基本规则企业标准.docx（37页珍藏版）》请在冰豆网上搜索。
技术文件编写基本规则企业标准
技术文件编写基本规则
1范围
本标准规定了技术文件编写的基本规则,给出了有关表述的一些样式,并提供了技术文件出版的格式和字体、字号。
本标准适用于企业技术文件的编写。
2规范性引用文件
GB/T1.1标准化工作导则第1部分：
标准的结构和编写规则
GB3101有关量、单位和符号的一般原则
GB3102（所有部分）量和单位
GB/T14691技术制图字体
GB/T15834标点符号用法
QJ/ML0002-A产品图样及技术文件编号方法
QJ/ML0101-A产品图样及设计文件格式
3术语和定义
下列术语和定义适用于本标准。
3.1
规范性要素
要声明符合标准而应遵守的条款的要素，分为一般要素和技术要素。
3.2
资料性要素
标识标准，介绍标准，提供标准的附加信息的要素，分为概述要素和补充要素。
3.2.1
概述要素
标识标准，介绍其内容、背景、制定情况以及该标准与其它标准的关系的要素，即标准的封面、目次、前言等。
3.2.2
补充要素
提供附加信息，以帮助理解或使用标准的要素，即标准的资料性附录、参考文献等。
3.3
要求
表达应遵守的准则的条款。
3.4
技术文件
包括设计文件、工艺文件、试验文件、检验文件、标准、指导书等。
4总则
4.1要求
技术文件所规定的条款应明确而无歧义，并且：
——在其范围所规定的界限内按需要力求完整；
——清楚、准确、相互协调；
——充分考虑最新技术水平；
——为未来技术发展提供框架；
——能被未参加文件编制的专业人员所理解。
——各种文件编写时，除符合本规则的要求外，还必须符合各自的编写方法。
4.2统一性
在每项技术文件内，其结构、文体和术语应保持一致。
某一给定概念应使用相同的术语，对于已定义的概念应避免使用同义词。
每个选用的术语应尽可能只有惟一的含义。
4.3技术文件间的协调性
为了达到所有技术文件整体协调的目的，每项技术文件应遵照现行基础标准的有关条款，尤其涉及下列方面：
——标准化术语；
——术语的原则和方法；
——量、单位及符号；
——参考文献；
——技术制图；
——图形符号。
此外，对于特定技术领域，还应考虑涉及诸如下列内容的标准中的有关条款：
——极限和配合；
——尺寸公差和测量的不确定度；
——优先数；
——统计方法；
——环境条件和有关试验；
——安全；
——化学。
5层次的描述和编号
5.1章
章是技术文件内容划分的基本单元。
在每项技术文件中，应使用阿拉伯数字从1开始对章编号（见附录A）。
编号应从第一章开始，一直连续到附录之前。
每一章均应有标题。
标题应置于编号之后，并与其后的条文分行。
5.2条
条是章的细分。
应使用阿拉伯数字对条编号，（见附录A）。
第一层次的条可继续分为第二层次的条，需要时条一直可分到第五层次（例如5.1.1.1.1.1、5.1.1.1.1.2等）。
同一层次中有两个以上（含两个）的条时才可设条。
例如，第2章的条文中，如果没有2.2条，就不应设2.1条。
第一层次的条应给出标题。
标题应置于编号之后，并与其后的条文分行。
后几层次的条也可同样处理，或者在编号后直接写出内容。
在某一章或条中，同一层次的条，有无标题应统一，例如，2.1有标题，则2.2也应有标题。
5.3段
段是章或条的细分，段不编号。
尽量不出现以下示例所表明的“悬置段“，以避免在引用这些段时产生混淆。
示例：
不正确
5标识
×××××××××××××××××××}
×××××××××××××××××××}悬置段×××××××××××××××××××}
5．1××××××××
×××××××××××××××××××
5．2×××××××
×××××××××××××××××
×××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××
6试验报告
正确
5标识
5．1××××××××
××××××××××××××
×××××××××××××××
×××××××××××
5．2××××××××
×××××××××××××××××××
5．3×××××××
×××××××××××××××××
×××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××
6试验报告
5.4列项
列项可用下述形式引出：
一个句子（见示例1）；一个句子的前半部分，该句子由分行列举的各项来完成（见示例2）；列项中每一项前应加破折号或圆点。
如果需要识别，可使用带半圆括号的小写拉丁字母序号。
在字母形式的列项中，如需细分，可使用带半圆括号的阿拉伯数字序号（示例3）。
示例1：
下列各类仪器不需要开关：
——在正常操作条件下，功耗不超过10W的仪器；
——在任何故障条件下使用2min，测得功耗不超过50W的仪器；
——用于连续运转的仪器。
示例2：
仪器中的振动可能产生于：
·转动部件的不平衡；
·机座的轻微变形；
·滚动轴承。
示例3：
标准中使用的量和单位：
a）小数点符号为“·”；
b）标准应只使用：
1）GB3101、GB3102各部分所给出的单位；
2）GB3101给出的可与国际单位制并用的我国法定计量单位，如分（min）、小时（h）、天（d）、度（○）、
分（’）；秒（”）、升（L）、吨（t）、电子伏（eV）和原子质量单位（u）；
3）GB3102给出的单位，如奈培（Np）、贝尔（B）、宋（some）、方（phon）和倍频程（oct）；
…………
5.5附录
附录分为规范性附录和资料性附录，应按其在条文中提及的先后次序编排附录顺序，并编号。
附录编号由“附录”和表明顺序的大写拉丁字母组成，字母从“A”开始，例如“附录A”。
附录编号下方标明附录的性质，即“规范性附录或资料性附录”，在下方是附录标题。
每个附录中的章、图、表和数学公式的编号应重新从1开始，编号前应加上附录编号中表明顺序的字母，字母后跟下脚点。
例如：
附录A中的章用“A.1”、“A.2”；图用“图A.1”、“图A.2”；表用“表A.1”、“表A.2”等。
6起草
6.1资料性概述要素
6.1.1封面
每项技术文件均应有封面。
6.1.2目次
目次为可选要素。
如果需要或文件超过15页，可设置目次。
目次所列的内容和顺序如下：
——前言；
——章；
——带有标题的条（需要时列出）；
——附录，应在圆括号中标明其性质，即“（规范性附录）”或“（资料性附录）”；
——附录的章和带有标题的条（需要时列出）；
——参考文献；
——图（需要时列出）；
——表（需要时列出）。
在目次中应列出完整的标题。
“术语和定义”一章中的术语不应在目次中列出。
6.1.3前言
企业技术标准应有前言，其他技术文件视需要而定。
前言不应包含要求、图和表。
前言由特定部分和基本部分组成。
在特定部分应视情况依次给出下列信息：
——说明本文件起草的依据；
——说明本文件起草的目的；
——说明与文件前一版本相比的重大技术变化；
——说明本文件与其他标准或文件的关系；
——说明本文件中的附录哪些是规范性附录，哪些是资料性附录。
在基本部分应视情况依次给出下列信息；
——本文件由××××提出、起草和归口管理；
——本文件所代替文件的历次版本发布情况。
6.2规范性一般要素
6.2.1名称
名称为必备要素，它应置于正文首页和技术文件的封面。
6.2.2范围
除文件编写方法另有规定外，范围为必备要素，它应置于每项技术文件正文的起始位置。
范围应明确表明技术文件的对象和所涉及的各个方面，由此指明技术文件或其特定部分的适用界限。
必要时，可指出技术文件不适用的界限。
范围不应包含要求。
范围的陈述应使用下列表述形式：
“本文件
……的尺寸”
——规定了……的方法。
”
……的特征。
”
……的系统。
”
——确定了
……的一般原则。
”
——给出了……的指南。
”
——界定了……的术语。
”
技术文件适用性的陈述应由下述引导语引出：
“本文件适用于……”；
“本文件不适用……”。
6.2.3规范性引用文件
6.2.3.1当技术文件引用了文件中的具体条款时，应注日期引用，对于注日期引用文件必须引用现行有效版本，在引用文件一览表中及条文均应写出引用文件的年号（四位数表示）；不引用文件中的具体条款，并且可接受引用文件将来的所有改变（修订版本），可不注日期引用。
6.2.3.2规范性引用文件中列入的文件，必须在条文中被规范性引用。
对于在条文中没被引用，甚至未提及，只是在编制过程中参考过的文件，不能列入规范性引用文件一览表，需要时可列入参考文献。
注日期引用文件，正文中可引用到章、条号。
不注日期引用文件，正文中不能引用到章、条号。
6.2.3.3凡注日期引用的文件，只能使用所注日期的版本，而以后的修订版本（或更改单）一般不能自动适用，必须根据被引用文件修改单或修订版的内容发布技术文件修改单，对技术文件进行修订或对相应条文进行更改。
6.2.3.4引用文件按上级行政主管部门文件、国家标准、行业标准、国际标准、本企业标准、其它企业标准、其他国际标准顺序，按标准编号从小到大依次排列。
6.3规范性技术要素
6.3.1术语和定义
术语和定义为可选要素，它给出为理解技术文件中某些术语所必需的定义。
应使用下述适合的引导语：
——“下列术语和定义适用于本××××”；
6.3.1.1选择需定义的概念
在不同的语境中有不同的解释，或者不是一看就懂的术语，均应通过定义有关概念予以明确。
对于通用词典中的词或通用的技术术语，只有在用于特定含义时，才应对它下定义。
6.3.1.2避免重复和矛盾
对某概念建立有关术语和定义以前，要查明在其他技术文件中该概念是否已有术语和定义。
如果某概念用于几项技术文件，宜在其最通用的技术文件中或在术语标准中下定义。
而其他技术文件宜引用对该概念下定义的技术文件，不必重复该概念的定义。
6.3.2要求
要求为可选要素。
这是技术文件的技术要素中非常重要的要素。
它应包含下述内容：
a）直接或以引用方式给出技术文件涉及的产品、过程或服务等方面的所有特性——即技术文件规定的各类技术性能或指标要求；
b）可量化特性所要求的极限值，必要时可同时给出其允许偏差；
c）对每个要求，或者引用测定或检验特性值的试验方法，或者直接规定试验方法。
6.3.3抽样
抽样为可选要素，它规定抽样（取样、采样）的条件和方法，以及样品保存方法。
该要素也可置于要素6.3.4的起始位置。
6.3.4试验方法
试验方法为可选要素。
它是技术文件的技术要素中非常重要的一个要素。
该要素应给出与下列程序有关的所有细节：
测定特性值或检查是否符合要求，以及保证结果的再现性。
应指明试验的种类：
即型式试验、例行（出厂）试验、抽样试验。
试验的种
类一般应根据国家标准、行业标准确定。
6.3.5标志、标签和包装
标志、标签和包装为可选要素，它可规定如何标注产品的标志（例如生产者或销售商的商标；型式或型号）。
该要素可包含对产品的标签和（或）包括的要求（例如储运说明、危险警告、生产者名称和地址、生产日期等）。
所规定的标志符号应符合有关国家标准或行业标准的规定。
6.3.6规范性附录
规范性附录为可选要素，它给出技术文件正文的附加条款。
附录的规范性的性质应加以明确，如“遵照附录A的规定”，“见附录C”等。
6.4资料性补充要素
资料性附录为可选要素，它给出对理解或使用技术文件起辅助作用的附加信息。
该要素不应包含要声明符合技术文件而应遵守的条款。
附录的资料性的性质应加以明确，如“参见附录B”
6.5其他资料性要素
6.5.1条文的注和示例
条文的注和示例应只给出对理解或使用技术文件起辅助作用的附加信息，不应包含要声明符合技术文件而应遵守的条款。
注和示例宜置于所涉及的章、条或段的下方。
章或条中只有一个注，应在注和第一行文字前标明“注：
”。
同一章或条中有几个注，应标明“注1：
”、“注2：
”、“注3：
”等。
章或条文中只有一个示例，应在示例的具体内容之前标明“示例：
”。
同一章或条中有几个示例，应标明“示例1：
”、“示例2：
”、“示例3：
”等。
6.5.2条文的脚注
条文的脚注用来提供附加信息，应尽量少用脚注。
条文的脚注不应包含要求。
脚注应置于相关页面的下边。
脚注和条文之间用一条细实线分开，细实线长度为版面宽度的四分之一，置于页面左侧。
通常，应使用后带半圆括号的阿拉伯数字从1开始对脚注编号。
全文中脚注应连续编号、即：
1）、2）、3）等。
在需注释的词或句子之后应使用与脚注编号相同的上标数字1）、2）、3）等标明脚注。
6.6一般规则和要素
6.6.1条款表述所用的助动词
表示要准确地符合技术文件而应严格遵守的要求时用“应”或“不应”。
表示不赞成但也不禁止某种可能性或行动步骤时用“宜”或“不宜”。
表示在技术文件的界限内所允许的行动步骤时用“可”或“不必”。
陈述由材料的、生理的或某种原因导致的可能和能够时用“能”或“不能”。
6.6.2图
6.6.2.1用法
如果用图提供信息更有利于技术文件的理解，则宜使用图。
每幅图在条文中均应明确提
及。
只允许对图进行一个层次的细分。
例如，图1可分成a）、b）、c）等。
6.6.2.2编号
每幅图均应有编号。
图的编号由“图”和从1开始的阿拉伯数字组成，例如“图1”、“图2”等。
图的编号应一直连续到附录之前，并与章、条和表的编号无关。
只有一幅图时，仍应标为“图1”
附录中图的编号见5.5条。
6.6.2.3图题
图题即图的名称。
每幅图宜有图题，并置于图的编号之后。
技术文件中有无图题应统一。
图的编号和图题应置于图下方的居中位置。
6.6.2.4技术图样
技术图样应按照有关标准绘制。
5.6.2.5图注
图注应区别于条文的注。
图注应置于图题之上，并位于图的脚注之前。
图中只有一个注时，应在注和第一行文字前标明“注：
”。
同一幅图中有多个注时，应标明“注1：
”、“注2：
”、“注3：
”等。
每幅图的图注应单独编号。
图注不应包含要求。
关于图的内容的任何要求应作条文、图的脚注或图题之间的段给出。
6.6.2.6图的脚注
图的脚注应区别于条文的脚注。
图的脚注应置于图题之上，并紧跟图注。
在图中需注释的位置，用上标形式从“a”开始的小写拉丁字母表示，第一条图的脚注为“a”；第二条图的脚注为“b”，以此类推。
当易产生误解时，脚注也可用上标形式的“*”表示，第一条图的脚注为“*”；第二条图的脚注为“**”，以此类推。
图的脚注可包含要求。
因此，当起草图的脚注的内容时，应使用适当的助动词，以明确区分不同类型的条款。
6.6.3表
6.6.3.1用法
如果用表提供信息更有利于标准的理解，则宜使用表。
每个表在条文中均应明确提及。
不允许表中有表，也不允许将表再分为次级表。
6.6.3.2编号
每个表均应有编号。
表的编号由“表”和从1开始的阿拉伯数字组成，例如“表1”、“表2”等。
表的编号应一直连续到附录之前，并与章、条和图的编号无关。
只有一个表时，仍应标为“表1”。
附录中表的编号见5.5条。
6.6.3.3表题
表题即表的名称。
每个表宜有表题，并置于表的编号之后。
标准中有无表题应统一。
表的编号和表题应置于表上方的居中位置，如下所示：
示例：
表×表题
××××
××××
××××
××××
6.6.3.4表头
每个表应有表头。
表头一般横排，置于表的最上端。
表头的某栏中使用的单位一般应标在该表头中量的名称之下。
见示例1：
示例1：
类型
线密度
kg/m
内圆直径
mm
外圆直径
mm
如果表中所有单位均相同，应在表的右上方标明单位符号。
见示例2：
示例2：
mm
类型
长度
内圆直径
外圆直径
不允许使用示例3的表头，而应使用示例4的表头。
示例3：
类型
尺寸
A
B
C
示例4：
尺寸
类型
A
B
C
6.6.3.5表的接排
如果某个表需要转页接排，在随后的各页上应重复表的编号。
编号后跟“（续）”，表题可省略，如下所示：
表1（续）
续表均应重复表头和关于单位的陈述。
6.6.3.6表注
表注应区别于条文的注。
表注应置于表中，并位于表的脚注之前（见以下示例）。
表中只有一个注时，应在注的第一行文字前标明“注：
”。
同一个表中有多个注时，应标明“注1：
”、“注2：
”、“注3：
”等。
每个表的表注应单独编号。
表注不应包含要求。
关于表的内容的任何要求应作为条文、表的脚注或表中的段给出。
示例：
mm
类型
长度
内圆直径
外圆直径
l1a
d1
l2
d2b
包含要求的段。
注1：
表注。
注2：
表注。
a表的脚注。
b表的脚注。
6.6.3.7表的脚注
表的脚注应区别于条文的脚注。
表的脚注应置于表中，并紧跟表注。
在表中需注释的位置，用上标形式从“a”开始的小写拉丁字母表示，第一条表的脚注为“a”；第二条图的脚注为“b”，以此类推。
当易产生误解时，脚注也可用上标形式的“*”表示，第一条表的脚注为“*”；第二条表的脚注为“**”，以此类推。
表的脚注可包含要求。
6.6.4引用
通常，应采用引用文件中特定条文的方法，而不要重复抄录需引用的具体内容。
这样，可避免由于重复可能产生的错误或矛盾，也可以避免增加标准的篇幅。
6.6.4.1引用条文
应使用下列表述方式引用条文：
——“按第3章的要求”；
——“符合3.1的规定”；
——“按3.1.b）的规定”；
——“按3.1.1给出的细节”；
——“见附录C”；
——“参见附录B”（针对资料性附录）；
——“参见B.2章给出的要求”；
——“参见表2的注”。
——“见6.6.3的示例2”。
如果需要引用列项中无序号的某项，则使用如下表述方式：
“按3.1列项中的第二项规定”。
如果某条内无序号的列项多于一个，则引用时可使用如下表述方式：
“按5.2中第二个列项中的第二项规定”。
6.6.4.2引用图和表
技术文件中的每个图和表均应在条文中提及。
例如使用下列表述方式：
——“图A.6所示”；
——“（见图3）”；
——“表2给出”；
——“（见表B.2）”。
6.6.4.3引用其他文件
引用其他文件可以注日期，也可不注日期。
所有规范性引用文件，无论是注日期，还是不注日期，均应在“规范性引用文件”一章中列出。
注日期的引用文件，随后如果有修改单或修订版，则引用这些文件的标准可根据需要发布修改单，以便引用这些被引用文件的修改单或修订版的内容。
注日期引用时，使用下列表述方式：
——“……按GB×××××.3—1988进行试验，……”（注日期引用其他标准特定的部分）；
——“……遵照GB/T××××—1997中第3章……”（注日期引用其他标准中特定的章）；
——“……按GB/T××××.4—1996表1的规定，……”（注日期引用其他标准的第4部分中特定的表）。
只有引用完整的文件或标准的某个部分，并在满足下列条件之一的情况下，才可不注日期引用文件：
a）根据标准的目的，可接受所引用文件将来的所有改变；
b）针对资料性引用的文件。
不注日期引用应视为包括所引文件的所有修改单和修订版。
不注日期引用时，使用下列表述方式：
——“按GB/T4457.4和GB3102规定的……”；
——“……见GB/T16273……”。
6.6.5数和数值的表示
6.6.5.1为了清晰起见，数和数值相乘应使用乘号“×”，而不使用圆点。
示例：
写作1.8×10-3（不写作1.8·10-3）
6.6.5.2表示非物理量的数（相对物理量的数值而言），数字一至九宜用汉字“一”、“二”、“三”……等表示，大于九数字一般用阿拉伯数字表示。
示例1：
“用五根5m长的管子进行试验。
”
示例2：
“再选15根管子进行压力试验。
”
表示物理量的数值，应使用后跟法定计量单位符号的阿拉伯数字。
6.6.6量、单位、符号
应使用GB3101、GB3102规定的法定计量单位。
表示量值时，应写出其单位。
度、分和秒（平面角度）的单位符号应紧跟数值后；所有其他单位符号前应空四分之一个字的间隙。
数学符号应遵照GB3102.11的规定。
技术文件中有关量和单位可参见GB/T1.1中附录F。
6.6.7数学公式
6.6.7.1公式的表示形式
公式应以正确的数学形式表示，由字母符号表示的变量，应随公式对其含义进行解释。
公式不应以量的描述性术语或名称的形式表示。
示例：
v
式中：
v——一个匀速运动质点的速度，m/s；
l——运行距离，m；
t——时间间隔，s
6.6.7.2编号
如果为了便于引用，需要对文件中的公式进行编号，则应使用1开始的带圆括号的阿拉伯数字：
X2+Y2（1）
公式的编号应是连续的，并与章、条、图和表的编号无关。
6.6.8尺寸和公差的表示
尺寸和公差应以无歧义的方式表示。
示例1：
80mm×25mm×50mm（不写作80×25×50mm）
示例2：
80µF±2µF或（80±2）µF（不写作80±2µF）
示例3：
mm（不写作mm）
示例4：
80mm
µm
示例5：
10kPa～12kPa（不写作10～12kPa）
示例6：
0℃～10℃（不写作0～10℃）
为了避免误解，百分数的公差应以正确的数学形式表示。
示例7：
用“63%～67%表示范围。
示例8：
用“（65±2）%”表示带有公差的中心值，不应使用“65±2%”的形式。
6.6.9规范汉字和标点符号
技术文件中应使用规范汉字。
技术文件中使用标点符号，应符合GB/T15834的规定。
6.6.10终结线
在技术文件的最后一个要素之后，应有终结线。
7编排格式
7.1通则
技术文件条文编排格式参见附录B。
7.2封面
通用技术文件封面的格式见QJ/ML0101-A标准中“格式ML9109”。
企业技术标准封面的格式代号为“ML9004”（参见本标准附录C中图C.1）。
7.3目次
目次中章、条的编号和前言、附录均顶格排。
章、条编号后为标题。
附录编号后为附录的性质，并加圆括号，其后为附录标题。
章、条的标题以及附录的标题与其前面的内容之间
空一个字的间隙。
前言、标题与页码之间用“……”连接，页码不加括号。
目次所列内容回行时顶格排。
通用技术文件目次的格式见QJ/ML0101-A标准中“格式ML9111”，企业技术标准目次的格式为空白页。
编排格式参见本标准附录D中图D.1。
7.4前言
通用技术文件前言的格式见QJ/ML0101-A标准中“格式ML9110”，企业技术标准前言的格式代号为“ML9005”（参见本
升级会员 