改进文档的 4 个步骤:如何为用户提供针对问题的准确答案

368 位读者喜欢这篇文章。
Typewriter keys

April Killingsworth。Rikki Endsley 修改。CC BY-SA 2.0。

当人们使用您的软件时,他们试图完成一个目标。他们试图解决问题、找到 ATM 机、捕捉 Leafeon。他们通常不是因为喜欢软件本身而使用它。但是,仅仅因为您的用户不期望享受某些软件,并不意味着他们没有感受。如果软件的设计特别好,可以帮助他们完成想要做的事情,他们可能会注意到惊喜,但他们不会注意到中性的情绪,他们主要注意到的情绪是恼怒甚至愤怒。

为人们提供有关您的软件信息的最重要部分是记住,他们使用它是为了完成某事,而不是他们想阅读有关它的信息。

很少有人喜欢阅读文档,也很少有开发人员喜欢编写文档。但是文档可以使您不必一遍又一遍地回答已经恼火的用户的相同问题。当大多数人阅读文档时,他们已经失败并感到沮丧,再多的可爱项目符号也无法使情况好转。使情况好转的是帮助他们尽快获得针对他们具体问题的准确答案。这其中有一门艺术,而且这是一门您可以学习的艺术。为了降低支持成本和用户流失,您将不得不编写一些文档,我将告诉您如何尽可能轻松地做到这一点。

1. 弄清楚真正的问题是什么

如果您没有用户,那么请找一些像您的目标用户一样的人。如果您没有目标用户的个人资料和角色,我建议您退后几步,因为您还没有真正准备好开始编写用户文档。

询问您的用户他们试图用您的软件做什么。不要想当然地认为您知道。观察他们使用产品并找出他们在哪里挣扎或困惑。只有当您不过多帮助他们时,您才会知道这一点。当您观看人们搞砸时,保持双手和声音中立是产品测试中非常困难的一部分。

找出用户在哪里互相帮助。Stack Overflow 是用户提问和帮助的丰富宝藏。可能有 IRC 频道、Slack 聊天、用户论坛、走廊里人流量很大的实体公告板。无论是什么,记下人们提出的问题,以及答案(如果您能找到任何答案)。您也许可以进行粗略的频率分析,以便找出哪些问题使人们感到困惑,哪些问题社区尚未充分解答。

如果您有任何人在做支持工作,这也是一种宝贵的资源。浏览他们的工单列表,找出他们正在回答什么,尤其是那些更主流、不太奇怪的边缘案例问题。您是否有任何可以通过人们更好地理解软件工作原理来解决的功能请求?也将其添加进来。

缩小范围

现在您有了一个庞大的问题列表,几乎包含了用户曾经提出的所有问题。将其缩小到 20 个问题,以便立即处理。有趣的事实:正态分布曲线几乎适用于所有事物,包括软件用户提出的问题。如果您有 100 个功能/安装设置/困惑点,并且您解决了最常见的 20 个,那么您将帮助绝大多数人。我认为作为书呆子,我们对问题的长尾效应很着迷,但这并不是大多数问题所在的地方。

2. 使答案易于查找

现在您有了 20 个问题。以人们可以找到和使用的方式回答这些问题。您需要确保您正在回答实际问题,因为它们会影响功能,而不是按照问题的提出方式回答。如果您曾经做过技术支持,您就会知道人们很难在第一时间以系统专家能够理解的方式提出问题。

获得答案后,花几分钟对其进行测试,并确保答案在您向全世界发布之前实际有效。

接下来,您需要使答案易于查找。多年来,我学到的一件事是,您的用户对某物的称呼与您对某物的称呼可能完全不同,但是如果您想为他们服务,则需要使用他们正在使用的术语。

例如,多年来,当发生致命错误时,Microsoft 会显示蓝屏死机 (BSOD)。这是一个蓝屏,上面带有白色的无用十六进制转储。每个使用 Windows 的人都认得它。但是,在他们的文档中并没有以这种方式标识它。现在,当您搜索 microsoft.com 时,它是一个索引词,但是结果仍然显示不太具有描述性的内容。

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

示例

很多时候,搜索引擎优化 (SEO) 感觉像是一场骗局和一个问题。但是它不必如此。在其最理想的形式中,它是索引的下一代。您正在使用未出现在帮助文本中的搜索词来帮助人们找到他们正在寻找的答案。这是一个例子

  • 问题/搜索短语:钱包放不进自行车短裤
  • 您的网站:RoadID、身份识别、标签、狗牌、紧急情况
  • 您的 SEO 添加项:钱包、骑自行车、帆船、起点、氨纶、反光

