写作有效知识库文章的8个最佳实践

A 知识库 在“帮助我帮助自己”阶段探索您的产品时,可以成为客户最好的朋友。但随着凯西塞拉斯的股票 让用户真棒,公司经常将球放入购买后的出版。帮助内容通常是感受平庸的刺痛的第一件事之一。

购买前/购买之前的内容

虽然知识库如 帮助Scout Docs. 使您可以轻松创建视觉上引人注目的知识库文章,干净,有组织的写作并未以相同的转向方式出现。这需要真诚的努力。

最好的帮助内容是信息丰富,引人入胜,毫无疑问的,介绍如何以及为什么客户在第一次寻找帮​​助。要构建符合所有标准的知识库文章,请遵循以下八种最佳实践。

1.不要做出假设

客户转向您的自助文件以解决问题,因此您最重要的目标是误解。

写下您的帮助桌文章想象阅读它们的人是完整的初学者。跳过高级术语和行话,并谨慎在通过时提及DOS。假设客户需要每个步骤的指导是更安全的。

例如,如果客户正在查询如何将他们的网站迁移到新主机,则以下哪一项离开错误的最小空间?

  1. 在继续之前,请务必更改IP地址。
  2. 在继续之前,通过进入设置来更改您的IP地址> Manage Domain > IP Address.

选项假设读者知道如何更改其IP地址。选项二,另一方面,迎合了解如何更改其IP地址的客户 那些没有的人。

通过制作关于“简单”指令的假设,不要自我破坏。最好过度沟通。更有经验的用户可以简单地浏览他们不需要的指示,但是当您将关键细节留出文档时,初学者将击中障碍。

2.在冗长的文章中使用锚点链接

避免假设意味着您有时可能需要编写冗长知识库文章以确保您解释过程的每个步骤。

当您需要编写一个冗长的知识库文章时,它有助于包含一个带有锚点链接的内容表,以便更容易地跳过他们不需要的信息并直接导航到他们正在寻找的详细信息为了。

锚链接示例

即使对于正常长度的文章,客户也能理解能够跳到他们想要的部分。

3.让内容容易脱脂

漫长的知识库文章的另一个提示:不要用文本墙壁恐吓读者。当解决方案不容易找到时,联系支持将是客户的下一步。

设计师 rafal tomal. 下面显示副标题和行中断的正确使用是易于扫描的文档的快捷方式:

rafal tomal  - 内容造型

使用标题,标注,弹点,间距和视觉效果来突出重要信息,并一目了然地保持完整的指令可见。

这是我们文档知识库文章的示例 开始工作流程.

帮助Scout Doc  - 工作流程

它使用各种不同类型的格式粗体用于导航元素,一个有序列表,用于过程中的步骤,以及注释的不同背景颜色 - 吸引注意页面上的关键信息。

4.让内容易于阅读

为了磨练您的语音,网络上的最佳资源之一是 MailChimp的声音和音调。我会添加一些建议:

  • 普通散文不像你的谈话那么远,但它也不太靠近。写作你会和朋友说话,但是使用编辑打扮你的想法。
  • 考虑读者的目标:关于学习产品的Ins-outs(好奇)或修复错误或问题(挫折)的文章吗?相应地调整你的音调。
  • 对于关于非故障排除问题的文章,有点幽默很好,但烦恼迅速越过。
  • 避免俚语和任何边缘线。我曾经看到一位作家咀嚼过“吉普平”这个词,他们不理解其贬损性质。
  • 到目前为止。没有什么能拖下你的doc,而不是在太多单词上传播重要信息。

所有写作都必须参与 为了让人们阅读,但不要让解决方案迷失在华丽的散文,过度的“个性”和蜿蜒的笑话中。

5.逻辑地组织文章

在读者的工作流程中设计时,良好的文档变得很好。

除非您希望客户像鱼类从水中挣扎,否则试图组装宜家电视台,否则获得“流动”对。以下是三个原则来生活:

  1. 时间顺序: 正如您可能猜到的那样,必须以时间顺序组织一条帮助内容。客户应该做的第一件事必须是第一件事。
  2. 偶然的顺序: 如果可以将多个任务“首先”(即订单无关紧要),让客户首先做出最简单的事情。早期摩擦减少了他们完成或甚至遵循您建议的可能性,所以开始快速获胜。
  3. 注意工作流程: 以维持活动和势头的方式结构响应。避免在接近结束之前中断解决问题的工作流程。

