比较两个文档的相似程度_您的文档对读者的友好程度如何？

比较两个文档的相似程度

有成就的技术作家所要做的首要任务是为观众写作。 这个任务听起来很简单，但是当我想到世界各地的人们时，我想知道：他们能阅读我们的文档吗？ 可读性已经研究了多年，接下来是对研究成果的简要概述。

研究证明，人们对可以轻松理解的信息做出React。 问题是：我们是否在编写普通人可以轻松阅读和理解的内容？ 如果人们没有与我们的内容联系在一起，那么一个原因可能就是我们在“头顶上”写作，这种情况比您想像的要多。 为了听起来更好，更聪明，或者是我们领域的专家，许多人都会覆盖内容，或者使用大胆的词语来最大程度地利用印刷材料。

检查文档是否易于阅读的一种简单方法是使用可读性测试。 为此，已经创建了许多不同的测试，其中最受欢迎的三个是：

1. Flesch阅读轻松
2. Flesch-Kincaid
3. 冈尼雾指数

流行的可读性测试

Flesch阅读轻松测试

鲁尼夫·弗莱施 （ Rudolf Flesch） ， 《约翰尼为何无法阅读：以及您能对此做什么》的作者创建了《弗莱施阅读轻松测验》，以此进一步证明了他的信念，即美国教师需要重返语音教学而不是视读（全字读写） ）。 他的工作以及对阅读和语音的拥护是苏斯博士撰写《戴帽子的猫》的灵感。 该测试告诉我们阅读文本有多容易。 算法如下：

^{通过维基百科的图。 CC BY-SA 3.0}

结果得分解释如下：

^{通过维基百科表。 CC BY-SA 3.0}

这是什么意思？

• 分数越低，文字越难读
• 65是“普通英语”等级

此分数如何衡量知名出版物？ [1]

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

Flesch-Kincaid等级水平可读性测试

Flesch-Kincaid阅读测试是Rudolf Flesch（如上所述）和J. Peter Kincaid合作的结果。 彼得·金凯德（J. Peter Kincaid）是一位教育家和科学家，他曾在学术界工作或在美国海军从事研究工作。 J. Peter Kincaid在与海军签订合同的同时开发了其可读性测试版本，以评估技术手册的难度。 Flesch-Kincaid年级水平可读性测试将测试转换为美国年级水平，从而判断材料是否易于他人阅读。 算法如下：

^{通过维基百科的图。 CC BY-SA 3.0}

结果与美国年级水平相对应，因此一旦计算出分数，我们就会知道谁能理解我们的写作。 例如，奥巴马总统在 2012年的国情咨文中的 评分等级为8.5； 但是，《 平价医疗法案》 可读性级别为13.4 （大学或更高）。 一些热门书籍的可读性可能使您感到惊讶：

• 晚安月亮 （玛格丽特·怀斯·布朗的儿童读物）：2.8
• 《老人与海》 （美国作家欧内斯特·海明威）：4.1
• 哈利·波特与死亡圣器 （JK罗琳的哈利·波特系列小说）
• 从优秀到优秀：为什么有些公司实现飞跃……而其他公司却没有 （詹姆斯·科林斯的管理书）：10.4

冈尼雾指数

Gunning Fog Index创建于1952年。算法如下：

^{通过维基百科的图。 CC BY-SA 3.0}

该索引并不完美，因为某些单词（例如 university ）很复杂但易于理解，而短词（例如 boon ）可能不那么容易理解。 鉴于此，结果可以解释如下[2]：

• 美国高中毕业生雾度最高> 12
• 8-12之间（更接近8）是理想的
• <8接近普遍理解

我为什么要关心自己作品的可读性？

如果我们的写作太难读了，那么没人会读。 可悲的事实是，大约有50％的美国人读八年级。 我们的写作的年级越高，阅读的人就越少。 如果我们努力阅读某些内容，我们对内容的体验将是负面的，而这种负面的体验会使我们不太可能将内容推荐给其他人。 您是否曾经推荐过您不喜欢阅读的书？ 文档也是如此。

如何计算作品的可读性？

有几种计算可读性的方法。 计算它的最简单方法是在文字处理器或编辑工具中。 例如， Publican是基于DocBook XML的发布工具。 Publican版本4.0.0包括附加的Flesh-Kincaid Statistics Info功能，该功能使用户可以运行以下命令：

$ publican report --quiet

这将生成一个可读性报告。

如果您将vim用作文本编辑器，则可以从GitHub下载并安装vim可读性插件 （感谢Peter Ondrejka ）。 类似的插件gulpease也可用于gedit。 要在不使用插件的情况下检查可读性，请将文本复制并粘贴到Readability-Score.com上 。

最后的想法

保持简单，亲爱的！ 我们的文档越容易理解，就会有更多的人使用它。 如果您感到好奇，那么本文的可读性为：

• 弗莱施：68.5
• Flesch-Kincaid：6.9
• 冈宁雾：9.3

一旦知道了我们作品的可读性，就可以在必要时对其进行简化。 我将在下一篇文章中概述实现此目的的想法。 敬请关注！

资料来源

1. Flesch–Kincaid可读性测试（维基百科）
2. 狐狸指数
3. Shane Snow的这一惊人的阅读水平分析将改变您的写作方式
4. Readability-Score.com

翻译自: https://opensource.com/business/15/11/how-reader-friendly-are-your-docs

比较两个文档的相似程度