如何撰写有效的知识库文章 [与示例]

2021-07-01 16

写有用的知识库文章并不像你想象的那么难。了解如何制作一流的内容，使客户能够自助。

 (helpjuice.com)https://helpjuice.com/blog/knowledge-base-article
原文地址
撰写大量知识库文章的关键是确保内容清晰、引人入胜且为最终用户提供翔实的信息。
好消息是，为您的知识库制作令人敬畏的内容并不像许多人想象的那么复杂。
通过正确的方法和少量的专有知识，您可以撰写文章，以最小的压力改善客户和员工的体验。
在本文中，我们将全面介绍创建优秀的帮助文章的八个最佳实践，并分享几个示例来激励您自己。
如何撰写有效的知识库文章
归根结底，无效帮助文章和有效帮助文章的区别在于：出色的帮助内容使用户能够完成他们打算完成的任何事情。
以下 8 个步骤将确保您的知识库内容帮助用户完成工作：
·        了解用户痛点
·        假设读者什么都不知道
·        易于浏览
·        保持简洁
·        写简单的标题
·        磨练你的声音
·        内部链接
·        测试和改进流程
了解用户疼痛点
写有效的知识库内容，没有什么比理解为什么用户首先寻求帮助更重要的了。因为找出客户提出的问题并识别共同主题会引导您创作出最相关的内容。
这里的好消息是，大多数企业主已经有一个体面的想法，他们的用户在哪里被卡住。但是，如果您不确定，请在这 4 个地方进行翻找：
·        票务系统：支持电话、聊天和电子邮件可能是客户沮丧的丰富来源。
·        服务代理：他们对客户痛苦点有卓越的洞察力 - 列出他们处理的客户投诉最频繁的列表。
·        社交媒体：客户经常到社交媒体寻求帮助或表达不满 – 检查您的消息、提及和标签。
·        社区论坛：查看用户相互询问的内容，以及他们遇到的困难。

假设读者什么都不知道

知识库中可能发生的最糟糕的事情之一是：你的文章让用户很迷惑因为你写的东西他们根本不懂。
为了避免这种情况，假设你的读者不知道Zilch。撰写你的文章，就好像你正在与一个绝对的初学者沟通。
你不需要把事情搞得一概而解——多想想，比如用简单的语言交换技术术语和解释困难的概念。
例如，在解释客户如何开始细分电子邮件列表之前，营销自动化平台 Mailchimp 定义了新用户可能不熟悉的几个关键术语。
让读者跟上这样的速度，可以确保当引入更复杂的问题时，他们不会迷失方向。
另一个会破坏你文章的习惯是在不文章中提及操作指南。例如，假设读者想要使用软件编辑他们的照片
其中哪一个会是一个更有用的解决方案？
  1. 连接相机后，导入照片
  2. 连接相机后，单击"菜单>文件">添加照片>导入>导入所有
第一个方案，假设读者早已知道如何导入文件。另一方面，第二个方案既适合那些知道的人，也适用于那些不知道如何完成任务的人。
关键是什么？无论任务或概念多么简单，对读者所知道的都不要做出任何假设。更高级的用户只需跳过基本详细信息，但经验不足的用户如果丢失，将遇到困难重重的山峰。

使其易于浏览

假设读者什么都不知道意味着你的一些文章可能最终是相当冗长的。这不一定是件坏事。
但是，31% 的客户希望获得即时在线帮助，40% 的客户期望在 5 分钟内获得帮助 - 您需要让人们尽可能容易地找到他们需要的东西。
扩展文章的关键是根据适当的标题、子标题和要点将其分解，这样用户就不会感到被巨大的文本吓倒。
例如，看看Shipt如何拆分较长的形式内容，使其更容易消化。最初访问他们的知识库时，您会收到几个热门话题以及常见问题。
单击其中一个常见问题解答时，您被带到一个单独的页面，该页面进一步细分为以下屏幕截图中的子主题。
通过使用各种标题、间距、粗体文本和要点，信息立即变得更加平易近人。
要在文章中这样做：
  • 首先写出所有的想法，你要包括
  • 将相关想法捆绑在共同标题下
  • 以合乎逻辑的方式设置标题
  • 在每个标题下写下段落，每段不超过 2-3 句