为避免中断读者的工作流程,还要确保您要解决相关的问题和问题,您可以通过快速的常见后续问题清单关闭文章。

文档文章后续问题

把自己放在顾客的鞋子里,考虑这部独白: “好的,我已经准备好了。哦,等等,怎么样......“

6.使用策略性地使用链接

包括知识库文章中的链接是指导客户到可能所需的其他细节和指示的好方法。它还可以帮助您侧重于掌握的主题,而无需涵盖客户可能需要的每一个可能的问题或帮助。

文章目录

虽然链接到其他有用的文章肯定是最好的实践,但重要的是使用战略性地使用链接。如果您在错误的时间链接到错误的东西,则会增加读者分心的机会。您希望确保在单击链接时仅向客户单击“链接”是自然的下一步。

7.坚持简单的文章标题

标题应尽可能直接。抑制你的创造力,赞成清晰度。卡住时,问问自己:客户搜索什么?

请记住,人们用基本关键词搜索:“如何将您的WordPress网站迁移到”迁移WordPress网站“。创建包含操作短语的标题。

如果您是有关“转发”您的电子邮件的信息,请访问Scout用户,我们的知识库将返回以下内容:

文档文章搜索标题

没有一个标题是令人兴奋的。相反,他们很简单 - 就像他们应该一样。

此外,依赖于主动语音中的动作词,以获得大多数标题:

  • “如何(空白)”
  • “使用(空白)”
  • “设置(空白)”

或者使用他们需要的操作的精确短语,例如“上传您的第一个视频”,“安装插件”等。

8.使用图像来节省时间并创建清晰度

“展示,不要告诉”是每个知识库的Modus Operandi。

当您通过如何在系统中做某事时,您可以通过在界面中显示屏幕截图和/或GIF,编写更少的单词并使您的说明更清晰。

说一位帮助侦察兵客户想要了解有关分配对话的更多信息。这就是他们所看到的:

屏幕截图示例

文本的每个解释性段落都是屏幕截图,显示客户在执行此步骤时应该看到的内容。

抱怨 是一个简单,经济实惠的,功能丰富,功能丰富的屏幕截图工具和编辑器,可在Mac和PC上工作。

除了简单捕获屏幕截图外,还可以使用Snagit将数字和箭头添加到您的屏幕截图和包含敏感信息的文本的截图。

文章与注释

对于GIF, 涂料捕获 是Mac的一个很棒的工具,可以轻松捕获屏幕上的一系列步骤。

使用您的知识库数据来改进您的产品

编写有效的知识库文章是为客户提供更好的自助服务选项的第一步,但许多公司忘记该过程是全圈 - 您所写的东西可以作为您的产品和营销的洞察力来源。

在一个关于他所做的改进的智能文章中, Garret Dimon共享 他的文档报告(下面的屏幕截图)变成了额外的渠道,了解客户已卡住的地方:

“我们的秘密武器之一是”Docs“报告,帮助侦察员,让我们看看人们在帮助地点中搜索的条款。因此,例如,如果我们看到人们经常搜索'我如何添加用户?'那么我们知道我们需要使其更加明显。“

sifter docs报告 Sifter的Docs在帮助侦察中报告

此外,请记住,帮助内容有时有时是前景的第一个联系点。如果你的文章 价钱 正在看一大吨命中,调查为什么这是如此。营销网站的定价太令人困惑了吗?

因此,除了遵循上述最佳实践来创建有效的,连贯的帮助内容,请确保您定期审查报告,以获取您的知识库内容,营销和甚至您的整体产品的想法。

 格雷格 ory Ciotti.
格雷格 ory Ciotti.

格雷格 是作家,营销策略师和帮助侦察兵。与他联系 推特 linkedin. .

开始帮助 Scout

为您的客户提供更好的体验,为您的团队更少。你'LL在几分钟内设置。

免费的15天试用