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

 

1  范围

GB/T 19678--2005/IEC 62079=200

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

    本标准规定了设计和编写各类说明书的一般原则和详细要求。说明书对各种类型的产品——从简单的一罐油漆，到复杂的大型工业成套设备——都适用。本标准适用于下列人员：

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

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

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

    本标准未规定应随产品一起提供的文件的固定数量。显然要作出这样的规定是不可能的，因为本标准对一切类型的产品都应有效，而文件的数量大多取决于产品的复杂性。因此，本标准列出了可能考虑到的多种多样说明书。本标准旨在对这样的说明书如何编制实行标准化。

2规范性引用文件

    下列文件中的条款通过本标准的引用而成为本部分的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本部分，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。

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

    GB/T 4728(所有部分)  电气简图用图形符号(idt IEC 60617)

    GB/T 5094.1--2002工业系统、装置与设备以及工业产品结构原则与参照代号第1部分：基本规则(IEC 61346-I：1996, IDT)

    GB/T 5465（所有部分）  电气设备用图形符号  (GB/T  5465.  1--1996，eqv IEC 416. 1988;GB/T 5465.2--1996,idt IEC 60417:1994)

    GB/T 6988.1--1997  电气技术用文件的编制  第1部分：一般要求(idt IEC 61082-1：1991)GB/T 6988.3--1997  电气技术用文件的编制  第3部分：接线图与接线表(idt IEC 61082-3:1993)

    GB/T 6988.4--2002  电气技术用文件的编制  第4部分：位置文件与安装文件(idt IEC 61082-4:1996)

    GB/T  15706.1--1995  机械安全基本概念与设计通则第1部分：基本术语、方法学(eqv ISO/TR 12100-1:1992)

    GB/T 16901.2--2000图形符号表示规则产品技术文件用图形符号  第2部分。图形符号（包括基准库中的图形符号）的计算机电子文件格式规范及其交换要求(eqv IEC 81714-2,1998)

    GB/T 16935.1--1997  低压系统内设备的绝缘配合  第一部分：原理、要求和试验(idt IEC60664-1:1992)

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

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

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

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

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

    IEC 61355:]997工厂、系统和设备用文件的分类和代号

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

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

    IS03864:1984  安全色和安全标志

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

    IS0 7001:1990公共信息符号

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

    IS0 10303-203=1994工业自动化系统与集成——产品数据表示法与交换——第203部分：应用协义：配置受控设计

    IS0 10628=1997  加工工厂的流程图——一般规则

    IS() 146171)（所有部分）  简图用图形符号

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

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

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

3  术语和定义

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

3.1

    更改change

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

    [修改后的IS0 10303-203]

3.2

    试运转  commissioning

    交付产品准备投入运营之前或与此有关的程序，包括最终验收测试、交付使用、维护和修理的图样说明书，必要时还包括对有关人员的培训。

3.3

    护栏guard

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

3.4

  损伤harm

  对人们健康的实际伤害或损害，或者对财产或环境的损坏。[ISO/IEC导则51：1999，3.33

3.5

    危险hazard

    损伤的潜在源。

    [ISO/IEC导则51:1999，3.5]

3.6

    （使用）说明书  instruction(for use)

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

1)  正在出版过程中．（此为IEC 62079,2001发布时IS0 14617的状态，现已正式出版。）

3.7

    说明资料  instruction material

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

3.8

    手册  manual

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

3.9

    维护  maintenance

    所有技术和管理工作的组合，意在保持一个项目或一个产品处于有效的和安全的状态，或经过修复达到此状态，在此状态下可以完成所需功能，这些工作包括检测、更新、修理、调节和清理等工作。[修改后的IEV 191-07-0]

3.10

    标记  marking

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

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

3.11

    修改  modification

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

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

3.12

    防护器件  protective device

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

    [IS0 12100-1，3.23]

3.13

    修理repair

191-07-19]

3.14

    可合理预见的误用  reasonably foreseeable misuse

    产品、程序或维修件的使用未按供应方预定的方法，但它们可以迅速导致预知的人的行为。 ISO/IEC导则51:1999，3.143

3.15

    风险risk

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

    EISO/1EC导则51:1999，3.2]

3.16

    服务service

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

    [修改后的IEV 191-01-04]

3.17

    技术熟练人员  skilled person

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

   GB/T 19678--2005/IEC 62079:2001

风险和危险。

    [IEV 195-04-01和修改后的IEC 60204-1:1997的3.5.2]

3.18

    规范  specification

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

    [修改后的IS0 10303-203:1994，4.2.31]

3.19

    供应方  supplier

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

