by ClickHelp —最佳帮助创作工具
有时，您只是打开一个用户手册就知道它是不好的。 它看上去并不马虎，它具有很多内容，可以从各行中看到文档团队的辛勤工作。 而且，它仍然很糟糕。 这怎么发生的？ 我的朋友们，这是一个文档团队因不遵守全能80/20规则而沦为受害者的例子。 在本文中，我们将教您如何使用它并创建高质量的用户指南。
可能很好的用户手册
我猜我们所有人都偶然发现了这样的用户指南：有很多主题，数百篇，每个功能似乎都被提及。 我们去哇！ 看起来非常有用！”。 然后，失望降临了-大多数主题看起来非常简短而肤浅，大多数情况下，它们只是描述某些功能而没有提供任何提示或用例。 基本上，它看起来更像是字典，而不是产品文档。 我们可以猜想，负责本用户指南的技术作家做了很多工作，并确实对项目进行了一些思考。 他们的结构正确，涵盖了几乎所有功能，我们看到了正确的语法，正确的屏幕截图……但是，这几乎没有用。 怎么会？
或者，这是另一个例子。 您想在使用应用程序时执行某些特定任务。 您进入他们的文档门户并开始研究。 您会遇到许多精彩的内容，长期的帮助主题，并看到代码示例，方案和gif。 Aaand，您仍然找不到所需功能的任何信息。 在某些主题中多次提到它，但从未正确描述。 您很伤心，需要一个好友来交谈，因此您打电话给他们的支持，并询问他们-当许多用户肯定会使用这项功能时，他们为什么忘记将此功能纳入其文档中！ 这是怎么回事？
我敢打赌，此类用户手册的创建者从未听说过80/20规则。 这不完全是技术写作的规则。 这是可以应用于这个世界上几乎所有事物的规则。 不要从字面上看数字，这只是一个想法，应该遵循的原则，以确保您不会犯此类简单的错误。
简而言之80/20规则
此规则也称为帕累托原理。 它以意大利经济学家和社会学家Vilfredo Pareto的名字命名，他注意到20％的努力通常会产生80％的效果。 最初，帕累托研究了该国的经济状况，发现80％的土地属于少数幸运者，大约占总人口的20％。 经济学家开始研究其他国家，而80/20规则也适用于其他国家。 后来，他发现这些不可思议的数字非常适用于经济以外的情况。
文档编写中的80/20规则
如果我们通过80/20规则的棱镜看技术写作，我们可以做很多有用的观察。 例如，尝试回答以下问题：您想在用户手册中描述每个功能吗？ 然后，这个：您需要吗？
事实是— 80％的人正在使用20％的功能。
返回问题-在第一种情况下，您可能回答是。 这意味着您可能是完美主义者。 理想世界中的理想用户指南肯定会包含每个功能的详尽说明。 您会看到，在理想的世界中，您将有无限的时间和人力资源。 但是，我们生活在敏捷软件开发的世界中，效率和时间框架至关重要。
因此，您必须驯服完美主义才能提高文档质量。 不要让自己分散注意力，不要觉得自己需要涵盖每个主题并让每个人都开心。 实践表明，最好创建一个演示如何使用主要功能的教程，而不是试图为数百个帮助主题寻找资源，而最终，一半的质量会很差，而另一半则永远不会。被任何人使用。 时间是最宝贵的资源，请不要浪费时间。
当然，在将一些帮助主题从清单中删除之前，必须分析产品和客户需求。 另外，在将用户手册分发给最终用户之后，请确保始终保持沟通渠道畅通。 是否遵守80/20规则，反馈应该成为文档编写过程的关键部分。 您可能会发现某些功能正在流行，其描述需要更详细。 或者，相反，一些帮助主题几乎无法基于统计信息获得任何视图，因此，在下一次文档迭代时，不值得关注它。 如果您想了解有关文档反馈的更多信息，这是另一篇关于技术文档中用户评论的文章。
另一条建议。 文档的某些部分是不可替代的-不要试图摆脱“入门”部分。 这正是您应该使用的资源。 新客户应始终处于关注的中心。 是他们将推动您的业务向前发展。 为他们提供最佳的入职体验，它将获得回报。
结论
如您所见，帕累托原理可以并且应该应用于技术文档。 使用此简单规则，可以提高工作效率并使用户满意。
祝您技术上写好运！
ClickHelp —在线技术写作和文档工具
