说明书编写标准

工业产品使用说明书 总则
GB 9969．1—1998
国家技术监督局1998—03—25批准 1998—10—01实施

1 范围
本标准规定了工业产品使用说明书(以下简称使用说明书)的基本要求和编制方法。
本标准适用于编制非消费品的工业产品使用说明书。
注：编制消费品使用说明书按GB 5296．1—1997《消费品使用说明 总则》执行。

2 引用标准
下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效。所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。
GB／T 1．1—1993 标准化工作导则 第1单元：标准的起草与表述规则 第1部分：标准编写的基本规定
GB 5296．1一1997 消费品使用说明 总则

3 基本要求
3．1 当需要时必须编制使用说明书，使用说明书是交付产品的组成部分。
3，2 使用说明书应明确给出产品用途和适用范围，并根据产品的特点和需要给出主要结构、性能、型式、规格和正确吊运、安装、使用、操作、维修、保养和贮存等方法，以及保护操作者和产品的安全措施。详细内容见附录A(标准的附录)。
3．3 对涉及环境和能源的产品，使用说明书应规定必要的保护环境和节约能源方面的内容。
3．4 对易燃、易爆、有毒、有腐蚀性、有放射性等性质的产品，使用说明书应包括注意事项、防护措施和发生意外时紧急处理办法等内容。
3．5 当产品结构、性能等改动时，使用说明书的有关内容必须按规定程序，及时作相应修改。生产厂应向用户提供和产品对应的说明书。
3．6 使用说明书可按产品型号编制，也可按产品系列、成套产品编制。按系列、成套产品编制时，其内容和参数不同的部分必须明显区分。
复杂产品和成套设备可按功能单元、整机分别编制使用说明书，再按产品型号、用途组合成系统的使用说明书。
3．7 冶金、矿产、建材、化工等原材料类产品及用于主机厂配套的元器件等产品，若其质量证明书、产品手册等技术文件能满足用户对使用说明书的需要时，可用其代替使用说明书。
3．8 对安全限制有要求或存在有效年限的产品应提供产品的生产日期和有效期、储存期。
3．9 应标明使用说明书的出版日期(GB 5296．1—1997中4．10)。
3．10 使用说明书应与生产、制造者印发的有关同种产品的资料，例如广告或包装上的内容一致(GB 5296．1—1997中4．11)。
3．11 当需要时，应在包装或使用说明书封面显著位置注明：“安装、使用产品前，请阅读使用说明书”(GB 5296．1—1997中4．12)。
3．12 使用说明书应标注产品所执行标准的编号和生产许可证号，可标注认证标志。

4 使用说明书的编制
4．1 文字、语言
4．1．1 供国内用户的工业产品必须提供汉语使用说明书。根据需要也可提供汉语和其他语言对照的使用说明书，此时汉语说明位置要醒目、突出。
4．1．2 供出口的工业产品须提供销售地区官方语言编写的使用说明书。当需要提供一种以上语言的使用说明书时，各种语言之间应明显区分。
4．1．3 使用说明书应采用国务院正式公布、实施的简化汉字。销往国外或澳门、台湾地区产品的使用说明书，如用户要求可使用繁体字。
4．1．4 当使用说明书从一种语言翻译成其他语言时，应由有权威的语言专家和技术专家完成翻译的全过程，包括审核(GB 5296．1—1997中8．6．5)。
4．1．5 使用说明书有关安全内容的文字表示规定，见4．7．2。
4．2 表述的原则
4．2．1 使用说明书内容的表述要科学、合理、符合操作程序，易于用户快速理解掌握。例如：灭火器的使用说明必须保证读者用最短的时间，就能读懂会用。
4．2．2 对于复杂的操作程序，使用说明书应多采用图示、图表和操作程序图进行说明，以帮助用户顺利掌握。
4．2．3 具有几种不同和独立功能的产品的使用说明书，应先介绍产品基本的和通常的功能，然后再介绍其他方面的功能。
4．2．4 使用说明书应尽可能设想用户可能遇到的问题。如产品在不同时间(季节)、不同地点、不同环境条件下可能遇到的问题，并提供预防和解决的办法。
4．2．5 应使用简明的标题和标注，以帮助用户快速找到所需内容。
4．2．6 语句表述应只包含一个要求，或最多包含几个紧密相关的要求。为清楚起见
——最好使用动词主动态，不用被动态；
——要求应果断有力，而不软弱；
一最好使用行为动词，不用抽象名词；
——表述应直接了当，而不委婉。
示例如下：
语句表述 应这样表达 不应这样表达
使用主动态 关掉电源 使电源被中断
果断有力 不许动手环 手环不应被动
使用行为动词 避免事故 事故的避免
直接了当 拉操作杆 使用者从机器拉回操作杆