3.20

    用户l使用者  user

    具有使用产品和（或）使产品执行所需功能（包括产品寿命结束时从清理到停止运行一系列工作）的能力的人或组织。

    注，说明书可使用户高效使用产品，减少为使用、修理或修改产品所需花费的时间，同时可减少由于缺乏对产品的了解而可能造成的偶然伤害和故障．

4  原则

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

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

    说明书的信息内容应包括用户所预期的全部责任。因此，说明书的内容取决于交付的类型。例如，如果安装和试运转包括在交付范围之内，则提供给用户的说明书只包括使用和维修的信息。

4.2把风险减到最小

    说明书是产品安全理念不可缺少的部分。它们应给使用者提供避免不能承受的风险、损坏产品以及错误动作或低效工作的信息，但不能用来补偿设计缺陷。它们应直接帮助避免可能带来伤害的可预知的误用，因此，

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

    ——应适当地给出警告（按ISO/IEC导则51）。

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

4.3特殊处置

    如果适当，应规定特殊防护措施要求，例如，为保护用户和现场人员的安全需要成年人的监督或穿着专门的工作服。对于特定的人群，如儿童和老年人以及丧失劳动能力者，需要时，也应给出警告(见ISO/IEC导则50)。

4.4特殊目标群体

    如果某些说明只针对特定的人群（如用于安装、修理或某些类型的维护），则应单独提供并应适当注明，在某些情况下，不必把它们附属于产品。

4.5低寿命产品

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

4.6说明书需要考虑的事项

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

    ——风险（见3.15）

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

    ——产品设计（如复杂程度）；

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

    的任务是否适当：

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

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

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

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

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

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

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

见附录C。

4.6.1  位置

    说明书（或其有关部分）应用下列一种或多种方法给出：

    ——在产品上（如用图形符号、颜色、简短文字）

    ——在包装上（如拆包说明）；

    ——在随机文件（如活页或手册）或在线文件（例如CD-ROM，Web，在线求助系统）内

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

    说明书复杂时，可把某些重要信息在产品上给出或显示（侧如用简短的说明或提示卡、告示、图形符号或标记）（也见6.2.4）。

4.6.2媒体

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

    ——图形符号；

    ——文字或语音交流；

    ——带文字和图解的活页，

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

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

    注。将说明书置于产品内对使用者有明显的好处。但对某些产品来说，由于它们尺寸小或形状所限，或者当使用时

    它们的局部挡住视线，把说明书的一部分或全部置于随机资料中可能是最佳的，或许是唯一的解决办法。

4.6.3使用期限

    因计划使用地的环境和产品预期寿命的不同，应作以下考虑：

    ——在产品整个预期寿命内，产品的说明书应是永久性的并且字迹清楚（也见6.2.4）。

    ——在包装上或在随机资料内提供的说明书（如活页、手册、数据媒体等）应耐用；它们的设计和制作，在产品计划使用环境中的预期寿命内，要经碍起持续不断的使用。

4.6.4说明书的可用性

    在说明书上标出“妥善保存以备将来参考”可能是有益的——但初始装配或安装所需要的除外。供应方在产品的整个预期寿命内应负责更换所有这些说明书的复印件。

    由于包装常常是非永久性的，并且在拆包过程中要受到破坏，一般不要求把包装说明长期存放以备将来参考用。如果这种情况不可避免（例如某种实际的原因），要保存它们以备将来参考的通告应明确地示出。如果包装的一部分由于它内装说明书需要保存的话，则该部分应易于与包装的剩余部分分开。

    对于电子数据媒体的说明书，应采取措施以便在整个产品寿命期内它们都是可读的，而与例如软件的更改无关。

4.6.5用户指导系统

    复杂或危险的系统往往具有失效一救助功能的控制系统，因为用户在没有自动控制系统的帮助下不能控制整个操作系统。建议这样的系统以显示屏或其他手段给用户提供使用指南，它们会有适当的可预知不希望状态的警告。

    如果适用，应满足符号与可听和可视指示的要求（也见6.4和6.11）。

4.6.6使用者的培训

    文件不能满足4.1规定的一般要求时，由于产品的复杂性，或需要更广泛的用户信息，或者使用者知识不足，可提供使用者培训课程。

4.7说明书的编制

4.7.1  真实性与一致性

4.7.1.1  说明书与产品的关系

    说明书应明确地与所供应的产品相关联，因此，它们应重复标记产品的信息，即制造商的名称和地址、系列代号或型号、序号以及表示产品符合公认标准的标记（如果可用）。

4.7.1.2产品的不同型式

    如果说明书提到有一种以上的变型，则特定变型的信息应可清楚地识别。

4.7.1.3安装与维修支持

    应包括便于安装和维修的信息，如特定产品供应方的地址或指定的维修站。

