Baklib|怎样编写内嵌式的帮助文档？

尼尔森十大互动原理中的“人性化帮助原则”提出，建议我们应当给系统提供一份帮助文档。由于在使用中，用户会遇见问题，所以必须要查看帮助文档和说明书，以便更好地让用户更好的理解和掌握产品系统，熟悉操作。

首先，我们要谈谈为什么要编写一本帮助文档，以便理解其重要性并为此做出更多的工作。

为何要编写一本产品说明书

1.帮助用户更好的处理问题

2.在回答中引导用户的行动

3.减少顾客的工作负担和对新顾客的培训

4.塑造一个好的企业品牌

5.对产品的线上营销有所帮助

6.对搜索引擎优化网站的帮助

实际上，有两种类型的帮助文档。

一、在网上设立帮助中心。

帮助中心面临的问题包括：什么是公司的规模，产品定价和发行。

二、将帮助文档内置在系统中。

重点介绍企业的运行过程，便于用户在浏览时进行操作。我们将讨论怎样编写内置的帮助文档。

内置在程序中的帮助文档看起来非常的简单，但是它包含了大量的详细信息。有些程序可以很随便地安排文档的版面和排字，而这些东西全是文字或者是照片。第一眼看上去，他们是如此的密密麻麻，无法找到重点。因此，怎样编写嵌入的帮助文档？

内嵌帮助文档的编辑要素：

1.程序明晰

在编写帮助文档时，产品必须对流程和状态的改变十分了解。比如，手工帐户，管理帐户，因此，客户管理人员应当先了解手工帐户的记录，以及哪些行为会更改帐目状况等等。

如果这个软件不是很清晰的，那么在说明文档中就很容易混淆了。另外，当一个程序包含多台终端机时，还应当清晰地说明各终端机的运行结果，也就是将整个流程都进行了纪录。比如，在互联网中，由于移动设备的运行而改变了互联网的终端，这一点也应当明确。

2.简短的语言

说明文档的内容不能过多，只需要说明一下。之后帮助你用一个方向键来显示屏幕。

如果大量的文档将会对读者的阅读造成不良的影响，从而使读者失去耐心。

3.说明关键问题

在我开始编写一个关于产品的文档时，可以轻松地将它作为一个模块的说明文档来编写。由于一些模组只是一个简单的展示，并没有任何的流程和复杂的函数，因此，它们只是一些简单的文字和一些简单的文字。这就造成了很久的缺乏焦点和缺乏可读度的问题。因此，在编写时，要充分地了解到，重要的是，要注意到这个模块中的复杂的商业过程。

房屋查询，帐单查询，不用做任何说明，就能让用户知晓。而那些涉及更深层的商业问题，如住房，手动帐户，现金提取和放款，都是客户希望的。所以，在编写该产品前，你可以对你所管理的组件中的关键流程和关键的动作进行精炼。其次，根据这一点，思考怎样用较短的篇幅来进行完整的阐释。

4.标准模板

尼尔森的一个交互原理就是连贯原理。在帮助文档中也是如此。因为不同的产品一般都有各自的功能，所以，在初始阶段，如果不能进行统一的设计，很可能会导致结果混淆。

建议用一个统一的模版来帮助文档，并把公司名字和商标展示在网页上。

实际上，有许多样式，包括 word, ppt 和 PDF 文档。如今，更好的方式是将 ppt 转化成 pdf。通过这种方式，网页的展示和互联网的观看将会更好。

5.常见问题描述

嵌入的帮助文档也要求对常用问题进行说明，尤其是那些经常发生的不正常事件，更是要被提示。举例来说，某些潜在的约束会在被拒绝支付和放款之后的次日开始。由于这一切都是由常规的工作完成的，因此很难在网页上告知用户。所以你可以在这个“帮助文档”中解答用户提出的问题。

帮助文档编写工具：

baklib 是一个中国的互联网文字编辑器，为企业级用户提供 FAQ 帮助文档，同时也提供知识库，产品手册，帮助中心，发行文档。为热爱写作的读者，可以制作日志，也可以制作私人日志，拥有超强的性能！独立的网站，不同的版块，可根据不同的版型将创意的内容引导为不同的精美的介面，让用户更容易的进行内容的共享，更有助于建立自己的品牌形象。

产品评价：

1.容易编，有条理。

2.丰富的显示模板，具有良好的印刷效果。

3.具有很好的文字查询能力。

4.高度的显示设定。

5.单独的域名。

6.多终端安装，不需要任何的软件。

7.还可以应用在常见问题，知识库，发行说明和个人 blog 等。

制作过程：

首先要登陆 Baklib 网站，在百度上可以看到 Baklib，登陆账号，单击网站建立（帮助文档）

在此选定用于生成的帮助文档的方案

网站上有十几个免费的主题模板，以后可以在设定中随时更改。

输入一个名字，第二个域名（自由），并选中与您的产品相匹配的主题色彩。

还有一个步骤是“内容编辑”，只要把“帮助文档”的内容写出来就可以了。

编写内嵌式帮助文档对于用户体验有非常直观的影响，用户体验上去了，企业的市场竞争力也就上去了。如果在阅读了该篇文章你还是不知道该怎么样去编写的话，可以看看我们往期的相关文章哦。