建材装备产品使用说明书编写规则

图片

一.范围

本文件规定了建材装备产品使用说明书(以下简称“使用说明书”)的基本要求、编制要求、主要构成和编写内容。

本文件适用于编制建材装备产品(建材机械、设备)使用说明书。


.规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。

GB/T 9969-2008 工业产品使用说明书 总则


三.术语和定义

本文件没有需要界定的术语和定义。


四.基本要求

4.1产品应提供使用说明书,使用说明书应详述主要用途、结构及工作原理、技术参数、型号、规格和正确吊运、安装、使用、调试、操作、维修、保养和贮存等内容。

4.2使用说明书内容应易于用户阅读和理解,内容应简明准确,不应引起歧义。

4.3使用说明书中产品的相关信息应与该产品的其他公开资料,如宣传广告等内容应保持一致。

4.4当产品安装方式、性能参数、结构形式改动时,使用说明书的有关内容必须按规定程序及时作相应修改。生产者应向用户提供和产品相对应的使用说明书。

4.5使用说明书可按产品规格型号类型编制,也可按产品系列、成套产品编制,按系列、成套产品编制时,其内容和参数不同的部分应明显区分。

使用说明书应清晰地指明产品,说明该产品的型号、样式或种类,不应因一些因素导致使用者手中的使用说明与实际使用的产品不符。

4.6使用说明书应符合相关的环境保护、防火、安全、职业健康等要求。

4.7对易燃、易爆、有毒、有腐蚀性、有放射性等性质的产品,使用说明书应包括安全使用方法、注意事项、防护措施和发生意外时紧急处理办法等内容。

4.8因操作使用不当,可能危害人体健康安全或者造成财产损坏的产品,应以显著方式标注安全说明或警示说明。

4.9使用说明书应尽多设想用户可能遇到的问题,并提供预防和解决的办法。

4.10用于产品主机配套的元器件等产品,可将其附于使用说明书中,也可以配件手册形式另附。

4.11使用说明书中应表明制造商的名称和详细地址,标明出版日期或版本。

4.12应在使用说明书封面或包装显著位置注明“使用产品前请阅读使用说明书”。

4.13根据包装、运输和使用的需要,使用说明书应采取下列一种或多种方式提供:

A)随同产品提供的文件或资料中;

B)若使用二维码、条形码等电子标签作为载体时,可印或粘贴在包装上。

4.14使用说明书应详述数字化技术、绿色低碳技术(若有)。

4.15使用说明书应提供必要的保护环境和节约能源方面的内容。

五.编制要求

5.1文字、语言

说明书的文字、语言应符合GB/T 9969-2008中4.1的要求。

5.2表述的原则

5.2.1使用说明书内容的表述应简要、科学、合理、符合操作程序。对于复杂的安装、操作、使用等程序,应多采用图表、图示和程序流程图表述,也可用操作动画视频等进行说明,易于用户快速理解掌握。

5.2.2应使用简明清晰的标题和索引,以帮助用户快速找到所需内容。

5.2.3语句表述相关要求,应符合 GB/T 9969-2008 4.2.6 节的规定,具体内容见下:语句表述应只包含一个要求,或最多包含几个紧密相关的要求。为清楚起见:

最好使用动词主动态,不用被动态;

要求应果断有力,而不软弱;

最好使用行为动词,不用抽象名词;

表述应直截了当,而不委婉。

语句表述示例见表1。

1 使用说明书语句表述示例

图片

5.3图、表、符号、术语

5.3.1使用说明书中的图表应整洁清晰美观,布局合理,按国家规定的绘图标准绘制,图、表应和相应正文印在一起,图、表应按相应序列号顺序标出。

5.3.2引用文中图、表时,需标明图号、表号,并注明其第一次出现时所在页码。

5.3.3使用说明书中的符号、代号、术语、计量单位应符合发布的国家法律、法规和有关标准的规定,并保持前后一致。需要解释的术语应给出定义。

5.3.4图示、符号、缩略语在使用说明书中第一次出现时应有注释。

5.4目次(索引表)

5.4.1当使用说明书超过一页时,每页都应有页码,章条较多时,应编写目次。

5.4.2按功能单元、整机组成的复杂产品或成套设备的使用说明书应有总目次。各功能单元、整机的说明书应有详细的目次。

5.5印制

5.5.1使用说明书的印制材料应结实耐用,能保证使用说明书在产品寿命期内的可用性。

5.5.2使用说明书的文字、符号、图、表、照片等应清晰、整齐。双面印制的,不得因背透等原因而影响阅读。