4.7.1.4标识一致

    说明书应与供应方发出的同一产品的所有其他材料如广告材料或包装材料一致。

4.7.1.5计量单位

    说明书中所表示的量应遵从设备上所用的计量单位，优先用Sl单位（国际计量单位制）或SI的导出单位(见IS0 1000)。

4.7.1.6可选模块与附件

    有关可选模块或附件的说明书应与总说明书明显地分开，也应与其他模块或附件的说明书分开（例如用分开的章节、标题等），以使用户不致被无关信息干扰。

    示例如果产品可选用充电电池充电的手段，而在电池夹中又可能装有非充电电池，应提出不准对非充电电池充电的警告，并告示可以与充电电池一起使用的其他充电电池的型号。

4.7.1.7特殊工具、设备、材料

    只要适当，说明书应包含互连附件和其他设备的说明，同时包含相应附件、可拆卸部件和一些特殊材料的指标。说明书还应包含获得特殊工具、材料等以及技术帮助的供应方名称和地址。

    为了替换、修理、再加工、再装填等等需要，应提供重包装说明书。

4.7.2目标群体的考虑

4.7.2.1  文本可懂

    当预知产品将由非专业人员使用时，说明书的编写应取普通人易懂的形式。难免有普通人不能理解的技术术语和表达式时，应对它们的意义进行解释。

4.7.2.2信号要加以说明

    信号要加以说明，以便使用者能明确地识别它们。

4.7.2.3特定用户的说明书

    如果某些说明书由特定的用户群专用，如管理儿童的成年人，则应单独提供说明书（见4.4和5.2）。

4.7.2.4不同的说明文件

    可能需要不同类型的说明文件。例如：对于汽车，有用户自行维修指南和供维修商用的修理手册。

在分工方面也应考虑不同类型，例如，由用户进行的日常维修工作，和需要有适当培训的人或有工具和适当文件的、受过培训的技师的修理工作。

4.7.3语种

4.7.3.1通则

    在决定说明书用单一语种或多个语种时，应考虑预定的用户（说明书的目标群体）。说明书语种通常经过合同约定。

    如果使用一个以上的语种，则每一语种应清晰地与其他语种相区别，并应努力把译文和相关图解一并保存。

    不同语种的说明书最好分开提供，例如，作为分开的活页或手册，或者作为分开的章节或分页。

    注1：许多国家中，用产品使用国的官方语言提供用户信息为法定的要求．

    注2：因说明书目标群体和信息计划用途的不同，对于不同的说明书（例如维修、使用、处理等）可以使用不同的

    语种。

4.7.3.2使用说明符号

    由于一般可利用的空间有限，特别是当使用说明书的国家有一种以上的官方语言时，发出的产品说明书可能出现语种的问题。制造产品时要知道销往国或许不可能，但问题可以这样解决；

    ——采用图形符号（见6.4），只要这些符号被用户清楚识别；

    一一采用数字，在随机文件中用适当的语言对其意义进行解释；

    ——采用已被国际公认的文字或缩写(如STOP、MAX、MIN)。

4.7.3.3  文字与图解相邻

    需要一起阅读的文字和图解应相邻。在需要的地方，图解应用每一种语言重复制作。如果图勰的设计可以适用于说明标识部分的多种语言，则无需有各自单独的图解。图解标题的编写只应使用相邻文字的语种（也见6.3.2）。

4.7.3.4译文正确（译文质量）

    如果说明书是从原始语种译成其他语种，则过程中的每一步都应由可胜任的专门翻译来完成，包括检查和校读。

5说明书的内容

5.1  通则

    说明书的内容要考虑如下要求和建议：

    ——所有产品都需要的（如5.3b）、5.2 e））

    ——特定产品的（如5.5、5.10.2）；

    ——对特定工作的（如5.9.1、5.11.3）

    ——只对大型复杂产品、机械和成套设备的(如5.9.4、5.14)。

    对于特定工作（如运输、安装、维修）的人员，其特定说明书应编制单独的文件。

