当前位置:主页> 技术支持> 论文选登
 
   
 
 
本文作者

浅谈产品说明书的质量保证

乔文俊 

20052

作者部门:技术开发部

作者职务:高级工程师 技术顾问

 

 

 


  说明书是产品技术文件的一种,在产品的流转过程中起着与用户直接沟通的重要作用:在商品交易中起着宣传和承诺的作用,在产品的使用和维护中起着告知和权威性的指导作用,是其它技术文件所不可替代的。说明书中融合了产品的专业技术和产品服务对象的工艺或试验技术,并受到国家质量法规、安全卫生法规、广告法规和编制规范的约束和指导。说明书质量是企业人文素养的体现,也是企业文化的一个投影。一个优良的产品必有一本精美的说明书作衬托。
产品说明书的描述必须与产品实物相符。说明书要说得明,用户看得懂,要领容易记。说明书的一切瑕疵都会使用户对所购买的产品质量产生联想。说明书的排版质量、纸张和印刷质量是不可忽视的因素。本文着重讨论编制和管理二个常见因素对产品说明书质量的影响问题。

  一、编制质量是产品说明书质量的主导因素
  想要使说明书说得明、看得懂、要领突出、通篇协调,这是编制人员的职责。说明书的编制质量受以下因素的影响:
  1)编制水准 编制人员的编制水准和他们的技术水平是二个不同的概念。说明书通常是由技术人员起草编制的。技术人员可以设计出较为完美的产品,但不一定能编制出完美的说明书。说明书的编制工作涉及到编制人员的专业水平、逻辑水平、编辑及文字功底、审美观、考虑问题的角度、抽象表达能力等等,是设计人员综合能力的一个体现。产品设计受到的是大量标准和规定的约束,说明书受到的是用户的考核。产品的复杂程度以及产品使用的不同对象都会对说明书产生不同的要求和评价。编制需要顾及这些因素。例如:相对试验箱类产品而言,干燥箱类产品操作简单,一般由生产第一线的熟练工人操作据多。试验箱类产品结构复杂,需要设定的参数和程序多,一般由技术人员或专业试验人员操作。根据这些特点,干燥箱类产品说明书应强调以简洁明快为主,试验箱类产品说明书应强调以严密周到为主。
  2)逻辑和文字。说明书内容要完整、章节相扣步步深入。章节顺序应尽量统一。尽可能避免调节章节的顺序,以便检查是否有缺漏的章节。文句的表述要保持确切流畅、通顺简洁。操作步骤的叙述要和图示内容密切结合。出现在不同段落中的同一另部件,其名称叫法要一致。名称要规范,不能用土语。文句必须遵守语法的规则。如果说明书出现了许多明显的病句或表达不清的句子,说明书的权威性就会受到置疑。过分的形容和夸大的描述还可能带来与愿望完全相反的麻烦。生僻的文字和错别字应尽量避免。模棱两可的文字应该一律更正或删除。说明书同样要遵守广告法的规定,不能有贬低别人抬高自己的成分。随着社会人文科学的发展,说明书的内容更要考虑以人为本的问题,既要客观,又要有人性化。
  为了使说明书能起到完整说明的作用,说明书至少要包括以下内容:1)产品的用途和简介;2)产品技术标准和本产品特定适用对象的工艺方法标准代号;3)产品使用时的环境条件;4)产品技术参数;5)产品结构和原理简介;6)产品的出厂状态及操作和调整方法;7)运输、储存、维护和保养方法;8)告戒或注意事项;9)常见故障及排除方法;10)随机文件和易损件清单;11)对用户的售后服务承诺和保修联系方法等。说明书中不应列入与产品无直接关系的内容,以免淡化说明书的主要功能和主题。
  3)审美观。可以用图示形式表达的场合,应根据图文并茂的原则进行安排。表格、图示与相关说明文字在位置上应尽可能靠近,便于图文互相对照查阅。相关的内容尽量在同一页内表达完毕,便于不用翻页即能查阅所要阅读的内容。避免出现大段的文字说明。因为连续大段的文字容易使用户由枯燥而产生阅读疲劳,影响阅读效果。遇到这种情况,必要时可以插入相关插图进行调节。所采用的照片如果分辨力差的话不如用绘图代替。说明书的指导作用决定了说明书特有的严肃性,应该避免出现卖弄和色彩上的花里胡哨现象。
