问题9：文档质量评价标准和规范有哪些？
从语言角度来评价文档质量,大家很可能想到用“段落鲜明、句子通顺、语法正确(无病句)”等字眼来描述。其实,语言正确仅仅是文本“识读”层面的标准,是沟通低层次的要求。即使在语言正确的前提下,模仿模板使用标题、列表和表格的文档也不一定能拥有和模板同样的质量。优质文档不仅要可“识读”,更要“适读”,也就是要在文档的使用性和用户体验层面有更多的要求,因此,辨识文档质量需要了解相关的评价标准和规范。
IBM公司的文档质量标准被公认为职场文档的通用评判指标,它们包括“易获取、易理解、易使用”这三大标准,在各大标准下再细分有小标准,具体如表9-1所陈述:
表9-1 IBM公司的文档质量标准参考
续表
虽然表9-1中的这些标准发起的语境是英文语境,但它们对于中文语境也具有较高的参照价值。在职场中,无论你的文档类型是技术类还是行政类,都可以参照这些标准来撰写、评估,这些标准可以有效提升文档质量。
除了IBM的标准,专业的文档人员可能还会需要参考国际或国内一些其他涉及技术文档质量的强制性或推荐性标准。其中ISO/IEC 82079－1是技术信息领域最基础、最重要的国际通用标准,该标准适用于所有的行业领域,从使用说明的编制流程、质量评估到人员资格要求都作了规定,是技术撰稿人、技术文档服务提供商、翻译人员和本地化人员等重要的工作参考。表9-2整理了部分行业评价技术文档质量的国际标准及国内标准。
表9-2 部分行业评价技术文档质量的标准
续表
除了上述标准外,国内还有一些与文档质量相关的标准零散分布在其他标准文件中,如GB/T18978.13－2009使用视觉显示终端(VDTs)办公的人类工效学要求中涉及的用户指南标准、GB2893.2－2008图形符号、安全色和安全标志中涉及的产品安全标签的设计原则等。由于国内的技术文档评价标准还有待整合完善,目前部分高新企业和一些高校积极合作,深度借鉴成熟国际企业的实践,正大力推进国内技术文档团体标准在不久的未来出版。
参考文献
Gretchen Hargis.et.al,Developing Quality Technical Information:A Handbook for Writers and Editors.[M].2nd ed.New York:IBM Press,2004.