GB/T 19678-2005 说明书的编制 构成、内容和表示方法

ICS29.020

K04荡黔

中华人民共和国国家标准

GB/T19678-2005/IEC62079:2001

说明书的编制构成、内容和表示方法

Preparationofinstructions-Structuring,contentandpresentation

(IEC62079:2001,IDT)

2005-03-03发布2005-08-01实施

中华人民共和国国家质量监督检验检疫总局发布

中国国家标准化管理委员会

GB/T19678-2005/IEC62079;2001

目次

前言···················，·············································，···············································……m

引言·············································································································……N

1范围·············································································，······························……1

2规范性引用文件······················································，·····································……1

3术语和定义···························································································，······……2

4原则···，·············································································，···························……4

4.1说明书是产品的组成部分··········，·····································································…·…4

4.2把风险减到最小························，··················，·································……，····……4

4.3特殊处置·······，······································，······················································……4

4.4特殊目标群体·······························，·····，·················································.·...·，，·……4

4.5低寿命产品·····························，·······························.···，······，···.···········.·……4

4.6说明书需要考虑的事项·、“、··、···，，、，，································，·····························……4

4.7说明书的编制·································································.········..……，，，.…6

5说明书的内容····························，·············································.·····……，，……7

5.1通则··············································，·········································，··············……7

5.2产品标识与规范、一般警告····························································，···················…·…7

5.3说明文件的标识······························································，·········.·········.·……，.…8

5.4产品修改···············································································，················……，，，…8

5.5安全提示········，····························································································……8

5.6预定的环境·······································································，··························……8

5.7合格声明·······························································，···························，········……9

5.8如何使用说明资料···························、·、··········、·、·‘·、·、、、、·，，、，、·、、、、·、·····，·，。、···…·…9

5.9为产品使用作准备···············································，·······································……9

5.1。使用说明书································································································……10

5.11维修说明书·················，··························································.·········……，··……11

5.12备件表·····················································，·，··············································……12

5.13专用工具、设备和材料的说明书······································································……12

5.14修理和替换零件的说明书，································，，·····························，·····……“”’“‘13

5.15停止产品使用(停止运行)··············································································……13

5.16目录、索引和其他清单、定义及元句法(meta-syntax)13

6说明书的表示方法····················，·································，·····。·······························……14

6.1交流原则·················，···································，················································……14

6.2可读性·····················，····，·······························，··············································……14

6.3图解·························，····································，··································，·········……15

6.4图形符号·················，···，，·······························································，···············……15

6.5表格···························，·······························，··············································……16

6.6表图和简图··································································································……16

6.7流程表图和流程简图··················································，····································……16

I

GB/T19678-2005/IEC62079:2001

6.8电子媒体、音频、视频·································，························..·······.·……，……16

6.9突出警告标志················，···························································.·.……，……，16

6.10颜色和颜色代码···································‘····································…‘…，……，…17

6.11可视和可听指示的说明················，···································，·.·····，·…·，···.·……，……17

附录A(资料性附录)说明书使用价值的评价··························，·································……18

附录B(资料性附录)合格检查表;技术评价···························································……20

附录C(资料性附录)评价检查表;表示评价····························································……23

附录D(资料性附录)用户说明书目录示例···················，············································，一27

参考文献························，·············，·········，·························································……29

GB/T19678-2005/IEC62079:2001

前言

本标准等同采用IEC62079:2001说《明书的编制—构成、内容和表示方法》(英文版)。

本标准的附录A、附录B、附录C、附录D都是资料性附录。

本标准由全国电气信息结构、文件编制和图形符号标准化技术委员会提出并归口。

本标准负责起草单位:机械科学研究院中机生产力促进中心。

参加起草的单位还有:国电华北电力设计院工程有限公司、中国航空综合技术研究所、北京钢铁设

计研究总院、中国航空工业规划设计研究院、成都电业局电力勘察设计院、辽宁立德电力电子有限公司、

凌海科诚电力电器制造有限责任公司。