5.2产品标识与规范、一般警告

    因产品类型不同，规范表应通过如下信息向用户提供产品标识以及要求、性能和容量总的概况：

    a)采用参照代号、序号、名称、模式和（或）型号的产品标识

    b)产品供应方的名称或商标f如果适当，还应包括电话和传真号以及电子邮件地址；

    c)  产品上的标识部位；

    d)  用户类型的说明（例如，如果只限于熟练人员使用）以及为正常工作典型的聘用工作人员的要求，

    e)产品的计划用途、主要功能和应用范围；

    f)如5.5未提及，工作和贮存的气候条件限制（例如温度范围、气体爆炸危险区域应用的限制、湿度、户外工作）‘

    g)总尺寸、质量、容量、性能数据；

    h)电力、气、水和其他消耗品如洗涤剂、润滑剂、清洁材料的供给数据以及熔断器（熔断器型式、额定值和特性）’

    i)  能源消耗与条件、电击防护等级（Ⅱ类设备用符号GB/T 5465.2--5172标记，Ⅲ类设备用符号

    GB/T 5465.2--5180标记）和IP代码I

    j)  在特定工作条件下噪声、气体、废水等的数量，

    k)  电磁兼容性(EMC)；

    1)如5.5或5.10.6未提及，有关人身防护设备（例如工作服、防护眼镜）和对特定人群伤害的一般信息；

    m)5.9.3、5.10或5．-15.3未提及的有关安全处置的建议}

    n)  其他文件中未提供的任何担保条件（例如终止日期、非供应方提供的修改后终止）；

    o)  由于使用或处置产品或其副产品所引起任何伤害的明显文字和（或）符号形式的警告；

    p)  防止可合理预见到的误用的警告；

    q)  辐射带来伤害的警告（例如激光、微波、紫外线、超声）。

5.3说明文件的标识

    说明书应有唯一的识别标记，包括

    a)识别号；

    b)  发行日期，

    c)必要时更改标志和更改日期I

    d)若与5.2 b）不同，说明书出版者的名称和地址。

    注：应给出文件的标题或名称．如果文件贮存在文件管理系统中，为了检索的需要，应补充例如按IEC 61355的文

    件种类代号的分类标志，以方便该文件的检索．也可以考虑其他分类标志，例如关键字，

    说明书应表明它们是否适用于产品的任何修改。如果适合，应给出用户修改产品或工具的方法，包括说明书的修改（见5.4）。   

 5.4产品修改

    给予用户的用于说明允许产品修改的说明书应足够详尽并清楚地描述和说明用户如何正确地修改产品，以保证连续安全和有效的工作。

    如果产品的修改是在产品已验收并使用之后，例如是以下情况：

    ——供应方与用户间的契约协议I

    ——安全缺陷需收回产品。

    建议对说明书进行适当的修改。

5.5安全提示

    除了产品规范中的一般警告外，应在专用说明书，例如安装、使用、维修和停产说明书的适当章节中给出安全操作的建议和（或）安全提示。

    下面给出专门的安全提示的例子。

    伤害警告和应用限制（例如：不适用于浴室或类似潮湿场所）在用户说明书的规格表上、在推销的活页中以及销售地点应清晰可见（并见ISO/IEC导则14）。

    如果安全地使用产品需要人身防护设备，应给出明确的告示，并且应该在销售地点的包装上以及产品上突出地显现该信息。

    注：如果购买产品需要根据说明书作出抉择，则在销售地点应提供此种说明书或其有关部分．此种产品信息应包括本标准提出的警告，例如需要防护工作服，以及对父母限制儿童使用的警告．

5.6预定的环境

    应该给出工作的界限和降低额定值使用的条件，如果需要，还应给出特定物理环境条件下的测试条件。例如：

  ——工作和贮存的环境空气温度范围l

  ——湿度和海水状况；

  ——海拔高度，

  ——污染物和污秽等级（见GB/T 16935.1）以及爆炸性气体、锯屑等；

    ——振动、冲击和撞击，

    ——通告，如“仅供室内使用”。

5.7合格声明

    如有必要，说明资料应包括一种文件或一种提示，即制造商用来证明产品符合法律或合同的要求

（例如“制造商的声明”或“合格声明”），并且，如有必要，测试标志由独立测试单位重发。

5.8如何使用说明资料

    a)  资料的重要性

    提示用户注意资料的重要性：

    ——说明资料是产品的组成部分；

    ——在产品寿命期内要保存它们，

    ——把它们传给产品的任何后续持有者或用户；

    ——如合适，要保证把收到的任何修改汇人文件。

    b)  如果复杂产品包含几个子系统或辅助产品，则对于每个系统都应提供详细资料及安全使用说明。说明资料应指明产品不同功能的部分对应于说明书的哪一部分。每一部分应有清楚的

    标识。

5.9为产品使用作准备

    如果产品的若干部分交付以后，在安装前直至使用，需要贮存的时间较长（例如大型机械成套设备），则说明书应提供在拆包、质量检查和贮存时防止损坏所需的信息。

    因此，这样的说明书应包含运输（见5.9.1）、贮存（见5.9.2）、安装（见5.9.3）和试运转（见5.9.4）必需的信息。（见GB/T 6988.1和GB/T 6988.4。）

    小型或简单产品只需此种说明书的一部分。

5.9.1  运输

    说明书应包含以下内容：

    ——尺寸、质量值、重心位置；

    ——运输吊装说明（例如指示起吊设备的固定点的图）。

