定义：RTFM（Read The F'ing Manual）。有时它被讽刺地渲染为 Read The Fine Manual，这是一个对那些提出问题的人说的短语，我们这些开明人士认为回答这些问题有损我们的尊严，但利用这个机会来打压新手的自尊心却不有损我们的尊严。
您是否注意到，一个特定的开源社区越频繁地告诉您 RTFM，FM 就可能越糟糕？我多年来一直在思考这个问题，并得出结论，这是因为耐心和同理心是编写良好文档的基础，就像它们是成为一个正派人的基础一样。
首先，一些免责声明。
虽然我从事开源文档编写工作已经快 20 年了，但我没有接受过实际培训。有些人接受过培训，并且有一些很棒的书籍，如果您关心这些东西，您应该阅读这些书籍。
首先，我推荐 Anne Gentle 撰写的 Conversation and Community。如果您正在寻找关于这方面的会议，我建议参加两个会议：Write The Docs 和 OpenHelp。
本文的标题来自 Kathy Sierra，她在多年前的一次演讲中展示了一张 幻灯片，上面写着，“如果您希望他们 RTFM，请制作更好的 FM。” 但我们如何做到这一点呢？
开源世界中有一个普遍的共识：每个人都知道文档很糟糕，没有人愿意编写文档，而且情况就是这样。但事实是，很多人想编写文档。我们只是让他们参与变得太难了。因此，他们在 Stack Overflow、他们的博客和第三方论坛上撰写文章。虽然这可能很好，但这也是最差实践解决方案蓬勃发展并获得势头的好方法。接纳这些人并让他们成为您项目的官方文档工作的一部分有很多优势。
与小说写作不同，小说写作的普遍建议是直接开始写作，但对于技术写作而言，您需要稍作计划。在开始之前，您应该问自己几个问题。
谁？
首先是谁？。您是为谁写作？一些专业技术作家会创建 人物角色，以便他们在写作时可以思考，“Monica 在这种情况下需要知道什么？” 或“Marcus 可能在哪个方面遇到问题？” 然后相应地写作。
在这个过程的这一点上，记住并非所有的受众都是年轻、白人、说英语的男人 他们是看着 Monty Python 长大的 至关重要。
案例 A：Python 文档
Python 文档 中充斥着 Monty Python 的引用
现在，不要误会我的意思：Python 文档在很大程度上是很棒的。但我对它有一个抱怨——内部笑话。Monty Python 的幽默贯穿所有文档，这是一把双刃剑。内部笑话形成了一种社区意识，因为您理解这个笑话，所以您是内部人士。除非您不是。在这种情况下，内部笑话鲜明地指出您不是内部人士。在此处谨慎行事。考虑包含一份参考指南，解释这些笑话，并且在死鹦鹉的情况下，指向一个 YouTube 视频
俚语也是如此。
案例 B：PHP 文档
在这个 PHP 文档示例 中，英语谚语大海捞针被引用，旨在使示例更易于理解。如果您是以英语为母语的人，这个例子很棒，因为它清楚地表明了哪个参数是哪个。但是，对于非英语母语的读者来说，这个例子表明他们不是目标受众，这可能会对将新人带入您的社区产生令人不寒而栗的影响。
哪里？
接下来要问的问题是哪里？。是的，您需要在您的项目网站上提供文档，但对话还在哪里发生？除非在极少数情况下，否则其他网站，例如 StackOverflow，是您项目的实际文档。如果您真的关心帮助您的用户，您需要去他们所在的地方。如果他们在 Twitter、Facebook 或 AOL 上提出问题，您需要去那里，在那里回答他们的问题，并给他们指回官方文档的指针，以便他们知道下次在哪里查找。
您无法控制人们在哪里进行对话，试图这样做会被视为与您的受众脱节。（当我在谈论这个话题时，他们无论如何都不是您的受众。）
有一次，当我在一家前雇主工作时，我们发现我们的受众在 Facebook 上进行对话，而不是在我们的网站上。掌权者决定我们必须阻止这种情况，我们建立了自己的内部社交网站。然后我们告诉所有人，他们在讨论我们的组织时必须使用它——而不是 Facebook。我猜您能猜到这对我们来说效果如何。
但是，当您忽略 StackOverflow、Twitter 和各种第三方网站上的受众时，您也在做同样的事情，因为他们不在正确的位置。
什么？
接下来是机制。您应该写什么？
范围
您必须决定的第一件事（是的，您需要决定这一点，因为不一定只有一个正确的答案）是您的文档范围是什么。也就是说：您愿意涵盖哪些主题？当然，这意味着其他所有内容都超出范围，应该推给其他人的文档。
例如，在 Apache Web 服务器文档中，我们有一份名为 入门 的文档，其中涵盖了您在开始之前需要了解的内容。该文档的目标是划定一条线，说明什么是文档范围之外的内容，同时还将人们指向实际上深入涵盖这些内容的资源。因此，HTTP 规范、DNS 的内部工作原理以及内容事项（例如 HTML 和 CSS）都完全超出了文档的范围，但每个使用 Apache Web 服务器的人都需要了解这些内容。
文档类型
一旦您确定了范围以及您要为谁写作，您就可以为他们编写几种不同类型的文档。Anne Gentle 将它们分类如下
从这里开始
就像我之前提到的入门文档一样，这是您告诉用户他们在开始之前需要了解什么的地方。
参考指南
参考指南是全面的，通常非常枯燥。这是定义术语、解释函数输入和输出以及给出示例的地方。语气是事实性且切中要害的。没有太多讨论或对话。声音通常是非个人的。
教程
教程手把手地引导您沿着路径前进。它们向您展示每个步骤，偶尔会在路径旁边的长凳上坐下来，解释特定步骤的基本原理。它们非常健谈，有时甚至喋喋不休。声音是私人的；您正在与早期人物角色阶段定义的特定人交谈。
学习/理解
学习/理解文档通常从教程链接过来，它们会更深入地挖掘。他们调查特定事物的来龙去脉。为什么做出某个决定？它在代码中是如何实现的？这件事的未来会怎样？您如何帮助创造未来？这些文档有时最好以博客文章的形式完成，而不是作为正式文档的一部分，因为它们可能会严重分散那些只是想解决问题的人的注意力。
食谱/配方
《食谱》通常是 O'Reilly 技术图书目录中最畅销的部分，这是有原因的。人们想要解决方案，而且他们现在就想要。您文档的配方或食谱部分应提供针对常见问题的即用型最佳实践解决方案。它们应附带解释，但您应该理解，大多数食谱用户会复制粘贴解决方案，然后就此结束。
您的很大一部分受众只关心解决他们眼前的难题，因为这就是他们获得报酬的全部目的，您需要理解这是一个完全合理的需要。当您组装新的宜家书桌时，您不关心为什么选择特定的螺丝尺寸，您只是想要说明书，并且您希望它们能工作。
因此，至关重要的是示例已经过测试。无论示例多么微不足道，您都必须对其进行测试，并确保它能完成预期的工作。许多令人沮丧的时间都花在了试图弄清楚文档中的示例为什么不起作用上，而几分钟的测试就会发现冒号应该改为分号。
配方还应提倡最佳实践，而不仅仅是最简单或最快的解决方案。并且永远不要告诉他们如何不这样做，因为他们只会复制粘贴它，然后陷入比开始时更糟糕的困境。
我最喜欢的网站之一是 There, I Fixed It，它展示了那些不考虑其解决方案可能产生的后果就解决问题的人的聪明才智——他们只是想解决问题。
错误消息
是的，错误消息也是文档。有用的错误消息实际上指向解决方案，可以节省无数的搜索和挫败时间。
考虑以下两条错误消息
`ERROR. FORBIDDEN`
和
`Access forbidden by file permissions. (ERRNO 03425)`
第一条消息令人震惊，但无济于事，需要大量摸索才能弄清楚为什么被禁止。第二条消息告诉您这与文件权限有关，并且额外的好处是错误编号，您可以在 Google 上搜索到许多详细说明如何解决问题的文章。
理念
这种完整的思路源于多年忍受技术支持渠道——IRC、电子邮件、正式文档、Usenet 等等。我们这些掌握答案的人似乎想让新人感到困难。毕竟，我们光着脚在雪地里上学，然后又走回来，还记得吗？我们通过阅读代码和实验来弄清楚如何使事情正常工作。我们为什么要让这些孩子们更容易呢？他们应该被迫挣得它，就像我们以前一样，对吗？
技术世界每天都变得越来越复杂。您需要知道的事物清单一直在增长，没有人可以成为所有方面的专家。期望每个人都完成所有功课并提出聪明的问题不仅是不合理的，而且正在变得不可能。
富有同情心的技术支持——以及更好的文档——是人们有效使用您的软件的唯一途径。而且，如果他们无法在合理的时间内获得答案，他们将使用具有更好铺平道路的不同解决方案。
在他 Programming Perl 一书的第一版中，Perl 编程语言的创建者和该社区的创始人 Larry Wall 开玩笑地谈到了程序员的三个美德：懒惰、急躁和傲慢
对这个笑话的解释 非常值得一读，但请记住，这些是程序员作为程序员的角色，与计算机相关的优点。在 1999 年出版的 Open Sources: Voices from the Open Source Revolution 一书中，Larry 解释说，作为一个人，与其他人交往时，我们应该渴望的三个美德是：勤奋、耐心和谦逊。
当我们帮助人们解决技术问题时，急躁会被视为傲慢。“我的时间比您的问题更重要。” 傲慢被视为贬低。“您很愚蠢。” 懒惰呢？好吧，那只是懒惰。
耐心和友善，帮助人们以自己的节奏前进（即使感觉很慢），会被视为尊重。欢迎各级人士，并耐心地帮助他们提升到下一个级别，这就是您建立社区的方式。
不要让人感到愚蠢：这必须是一个核心目标。
即使世界上每个人都是混蛋，您也不必是。
菜肴
本文是 Rikki Endsley 协调的“文档菜肴”专栏的一部分。要为本专栏投稿，请提交您的故事创意或通过 open@opensource.com 与我们联系。
24 条评论