由于实际的产品范围、种类不同,产品使用说明书的内容也有所不同。从行业来说,许多行业都有自己产品使用说明书的标准。下面附上一份国家技术监督检验检疫总局、国家标准化管理委员会发布的,GB 9969—2008,《工业产品使用说明书总则》(2008年11月12日发布,2009年5月1日实施)及《附录A》。这是一份关于编制产品使用说明书的标准和规定,共我们参照。
中华人民共和国国家标准工业产品使用说明书总则
中华人民共和国国家质量监督检验检疫总局中国国家标准化管理委员会发布
前言
本标准参考ISO/IEC37号指南:1995《消费品使用说明》(英文版)对GB9969.1-1998进行修订。
本标准代替GB9969.1—1998《工业产品使用说明书总则》。
本标准与GB9969.1—1998相比主要变化如下:
——第1章增加了“本标准也可适用于其他形式的使用说明”;
——3.1修改为“使用说明书是交付产品的必备部分”;
——第3章增加3.2“使用说明书内容应简明、准确、易于阅读和理解;使用说明书不应用来掩盖设计上的缺陷”;
——3.4与GB9969.1—1998中3.3相比,删除“对涉及环境和能源的产品”;
——3.7与GB9969.1—1998中3.6相比,增加了“使用说明书应清晰地指明产品,说明该产品的型号、样式或种类,不应因一种型号与其改进型之间或两种不同的型号之间(不论这种不同有多小),或同一型号下不同规格之间的混淆而导致使用者手中的使用说明与实际使用的产品不符”;
——3.10与GB9969.1—1998中3.9相比,增加了“版本”;
——3.12与GB9969.1—1998中3.11相比,删除了“安装”;
——3.13与GB9969.1—1998中3.12相比,修改为“实行产品标准编号的产品,应在使用说明书上标注有效的产品标准编号”;
——第4章标题修改为“编制要求”;
——第4章中,依据GB5296.1—1997《消费品使用说明总则》,对4.1、4.4进行了修改;
——删除了GB9969.1—1998中4.5.2;
——4.5.3与GB9969.1—1998中4.5.4相比,删除了“出口产品的使用说明书,应在企业名称前加‘中华人民共和国’字样”;
——4.6.1修改为“使用说明书的开本幅面,可采用A4或其他幅面尺寸”;
——4.7中的“警告”修改为“警示”;
——4.8.1增加“在保证安全和正确使用的前提下”;
——增加第A.2章“安全使用注意事项”;
——第A.9章与GB9969.1—1998附录AA.8相比,增加“c)突发事件时的应急措施”;
——第A.13章与GB9969.1—1998附录AA.12相比,标题“其他”改为“环保及其他”,删除“生产厂保证、售后服务事项、联系方法等”和“需要向用户说明的其他事项”,并增加了“有关处置、处理方面的规定”。
本标准的附录A是规范性附录。
本标准由全国服务标准化技术委员会提出并归口。
本标准起草单位:中国标准化研究院、宁波富达电器股份有限公司。
本标准主要起草人:柳成洋、曹俐莉、卢丽丽、李涵、汪文雯、王世川。
本标准所代替标准的历次版本发布情况为:
-GB9969.1—1998;
-GB9969.1—1988。
工业产品说明书总则
1.范围
本标准规定了工业产品使用说明书(以下简称使用说明书)的基本要求和编制方法。
本标准适用于编制非消费品的工业产品使用说明书。
本标准也可适用于其他形式的使用说明。
注:编制消费品使用说明书按GB5296.1—1997《消费品使用说明总则》执行。
2.规范性引用文件
下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引
用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本标准,然而,鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本标准。
GB5296.1—1997消费品使用说明书总则
3.基本要求
3.1 使用说明书是交付产品的必备部分。
3.2 使用说明书内容应简明、准确、易于阅读和理解;使用说明书不应用来掩盖设计上的缺陷。
3.3 使用说明书应明确给出产品用途和适用范围,并根据产品的特点和需要给出主要结构、性能、型号、规格和正确吊运、安装、使用、操作、维修、保养和贮存等方法,以及保护操作者和产品的安全措施。详细内容见附录A。若需要,可提供安装、维修使用说明书。
3.4 使用说明书应提供必要的保护环境和节约能源方面的内容。
3.5 对易燃、易爆、有毒、有腐蚀性、有放射性等性质的产品,使用说明书应包括注意事项、防护措施和发生意外时紧急处理办法等内容。
3.6 当产品结构、性能改动时,使用说明书的有关内容必须按规定程序及时作相应修改。生产者(用质量法中的概念)应向用户提供和产品相对应的说明书。
3.7 使用说明书可按产品型号编制,也可按产品系列、成套产品编制。按系列、成套产品编制时,其内容和参数不同的部分必须明显区分。
复杂产品和成套设备可按功能单元、整机分别编制使用说明书,再按产品型号、用途组合成系统的使用说明书,需要时,可提供成套文件清单。
使用说明书应清晰地指明产品,说明该产品的型号、样式或种类,不应因一种型号与其改进型之间或两种不同的型号之间(不论这种不同有多小),或同一型号下不同规格之间的混淆而导致使用者手中的使用说明与实际使用的产品不符。
3.8 冶金、矿产、建材、化工等原材料类产品及用于主机厂配套的元器件等产品,若其产品手册等技术文件能满足用户对使用说明书的需要时,可用其代替使用说明书。
3.9 对安全限制有要求或存在有效年限的产品应提供产品的生产日期和有效期。
3.10 应标明使用说明书的出版日期或者版本。
3.11 同一产品的技术内容的表述,在生产者的使用说明书和其他各类资料(如,广告或包装)中保持一致。
3.12 当需要时,应在包装或使用说明书封面显著位置注明:“使用产品前请阅读使用说明书”。
3.13 实行生产许可证管理的产品,应在包装上标注有效的生产许可证编号。
4.编制要求
4.1 文字、语言
4.1.1 国内销售的工业产品必须提供中文使用说明书。
注:出口的工业产品需提供销售所在地的官方法定文字编写的使用说明。
4.1.2 国内销售的工业产品,当需要提供一种以上语种的使用说明书时,中文说明须置于外文前,中文标题应醒目、突出,各语种说明应明显分开。
4.1.3 中文使用说明必须采用规范汉字。
注:销往香港、澳门、台湾地区或国外的工业产品,如需方要求,使用说明书可使用繁体字。
4.1.4 当中文使用说明书翻译为内容相同的其他语种并同时提供时,应对所有内容包括注释进行翻译;对于没有图注的图示,可翻译出图示标题,并对原图示加以引用。
4.2 表述的原则
4.2.1 使用说明书内容的表述要科学、合理、符合操作程序,易于用户快速理解掌握。例如:灭火器的使用说明必须保证读者用最短的时间,就能读懂会用。
4.2.2 对于复杂的操作程序,使用说明书应多采用图示、图表和操作程序图进行说明,以帮助用户顺利掌握。
4.2.3 具有几种不同和独立功能的产品的使用说明书,应先介绍产品基本的和通用的功能,然后再介绍其他方面的功能。
4.2.4 使用说明书应尽可能设想用户可能遇到的问题。如产品在不同时间(季节)、不同地点、不同环境条件下可能遇到的问题,并提供预防和解决的办法。
4.2.5 应使用简明的标题和标注,以帮助用户快速找到所需内容。
4.2.6 语句表述应只包含一个要求,或最多包含几个紧密相关的要求。为清楚起见:
——最好使用动词主动态,不用被动态;
——要求应果断有力,而不软弱;
——最好使用行为动词,不用抽象名词;
——表述应直截了当,而不委婉。
语言表述示例如表1。
表1 使用说明书语句表述示例
4.3 图、表、符号、术语
4.3.1 使用说明书中的图、表应和正文印在一起,图、表应按顺序标出序号。
4.3.2 用前文中图、表时,需标图号、表号,并注明其第一次出现时所在页码。
4.3.3 使用说明书中的符号、代号、术语、计量单位应符合最新发布的国家法律、法规和有关标准的规定,并保持前后一致。需要解释的术语应给出定义。
4.3.4 图示、符号、缩略语在使用说明书中第一次出现时应有注释。
4.4 目次(索引表)
4.4.1 当使用说明书超过一页(含折叠形式)以上时,每页都应编号。活页资料、手册等的页数超过4页时,应有一个目次(索引表)。
4.4.2 当使用说明书较长时,应按汉语拼音顺序给出一个关键词的索引,目次应包括索引。
4.4.3 按功能单元、整机组成的复杂产品或成套设备的使用说明书应有总目次。各功能单元、整机的说明书应有详细的目次。
4.5 印制
4.5.1 使用说明书的印制材料应结实耐用,能保证使用说明书在产品寿命期内的可用性。
4.5.2 使用说明书的文字、符号、图、表、照片等应清晰、整齐。双面印制的,不得因背透等原因而影响阅读。
4.5.3 使用说明书的封面应有能准确识别产品类型的名称(如产品型号、牌号、系列等),产品名称和“使用说明书”字样。并应有生产者的名称(厂名)。
4.5.4 使用说明书在封底或封里必须有生产者的详细地址、邮政编码、电话号码等。
4.5.5 允许在封面上印有照片、图形、商标或其他认证标志。
4.6 文本
4.6.1 使用说明书的开本幅面,可采用A4或其他幅面尺寸。
4.6.2 图、表等允许横向加长,确属必要时也可纵向加长。(www.xing528.com)
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
(规范性附录)
使用说明书主要内容
A.1.概述
a)产品特点;
b)主要用途及适用范围(必要时包括不适用范围);
c)品种、规格;
d)型号的组成及其代表意义;
e)使用环境条件;
f)工作条件;
g)对环境及能源的影响;
h)安全。
A.2.安全使用注意事项
a)安全使用期、生产日期、有效期;
b)一般情况的安全使用方法;
c)容易出现错误的使用方法或误操作;
d)错误使用、操作可能造成的伤害;
e)异常情况下的紧急处理措施;
f)特殊情况(停电、移动等)下的注意事项;
g)其他安全警示事项。
A.3.结构特征与工作原理
a)总体结构及其工作原理、工作特征;
b)主要部件或功能单元的结构、作用及其工作原理;
c)各单元结构之间的机电联系、系统工作原理、故障报警系统;
d)辅助装置的功能结构及其工作原理、工作特性。
A.4.技术特性
a)主要性能;
b)主要参数。
A.5.尺寸、重量
a)外形及安装尺寸(可分开);
b)重量。
A.6.安装、调整(或调试)
a)设备基础、安装条件及安装的技术要求;
b)安装程序、方法及注意事项;
c)调整(或调试)程序、方法及注意事项;
d)安装、调整(或调试)后的验收试验项目、方法和判断依据;
e)试运行前的准备、试运行启动、试运行。
A.7.使用、操作
a)使用前的准备和检查;
b)使用前和使用中的安全及安全防护、安全标志及说明;
c)启动及运行过程中的操作程序、方法、注意事项及容易出现的错误操作和防范措施;
d)运行中的监测和记录;
e)停机的操作程序、方法及注意事项。
A.8.故障分析与排除
a)故障现象;
b)原因分析;
c)排除方法。
推荐采用表A.1形式。
表A.1 故障分析与排除示例
A.9.安全保护装置及事故处理(包括消防)
a)安全保护装置及注意事项;
b)出现故障时的处理程序和方法;
c)突发事件时的应急措施。
A.10.保养、维修
a)日常维护、保养、校准;
b)运行时的维护、保养;
c)检修周期;
d)正常维修程序;
e)长期停用时的维护、保养。
A.11.运输、贮存
a)吊装、运输注意事项;
b)贮存条件、贮存期限及注意事项。
A.12.开箱及检查
a)开箱注意事项;
b)检查内容。
A.13.环保及其他有关处置、处理方面的规定
A.14.图、表、照片(也可分列在上述各章中)
a)外形(外观)图、安装图、布置图;
b)结构图;
d)各种附表附件明细表、专用工具(仪表)明细表;
e)照片。
免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。