当前位置:文档之家› 外购件产品使用维护说明规则及模板

外购件产品使用维护说明规则及模板

前 言
本文件根据企业标准Q/TX01-030-2007《产品使用维护说明书编写规则》编制。

本文件主要包括三个部分内容:外购件产品使用维护说明书(以下简称使用维护说明书)的编制要求、编制模板及其编制质量检验要求。

附件1中6.1(确定维修等级)、11.2(确定备件数量的时间段及台车数)、附件2(填写检验表)是订货方将本文件提供给供应方之前必须完成的内容。

订货方将这些内容编制完成之后,将字体改回为常规字体(非斜体)。

供应方在编制文件时,必须无修改地保留该部分内容。

本文件斜体字部分内容是编制范例,仅供编制时参考。

文件编制完成之后,所有有关的编制要求及范例均必须删除。

如果产品没有本文件附件1中的相关内容(即附件2中未做要求的条款),则保留该条款,并在该条款标题下注明“本条不适用”。

外购件产品使用维护说明书编写规则及模板
1 使用维护说明书的编制要求
1.1 基本要求
1.1.1 使用维护说明书是交付产品的组成部分,必须满足订货方提供的检验表要求的内容,见附件2。

1.1.2 使用维护说明书应明确给出产品用途和适用范围,并根据产品的特点和需要给出主要结构、性能参数,正确的吊运、安装调试,使用操作说明,保养、维护、故障处理,运输和贮存,易损易耗件、专用工具及设备清单,废弃物处理方案等内容,以及保护操作者、维修人员和产品的安全措施。

详细内容见附件1编制模板。

1.1.3 使用维护说明书的内容除应符合本文件的规定以外,还应符合相应标准、国家有关法律和法规的规定。

1.1.4 当产品结构、性能等改动时,使用维护说明书的有关内容应按附件1的修改记录及时作相应修改,生产厂家或供应商应及时向订货单位提供和产品对应的使用维护说明书修改版。

1.1.5 复杂产品和成套设备可按各功能单元、整机分别编制使用维护说明书,再按功能组合成系统的使用维护说明书。

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

各功能单元、整机的使用维护说明书应有详细的目次。

目次的编写按GB/T 1.1《标准化工作导则 第1部分:标准的结构和编写规则汇编》的规定。

1.1.7 使用维护说明书的内容及编排按附件1模板,并根据订货方提供的维修等级(见附件1的6.1)、备件数量的时间段及台车数11.2(见附件1的11.2)及检验表(见附件2)详细编制产品在每个维修等级中的维修计划、维修工作及备件清单等。

正文的编写规则按GB/T 1.1的规定。

1.1.8 对涉及环境和能源的产品,使用维护说明书应规定必要的保护环境和节约能源方面的内容。

1.1.9 对易燃、易爆、有毒、有腐蚀性、有放射性、高压等对人体有危害的产品,使用维护说明书应包括注意事项、防护措施和发生意外时紧急处理办法等内容。

1.1.10 对安全限制有要求或存在有效年限的产品应提供产品的生产日期和有效期、储存期。

1.1.11 应标明使用维护说明书的出版日期。

1.1.12 使用维护说明书应与生产厂家或供应商印发的有关同种产品的资料内容一致。

1.2 编制要求
1.2.1 文字、语言
a) 供国内用户的产品使用维护说明书应提供汉语使用维护说明书;
b) 供出口的产品使用维护说明书应提供销售地区官方语言和汉语对照的使用维护
说明书或合同规定语言的使用维护说明书;
c) 使用维护说明书应采用国务院正式公布、实施的简化汉字。

销往国外或澳门、香
港、台湾地区产品的使用维护说明书,如果合同规定或用户要求可使用繁体字;
d) 使用维护说明书有关安全内容的文字表示规定见1.2.3。

1.2.2 表述的原则
a) 使用维护说明书内容的表述要科学、合理、符合操作程序,易于用户快速理解掌
握。

b) 使用维护说明书应多采用图示、图表、操作程序图、拆装步骤工序图进行说明。

c) 具有几种不同和独立功能的使用维护说明书,应先介绍产品基本的和通常的功
能,然后再介绍其他方面的功能。

