技术文件编写规定.docVIP

上海宝钢建筑工程设计研究院 作 业 文 件 文件名称：技术文件编写规定 编 号：QC10－2004 版 本 号：A 受 控 号： 持 有 人： 前 言 《技术文件编写规定》（文件编号QC10-2004）现行版本为A版，自2004年10月28日起实施。 文件编写和管理部门 ： 技术质量部 文件起草人 ： 文件审核人 ： 文件批准人 ： 1 适用范围 公司编写的技术文件，包括工程设计、咨询文件和技术服务文件。本规定也可作为编写其他文件的参考。 2 职责和权限 技术质量部为技术文件编写规定的归口管理部门。 3 编写原则 3.1 目的 通过规定明确的条文规范技术文件的编写，以便于与顾客的交流。为实现这一目的，文件应该 ——在其范围所规定的界限内按照需要，力求完整； ——内容和深度符合规定； ——上下文始终保持一致、清楚、准确； ——充分考虑技术的先进性； ——能使未参加制定该文件的有关人员理解。 3.2 文体 文件的编写应尽可能简单、明了。文字表达应准确，采用国务院正式公布、实施的简化汉字。标点符号应符合有关规定。 3.3 统一 文件内，文体和术语、符号、代号应保持一致。应采用类似的措辞表述类似的条文，采用完全相同的措辞表达完全相同的条文。 文件应采用公司规定的计算机软件进行编辑，版本以计算机中心统一安装的为准。 3.4 译文本的等效性 将文件翻译成其他文种时，应在技术上等效，在结构上一致。 4 编写细则 4.1 总体编排 构成一项文件的全部要素分为三类： ——概述要素：包括识别标准，介绍文件的制定，说明文件背景以及与其他文件的关系等内容； ——主体要素：文件的内容、要求和必须遵守的条文； ——补充要素：提供有助于理解文件的补充信息。 一项文件不需要包括上述所有的要素，但可以包括上述要素之外的其他要素。 4.2 概述要素 4.2.1 封面 封面是技术文件的外表面，提供应有的信息，并起保护作用。 封面上可包括下列内容： a) 本单位全称； b) 文件名； c) 责任者姓名，必要时可注明责任者职务、职称； d) 日期。 设计文件封面的格式应与《设计产品标识规定》（QC09-2004）相统一。 除了规定的设计文件以外，封面不是必不可少的。 4.2.2 目次 目次是可酌情取舍的概述要素，但是如果它能使使用者获得对文件的总体概念，而且便于查阅，则是必要的。目次通常只列出章和附录。 4.2.3 引言 引言是可酌情取舍的概述要素，如果需要，则可用来给出关于文件技术内容以及促使制定该文件的原因的特殊信息或说明。 4.3 主体要素 4.3.1 组成 主体要素由正文、表、图、引用等部分组成。 4.3.2 正文 正文包括下列内容： a) 文件的主题、范围及需要说明的问题； b) 产品或服务有关的全部特征； c) 可定量表示的特性所要求的极限值； d) 引用测定或检验特性值的试验方法，或者试验方法本身； e) 需要规定的注意事项或安装指南。 正文可以包括上述内容以外的其他内容。 4.3.3 表 适当时应使用表，以一种易于理解的方式提供信息。每张表在正文中都应明确提及。表应该用从1开始的阿拉伯数字编号，只有一张表则应标明“表1”。表题应放在表的上面，居中编排。 4.3.4 图 适当时应使用图，以一种易于理解的方式提供信息。每幅图在正文中都应明确提及，图样一般应排在有关内容的附近。图应该用从1开始的阿拉伯数字编号，只有一幅图则应标明“图1”。图题应放在图的下面，居中编排。 4.3.5 引用 应尽可能采取引用文本的特定部分的方法，而不要重复写出被引用的内容，以避免失误或不一致。如果必须重复文本内容，其来源应明确标出。 引用包括引用文献。文献序号按文中出现的先后顺序，以阿拉伯数字标注在所指引部分的右上角，并用方括号括起。参考文献表的著录按引用顺序排列，序号不加标点符号，后间空一字。每条著录结尾处不加标点。参考文献表放在正文之后。 4.3.6 数学公式 方程式要用正确的数学形式来表示，其中，用字母符号代表不同的量值，其意义解释写在方程式的下面。说明性的词语或量的名称不应排列成方程式的形式。 较长的式，另行居中横排。如式必须转行时，只能在+、-、×、÷、、处转行。上下式尽可能在等号“=”处对齐。 如有必要对正文中一些公式或所有公式进行编号，应使用带圆括号的阿拉伯数字。示例： X2+Y2=Z2…………………………………………………………………………(1) 这种编号与章、表和图的编号无关。 4.3.7 数值的表述 小数点记号为“ . ” 。小于1的数值写成小数形式时，应在小数记号前加上零。从小数记号向左或向右读时，每三位数一组，用空1/4个汉字同前一位数或后一位数分