渗透步骤 文档_完善文档的4个步骤：如何为用户提供问题的确切答案

渗透步骤 文档

当人们使用您的软件时，他们正在努力实现目标。 他们正在尝试解决问题，找到自动柜员机，赶上Leafeon。 他们通常不使用软件，是因为他们自己享受软件的乐趣。 但是，仅仅因为用户不希望使用某些软件并不能消除他们对此的感觉。 如果它经过特殊设计可以帮助他们完成自己想要的事情，他们可能会感到高兴，但他们不会注意到中性的情绪，而且他们注意到的情绪大多是烦人甚至是愤怒。

向人们提供有关您的软件的最重要的部分是记住他们正在使用它来完成某件事，而不是他们想阅读它。

很少有人喜欢阅读文档，很少有人喜欢编写文档。 但是文档使您不必为已经烦躁的用户一遍又一遍地回答相同的问题。 到大多数人阅读文档时，他们已经失败了，并感到沮丧，并且没有任何可爱的要点会变得更好。 更好的方法是帮助他们尽快找到确切问题的准确答案。 这是一门艺术，您可以学习。 为了减少支持成本和减少用户流失，您将不得不编写一些文档，而我将告诉您如何尽可能轻松地进行操作。

1.弄清楚问题到底是什么

如果您没有用户，请找到一些与您的目标用户相似的人。 如果您没有目标用户的个人资料和角色，建议您备份一些步骤，因为您还没有真正准备好开始编写用户文档。

询问您的用户他们打算如何使用您的软件。 不要以为你知道。 看着他们使用产品，弄清楚他们在哪里挣扎或困惑。 如果您对他们的帮助不大，您只会知道这一点。 当您看着人们不满时，保持手和声音的中立是产品测试中非常困难的部分。

找出用户在哪里互相帮助。 堆栈溢出是用户问题和帮助的宝贵财富。 走廊上可能有一个IRC频道，一个闲聊，一个用户论坛，一个人流量大的物理公告板。 不管是什么，记下人们提出的问题以及答案（如果可以找到的话）。 您可能可以进行粗略的频率分析，以便找出使人们感到困惑的地方以及社区未充分回答的问题。

如果您有任何支持的人，这也是宝贵的资源。 浏览他们的票务清单，找出他们在回答什么，尤其是那些更主流且不太奇怪的情况的问题。 您是否有任何功能要求，只要人们了解该软件的工作方式即可解决？ 还要添加它。

缩小范围

现在，您有大量的问题列表，几乎是用户曾经问过的所有问题。 立即解决20个问题。 有趣的事实：正态分布曲线几乎适用于所有情况，包括软件用户所遇到的问题。 如果您有一百个功能/安装设置/混淆点，并且解决了最常见的20个问题，那么您将为绝大多数人提供帮助。 我认为，作为书呆子，我们对问题的长尾着迷，但这并不是大多数问题所在。

2.使答案更容易找到

现在您有20个问题。 以人们可以找到和使用的方式回答这些问题。 您需要确保回答的是影响功能的实际问题，而不是被问到的问题。 如果您曾经获得过技术支持，那么您就会知道，人们很难以第一次对系统专家有意义的方式提出问题。

获得答案后，​​请花几分钟进行测试，并确保答案确实有效，然后再向全世界发布。

接下来，您需要找到答案。 多年来，我了解到的一件事是，您的用户所说的东西和您所说的东西可能完全不同，但是如果您要为他们提供服务，则需要使用他们使用的术语。

例如，多年来，当发生致命错误时，Microsoft都会显示“蓝屏死机”（BSOD）。 这是一个蓝屏，白色文本无用的十六进制转储。 每个使用Windows的人都认可它。 但是在他们的文档中没有以这种方式确定。 现在，当您搜索microsoft.com时，它已成为一个索引词，但结果仍然缺少描述性。

如果您想帮助用户，并且他们称其为旋转的沙滩球，BSOD或故障而不是错误，则必须将这些术语放在您提供的任何答案的元文本中。 如果这是一个有用的搜索词，那绝对是正确的选择。

例

如此多次，搜索引擎优化（SEO）就像是一个骗局和问题。 但这不是必须的。 最理想的形式是下一代索引。 您使用的是未出现在帮助文本中的搜索字词，以帮助人们找到所需的答案。 这是一个例子：

• 问题/搜索词：钱包不适合骑自行车短裤
• 您的站点：RoadID，标识，标签，狗标签，紧急情况
• 您的SEO新增功能：钱包，骑自行车，航行，开始，氨纶，反光

之所以行之有效，是因为您了解到人们想要将钱包携带在自行车上的原因是，这样人们就可以知道在路上被撞到时该打电话给谁，但是Spandex并不宽容钱包的存储，因此他们需要小巧且可穿戴的东西。 SEO需要相当多的人为智能，但是它也可以使该站点对于那些想要您拥有的人更好地工作。

3.分组答案

FAQ页面通常是懒惰的，并不真正有用。 我知道开发人员经常会觉得他们需要它，因此您的目标应该是向人们提供有关如何使用和理解您的软件的线索。

将您的答案分组，使人们有可能碰到意外：如果他们认为要解决的这个主题不可行，则页面上的下一个主题可能会解决。 您可以为他们提供搜索条件或相关功能附近的搜索字词。

例如，也许他们以为正在寻找语言，但实际上却在寻找键盘布局。 如果由于在您的软件中是合乎逻辑的，而使它们靠在一起，并且在FAQ中也使它们靠在一起，那么它们现在就不再那么烦人了。 记住，这就是目标：不那么生气的用户。

4.告诉人们接下来需要知道什么

一旦您回答了某人的问题，那就太好了。 这是您一次帮助他们的机会。 如果您的答案与其他步骤或问题有关，请将其放在底部作为下一步：

大！ 您已经配置了电子邮件设置。 接下来，设置您的两因素身份验证。

并非所有人都会单击它，但是即使有人在中间随机输入，它也会为您的文档提供顺序和通过流程。 您已经留下了一些面包屑，他们可以选择遵循。

更多资源

这两本书是学习明智地合理使用文档编写资源的精湛技巧的绝妙资源： Badass：使用户超赞 ， 每一页都是第一页 。

翻译自: https://opensource.com/life/16/11/right-way-help-users-learn-your-software

渗透步骤 文档