5.9.2贮存

    说明书应包含以下内容：

    ——产品贮存条件

    ——包装、重新包装和拆包说明，包含在运输和贮存过程中为保护和保存产品所采取的措施细节

    ——包装或物品清单。

5.9.3安装

    说明书应包含以下内容：

    ——拆包（有外包装的）程序、拆除运输和包装限制物、设备运输夹紧物以及拆除并安全处置保护性和保存性包装的方法；

  ——物品清单I

  ——固定（拴住）和减振要求l

  ——基座或类似基础的型式和质量，

  ——产品发生的噪声、振动、辐射、气体、水蒸汽、尘埃的规范，防止传播的措施，例如推荐的通风、阻尼元件等；

    ——使用、维修的最小空间；

    ——布局设计l

    ——表示元件位置的安装设计（见GB/T 6988.1）；

    ——互连图或表（见GB/T 6988.1）；

    ——接通水、水流和气流的方法及允许的压力；

    ——装配和安装条件；

    一允许的环境条件（温度、湿度、振动、冲击、撞击、电磁辐射等）；

    ——产品连接电源的说明，特别要说明防止电气过载、电压和频率的允许偏差、防止安装期间未经允许的接近和使用的劝告；

    ——废品清除或处置准备工作通告。

5.9.4试运转

    对于大型和非常复杂的产品和大型工业成套设备，要特别提供试运转说明书。其目的是为用户供初始产品调整所需信息。此种说明应包含如下内容，例如：

    ——符合IEC 61506的下载程序、软件说明，

    ——检查说明

    ——连接前和首次工作前要进行的检查，

    ——验收、检验和性能测试规范的细节。

5.10使用说明书

    应为产品用户提供有关正常安全使用或操作的信息。如果适当，它应包括关于自控和遥控产品、特殊的功能或状态、供观察的指示、人身防护和故障探测说明等信息。

5.10.1  正常安全使用

    说明资料应包含如下涉及产品本身的可用信息：

    ——产品及其附属设备、围栏和（或）保护器件的详细说明，

    ——产品广泛的应用范围，如果适当，同时考虑原型机的变化；

    ——可合理预知的误操作警告；

    ——供应方降低风险时未能消除的剩余风险的信息；

    ——由于某些附属设备的应用可能产生特殊风险，此种应用所必需的补充防护措施的信息，

    ——需要便携式手持和手控机械时关于振动的信息；

    ——停止产品工作的模式和手段l

    ——流程图或功能图(见GB/T 6988.1),

    ——手动控制器说明}

    ——设定和调节说明；

    一一次干预后重新启动的说明I

    ——表示产品主要功能特别是安全功能的简图；

    ——如何采取措施，防止产品发出噪声、振动、辐射、气、蒸汽或尘埃；

    ——清除废物的建议；

    ——使产品达到完满的工作性能、连同检查细节、设定调节控制器方法和应设定内容所需初始工作的说明；

    ——正常工作期间用户力所能及的维修工作；

    ——失效的鉴别和处理；

    ——对用户可能是新的技术，如信息技术的细节I

    ——产品使用后的贮存。

5.10.2  自动和遥控产品

    用户指导系统应给在线用户提供产品工作状态的补充信息。例如：

    ——典型工作所提供的全部信息；

    ——在系统达到过度危险状态以前自动转入安全工作方式时所提供的信息；

    ——现行工作状态使用户能了解此自动引导功能；

    一控制系统自身失效时做些什么；

    一如何处理失效状态的说明。

    注：用户软件的指导系统，参考IEC 61506。

5.10.3特殊功能或状态

    用户应收到如下所需信息：

    一紧急停机的方式和手段I

    一电源、冷却等一旦意外中断应采取的措施；

    ——故障识别和定位以及一次干预后重新启动的说明，

    一使用的消防设备型式；

    一危险物资可能辐射或泄漏的警告，如有可能，消除它们的影响或回到初始状态方法的说明。

5.10.4供观察的指示

    说明资料应提供用户可识别的指示和警告器件的信息。特别是，不允许的危险发生以前，发出的指示应易懂并明确。说明资料中的补充信息应说明如下内容：

    一告警指示l

    ——故障鉴别和位置的指示；

    ——表示正常状态的指示；

    ——出现在产品上的告警符号。

