工业产品使用说明书的编写方法.doc

工业产品使用说明书的编写方法凡工业产品（不包含食品和消费品，下同），一般都应编制使用说明书，随产品交付用户，以便于用户正确安装和使用产品，成为沟通产需双方的桥梁和工具。GB9969l88工业产品使用说明书总则明确规定了工业产品使用说明书的内容及其编写方法。一、编写工业产品使用说明书的基本要求编写工业产品使用说明书应符合下列四个方面基本要求：1应明确具体规定产品的用途和使用方法要根据产品的使用功能和特点，具体而明确地写明产品的用途和适用范围，同时写明主要结构、性能参数、型式和规格以及正确贮运、安装、使用（操作）、维修、保护等方法。产品使用说明书可按产品型号编写，也可按产品系列编写。2涉及到安全、卫生和环境保护等方面要求必须写明当产品具有危险和有害因素时，必须在产品使用说明书中写明保护产品和操作者的安全卫生措施，对易燃、易爆、有毒、有腐蚀性和有放射性的危险产品，更应在使用说明书上规定防范措施、注意事项以及发生意外时的紧急处理办法等内容。对影响环境的产品，使用说明书上还应规定必要的保护环境方面的内容。此外，对一些耗能较大产品应说明节能措施。3复杂产品和成套设备应编写系统的使用说明书对一些复杂产品和成套设备，可按其功能单元、整机分别编写使用说明书，再组合成一套系统的使用说明书。4简单产品可不写使用说明书对一些冶金、矿产、建材等原材料类产品以及用于组装配套的一些元器件、零部件等简单产品，如其产品标准、产品手册、质量证明书等有关技术文件能满足用户需要时，可由这些技术文件代管产品使用说明书，不必另行编写产品使用说明书。二、产品使用说明书的内容构成一般工业产品使用说明书应包括下列内容：1产品概述产品概述部分主要写明产品的用途，适用范围（必要时还应写明不适用范围），产品规格型号的含义，使用环境条件或工作条件等方面内容。2结构特征与工作原理该部分叙述产品结构特点及其工作原理，包括主要部件或功能单元的结构，作用及其工作原理，辅助装置的功能结构及工作原理和各单元之间的机电联系，故障告警系统等。3技术特征这部分主要是写明产品的主要性能和主要参数。4尺寸、重量写明产品的外形尺寸、安装尺寸和产品重量（毛重）。5安装与调试这部分主要写明安装的地基、条件、程序与注意事项，安装后调试程序、方法与注意事项，必要时还应写明安装、调试后的验收项目、方法以及试运行要求。6使用与操作方法这部分主要写明使用前的准备与检查内容，使用中的安全防护措施，运行操作程序、方法、注意事项，监测和记录内容，直到停机的操作程序、方法的注意事项。7故障分析与排除对产品使用中可能出现的故障应写明原因及排除方法，一般采用下表格式。故障现象 原因分析 排除方法 备注8安全保护装置及事故处理对一些具有危险因素的产品，应写明：a安全保护装置及注意事项；b出现故障或事故时的处理程序和方法。9保养与维修这部分既要写明日常维护、保养和校准方面内容，又要写明检修周期、正常维修程序，以及长期停放时的维修保养措施。10贮存、运输应写明吊装、吊卸、运输过程中注意事项和贮存时的条件、期限及检查等内容。11开箱及检查应写明开箱时步骤及注意事项，以及检查步骤及内容。12其他应写明产品生产企业和售后服务事项、联系方法和质量保证等方面内容，还可写一些需要向用户说明的其他事项。上述内容并不是每份产品使用说明书都要写的，应根据具体产品的特点，恰当地选择上述内容，并合理编排次序，还可增加一些必需的内容，如随机备件、易损件明细表等。使用说明书中所需用的各种图表、照片，既可分别编排在上述各部分内容中，也可集中在一起附在最后。机械部门依据GB99691制定了机电产品使用说明书编写规定，从机电产品特性出发，规定了更具体明确的要求，其正文包括：产品的主要用途和适用范围；产品适用的工作环境和条件，必要时还可规定不适用的工作环境和条件；产品的规格及与使用、安装有关的技术参数；产品的总体结构或主要部件的结构、性能，并配备必要的图形；产品系统说明，如机械传动系统、电气系统、液压系统、气动系统、光学系统等，叙述其工作原理、操作方法，必要时绘制系统图、原理图、电路图等；吊运和保管中注意事项，必要时附吊运图；安装与调试程序、方法、要求等；使用与操作。包括：a使用前的准备和检查；b使用前和使用中的安全及安全防护；c操作程序、方法、注意事项及容易出现的误操作和防范措施；d运行中的监测与记录等。维护与保养周期、方法、工具、条件及易损件等；常见故障及其排除方法。附件及易损件（表）成套性。即产品的主机，辅机或辅加装置及其它配套件，可列表叙述。其它工业产品，也应由产品归口行业部门编制具体明确的产品使用说明书编写规定或细则。三、使用说明书的经写和印刷细则GB99691规定了编写和印刷使用说明书的一些具体事项：1使用说明书的文本尺寸产品使用说明书的开本相面，一般应符合GB788图书杂志开本幅面尺寸的规定。铅印本建议采用32开（130mm184mm）和16开（188mm26mm），也可采用64开（92mm126mm）和GB788规定的其他幅面尺寸。晒印本应采用A4号图纸（210mm297mm）。图表等允许向横向加长，确属必要时，也可向纵向加长，但均应按使用说明书开本大小折叠。数量太多时，也可与使用说明书分开装订。使用说明书根据内容多少确定为单页、折页和多页。多页应装订成册。2使用说明书的封面和封底使用说明书的封面应有能识别产品类别的名称、产品名称和使用说明书字样，并应有生产企业名称。出口产品使用说明书应在企业名称上冠以“中华人民共和国”字样，并应中、英文对照。允许在封面上印有产品照片、图形和经认可的标志和标记，如注册商标、厂标、产品标记和合格认证标志等。使用说明书的封底必须有产品生产企业的详细地址及邮政编码。必要时亦可写（印）上联系电话和电报挂号。3使用说明书的目次和目录在使用说明内容较多、章条太多时应编写目次，以方便用户查阅。复杂产品和成套设备的使用说明书应装订在一起，并编写目录。4使用说明书的文字、符号和单位使用说明书只供国内用户，可只写汉字，但汉字中简化字必须为国家正式公布的规范简化字，供给港、澳、台地区用户的使用说明书应写繁体字，不用简化字。出口产品使用说明书应汉英文对照（必要时还可书写其他外文），或按用户要求文种编写使用说明书。使用说明书中的文字应简明扼要，通俗易懂，段落分明，标点符号无误。无论是汉字、外文字母及数字均应字体端正、笔划清楚、排列整齐、间隔均匀。使用说明书中使用的各种符号、代号和计量单位均应符合国家有关法令、法规和标准的规定，在同价使用说明书中前后一致。使用说明书的图、表、公式和数值，应符合GB1l等标准的有关规定。产品结构图优先采用立体图。采用非标准图形符号时，应注明其含义。5使用说明书的印制使用说明书应能长期使用，保证在产品预期寿命期内的可用性。一般已批量定型生产的产品使用说明书，应采用铅印，否则可晒印。使用说明书上的文字、符号、图形、表