审美观与人文素养有关。不同的地缘文化和教育水准会就有不同的审美观点。在色彩的浓淡素杂、对比的强弱变化、文图的配比多寡和表达方式上,人人的欣赏角度不尽相同。本文所及也仅是作者一孔之见。说明书要做到人人夸赞是不可能的,尽量完美是可以争取的。
  4)考虑问题的角度。说明书的对象是用户。用户的概念不能只理解为产品的使用人员,还应该包括用户单位的设备管理、设备采购和设备维护人员。本企业的销售和售后服务人员也是说明书的间接用户。编制的说明书需要同时考虑他们的不同需要,必要时征求不同角度的意见。
  以常见故障的排除方法一节来讲,科技人员可能比较习惯于以结构和原理为出发点,考虑哪个关键环节出现问题时将出现什么现象,再考虑用对应的方法去排除故障。虽然编制人员费尽心计罗列了许多可能的问题和排除故障的方法,但很可能这些环节出现问题的概率很低,用户从中找出真正解决的方法要从理解设计思路开始走一些曲折的途径。另外,说明书上列了过多的故障可能,用户也完全可能产生错觉:是不是这种设备的可靠性很低。这种错觉并不是编制想要的效果。应该提倡编制要站在用户的立场上编制说明书。作为一个对设备的结构和电气原理不甚精通的直接用户,他首先希望设备的故障概率低、产品合格率高。其次不会产生严重的故障。即使发生一般故障,在说明书的指导下,自己也能很快排除。因此,说明书的编制人员应该首先选择从产品服务对象可能发生的不合格现象入手来编制常见故障的排除办法,使用户一发现问题就能很快找到对应的解决办法。
5插图和抽象表达能力。图示表达应真实确切,采用局部表达方式时,应对所表达的局部在整体上的部位有文字或简图交代。好的抽象表达方式(例如国家标准规定的一些警告和警示标志)是一种简捷明要的办法,可以使用户很容易接受和记住所要表达的信息。应该提倡尽量采用标准规定的抽象表达方式。当需要创造新的抽象表达方式时,创造的抽象图示应为用户很容易理解并接受,同时也不会使用户产生其它不应有的理解结果。
  三维立体表达方式与平面表达方式在不同的场合和不同的阅读对象面前会得到不同的效果。但立体表达方式的视觉真实性更容易为用户所理解。绘制立体表达时需要注意:一要遵守三维效果图的视觉规则,二要突出需要表达的重点。不需要表达的部位应予适当简化或淡出。违反规则和眉毛胡子一把抓的立体图会降低说明书的品位,冲淡表达的效果。

  二、管理不妥同样会对产品说明书的质量带来影响。
  基准范本管理不当,可以造成付印的是过期无效的说明书;更改程序管理不当,可以造成说明书与产品实物的不符合。基准范本只能保留一份,而且与历史版本必须分开存放。各种版本的存放位置和标识要清楚。说明书发生更改,必须遵循从论证开始,经过批准、更改范本、付印验收、发新收旧这个管理程序。这些程序应该有记录可查。漏掉任何一个环节,都有可能对产品说明书的质量带来影响。产品新老交替时期,新老产品的说明书和范本均在有效期内,一有疏忽就可能产生严重差错,这一点必须引起特别注意。
  必须杜绝在说明书上打补丁和开天窗的现象。在用户看来,这是产品不成熟不稳定的表现。如果补丁出现在数据和结构原理部位,用户不太可能理解为是笔误,多半理解为产品的参数不稳定,设计不成熟。进而联想到这个厂以前的产品可能都有类似问题。如果补丁出现在文字部位,用户可能认为这个厂编制水平不高,审核不严。进而会联想到这个厂的管理水平和文化素养方面去。如果说明书出现开天窗的现象,用户只能认为这是一本不严肃的、很随意的说明书。说明书的不严肃只能理解为产品也是不严肃的。如果同一本说明书上同时出现多处这样的问题,产生的负面效应将是非常严重的,也必然会对企业的形象和利益带来直接影响。如果这些现象的出现将不可避免时,莫如更换版本。但避免出现这些现象的根本办法,应该是企业严格按照《GB/T19001-2000 质量管理体系 要求》的规定,做好产品开发设计或改进的论证、评审和确认工作,认真做好产品说明书的编制、校对、审核和文档管理工作,从根本上减少差错和漏洞,使说明书的质量得到有效保证。

 

 

返回页首

如有关于本站点的问题或建议,请发邮件联系我们
版权所有(C) 上海实验仪器厂有限公司 Shanghai Laboratory Instrument Works Co., Ltd.
上次修改时间: 2002-12-16 12:18