5.10.5故障探测说明

    故障诊断程序的辅助工具如功能识别维修系统(FIMS)、故障分步诊断(FSD)、故障步和算法，或者在复杂系统中，故障树和基于计算机的故障诊断，应在说明书中加以考虑。

    往往，故障定位和诊断应限于期望用户可合理承担的工作，以下信息应予提供：

    ——故障鉴别和定位指示、表；

    ——表示正常状态的指示表l

    ——适用时，辅助故障探测的内装诊断系统的说明；

    ——使维修人员能够合理执行任务的图和简图（特别是故障探测任务）；

    ——记录设备的误动作、记录非正常征兆和指示并自动记录告警和脱扣操作的说明l

    ——启动备用或替换系统并断开和隔离误动作单元的说明；

    ——供应方或可获得技术帮助的其他单位的名称、地址、电话号码等。

5.10.6人身防护

    如果必要，说明资料应提供：

    一一有关将要使用的人身防护设备的信息#

    一一由用户采取的防范措施的建议（专用防护器件、防护距离、安全标志和指示等）；

    ——可能的症状以及任何药物治疗的细节，包括首先的救护程序；

    ——必要的训练。

5.11  维修说明书

5.11,1  通则

    提供给非熟练人员自行维修的维修说明书应与熟练人员的说明书严格分开。供熟练人员用的维修说明书，关系到需要专门技术知识、操作或特殊技能的维修作业，只应由熟练人员（维修工作人员或接受过训练的技术人员）来完成。

    建议为后者编制的文件与非熟练人员的文件分开，

5.11.2供非熟练人员用的维修说明书

    如果产品的用户可以进行某些维修作业而不损伤用户、他人或产品，则说明资料应提供可能的维修

作业并带有适当的图解以及本标准提到的所有其他信息。这样的说明书可附有如下相关信息：

    ——维修作业的性质和频率}

    ——预防维修、维修一览表和必要的安全检查；

    ——用户可否尝试维修或自行排除故障，或应请能胜任人的明确信息}

    ——安全警告I

    ——告警器件的日常检查l

    ——在那些需要清洁或净化的场所，应详尽地给出清洁方法。当错误材料或不适当的程序可能招致直接危害或引起锈蚀或削弱安全有关的结构零件的危害时，说明书应标明清洁所用的材料，

    ——供应方或可能得到技术帮助的其他单位的名称、地址、电话号码等。

5.11.3供熟练人员用的维修和排除故障的说明书

    此种说明书应包含如下有关信息：

    ——检测的性质和频率；

    ——对正在运转的或带电设备进行维修的安全提示和告警I

    ——故障诊断和鉴别的信息I

    ——修理和调整的说明；

    ——适用时，辅助故障寻找的内部诊断系统的说明l

    ——使维修人员能合理履行任务的图和简图（特别是故障寻找任务）；

    ——告警设备的日常检查，

    ——如果所用的清洁或净化过程和材料可能招致直接危害或引起锈蚀或其他削弱结构零件的危害的话，应详尽地给出清洁方法’

    ——维修计划表，如有必要，以主要计划形式汇总的在特定时限内进行的所有可预知任务的说明

    ——供应方或可获得技术帮助的其他单位的名称、地址、电话号码等。

5.12备件表

    备件表的用途是提供用户识别涉及产品工作或维修可能需要的所有零件的手段。对于每一种零件，如果适当的话，应提供如下信息：

    ——名称和标识，采取整个提供说明资料和在商务交易中所用的形式；

    ——供应方的牌号（型号）和种类号以及名称，如与上述不同，则为有标记零件的标准号和种类号；

    ——零件的图解及其位置，最好用立体图；

    ——推荐的备件数量'

    ——应标明在产品预期的寿命期内替换几次所需的零件（例如电池、滤尘器、闸瓦和其他消耗品），

    ——作为备件的电源和交流电源；

    ——应标明由制造商或别处提供的存在整修的零件I

    ——对于复杂产品，列出表示多个零件用于何处的表格；

    ——如果某个备用件可能用于产品的不同地方，则应按GB/T 5094.1表示清楚；

    ——如果在其他文件中未给出备用件的到期年份，则按备用件有效保单。

    注：当保单问题在不同销售渠道或国家间有变化时，把保单问题特别放人单独的文件内是合理的．

    供应方应列出需要检查并由供应方或代理商专门供应的所有零件。

    对于使用特定零件如电池或熔断器的产品应示出其特定型号。

    应提供供应方或可能获得备件、磨损件材料等和技术帮助的其他单位的名称、地址、电话号码等。

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

5.13.1专用工具和设备

    在正常工作时不一定使用，但在特殊情况下使用的任何专用工具、项目或设备的说明书应与一般说明书分开。

    说明书应包含与附件和其他设备互连的描述，并包含相配附件、可拆零件和任何专用材料的表示法。

5.13.2材料

    应提供供应方或可获得专用工具、材料等和技术帮助的其他单位的名称、地址、电话号码等。

    如必要，为了替换、修理、再制和充填产品，应提供再包装说明书。

    如适当，应标出消耗品、清洁材料、润滑产品和修理工具包。

