您的文档对读者友好吗?

目前还没有读者喜欢这篇文章。
Image of typewriter keys

原始照片由 mpclemens 拍摄。由 Rikki Endsley 修改。CC BY-SA 2.0

任何一位有成就的技术作家的首要任务都是为读者写作。这个任务听起来很简单,但是当我想到世界各地的人们时,我开始思考:他们能读懂我们的文档吗?可读性是一个已经被研究多年的课题,以下是对研究结果的简要总结。

研究证明,人们会对他们容易理解的信息做出反应。问题是:我们编写的内容是否是普通人可以轻松阅读和理解的?如果人们无法理解我们的内容,原因之一可能是我们写得“太高深”,这种情况比您想象的更常见。为了听起来更优秀、更聪明或更像我们领域的专家,许多人会过度写作内容,或使用大词来占据最多的印刷材料空间。

检查您的文档是否易于阅读的一个简单方法是使用可读性测试。为此目的已经创建了许多不同的测试,其中最流行的三个是

  1. 弗莱士阅读容易度
  2. 弗莱士-金凯德
  3. 冈宁雾度指数

流行的可读性测试

弗莱士阅读容易度测试

鲁道夫·弗莱士约翰尼为什么不会阅读:《以及您能为此做些什么》的作者,创建了弗莱士阅读容易度测试,以进一步推进他认为美国教师需要回归语音教学而不是视觉阅读(整体单词识字)的信念。他的工作和对阅读和语音学的倡导是苏斯博士创作戴帽子的猫的灵感来源。此测试告诉我们文本的易读程度。算法如下

algorithm

图片来自 维基百科CC BY-SA 3.0

结果得分解释如下

table

表格来自 维基百科。 CC BY-SA 3.0

这意味着什么?

  • 分数越低,文本越难阅读
  • 65 分是“简明英语”评级

这个分数与知名出版物相比如何?[1]

  • 读者文摘:65
  • 时代杂志:52
  • 哈佛法律评论:>40

弗莱士-金凯德学年级别可读性测试

弗莱士-金凯德阅读测试是鲁道夫·弗莱士(上面提到过)和 J. 彼得·金凯德之间合作的成果。J. 彼得·金凯德是一位教育家和科学家,他一生都在学术界工作或在美国海军进行研究。J. 彼得·金凯德在与海军签订合同期间开发了他的可读性测试版本,目的是评估技术手册的难度。弗莱士-金凯德学年级别可读性测试将测试转换为美国学年级别,这使得判断材料是否易于他人阅读变得更容易。算法如下

algorithm

图片来自 维基百科。 CC BY-SA 3.0

结果对应于美国学年级别,因此一旦计算出分数,我们就知道谁可以理解我们的写作。例如,奥巴马总统的2012 年国情咨文的学年级别为 8.5;然而,平价医疗法案 的可读性级别为 13.4(大学或更高学历)。一些流行书籍的可读性结果可能会让您感到惊讶:

冈宁雾度指数

冈宁雾度指数创建于 1952 年。算法如下

algorithm

图片来自 维基百科。 CC BY-SA 3.0

这个指数并不完美,因为有些单词(例如university)很复杂但容易理解,而短词(例如boon)可能不容易理解。鉴于此,结果可以解释如下 [2]:

  • 雾度分数 >12 最适合美国高中毕业生
  • 8-12 之间(更接近 8)是理想的
  • <8 接近普遍理解

为什么我应该关心我的写作的可读性?

如果我们的写作太难阅读,那么没有人会想阅读它。可悲的事实是,大约 50% 的美国人具有八年级的阅读水平。我们的写作学年级别越高,可以阅读它的人就越少。如果我们很难阅读某些内容,那么我们对内容的体验将是负面的,而这种负面体验会使我们不太可能向其他人推荐该内容。您有没有推荐过您不喜欢读的书?文档也是如此。

我如何计算我的写作的可读性?

有几种方法可以计算可读性。计算它的最简单方法是在文字处理器或编辑工具中。例如,Publican 是一种基于 DocBook XML 的发布工具。Publican 4.0.0 版本新增了 弗莱士-金凯德统计信息功能,该功能允许用户运行以下命令

$ publican report --quiet

这将生成可读性报告。

如果您使用 vim 作为您的文本编辑器,可以从 GitHub 下载并安装 vim-readability 插件(感谢 Peter Ondrejka)。gedit 也提供类似的插件 gulpease。要检查可读性而无需使用插件,请在 Readability-Score.com 复制并粘贴文本。

最后的想法

保持简单,亲爱的!我们的文档越容易理解,使用它的人就越多。如果您好奇,本文的可读性为

  • 弗莱士:68.5
  • 弗莱士-金凯德:6.9
  • 冈宁雾度:9.3

一旦我们知道我们写作的可读性,我们就可以在必要时简化它。我将在我的下一篇文章中概述简化它的想法。敬请期待!

来源

  1. 弗莱士-金凯德可读性测试(维基百科)
  2. 冈宁雾度指数
  3. Shane Snow 的《这项令人惊讶的阅读水平分析将改变您的写作方式》
  4. Readability-Score.com
标签
Avatar
Laura Novich 是一位资深技术作家,她的职业生涯始于 1997 年,当时她在 3Com 担任技术作家。从那时起,她曾在几家初创公司工作过,现在在红帽公司担任技术作家,专门研究虚拟化产品。

8 条评论

这太棒了。我使用 Publican 多年了,但我不知道 4 中添加了 report 选项。

当数学和语言艺术混合在一起时,我表示怀疑,但这让我感到好奇。

我通常会把它给家人看,以了解非技术、技术和更技术受众的接受程度。

:)

此外,Perl 脚本语言有一个模块“Lingua::EN::Fathom”,可以生成这三个测试的值。非常流畅!必须开始在我的博客文章中使用它。

可读性和可理解性的另一个方面是要考虑非英语母语人士。
显然,世界各地的人们理解英语的能力越来越强,但即便如此,您也应该小心使用比喻性的语言,在许多情况下,这些语言很容易通过复杂性测试,但却很难翻译成其他语言。还有一些习语短语,在不同的语境下有不同的含义。

Greg 说得好,这就是为什么本地化比翻译更重要,因为习语需要本地化和翻译,以确保信息传达相同的含义和意图。
感谢您的评论!
Laura

回复 ,作者 Greg P

Laura,这是一篇非常棒的文章,原因有很多。首先,鼓励我们所有人思考我们工作的可读性是一个极好的主意;感谢您!其次,拥有自动诊断工具非常酷。第三,一个专门解决文本整体可读性的工具本身就非常有趣。事实上,它让我去寻找其他这样的工具,我找到了这个

https://github.com/bookieio/breadability

它不仅介绍了自己(作为一个工具),还提供了一些其他替代方案。

除非首字母缩略词的含义已在文档中先前定义**且**已包含在文档末尾的词汇表中,否则永远不要在文档中使用首字母缩略词。我能想到的唯一例外是 USA,当上下文清楚地表明它指的是地理区域时。

知识共享许可协议本作品根据知识共享署名-相同方式共享 4.0 国际许可协议获得许可。
© . All rights reserved.