也许大家都参与过2015年下半年的中国技术文档使用情况问卷调查,或看过2015年《中国技术文档使用情况调查报告》,有效问卷710份,涉及北京、天津、河北、上海、江苏、广东、四川等20余个省市及澳门、海外地区。那么,从这份报告之中,作为技术传播从业者的我们,都能得到些什么启发呢?
该份报告共23道题,主要涵盖技术文档使用效果的三个层面,即认知效果、情感效果、行为效果。从调查报告的结果来看,用户对技术文档的易理解性、易查找性、易用性和愉悦性评价普遍很低,而技术文档的使用率和用户对文档的忠诚度就更低了。
虽然影响用户评价的因素很多,比如遇到问题时寻求帮助的方式、是否习惯看文档、查阅文档的动机、对不同媒介文档的偏好、甚至年龄学历职业等,而其中也有很多因素是我们从业者无法更改的,但是笔者总结下来,从技术传播从业者的角度,还是有些是我们在平时工作中可以去努力的。
一、 杜绝词句错误
虽然遣词造句是我们的看家本事,但从这份报告我们不难看出,仍有不少这方面的问题给用户带来了直接的困扰,严重影响了用户体验,例如错别字、语法错误、歧义句、用词不统一等。而有些文档由于是翻译得来,在文档写作时受到了源语言的影响,或翻译不专业,或出现长句、复杂句、欧化句等。针对此类问题,我们需要在努力提高基本功的同时,认真开展审核、严把审核标准、提高审核效率和质量。力求语言规范、准确、一致、易于理解和查找。
二、 表达要清晰明确
笔者归纳了一下,从这份报告来看,用户抱怨较多的还有关于表达的问题,例如内容自相矛盾、复杂冗余、表述不清、主题不明等,导致用户很难或根本无法理解文档内容。有些文档甚至因为内容表达的不明确而导致用户无法轻易找到所需内容。因此,我们在日常写作和审核中具体要做的是:确保内容一致性、表达简洁清晰、主题突出,力求用户看得懂、找得到。
三、 改善文档呈现
目前多数文档仍是以文字呈现为主,但是图片有自己的独特用处。该用图片之处我们还是要使用图片,与文字相辅相成,才能便于用户阅读和理解。同时要注意图文搭配要适当、一致、重点突出,最大程度地运用好各种呈现形式的特点,为用户的体验服务。
四、 改进文档逻辑与架构
在文档开发初期的规划阶段和开发过程中,在文档(甚至文档库)逻辑和架构的规划和组织方面,我们还需要注意文档的逻辑顺序和架构设计要清晰、简洁、准确、合理,确保文档能够快速有效地引导用户找到其所需信息,使用户的问题在文档中找得到、找得快。
五、 坚持从用户角度出发
在写作过程中,我们要始终秉持用户角度,杜绝研发、市场等其它方从素材、审核等方面对文档写作角度的影响。例如,用词、场景、用户技术/知识水平定位以及因此决定的信息量(缺失或冗余)、内容难度等方面,都要坚持从用户角度出发去规划、去写作。
六、 丰富自身的产品及行业知识
作为从业基本要求之一,对产品及行业的了解仍然是我们需要改进的地方。我们业者要多学习掌握相关知识、技术、经验,对文档开发工作效率和文档质量都会有很大助力,进而提高用户的满意度。
我们常说用户至上,而此次调查反映出的部分用户的使用体验和反馈正表明了我们的不足。我们每一位从业者都应该多多审视用户反馈,不断提高自身职业水平、促进技术文档在国内的发展。
注:
-
TC沪联正在广泛征集研究课题,如果您对日常TC工作的某一方面有任何改善想法或感兴趣的课题,欢迎与我们联系。您将有机会参与到我们的研究项目中,和志同道合的同仁们一起努力,事半功倍。
-
2015年《中国技术文档使用情况调查报告》上篇请见:http://mp.weixin.qq.com/s?__biz=MjM5MzA5NzM3Mg==&mid=402759091&idx=1&sn=e4b9984f8e2f3080d42d82d53b27dc08&scene=0#wechat_redirect
-
2015年《中国技术文档使用情况调查报告》下篇请见:http://mp.weixin.qq.com/s?__biz=MjM5MzA5NzM3Mg==&mid=402891018&idx=1&sn=f9eed9eba6de64dd64cd6533012c481e&scene=0#wechat_redirect