本标准主要起草人:郭汀、高惠民、沈兵、曾幼云、陈泽毅、方玉涛、王春海、王健斌

GB/T19678-2005/IEC62079:2001

引言

本标准提供了编制产品用户说明书时应遵循的要求和方法规则

说明书是告知用户如何以正确的和安全的方式使用产品信息的工具。可以单独或综合使用文本、

文字、标记、符号、简图、图解和可听或可见信息作为交流手段。

因产品特征、复杂性、风险和法定要求的不同，用户用的信息可以在产品或其包装上，或所附的资料

中，例如活页、手册、录音和录像带以及利用计算机的表示形式，它们可单独使用或结合使用。

不存在一种总标准可以提供包括每种特殊情况的全面的信息。因此，本标准要与特定产品标准的

要求一起使用，或者，如果无此标准，则与类似产品标准的相关要求一起使用。还要提醒本标准的用户，

某些产品和供他们使用的随机说明书要遵从于法规，这些法规可能包含安全和废弃物的特殊要求。因

而本标准可作为未来特定产品标准参照的框架。

在多数情况下，将来为产品提供的说明书是由制造或供应方和用户双方协商形成的。为了此种协

商，本标准列举了多种多样的说明书可作为框架。

还应提及的是，在多数国家中，要提供的说明书数量取决于区域的或国家的法规，如欧盟的机械

指令。

说明书质量的评价应遵循共同的准则，因而，本标准提供了若干资料性附录，这些附录包含一些实

用性的推荐材料以及用于评价的推荐方法。附录A、附录B和附录C首先是向从事这样的评价工作的

专家建议的，但它们对上面提及的标准的主要对象群体也是有帮助的。

GB/T19678-2005/IEC62079:2001

说明书的编制构成、内容和表示方法

1范围

本标准规定了设计和编写各类说明书的一般原则和详细要求。说明书对各种类型的产品—从简

单的一罐油漆，到复杂的大型工业成套设备—都适用。本标准适用于下列人员:

—产品制造商、专业作者、专业插图作者、软件设计者、译者或从事构思和起草说明书工作的其他

人员;

—安装和(或)使用产品的产品制造商的指定代表。

在产品供应方和用户之间协商合同时说明书也是有用的

本标准未规定应随产品一起提供的文件的固定数量。显然要作出这样的规定是不可能的，因为本

标准对一切类型的产品都应有效，而文件的数量大多取决于产品的复杂性。因此，本标准列出了可能考

虑到的多种多样说明书。本标准旨在对这样的说明书如何编制实行标准化。

2规范性引用文件

下列文件中的条款通过本标准的引用而成为本部分的条款。凡是注日期的引用文件，其随后所有

的修改单(不包括勘误的内容)或修订版均不适用于本部分，然而，鼓励根据本标准达成协议的各方研究

是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。

GB/T4025-2003人一机界面标志标识的基本和安全规则指示器和操作器的编码规则(idtIEC

60073)

GB/T4728(所有部分)电气简图用图形符号(idtIEC60617)

GB/T5094.1-2002工业系统、装置与设备以及工业产品结构原则与参照代号第1部分:基本

规则(IEC61346-1:1996,IDT)

GB/T5465(所有部分)电气设备用图形符号(GB/T5465.1-1996,eqvIEC416:1988;

GB/T5465.2-1996,idtIEC60417:1994)

GB/T6988.1-1997电气技术用文件的编制第1部分:一般要求(idtIEC61082-1:1991)

GB/T6988.3-1997电气技术用文件的编制第3部分:接线图与接线表(idtIEC61082-3:

1993)

GB/T6988.4-2002电气技术用文件的编制第4部分:位置文件与安装文件(idtIEC61082-4:

1996)

GB/T15706.1-1995机械安全基本概念与设计通则第1部分:基本术语、方法学(eqvISO/

TR12100-1:1992)

