综述
SUMMARY

压缩机产品使用说明书编写要点浅议

 压缩机产品使用说明书编写要点浅议
 
  企业每推出一款新产品,压缩机使用说明书的编写是避免不了的工作任务,本文笔者结合多次撰写说明书的经验,来分享说明书的编写过程。
  说明书是以应用文体的方式对产品来进行相对详细的描述,方便人们认识和了解。说明书有指导客户使用产品的作用,同时也是公司的宣传册,是与客户签订的“契约”。凡是客户必须知道的地方,说明书中不能遗漏一点,从而保证有效指导,提高产品使用的安全、寿命,如若内容不明确,可能会引起误会,甚至招来纠纷。此外高质量的说明书也可以激发客户再次购买的兴趣。
  编写说明书要有一个大概的框架。可以按照GB/T9969《工业产品使用说明书 总则》附录A中提供的标题作为框架,其逻辑性强,不会产生遗漏。然后对照标题去寻找相应的内容,分列项目、逐项说明,各项目明白地罗列出来,使客户看的明白。当然,可以根据具体产品的特点和使用要求对标题进行增减及合理排序。其中特别要注意的是,使用说明书应提供必要的保护环境和节约能源方面的内容,不能删减。这是一种社会责任和义务,也是标准的要求。
 
  说明书不同于普通的文章,其设计和编写都有规矩,可以参照标准GB/T 19678《使用说明的编制 构成、内容和表示方法 第一部分:通则和详细要求》。标准中规定了设计和编写各类使用说明的一般原则和详细要求。作为与客户沟通的媒介,使用说明书中相关信息的描述和细节应通俗易懂,符合压缩机客户群体的知识水平,使用说明应遵循客户群体的切实需求,提供充足的细节信息并保证相关信息的完整性。内容书写的基本要求和编制方法在标准中也写的很明白,大家可以自行翻阅,这里不再赘述。标准中带有“应”字段的内容要求在说明书中要体现出来,标准中带有“宜”字段的内容可以根据自身特点选择使用。
  说明书内容务必明白、准确才能使读者完全理解,没有含糊、误会的弊病。以中压无油空压机使用说明书为例。在动手写说明书的时候,作者心中不能存在一些连自己也理不太清楚的地方,落到纸面不能有一句不合理的,足以发生疑义的文句。这是一个消极条件,如果不顾这个消极条件,写下来的说明书就达不到它的目的。自己拿不准的,比如性能参数、寿命周期等等这些内容可以向相关技术人员请教确认。我们可以按标准列出提纲,请求技术人员来协助完善。另外,说明书的内容还要参考一些专业标准。GB/T10892-2005《固定的空气压缩机安全规则和操作规程》第14~22章有用户应履行和遵守的要求,特别是压缩机的安装、管道系统和压缩机的操作要求是客户必须掌握的,要在说明书中体现出来。

        GB22207-2008《容积式空气压缩机安全要求》中4.4.3超温停车装置灵敏性检验,介绍了检验方法和次数。5.4使用说明,介绍了说明书中必须包含的内容,根据机型可增减;JB/T 10683-2006《中、高压往复活塞空气压缩机》和JB/T 8933-2008《全无油润滑往复活塞空气压缩机》标准中有关于保修期、用户环境要求和针对无油高压空压机的专用条款,摘录出来写到说明书里。有关压缩机环境保护方面可参照标准GB50894-2013《机械工业环境保护设计规范》。法律方面的问题,可以在说明书完成初稿后,由法务审定,特别是售后服务,责任边界方面要定义清楚,不能含糊。其它机型的产品也有相应的标准要求,一般行业标准的内容要比国家标准更加详细,其参照的规范性引用文件也是标准巡查的线索。
  说明书要指导用户使用产品,就要充分考虑用户的接受程度,尽量多的使用图标、图表、图示等简洁明快方式去表达,方便客户理解。例如,用警告图标(三角框加一个“!”),客户看到这个符号,就会引起注意;用流程图表来演示操作过程,方便客户理解前后操作的衔接关系。空压机系统流程图、电气原理图、设备爆炸图与零部件明细表等图示,这都是使用说明书里不可或缺的。其中,系统流程图演示了气路,水路等流经的器件,客户可以通过它了解器件之间的物理关系,从而有一个宏观的概念。电气原理图是用来表明设备电气的工作原理及各电器元件的作用,相互之间的关系的一种表示方式。 运用电气原理图,可以方便客户分析电气线路,排除电路故障、程序编写等。
 
  为了使客户有一个良好的阅读体验,字体的选择应严谨、简洁、耐看。黑体和宋体气质庄重,是很好的选择。段落、字间距等格式也要斟酌。外文和繁体字使用说明书的要求可参照GB/T 19678标准。
  配色方案的选择也是一个有讲究的方面,一个设计学院的学生学习配色可能要花两年的时间。没有经过专业训练的人做这件事情是有困难的,做出来的配色方案会使人感觉俗气。我在这里简单说一下一些配色经验,首先颜色不要超过三种,一主两辅最好,如果公司有主题色,尽量采用,或在商标中取色。其次可以在网上找到优秀的配色方案。这里推荐Dribbble网(https:// dribbble.com/),在该网站有很多优秀的图片,而且还非常贴心的给出了配色表,还有一个配色网(http://www.peise.net/),也有很多优秀的配色方案可以拿来用。
  说明书写的太多,客户阅读起来困难,写的太少,客户感觉你不太重视,所以要权衡,反复锤炼文字。此外,说明书是要批量印制的,一个错误可能会带来非常大的影响,所以要在印制之前仔细校对检查。
  最后,借鉴成熟公司的说明书,优秀公司的产品说明书,都是经过市场检验,千锤百炼,有其独到之处,拿来参考最好不过。
 
  参考文献
  GB/T 19678.1-2018/IEC 82079-1:2012 《使用说明的编制 构成、内容和表示方法 第一部分:通则和详细要求》
  GB/T9969-2008《工业产品使用说明书 总则》’;
  GB/T10892-2005《固定的空气压缩机安全规则和操作规程》
  GB22207-2008《容积式空气压缩机安全要求》;
  HG/T 20206-2017《化工机器安装工程施工及验收规范(中小型活塞式压缩机)(附条文说明)》
  JB/T 10683-2006《中、高压往复活塞空气压缩机》
  JB/T 8933-2008《全无油润滑往复活塞空气压缩机》
压缩机产品使用说明书编写要点浅议

  • 温馨提示:如果您喜欢本文,请与我们联系索取原文。
    E-mail: magazine@compressor.cn