5.14修理和替换零件的说明书

    修理和替换零件的说明书应提供给用户必要的信息s

    ——修理设备和（或）更换已损坏的、磨损的或老化的零件l

    ——在更换重要零件后要进行的测试。

    在特殊情况下，为建立有适当装备的车间和组织，配有经过训练的人员或技术人员(见5.11.3)的

说明书可能是有帮助的。

5.15停止产品使用（停止运行）

    说明书应包含停止产品使用和采取进一步措施（销毁、再利用、处理）有关的信息。

5.15.1  破坏

   出于适当的安全和经济的考虑说明书应单独或共同包含产品破坏和（或）任何废弃物的相关信息。

5.15.2再利用

    如果对产品的安全拆卸和类似对废弃物的再利用或处理需要特定程序的话，应加以规定，如有产品标准，这些程序的规定应符合产品标准。

5.15.3处理

    说明书应给用户传达有关废物处理和环境考虑方面的重要信息。

    如有任何危险物质与产品一起提供，出于适当的安全和法定要求的考虑．应提供必要信息说明其成分和正确处理的程序。

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

5.16.1  页编号

    如果说明书多于一页，则应编页号。如有可能，每页还应标出总页数，例如第1页共10页或1/10。

5.16.2  目录

    超过4页的说明书应有目录表。

    目录表出现的标题应与正文中所用标题相同。《用户说明书目录示例》见附录D。

5.16.3索引

    如果说明书长且复杂，应编有按字母表顺序的关键字的索引，并在目录中列出。

5.16.4控制器清单

    对于复杂的设备，应提供单独的用户控制器和指示器（如手动控制器、度盘、量器或指示灯）的清单。

5.16.5技术术语定义

    预定目标群体难免有不易理解的技术术语和缩略语，应加以解释。定义还应包括可能容易被误解的术语如“用户”或“维修件”。

    在说明资料的所有部分，无论是产品本身的、产品包装的或随机的资料中应采用一致的术浯。

5.16.6符号定义

    如果标志（图解）和符号不容易理解或不明确，应给予定义，特别是有关产品安全功能的应甩方面。

5.16.7传统表示方法的说明

    在说明资料中所采用的所有传统表示方法，例如用户进行操作的特定字榉，或特定的警告图解，它们不容易为预定目标群体所理解，都应加以说明。

6说明书的表示方法

6.1  交流原则

6.1.1  需遵循的标准交流原则

    为了达到最佳结果，负责设计和编制说明书的人们应把交流原则“先读，后动作”作为产品使用的顺序。活页、手册和其他说明资料的顺序应遵循步进法。

    如果说明书的读者必须快速反应（例如应用灭火器时），则应只需要最短的思考过程来理解说明书。

6.1.2不断地增进理解

    如果为了安全和正确使用产品必须遵循顺序操作法的话，说明书应能帮助并鼓励用户遵守顺序的学习和理解程序。促进这一程序特别有效的方法是图解、表格、流程图等（见6.3、6.4-、6.5、6.6和6.7）。

6.1.3基本功能优先

    预定完成几种不同且独立的功能的产品，其说明书应从基本功能或正常功能开始，而后讨论其他功能。

6.1.4简明扼要

    信息应尽可能地简明扼要，并应采用统一的术语和单位，非常用术语应有明确的说明：

6.1.5对用户问题的预计

    说明书应回答用户这些问题：何地？何人？什么？何时？如何？为何？并提供答案。

6.1.6标题和书页边缘空白处的注释简明的提供信息的标题和（或）书页边缘空白处的注释，应始终对用户起指导作用，并帮助找到他们需要的信息。

6.1.7一个句子，一个命令

    一个句子只应包含一个命令，或者，至多只包含少数几个密切相关的命令。

6.1.8文体

    编拟者应采用明确、直接和不含混的文体。例如：

    ——采用主动语态而不采用被动语态的动词

    ——用命令而不用软弱无力的形式来肯定；

    ——采用行为动词而不采用抽象名词；

    ——直接对用户说而不说用户可能作什么。见表1。

表1  一文体举例

原  则	推  荐	不赞成
采用主动语态	断开电源	确信电源已断开
肯定	不要拆卸连接片	你不应拆卸连接片
采用行为动词	使用、保持、避免	（相应抽象名词）
直说	朝你的方向拉动黑手柄	用户将朝离开机器的方向拉动黑手柄

 

6.1.9标准化用语和符号

    如果适当，应考虑使用标准化用语和（或）安全符号或图形符号来传达如警告一类的重要信息。

6.1.10人机控制原则

    用电子媒体如在线或屏幕文件表示的说明资料特别应满足IS0 9241-1至IS0 924-17所表述，的人机控制要求。

