如何写内嵌式的帮助文档

Baklib

+ 关注

2022-04-02 18:25

438次阅读

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

首先我们先来聊聊为什么要制作帮助手册，这样才能了解它的价值，从而为其付出更多努力。

帮助用户更好地解决问题
引导用户在答案中行为
减轻客户服务压力，培训新客户服务
树立良好的品牌形象
有助于产品网络营销
有助于优化网站SEO

事实上，大约有两种类型的帮助手册。

一是网站上的帮助中心。帮助中心的问题是一些常见的问题，如该软件适用于哪种规模的公司、产品定价和版本选择。二是嵌入系统中的帮助文档，专注于向用户展示业务操作步骤，用户可以边看边操作。今天我们要讲的就是如何写内嵌的帮助文档。

软件中嵌入的帮助文档似乎很简单，但实际上有很多细节。一些软件帮助文档的布局和排版非常随意，所有内容都是文本或图片。乍一看，它们很密集，找不到关键点。那么，如何写嵌入式帮助文档呢？

在撰写帮助文档时，产品首先应该非常熟悉每个过程中的过程和状态的变化。例如，手动账户，管家账户，所以产品经理应该首先找出什么时候手动账户记录，什么操作会改变账单状态等。

如果产品本身不清楚，它自然会在帮助文档中写得非常混乱。此外，如果一个过程涉及多个终端，那么它也应该清楚地写下每个终端的操作会导致什么状态，即记录整个过程。例如，移动终端的操作会导致网络终端的变化，这也应该写清楚。

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

如果文档太多，会影响用户的阅读体验，让用户不耐烦地阅读。

当我开始写产品文档时，我很容易把产品文档写成每个模块的描述文档。因为有些模块是显示模块，不涉及过程，也没有复杂的功能，所以这些模块是图片和干燥的几句话。这导致了很长一段时间，没有重点，可读性也不高。所以在写作时，要考虑用户最关心的问题，以及模块中复杂的业务流程。

房子的查看，账单的查看，这些简单的问题，完全不需要介绍，用户自然会知道。对于那些进入住房、手动账户、现金提取和贷款这些稍深的业务问题是用户想要看到的。因此，在撰写产品之前，您可以完善您负责的模块的一些重要过程和主要操作。然后在此基础上，考虑如何用最少的文本进行最全面的解释。

尼尔森的互动原则之一是一致性原则。这也适用于帮助文档。由于不同的产品通常负责不同的模块，如果模板在开始时不统一，最终的效果很容易混乱。

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

事实上，有很多款式，包括word、ppt和pdf文档。现在，风格更好的是使用ppt，然后转换为pdf格式。这样，无论是页面显示还是在线观看，体验都会更好。

嵌入式帮助文档还需要解释常见问题，特别是一些常见的异常情况，更需要提醒。例如，一些隐藏的限制将在拒绝结算和贷款后的第二天自动启动贷款申请。因为这些都是通过定期任务进行的，所以很难在页面上告诉用户。因此，您可以在帮助文档中回答用户的这些问题。

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

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