GB/T16901.2-200。图形符号表示规则产品技术文件用图形符号第2部分:图形符号(包

括基准库中的图形符号)的计算机电子文件格式规范及其交换要求((eqvIEC81714-2:1998)

GB/T16935.1-1997低压系统内设备的绝缘配合第一部分:原理、要求和试验(idtIEC

60664-1:1992)

IEC60050(191):1990国际电工词汇(IEV)第191章:可信性与服务质量

IEC60050(195):1998国际电工词汇(IEV)第195章:接地与电击防护

IEC60204-1:1997工业机械的电气设备第1部分:一般要求

IEC60848:1998控制系统功能表图的编制

IEC61310-1:1995机械设备的安全—指示、标记和驱动第一部分:可视、可听和可触知信

t

GB/T19678-2005/IEC62079:2001

号的要求

IEC61355:1997工厂、系统和设备用文件的分类和代号

IEC61506:1997工业过程测量与控制—应用软件文件编制

ISO1000:1992国际单位和供使用的其倍数和某些其他单位的建议

ISO3864:1984安全色和安全标志

ISO7000:1989设备用图形符号—索引与提要

ISO7001:1990公共信息符号

ISO9241(所有部分)带视频显示终端(VDTS)的办公室工作的人机工程要求

ISO10303-203:1994工业自动化系统与集成—产品数据表示法与交换一一第203部分:应用

协议:配置受控设计

ISO10628:1997加工工厂的流程图—一般规则

ISO14617"(所有部分)简图用图形符号

ISO/IEC导则14:1977供用户用的产品信息

ISO/IEC导则50:1987儿童安全与标准—一般准则

ISO/IEC导则51:1999安全方面—标准中的导则

3术语和定义

下列术语和定义适用于本标准。

更改change

改变产品原型、修改型或补充的行为，或将更改请求纳人设计从而形成新型产品的行为

[修改后的ISO10303-203口

3.2

试运转commissioning

交付产品准备投人运营之前或与此有关的程序，包括最终验收测试、交付使用、维护和修理的图样、

说明书，必要时还包括对有关人员的培训。

3.3

护栏guard

用围栏专门提供防护的产品的一部分

3.4

损伤ha而

对人们健康的实际伤害或损害，或者对财产或环境的损坏。

[ISO/IEC导则51:1999,3.31

3.5

危险haza川

损伤的潜在源。

[ISO/IEC导则51:1999,3.5口

3.6

(使用)说明书instruction(foruse)

产品制造者提供的安全而有效使用产品的信息。

1)正在出版过程中。(此为IEC62079:2001发布时ISO14617的状态，现已正式出版。)

GB/T19678-2005/IEC62079:2001

3.7

说明资料instructionmaterial

包含说明书的任何可用的传达信息的工具。

3.8

手册manual

包含用户信息的文件，如说明书。

3.9

维护maintenance

所有技术和管理工作的组合，意在保持一个项目或一个产品处于有效的和安全的状态，或经过修复

达到此状态，在此状态下可以完成所需功能，这些工作包括检测、更新、修理、调节和清理等工作

[修改后的IEV191-07-OIJ

3.10

标记marking

由元件或器件制造商添加的用来标识元件或器件类型的标志以及为安全使用表示产品某些特征的

代号

[修改后的IEC60204-1:1997,3.34]

3.11

修改modification

a)为了改变或扩展产品预定用途对之进行的更改。

b)产品修改后对说明书的修订。

3.12

防护器件protectivedevice

减少危险的安全器件(非护栏)(例如机械脱扣器件、电敏防护设备、压敏防护器件)

[ISO12100-1,3.23]

3.13

修理repair

对某个项目进行故障检修的一部分，包括替换已损坏的零件和重做有缺陷或已损坏的零件或功能

[修改后的IEV191-07-19习

3.14

可合理预见的误用reasonablyforeseeablemisuse

产品、程序或维修件的使用未按供应方预定的方法，但它们可以迅速导致预知的人的行为

[ISO/IEC导则51:1999,3.141

3.15

风险risk

发生伤害的可能性和该伤害严重程度的结合。

[ISO/IEC导则51:1999,3.21

3.16

服务service

由供应方组织提供给用户的全套功能，通过维修来支持用户。

[修改后的IEV191-01-04口

3.17

技术熟练人员skilledperson

具有适当教育和经验的人员，教育和经验使他(她)能够发现和避免产品运行或维修中可能产生的

GB/T19678-2005/IEC62079:2001

风险和危险。

[IEV195-04-01和修改后的IEC60204-1:1997的3.5.2口

3.18

规范specification

只规定与制件、制成件或产品有关的质量要求、功能特性、工艺或规则的文件。

[修改后的ISO10303-203:1994,4.2.31]

3.19

供应方supplier

提供产品和(或)相关服务的人或组织(例如制造商、承包商、安装者、集成商)。

3.20

用户;使用者“er

具有使用产品和(或)使产品执行所需功能(包括产品寿命结束时从清理到停止运行一系列工作)的

能力的人或组织。

注说明书可使用户高效使用产品，减少为使用、修理或修改产品所需花费的时间，同时可减少由于缺乏对产品的

了解而可能造成的偶然伤害和故障。

4原则

4.1说明书是产品的组成部分

说明书是交付产品不可缺少的部分。它们应创造条件促使用户正确使用产品。

说明书的信息内容应包括用户所预期的全部责任。因此，说明书的内容取决于交付的类型。例如，

如果安装和试运转包括在交付范围之内，则提供给用户的说明书只包括使用和维修的信息。

4.2把风险减到最小

说明书是产品安全理念不可缺少的部分。它们应给使用者提供避免不能承受的风险、损坏产品以

及错误动作或低效工作的信息，但不能用来补偿设计缺陷。它们应直接帮助避免可能带来伤害的可预

知的误用，因此，

—应提及可合理预见到的误用和产品的风险;

—应适当地给出警告(按ISO/IEC导则51),

注:在绝大多数国家中，供应方有法定义务把这种警告包括进去

4.3特殊处置

如果适当，应规定特殊防护措施要求，例如，为保护用户和现场人员的安全需要成年人的监督或穿

着专门的工作服。对于特定的人群，如儿童和老年人以及丧失劳动能力者，需要时，也应给出警告(见

ISO/IEC导则50)0

4.4特殊目标群体

如果某些说明只针对特定的人群(如用于安装、修理或某些类型的维护)，则应单独提供并应适当注

明，在某些情况下，不必把它们附属于产品。

4.5低寿命产品

对于安全或有效寿命有限期的产品，应注明制造年份和(或)到期年份。

4.6说明书需要考虑的事项

应考虑下列一个或多个因素或产品特征:

—风险(见3.15);

—环境、法律或类似的要求;

—产品设计(如复杂程度);

—由于产品的使用不能通过产品本身完全了解，使用者需要信息，应考虑并决定如下事项对所定

GB/T19678-2005/IEC62079:2001

的任务是否适当:

—说明书的位置((4.6.1);

—选择的交流媒体((4.6.2);

—说明书的使用期限((4.6.3);

—说明书的可用性((4.6.4);

—使用者的指导系统((4.6.5);

—使用者的培训((4.6.6)0

《说明书使用价值的评价》见附录A,《合格检查表;技术评价》见附录B,评《价检查表;表达评价》

见附录Co

4.6.1位ti

说明书(或其有关部分)应用下列一种或多种方法给出:

在产品上(如用图形符号、颜色、简短文字);

在包装上(如拆包说明);

—在随机文件(如活页或手册)或在线文件(例如CD?ROM,Web，在线求助系统)内;

—在随机资料内(例如提示卡、告示、计算机程序和显示)。

说明书复杂时，可把某些重要信息在产品上给出或显示(例如用简短的说明或提示卡、告示、图形符

号或标记)(也见6.2.4)。

4.6.2媒体

应该确定各种情况适用何种交流手段，例如

—图形符号;

—文字或语音交流;

—带文字和图解的活页;

—使用者、维修人员手册;

—软件支持的使用指南((4.6.5)等。

注:将说明书置于产品内对使用者有明显的好处。但对某些产品来说，由于它们尺寸小