一旦您拥有了坚固的结构，添加带有锚链接的内容表，以便用户能够直接导航到所需的部分也是明智的。对于更高级的人来说，这尤其方便，他们可能想要跳过入门级的东西。
例如，Zoominfo 做了一件很棒的工作，使用户能够轻松导航到相关部分，而无需上下滚动页面。
简言之，通过适当的构建您的文章以提高知识库的实用性，帮助用户更好地了解您的信息，并最终更快地解决他们的问题。

保持简洁

所有这些关于扩展文章的讨论，重要的是要记住目标不是文章的冗长，它只是创建全面指南的偶尔副作用。事实是，你的文章越简洁越好。
想想看：如果你的客户感觉很痛苦，他们不想筛选大量的多余的信息。相反，他们希望获得解决问题所需的相关知识，而不是多说一个字。
这意味着你必须成为一个无情的编辑。努力消除不增加问题的不必要的信息。缩短您的介绍。将措辞细小的段落切成大小。根据经验，如果您不确定某事是否相关，则假设不相关。
在适当情况下，也利用媒体进行更清晰的阐明。屏幕截图和 GIF 可以大大有助于用户在部署在文本旁边时更快地吸收信息。Giphy Capture 和 LightShot for Chrome是实现此目的的两大工具。
但是，使用视频解决问题或错误时要小心。虽然视频适合一般概述和介绍 - 但它们无法专注于您的客户正在寻找的细节。匆忙的人将被迫观看整个视频， 以获得他们需要的信息。
如果您确定使用视频，请务必对视频进行时间戳。此外，在旁边加入一个文本版本，使其对于您的用户而言更为高效且易使用。记住，万事皆有限度。

编写普通标题

知识库不是博客，所以没有必要尝试吸引读者的注意力。用户已经在寻找您的帮助。
相反，制作简单的标题，传达您的文章解决的问题。问这样一个问题："我的用户在查找此信息时会搜索什么？
请记住，人们通常使用基本关键字进行搜索 - "将如何插入图像和视频变为'插入图像和视频' - 因此，请围绕关键字短语对标题进行建模。
使用活动动词是开始文章标题的好策略。一些示例是：
  • "如何……"
  • "启动……"
  • "设置……"
  • "使用……"
  • "创建……"
  • "开始……"
或者，您也可以简单地说明文章的主题，例如"概述：文章模板"。只要你的文章很清楚， 你就不会走错太远。
正如您从我们的知识库中看到的 - 展出的标题都不是华丽的。相反，他们是明确的削减 - 只是他们应该的方式。

精炼你的语言

正如语言学家Steven Pinker 在他的著作《The Sense of Style》中指出的，聪明的人常常回避简单，试图证明自己的聪明才智。然而，正如Pinker所揭示的，使用华丽的语言只会让别人认为他们是沟通不畅的人。
你的知识库是完全一样的。如果这分散了人们对书面文字的了解，人们就不会对你所为留下深刻的印象。
因此，这里有7个提示，以保持事情点：
  • 把你的主题放在简单的语言中
  • 使用活动动词
  • 使用常见、熟悉的词语
  • 在所有文章中，每个概念都使用一个术语
  • 假设你正在与一个人交谈（理想情况下，你的买家角色）
  • 排除故障错误时避免幽默（对于非故障排除文章来说，一点幽默是可以的）
  • 保持它的意义 - 传播太多的想法将失去你的读者
  • 始终将读者的目标放在首位
最终目标是让你的文章引人入胜，但不要让你的信息迷失在"品牌个性"或不必要的复杂语言的海洋中。
两个工具，可以促使你的副本成形，Grammarly（真棒拼写检查和找到更好的措辞）和Hemmingway Editor，这将使你的写作大胆和清晰。

链接到相关内容

链接到相关内容可以减轻压力，不需要将太多信息塞进一篇文章中，同时仍然确保用户能够轻松地自我服务。
链接的重要性在于，您这样不会分散读者的注意力。我们不想在他们把我们想说的话内化之前把他们的注意力分散。
因此，不要链接到与手头主题不相关的文章。相反，仅当链接将用户推向下一个合乎逻辑的内容时，才会使用它们。
(注意：我们将在下一步讨论时，您将能够通过分析知识库处理的数据以及从服务代理收集反馈来找出逻辑部分。)