这之所以有效,是因为您了解到人们想在自行车上携带钱包的原因是为了让人们知道如果他们在路上被撞倒该给谁打电话,但是氨纶对于存放钱包来说是毫不留情的,因此他们需要一些小巧且可穿戴的东西。这种 SEO 需要相当多的人工智能,但它也使网站对于想要您所拥有的东西的人们来说运行得更好。

3. 对您的答案进行分组

常见问题解答页面通常是一种懒惰的敷衍了事,并且没有真正的帮助。我知道开发人员通常觉得他们需要它,因此您的目标应该是为人们提供有关如何使用和理解您的软件的线索。

以一种使人们有可能获得答案意外发现的方式对您的答案进行分组:如果他们认为会起作用的这个主题不起作用,那么页面上的下一个主题可能会起作用。您可以为他们提供他们在寻找的周围的搜索词或相关功能。

例如,也许他们认为他们正在寻找语言,但他们实际上正在寻找键盘布局。如果这些在您的软件中很接近,并且在您的常见问题解答中也很接近,那么他们现在就不那么恼火了。请记住,这就是目标:减少愤怒的用户。

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

一旦您回答了某人的问题,那就太好了。这是您再多帮助他们一点的唯一机会。如果您的答案与另一个步骤或问题相关,请将其放在底部作为下一步

太棒了!您已经配置了电子邮件设置。接下来,设置您的双因素身份验证。

并非所有人都会点击它,但这为您的文档提供了顺序和贯穿流程,即使有人从中间随机进入也是如此。您留下了一些他们可以选择跟随的面包屑。

更多资源

这两本书是明智地花费您的文档编写资源以学习精湛技艺的优秀资源: Badass: Making Users Awesome 和 Every Page is Page One

标签
A pink-haired woman with a half-smile looks directly into the camera.
Heidi 是一位技术作家、演讲者和开发人员教练,她正在扩展她的写作和行业专业知识,以帮助更多人成为更好的作家。她目前的热情包括自动化文档、文档驱动开发以及在所有衣服上缝制口袋。

4 条评论

哦,迫不及待想在 SeaGL 上看到您关于此主题的演讲

这些当然是不错的观点,但正如他们所说,“秘诀在于酱汁”。
许多新用户通常无法很好地组织他们的问题,虽然您可能很快就会感觉到他们不知道什么,但可能需要一些来回才能找出他们知道什么,因为这可能是帮助他们的关键。
我说“来回”是因为它不能像您审问他们那样的问答,而更像是一种支持和鼓励的对话。除了解决这个人的问题之外,这还会成为可以按照您概述的方式改进文档的知识。

Greg,新用户有时不清楚如何组织他们的问题,这当然是真的,但我认为现在也是我们放慢脚步并确保我们在他们甚至可以提出问题之前没有预先假设一堆术语的好时机。

当涉及到作家、用户和技术堆栈时,这可能取决于具体情况。我知道当我开始使用 FrameMaker 时,我甚至没有专业的词汇来提出可理解的问题,并且社区需要很大的耐心才能使每个新用户都跟上进度。

我希望我们的文档感觉不那么像耐心,而更像透明度。始终是一个理想!

回复 作者 Greg P

Greg Pittman 击中了关键问题——问题的提出方式。我们的词汇 [开发人员、程序员、书呆子、极客,无论我们如何称呼自己] 自我们开始以来已经发生了翻天覆地的变化。“记录和字段”是什么?问问农业领域的人。“SQL”是什么?猪被踢时发出的声音?(对不起,猪)解决这些词汇和术语问题至关重要。

此外,我们必须抵制回答我们希望他们问的问题,而不是他们想知道和理解的问题。XKCD 提供了另一个问题示例,
http://xkcd.com/773/

如果您阅读更多 XKCD 漫画(如果有人问,您是在做研究,而不是娱乐),您会看到更多这样的例子。它们非常受欢迎,您可以通过 Google 找到它们。例如,搜索“little bobby tables”(不带引号或逗号)。

Creative Commons License本作品根据 Creative Commons Attribution-Share Alike 4.0 International License 获得许可。
© . All rights reserved.