编者按：文档知识库是最常见、应用最广的一类知识库，文档写作是知识库建设的核心。视觉良好、清晰易懂、易于查找的知识库文档能够更有效地解决用户问题，发挥知识库的价值，本文将主要与您探讨知识文档写作的原则和注意事项。

 

1.不要做假设

客户访问帮助中心的文档是以解决问题为目的的，因此知识库文档写作的首要原则是避免模棱两可、含混不清、有歧义的表达。而且在写知识库文档时需要将读者设定为完全的小白用户，避免使用过多的专业术语。当表述中不得不提及一个非常识性概念时，需要引导到对应的解释内容中，最大限度地帮助客户扫清阅读障碍，确保客户基于文档手册执行的每一步操作都是清晰明确的。

我们来看一个例子：当客户查找如何将其网站迁移到新主机时，以下哪种表达是更合理的？

1）在开始之前，请确保更改IP地址。

2）在开始之前，请转至“设置>管理域> IP地址”处，更改IP地址。

第一种表达显然在假定读者已经知道如何更改其IP地址了，而第二种表达则覆盖了那些不知道如何更改其IP地址的客户。显然第二种在解决客户问题方面效果更好，更加合理。

在编辑知识库文档时不要假设用户已经知道某些操作，我们是自己的产品领域的专家，会想当然地觉得很多操作是简单的，但对于客户来说并不是这样，他们对于我们的产品及操作是陌生。拿以上例子来说，即使客户知道如何修改IP地址，我们又做了澄清也没关系，他们可以快速跳到感兴趣的的内容即可，但如果我们遗漏了相关操作，那对于经验不是很丰富的用户则会很不友好，他们还需要再去别的地方查询如何修改IP地址，导致文档的可用性差。

2.当文章内容过于冗长时，可应用超链接

避免对客户做假设意味着您有时可能解释过程的每个步骤，这就导致知识库文档过于冗长。这种情况下我们可以对文档内容进行拆解，另起一篇来介绍需要大量篇幅解释的操作，并将其内容以超链接的形式添加到目标文章中。当客户想要了解具体操作时，点击跳转即可；已经熟悉操作的客户则可以快速进入下一个步骤。

3.使内容易于浏览

对于较长的知识库文档，我们还需要注意的一个问题是通过颜色、字体、字号、分段、符号、间距、背景色等帮助客户快速了解文章结构、突出显示重要信息，并使所有说明一目了然。

否则通篇大段大段的文字会导致客户没有耐心读下去，结果就是转向人工客服寻求帮助。

4.使内容易于阅读

知识库文档的写作要避免过于专业、晦涩。最好能够选择比较白话、轻松的表达方式，在用词上要避免歧义；在结构上要注意突出重点，且能够从客户的视角出发，对其进行引导，从而高效地解决客户问题。

5.合理地组织文章顺序

最好的知识库文档需要能够当围绕用户的操作/使用流程来进行设计。要达到这一效果，一般需要遵循三个原则：时间顺序、难易程度和操作流程。一般来说，最好先让客户先进行最简单的操作，避免由于操作过于复杂消磨掉他们自主探索的热情。

6.有策略地使用链接

很多时候我们都会在知识库文章中添加链接，旨在向客户推荐他们可能需要的其他详细信息和说明。链接的引入可以帮助您专注于手头的主题，而不需要跳出主题去解释其他客户可能需要了解的内容。添加链接听起来很简单，但策略性地使用链接也很重要。如果您在错误的时间链接到错误的内容，则会导致读者分心，没能解决他们本来想要解决问题。

7.确保文章标题简单明了

标题应尽可能简单明了，力求清晰。在构想文章标题时，我们可以问自己：客户可能会搜索什么？一般来说人们喜欢使用基本关键字进行搜索。比如，在客户想要搜索“如何迁移商品库”时，会直接输入“商品库迁移”。因此，可选择操作短语作为文档标题。

8.通过图文表达提高知识库效率

对于产品使用、系统操作类的知识文档，可适当引入图文视频。截图或视频操作在解决这类问题方面效率更高。