企业如何添加内嵌式的帮助文档

尼尔森十大交互原则中的最后一条原则——“人性化帮助原则”提出我们应该为系统提供一份帮助文档。因为用户在使用过程中，经常会遇到一些问题，需要查看说明书和说明书，这样才能更快的了解系统，熟悉操作。

首先，我们先谈谈制作帮助文档的原因，以便了解它的价值并为此付出更多的努力。

制作产品说明手册的原因

帮助用户解决问题

引导用户反馈答案。

减轻客户服务压力，对新客户进行培训

树立品牌形象

对产品互联网营销有帮助

有助于网站搜索引擎优化

实际上，大约有两种帮助文档。

一是帮助中心网站。帮助中心的一些常见问题，例如该工具适用于何种规模的公司、产品定价以及版本选择等。二是在系统中嵌入了帮助文档，重点介绍了业务操作步骤，用户可以在浏览的同时进行操作。今天我们将讨论如何编写内嵌帮助文档。

嵌入在工具中的帮助文档看起来很简单，但是实际上包含了很多细节。有些工具帮助文档布局和排版非常随意，所有内容都是文字或者图片。乍看之下，它们密密麻麻，找不到关键点。那么，您如何编写嵌入式帮助文档呢？

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

1.流程清晰

在编写帮助文档时，产品应该首先对过程和状态的变化非常熟悉。例如，手动帐户，管家帐户，因此，产品经理首先应该知道手动帐户记录的时间，哪些操作会改变帐单状态等等。

如果产品本身并不清楚，那么在帮助文档中自然会出现混乱。另外，如果一个过程涉及到多个终端，它还应该清楚地记录每个终端操作的状态，即记录整个过程。例如，移动终端操作可能导致互联网终端发生变化，这一点也应该写清楚。

2.减少文字

帮助文档，文字不能太多，主要描述步骤。然后用箭头指示操作按钮，协助截图。

过多的文档会影响用户阅读体验，使用户失去耐心。

3.展示重要问题

当我开始写产品文档的时候，我可以轻松地把产品文档写成每个模块的描述文档。因为一些模块是显示模块，没有过程，也没有复杂的功能，所以这些模块都是图片和几句干巴巴的话。这导致长时间缺乏重点和可读性。因此，在写作的时候，要考虑到用户关心的问题，以及模块中复杂的业务流程。

看房子，看账单，这些简单的问题，根本不用介绍，就能让用户知道。对于更深层次的业务问题，如住房，手动账户，现金提取和贷款，这是用户希望看到的。因此，在编写产品之前，您可以对您所负责模块中的一些重要流程和主要操作进行精炼。然后再考虑如何用少的文本来进行全面的解释。

4.统一模板

一致性原则是尼尔森互动原则之一。帮助文档也是如此。由于不同产品通常负责不同的模块，如果模板一开始不统一，很容易造成混乱。

使用统一模板来帮助文档，然后将公司名称和商标显示在页面上。

实际上，有很多种风格，包括 Word, ppt, pdf 文档。这样，网页显示和在线观看的体验将会更好。

5.常见问题描述

嵌入式帮助文档也需要解释常见的问题，尤其是一些需要提醒的常见异常。例如，一些隐藏的限制会自动启动贷款申请，在拒绝结算和贷款之后第二天。因为这些都是通过常规任务完成的，所以很难让用户知道。因此，您可以回答用户在帮助文档中提出的问题。

帮助文档编写工具：

这里选择使用 Baklib 来编写帮助文档。

baklib 是一个中国在线文本编辑与托管工具，它不仅为企业用户提供 FAQ 帮助文档，也为企业用户编写知识库，产品手册，帮助中心，发行指南。对于爱好写作的用户，可以写日记手帐和个人博客，功能超赞！独立域名、多种模板支持将创作内容按模板导成各种漂亮界面，让内容分享更加方便，更有利于形成个人品牌口碑。

评价：

易于编辑和清晰的结构。

丰富的展示模板，友好的排版界面。

具有很强的文本检索能力。

展示设置自由度高。

独立域名。

无需下载，多端适配。

还可用于常见问题，知识库，发行说明，个人博客等等。

制作方法：

首先需要访问 Baklib 网站，在百度上搜索 Baklib，注册帐号，点击创建网站（帮助文档）。

选择使用场景，此处选择帮助文档制作

选择合适的网页主题模板，网站提供十多个免费主题模板，之后可根据需要在设置中更改。

填写名称，二级域名（免费），选择与产品相匹配的主题颜色

内容编辑界面，编辑您的帮助文档内容。

今天就到这里，希望能帮到你。下次我们将讨论另一种帮助文档——帮助中心。