5.5.3使用说明书的封面应有能准确识别产品类型的名称(如产品型号、牌号、系列等),产品名称和 “使用说明书”字样,并应有生产者的名称(厂名)。

5.5.4使用说明书在封底或封里必须有制造商的详细地址、邮政编码、电话号码等。

5.5.5允许在封面上印有照片、图形、商标或其他认证标志。

5.5.6电子版使用说明书内容格式应和纸质版保持一致,可根据需要增加视频、动画等内容

5.6文本

5.6.1使用说明书的开本幅面,可采用 A4 或其他幅面尺寸。

5.6.2图、表等允许横向加长,确属必要时也可纵向加长。

5.6.3使用说明书根据内容多少可为单页、折页和多页。多页应装订成册。

5.7安全警示

5.7.1使用说明书应对涉及安全方面的内容给出安全警示。

5.7.2安全警示的内容应用较大的字号或不同的字体表示,用特殊符号或颜色来强调。

5.7.3为达到最佳效果,安全警示的格式和编写注意以下几点:

(1)内容和图解应简明扼要;

(2)安全警示的位置、内容和形式应醒目;

(3)在正常使用产品时,能从使用位置看到危险警示;

(4)对于危害的性质应给予解释(如果需要,解释危害的原因);

(5)对于如何正确操作给予清晰的指导;

(6)对于如何避免危险给予清晰的指导;

(7)使用的语言、图形符号和图解说明应规范、清楚、准确;

(8)如同时要对安全、健康说明时,应优先对安全做说明;

(9)不应频繁地重复警示,这样会削弱必要的警示效力。

5.7.4当提醒用户时,使用说明书的安全警示标题应根据危险级别不同使用下列分级方法和警示用语:

(a)“危险”表示对高度危险要警惕;

(b)“警告”表示对中度危险要警惕;

(c)“注意”表示对轻度危险要关注。

5.7.5为了传达危险警示之类的重要信息,应在适当位置使用标准化的用语或安全标志或图形符号。这些用语和标志及其位置要求,应在有关产品的说明书中规定。

5.7.6使用说明书应对以下内容进行规定:

(1)视、听警示的位置;

(2)警示装置、安全防护用品和设备的管理、维修等。

5.8内容编排

5.8.1使用说明书内容编排,可根据具体产品的特点和使用要求对附录 A 选择增减并合理排序。

5.8.2附录 A 中各章的 a)、b)、c)……仅表示所包括的内容。同时也表示某些内容应在某章中表述,而不一定表示条的名称和编排次序。

5.7.1使用说明书应对涉及安全方面的内容给出安全警示。

5.7.2安全警示的内容应用较大的字号或不同的字体表示,用特殊符号或颜色来强调。

5.7.3为达到最佳效果,安全警示的格式和编写注意以下几点:

(1)内容和图解应简明扼要;

(2)安全警示的位置、内容和形式应醒目;

(3)在正常使用产品时,能从使用位置看到危险警示;

(4)对于危害的性质应给予解释(如果需要,解释危害的原因);

(5)对于如何正确操作给予清晰的指导;

(6)对于如何避免危险给予清晰的指导;

(7)使用的语言、图形符号和图解说明应规范、清楚、准确;

(8)如同时要对安全、健康说明时,应优先对安全做说明;

(9)不应频繁地重复警示,这样会削弱必要的警示效力。

5.7.4当提醒用户时,使用说明书的安全警示标题应根据危险级别不同使用下列分级方法和警示用语:

(a)“危险”表示对高度危险要警惕;

(b)“警告”表示对中度危险要警惕;

(c)“注意”表示对轻度危险要关注。

5.7.5为了传达危险警示之类的重要信息,应在适当位置使用标准化的用语或安全标志或图形符号。这些用语和标志及其位置要求,应在有关产品的说明书中规定。

5.7.6使用说明书应对以下内容进行规定:

(1)视、听警示的位置;

(2)警示装置、安全防护用品和设备的管理、维修等。

5.8.1使用说明书内容编排,可根据具体产品的特点和使用要求对附录 A 选择增减并合理排序。

5.8.2附录 A 中各章的 a)、b)、c)……仅表示所包括的内容。同时也表示某些内容应在某章中表述,而不一定表示条的名称和编排次序。


六.主要构成

6.1标题

说明书的标题应由“装备名称”和“使用说明书”组成。

6.2产品标识

应根据产品特点,提供诸如但不限于警示标识、警示说明、许可证编号、批准日期等内容。