4．3 图、表、符号、术语
4．3．1 使用说明书中的图、表应和正文印在一起，图、表应按顺序标出序号。
4．3．2 引用前文中图、表时，需标图号、表号，并注明其第一次出现时所在页码。
4．3．3 使用说明中的符号、代号、术语、计量单位应符合最新发布的国家法令、法规和有关标准的规定，并保持前后一致。需要解释的术语应给出定义。
4．3．4 图示、符号、缩略语在使用说明书中第一次出现时应有注释。
4．3．5 使用说明书中的图、表、公式、数值的表示方法应符合GB／T 1．1的有关规定。
4．4 目次、目录
4．4．1 当使用说明书超过一页时，每页都应有页码，使用说明书章条较多时，应编写目次。
4．4．2 按功能单元、整机组成的复杂产品或成套设备的使用说明书应有总目录。各功能单元、整机的说明书应有详细的目次。
4．5 印制
4．5．1 使用说明书的印制材料应结实耐用，能保证使用说明书在产品寿命期内的可用性。
4．5．2 批量生产的定型产品其使用说明书一般应采用胶印或铅印印制。
4．5．3 使用说明书的文字、符号、图、表、照片等应清晰、整齐。双面印制者，不得因透背等原因而影响阅读。
4．5．4 使用说明书的封面应有能准确识别产品类型的名称(如产品型号、牌号、系列等)，产品名称和“使用说明书”字样。并应有生产或制造企业的名称(厂名)。出口产品的使用说明书，应在企业名称前加“中华人民共和国”字样。
4．5．5 使用说明书在封底或封里必须有生产企业的详细地址、邮政编码和电话号码。
4．5．6 允许在封面上印有照片、图形和经认可的标记(如注册商标、／‘标等)。
4．6 文本
4．6．1 使用说明书的开本幅面，可采用64开、32开、16开，必要时可采用其他幅面尺寸。
4．6．2 图、表等允许横向加长，确属必要时也可纵向加长。数量多的大幅面的图、表可以分装。
4．6．3 使用说明书根据内容多少可为单页、折页和多页。多页应装订成册。
4．7 安全警告
4．7．1 使用说明书应对涉及安全方面的内容给出安全警告。
4．7．2 安全警告的内容应用较大的字号或不同的字体表示，或用特殊符号或颜色来强调。
4．7．3 为达到最佳效果，有关安全的论述和安全警告的编写应考虑以下几点：
——内容和图解要简明扼要；
——安全警告的位置、内容和形式要醒目；
——确保用户在正常使用产品时，能从使用位置看到存在危险的警告；
——解释伤害的性质(如果需要，解释伤害的原因)；
——对于如何正确操作，给予明确的指导；
——对于如何避免危险，给予明确的指导；
——使用的语言、图形符号和图解说明要清楚、准确；
——如同时要对安全、健康说明时，应优先对安全做说明；
——切记频繁重复警告和错误警告会削弱必要的警告效力。
4．7．4 使用说明书必须按下列等级和警告用语提醒用户：
——“危险”表示对高度危险要警惕；
——“警告”表示对中度危险要警惕；
——“注意”表示对轻度危险要关注。
4．7．5 具有高、中度危险的产品，应将安全警告永久地装制在产品显著位置，以便用户在产品的寿命期内都能清楚看到。使用说明书应指出安全警告的位置，引起使用者的注意。
4．7．6 为了传达危险警告之类的重要信息，应在适当位置使用标准化的用语和／或安全标志或图形符号。这些用语和标志及其位置要求，应在使用说明书中规定。
4．7．7 对视、听警告的位置，警告装置、安全防护用品和设备的管理、维修等内容，使用说明应做出规定。
4．8 内容编排
4．8．1 使用说明书内容编排，可根据具体产品的特点和使用要求对附录A(标准的附录)加以选择增减并合理排序。
4．8．2 附录A(标准的附录)中各章的a)、b)、c)、……仅表示所包括的内容。同时也表示某些内容应在某章中表述，而不一定表示条的名称和编排次序。


附 录 A
(标准的附录)
使用说明书的主要内容

A1 概述
a)产品特点；
b)主要用途及适用范围(必要时包括不适用范围)；
c)品种、规格；
d)型号的组成及其代表意义；
e)使用环境条件；
f)工作条件；
g)对环境及能源的影响；
h)安全。

A2 结构特征与工作原理
a)总体结构及其工作原理、工作特性；
b)主要部件或功能单元的结构、作用及其工作原理；
c)各单元结构之间的机电联系、系统工作原理、故障报警系统；
d)辅助装置的功能结构及其工作原理、工作特性。

A3 技术特性
a)主要性能；
b)主要参数。

A4 尺寸、重量
a)外形及安装尺寸(可分开)；
b)重量。

A5 安装、调整(或调试)
a)设备基础、安装条件及安装的技术要求；
b)安装程序、方法及注意事项；
c)调整(或调试)程序、方法及注意事项；
d)安装、调整(或调试)后的验收试验项目、方法和判据；
e)试运行前的准备、试运行启动、试运行。

A6 使用、操作
a)使用前的准备和检查；
b)使用前和使用中的安全及安全防护、安全标志及说明；
c)启动及运行过程中的操作程序、方法、注意事项及容易出现的错误操作和防范措施；
d)运行中的监测和记录；
e)停机的操作程序、方法及注意事项。

A7 故障分析与排除
a)故障现象；
b)原因分析；
c)排除方法。
推荐采用下列表格形式
故障现象 原因分析 排除方法 备注


A8 安全保护装置及事故处理(包括消防)
a)安全保护装置及注意事项；
b)出现故障时的处理程序和方法。

A9 保养、维修
a)日常维护、保养、校准；
b)运行时的维护、保养；
c)检修周期；
d)正常维修程序；
e)长期停放时的维护、保养。

A10 运输、贮存
a)吊装、运输注意事项；
b)贮存条件、贮存期限及注意事项。

A11 开箱及检查
a)开箱注意事项；
b)检查内容。

A12 其他
a)生产厂保证、售后服务事项、联系方法等；
b)需要向用户说明的其他事项。

A13 图、表、照片(也可分列在上述各章中)
a)外形(外观)图、安装图、布置图；
b)结构图；
c)原理图、系统图、电路图、逻辑图、示意图、接线图、施工图等；
d)各种附表：附件明细表、专用工具(仪表)明细表；
e)照片。