不断改进您的流程

完美的知识库并不存在。所有强大的知识库之所以成为这样，正是因为他们致力于不断改进其内容。
他们是怎么做到的？通过数据和反馈。
一个好的知识库软件将提供分析，可以让您得到的信息包括：
  • 您的内容如何随着时间的推移而执行
  • 用户正在搜索的主题
  • 人们最喜欢的主题是什么
  • 哪些文章需要改进
使用这些信息，您可以加倍了解哪些信息有效，并简化不起作用的内容。随着时间的推移，您将构建一个强大的文章集合，读者将会很感谢你。
值得一提的是，分析的好处不仅仅是改进您的文章。服务数据是了解客户思维和感受的一个很好的来源。这意味着它也可以帮助您构建更好的产品、改进您的销售流程或为您的营销战略提供信息。
试想一下：如果很多用户正在搜索"如何与（插入工具）集成"，您可以将这些信息反馈回您的开发团队，并构建客户想要的解决方案。
这意味着，虽然您的文章为用户提供了更好的体验，但他们如何与您的内容进行互动，为您的企业提供了有关如何改进的宝贵反馈。谈论双赢。

优秀知识库文章实例

好了，既然你明白了如何写一篇服务于最终用户的有效的文章，那让我们看看一些优秀的知识库的例子，从真正的公司，看看他们是如何实施这些做法。

Visual Overview of the HootSuite Dashboard (@Hootsuite)

Hootsuite 关于如何使用仪表板的指南是如何撰写知识库文章的完美例子。简短的介绍引向主题的视频概述，概述由下面经过深思熟虑的文章支持。完整的截图和方便的链接，以获得更多信息，使学习仪表板功能轻而易举。

McAfee WebAdvisor Blocking RMS Reports (@RMS Cloud)

RMS 创建了一个非常精彩页面。请注意可浏览的布局、清晰的分步说明、大文本和方便的视觉指南。这真的很有用，有了很多这样的文章，RMS云已经能够通过他们的知识库解决50-75%的日常服务请求。

网站转换跟踪（@Twitter）

Twitter 关于如何设置转换跟踪的长文章是如何构建较长形式内容的一个很好的例子。标题的间距、标题的使用、注释截图和永远存在的导航意味着用户可以快速定位、提取和实现他们所要获取的知识。

如何预览和比较课程（@Udemy）

名单上最短的文章，但同样令人印象深刻，是Udemy关于如何比较和预览课程的文章。很简单，关键是它讲清楚了标题在说什么。有需要提醒图标却仍然保持了页面的简洁。

How to Navigate Estimate Rocket（火箭@Estimate）

Estimate Rocket的这篇文章解决了如何导航SaaS工具的问题。每个面板在屏幕截图的帮助下被剖析并解释为简单的语言，以便用户确切地知道在文章在说什么。写作清晰简洁，标题间隔良好，有一个链接来联系实时支持，以防你没有得到你正在寻找的答案。

Setting Up Your Online Store（@Shopify）

这是 Shopify 的 "建立你的网上商店" 文章中的要点， 这使得在他们的平台上浏览就像散步一样轻松。在清晰的标题旁边加粗体字对帮助你浏览文章特别有效。如果这还不够，它们还包括链接到顶部的锚点，以达到最高效率。

如何制作拼贴画（@Collage）

电子商务公司使用这个页面让用户可以很轻松的创建自己个性化的照片拼贴。这是一个很好的例子，说明你不需要过分使用花哨的图形或复杂的设计。有时最好将内容配对，让您的帮助内容做它最擅长的事情。

总结

写好知识库文章首先可能是个挑战。但是，通过练习和一点经验的积累，你很快就会创作出你的客户喜欢的文章。
从简单的东西开始。开始写几篇关于简单主题的文章。随着你信心和技能的提高，你将更有能力处理复杂的文章，而不会拔掉你的头发。
和罗马一样，一天之内无法建立起一个优秀的知识库。所以不要急于求成。相反，请一步一步地处理文章的写作。注重质量，保持格式，保持一致，保持耐心。
相信这个过程，你会比你想象的更快地获得回报。