6.3版本号和发布日期。

应注明使用说明书版本编号和对应的发布日期。

6.4主体内容

6.4.1产品名称

使用说明书应包含装备产品的通用名称和专用名称。

6.4.2产品概述

使用说明书应详述产品的用途、型号及含义,根据产品特点给出外观、性能等理化特性及主要结构和工作原理。

6.4.3原材料、零部件

应介绍主要原材料、零部件的信息。

6.4.4安装调试与使用用途

主要包括但不限于以下内容:

a)产品的主要功能用途;

b)产品使用时注意事项,包括安全、操作、维护等内容;

c)产品的使用条件;

d)安装调试方法、验收标准。

6.4.5注意事项和防护措施

使用说明书应详细说明产品运输、安装、吊装、使用、检修、操作、维护等注意事项,以及施工、检修、调试时的防护措施等。

6.5 制造商信息


附录 A

使用说明书主要内容

A1.概述

a)规格、品种、型号组成及代表意义;

b)产品特点、用途及适用范围(必要时包括不适用范围);

c)产品的外观;

d)使用环境条件;

e)工作条件;

f)对环境及能源的影响。

A2.结构特征与工作原理

g)总体结构简述及其主要特征、工作原理;

h)主要组成部件结构及其工作原理;

i)辅助装置的功能介绍及工作原理。

A3.技术特性

j)主要性能;

k)主要参数。

A4.尺寸,重量

l)外形及安装尺寸(可分开);

m)重量。

A5. 安装、调试

n)设备基础、吊运条件及安装技术要求;

o)安装程序、方法及注意事项;

p)调试程序、方法及注意事项。

A6.验收、试运行

q)安装、调试后的验收试验项目、方法和判断依据;

r)试运行前的准备、试运行启动、试运行。

A7.安全事项

s)安全使用期、生产日期、有效期;

t)容易出现错误的使用方法或误操作,以及可能造成的伤害;

u)气体/灰尘/蒸汽/液压等安全防护措施;

v)运输、装配、调试时安全注意事项;

w)特殊情况(停电、移动等)下的注意事项;

x)其他安全警示事项。

A8.使用、操作

y)使用前技术交底和检查;

z)使用时的安全及安全防护、安全标志及说明;

aa)启动及运行过程中的操作程序、方法、注意事项及容易出现的错误操作和防范措施;

ab)运行中的监测、调整、记录;

ac)停机的操作程序、方法及注意事项。

A9.安全保护装置及事故处理(包括消防)

ad)安全保护装置及注意事项;

ae)出现故障时的处理程序和方法;

突发事件时的应急措施。

B1.维护保养

a)维护保养制度;

b)日常维护、保养、校准及运行时的维护、保养;

c)计划检修工作、检修周期;

d)正常维修程序;

e)长期停用时的维护、保养。

B2.故障诊断与处理

f)故障现象;

g)原因分析;

h)处理方法。

B3.备件及易损件清单

i)备件名称、数量;

j)易损件名称、数量;

k)可以以表格形式详述。

B4.贮存、运输

l)防水、防火、防压;

m)危险物品隔离存放;

n)贮存整齐、平稳,分区编号按顺序排放;

o)贮存条件、贮存期限及注意事项;

p)吊装、运输注意事项;

q)主要运输部件尺寸、重量、图样。

B5.开箱及检查

r)开箱前准备,开箱时注意事项;

s)检查程序和内容;

t)设备开箱记录。

B6.环保及其他

有关处理及处置方面的规定。

B7.图、表、照片(也可分列在上述各章中

u)外形(外观)图、安装图、布置图;

v)结构图;

w)原理图、系统图、电路图、逻辑图、示意图、接线图、施工图等;

x)各种附表附件明细表、专用工具(仪表)明细表;

y)照片。


参考文

1.GB/T 9480-2001 农林拖拉机和机械、草坪和园艺动力机械 使用说明书编写规则

2.GB/T 14232.2-2015 人体血液及血液成分袋式塑料容器 2 部分:用于标签和使用说明书的图.

3.GB/T 17889.3-2012 梯子 3 部分:使用说明书

4.GB/T 19678.1-2018使用说明的编制 构成、内容和表示方法 1 部分:通则和详细要求.

5.GB/T 23956-2009 化工产品使用说明书编写规定

6.GB/T 33980-2017 电工产品使用说明书中包含电气安全信息的导则.

7.GB/T 38117-2019 电动汽车产品使用说明 应急救援.

素材来源于网络整理

END