d) 使用维护说明书应尽可能设想用户可能遇到的问题,如产品在不同时间(季节)、
不同地点、不同环境条件下可能遇到的问题,并提供预防和解决的办法。

e) 使用维护说明书应使用简明的标题和标注、交叉引用,以帮助用户快速找到所需
内容,如工具、润滑油/脂型号、清洗剂种类等。

f) 语句表述应只包含一个要求,或最多包含几个紧密相关的要求。

为清楚起见
——最好使用动词主动态,不用被动态;
——要求应果断有力,而不软弱;
——最好使用行为动词,不用抽象名词;
——表述应直接了当,而不委婉。

示例见表1。

表1 语句表述示例
原则 推荐 不赞成
采用主动语态 关掉电源 使电源被中断
肯定,果断有力 不许动手环 手环不应被动
使用行为动词 避免事故 事故的避免
直接了当 拉操作杆 使用者从机器拉回操作杆
1.2.3 安全警告
a) 使用维护说明书应对涉及安全方面的内容给出安全警告。

根据ISO 3864-1-2002
《图形符号.安全色和安全标志.第1部分:在工作场所和公共领域中的安全标志
设计原理》设置了以下几类警示信息:
表示电击警示,其产品内部电压等级超过交流42V或者直流110V,操作人员在
未断电的情况下严禁靠近、接触相应产品。

表示警示,具体内容参见后部用粗体描述的内容,表示预防人身伤害或者重大
损坏的警示,如“接触网未接地前严禁登顶”等,在任何情况下操作人员都应
严格遵守其警示内容。

表示安全接地,高压柜体外壳都带有此标识。

表示设备对静电非常敏感,不得用手直接接触标有此符号的设备;如有特殊需
要,需遵从防静电规定进行操作。

b) 安全警告的内容应用黑体表示,在警示符号之后可以用“危险”、“警告”、“注
意”等词表示安全等级以提醒使用者。

其中:
——“危险”表示对高度危险要警惕;
——“警告”表示对中度危险要警惕;
——“注意”表示对轻度危险要关注。

c) 为了达到最佳效果,有关安全的论述和安全警告的编写应考虑以下几点:
——内容和图解要简明扼要;
——安全警告的位置、内容和形式要醒目;安全说明及警告用语应放在相应操作步骤及维护程序之前,以引起使用者注意,确保使用者在执行任务前能看到
存在的危险警告;
——解释伤害的性质(如果需要,解释伤害的原因);
——对于如何正确操作,给予明确的指导;
——对于如何避免危险,给予明确的指导;
——使用的语言、图形符号和图解说明要清楚、准确;
——如同时要对安全、健康说明时,应优先对安全做出说明;
——切记频繁重复警告和错误警告会削弱必要的警告效力。

1.2.4 图、表、符号、术语
a) 使用维护说明书的图、表和正文应在一起,图、表应按顺序标出序号。

b) 要在文中其它地方引用出现过的图、表、章条内容、专用工具及维修材料等时,
需标明其图号、表号、章条号、代号。

c) 使用维护说明书中的符号、代号、术语、计量单位应符合最新发布的国家法令、
法规和有关标准的规定,并保持前后一致。

需要解释的术语应给出定义。

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

e) 使用维护说明书中的图、表、公式、数值的表示方法应符合GB/T 1.1的有关规
定。

f) 维修章条中所需专用工具及设备、维修需用材料等应分别在所需要的步骤中说明
并标出引用代号,不能罗列在维修步骤之前。

2 使用维护说明书的编制模板
使用维护说明书的编制格式见本文件的附件1。

3 使用维护说明书的质量检验
3.1 使用维护说明书的质量评价及合格检查应遵循通用的准则,并依据检验表进行,详见附件2。

检验表是编制、交付和验收使用维护说明书程序的一部分,考虑了安全而有效地操作和维修产品的技术要求、文件的提供方式及图表、图纸的格式、编制语言、交付期限等内容。

3.2 订货方事先应详细填好检验表(附件2),并随本文件提供给生产厂家或供应商,以此作为最终文件质量检验的依据。

3.3 订货方根据检验表对生产厂家或供应商编制的使用维护说明书做出质量评价及合格检查,将不符合要求的使用维护说明书退回生产厂家或供应商修改。

相关主题