IBM 作为一家高大上的 IT 公司,对技术写作领域的影响也非常大,比如 DITA,比如技术写作规范,比如对技术写作人才培养(仅在上海,IBM 就有几十名技术文档工程师),等等。
那么,IBM 技术文档质量标准是什么?来看看 IBM 是如何定义高品质的技术信息内容的吧。
IBM 的 Corporate User Technologies Team 将高品质的技术信息概括为三个方面:
- 高质量的技术内容
- 优秀的用户体验
- 有价值的内容
下面分别来看看这三个方面都包括哪些具体的要求。
高质量的技术内容
- 准确性: 没有错误,并且均以事实为依据。
- 清晰度: 不能模棱两可或模糊不清;用户可以快速地理解所要表达的信息。
- 完整性: 包括并且只包括所有必要信息。
- 具体性: 包含合适的例子、应用场景、图示、类比、图片等。
- 内容组织:内容各部分的组织结构清晰,易于用户理解。
- 易检索性:用户可以简单快速地找到某个条目。
- 写作风格:恰如其分地遵循写作规范和遣词造句。
- 任务导向:内容应以帮助用户使用产品和工具以完成特定的任务为目标。
- 视觉效果:通过合理的布局、图画、颜色、字体、图标等显示方式增强信息的表现力和吸引力
优秀的用户体验
-
用户可以轻易地找到所需要的信息
多时候并不是缺少信息,而是用户无法找到他们想要的内容。搜索功能的可用性、易用性、准确性和导向性很重要。
-
信息内容的表现形式需保持一致
同一公司的不同产品或同一产品的不同版本应保持统一的风格,比如导航的功能图标、文件格式等。没有用户希望由于这些不一致而浪费他们宝贵的时间。
-
信息内容要能够解决当前用户眼前的具体问题
一份详尽的安装文档当然十分有用,但是让一个 Windows 操作系统的用户看到 UNIX 的安装指南并没有什么意义。
-
信息内容的获取方式要考虑用户的不同需求
将信息内容发布在互联网上可以让大多数人轻易地访问到,可是也许部分用户无法联网;很多人在使用电脑,可是也有越来越多的用户在使用手机和平板设备……
有价值的内容
信息内容是对用户有价值的,是基于对用户的需求和情况进行充分了解后的产物。不应把用户文档仅仅当成用于解释如何使用产品的工具,它是产品本身的一部分,将影响用户对产品的总体评价。
参考资料:
November 2013 Issue of TechComm - Community-Driven Information Quality Standards: How IBM Developed and Implemented Standards for Information Quality