6.2可读性

 6.2.1  印刷字型和尺寸

    产品上的信息、印刷资料和计算机化信息的字型和尺寸应清楚、大小适当以保证最佳的可读性。

    对于印刷说明书（如活页或手册或其他说明资料）中的连续文字应采用不小于9点∞的字型尺寸。

    最小行间距应不小于字型尺寸的120%（并见GB/T  16901.2--2000的附录1）。

    对于印刷件或其他说明资料和产品上的说明或用户需要经常查看的其他短信息的标题，其字型尺寸应不小于1 2点。

6.2.2俯视面

    产品上说明的位置及其表面与俯视面的夹角应该使用户使用产品时可以很方便地读取。

6.2.3最大亮度对比

    亮度对比一一从背景反射的光百分数与从印刷品反射的光百分数之差——应尽可能地大。

    根据上述参数，最小字型尺寸和最小亮度对比要求可在产品标准中规定。

    注1：对比度通常应不小于70%。质量好的白纸上的黑字提供约80%的对比度。

    注2：在不完全不透明的纸上双面印刷可能降低亮度对比和破坏清晰度。

6.2.4产品表面上的说明

    如果说明与产品自身的表面材料合在一起，例如在金属上、玻璃上或塑料上刻制或塑压文字、图形或符号，此种方法的优点是耐久，减少单独的零件等，但应权衡利弊，因为其清晰度一般不如好的印刷件（并见4.6.3）。

6.2.5标准

    国家标准可以包含更多的与清晰度有关的参数，特别是字型尺寸与阅读距离间关系的详细信息。当编制说明资料时，这些都是应该商量和考虑的。

6.3图解

6.3.1  图的质量

    不管选择的是照相、扫描或其他媒体，都应注意质量和清晰度。

6.3.2支持文字。的图解

    只要适当，文字和图解应一起使用，相互补充。例如，图解应补充文字说明，以便能够找到和识别手动控制器（操作件）。

6.3.3需遵循的工作顺序

    如果描述的是工作顺序，则文字和图解应遵照同一顺序，图解应尽可能靠近它们参照的文字。

6.3.4  带标题的图解

    图解应补充文字说明的标题，以便找到和识别控制器、子单元等。

6.3.5一个图解，一项信息

    一个图解只应提供相关功能所需的信息。    ‘

6.3.6为方便使用者的补充图

    当需要帮助用户时，图解或图懈的细节部分应在说明资料的相关部分加以重复。

6.3.7折页

    根据4.7.3.3的推荐，折页的图解、表格或流程图可置于活页或手册页之上，以便在不同的时间在邻近不同的文字页处可以阅读。要注意考虑的是经常使用的用纸制作的折页容易很快磨损。

6.4图形符号

    在说明书中出现的图形符号应遵循公认的标准。

6.4.1  产品和说明书使用标准符号

    没备上和可拆卸部件上使用的以及说明书中复制的图形符号应符合公认的标准，例如

2)  “点”的含义十二点活字的点，1个十二点活字的点为0. 351 mm。

6.4.2符号说明

    位于产品上或随机资料上的符号、图表和标记应在使用说明书中说明。说明书应清楚示出产品功能由产品上的那些符号所代表。

6.4.3简圈中的符号

    简图中使用的图形符号应符合公认的标准，例如GB/T 4728和IS0 14617。

6.5表格

    在说明资料中经常应用表格，以较方便的形式来给用户提供信息。

    ——表格能增进理懈时，应以表格形式表示；

    ——表格应置于相关文字附近；

    ——当对用户有帮助时，应在说明资料的相关部分重复表格或部分表格。

6.6表图和简图

    机器的说明手册或其他文字说明应包含与机器自身有关的补充信息，例如安全功能的表图或简图和有关电气设备的信息（见IEC 60204-1）以及使维修人员能够合理完成他们的任务的图样和简图（特别是故障检查任务）。

6.7流程表图和流程筒图

    为了安全和正确使用产品需要特定操作程序时，流程表图可能对用户有帮助-流程表图或流程简图应该邻近有关的文字。表达方式和图形符号应遵循公认的标准，例如IS0 10628或GB/T 6988.6。

6.8电子媒体、音频、视频

    电子媒体（又称多媒体）说明书，如培训、维护和修理说明书应遵循本标准的有关要求，例如语种、清晰度和图解。环境条件如光和噪声都应考虑。

    电子媒体说明书应遵循用户应按照顺序操作的次序。由视频或音频系统提供的说明书应具有与视频动画程序同步的对白或书面文字。

    程序的持续时间和信息内容不应超过用户理解这些信息的能力。

1943