互联网时代，很多软件都注重培养用户的习惯。面对大多数应用，用户都是“自学”的。然而，当面对ToB软件，尤其是那些业务复杂、深度较大的大型ToB软件时，用户会感到无所适从。在这种情况下，一本通俗易懂的帮助手册就变得尤为重要。如果帮助文档写得好，不仅能在用户中赢得好口碑，还能节省一些培训费用。
那么如何写一份有效的产品辅助文档呢？这就是本文将要讨论的内容。
帮助文档制作的关键点
从客户的角度创建帮助文档。以下是一些类型的客户，您可以参考。可以为以下三种类型的用户编写帮助文档:
客户“小白”的角色——不知道如何使用产品的用户，需要详细讲解每个操作步骤和每个功能的细节；
客户“懂行的人”，对技术一窍不通，但对各种功能的使用非常熟悉，可以利用视频演示等方式。
客户的角色“朋友”——他们是产品的忠实用户，他们会通过使用产品来提供真实的反馈和意见。他们懂一些技术，可以很大程度上帮助产品厂商优化产品，他们喜欢简洁快速地解决他们的问题。
这三个方面都有助于文档内容的编写，他们的反馈和建议可以使产品在内容上不断优化，使其成为受欢迎的帮助文档。
协助文件准备的原则
1.流程清晰。
产品在编写辅助文档的时候，一定要熟悉整个流程，熟悉每个流程的状态。比如手工记账和管家结账，那么产品经理自己还要确定手工记账的时间，哪些操作会影响账户状态等等。如果产品本身不懂，在帮助文档中自然会混乱。
另外，当一个流程涉及多个终端时，每个终端的动作都要记下来，这样就可以记录整个流程。比如你在手机上做的事情会引起Web的变化。这些都要写清楚。
2.短文本
在帮助文档中，文字不要太多，主要描述步骤、辅助截图、指示操作键的箭头等比较直观的内容。
如果帮助文档字数过多，会影响读者的阅读体验，使其失去继续阅读的兴趣。
3.显示重要问题
写的时候，想想用户最关心的是什么，模块里有哪些复杂的业务流程。查房源，查账单，这些都是很基础的东西，用户不用任何介绍就能看懂。至于房源录入、手工录入、提现放款等更深层次的业务问题，则是用户希望看到的。
所以在写产品帮助文档之前，可以先总结一下自己负责的模块的关键步骤和流程。然后，考虑如何用最少的文字给出最全面的解释。
4.统一模板
尼尔森的交互原则之一是“一致性原则”。这同样适用于帮助文档。
因为每个产品都有自己的模块，如果一开始不能统一模板，最后的结果就会变得千奇百怪。
帮助文件的模板最好采用统一的模板，在页面上显示公司名称和商标。
5.常见问题描述
嵌入式帮助文档还需要有常见问题描述，尤其是一些常见的异常事件。比如一些隐藏条件，拒绝还款后，第二天会自动进行贷款申请，因为这是通过一个预定的任务完成的，很难在网页中告诉用户。因此您可以在帮助文件中回答这些问题。
Baklib在线帮助文档生成平台
Baklib简单易用，易于构建帮助文档，多种主题模板，一键自由切换，可嵌入网页，用户可以直接访问帮助文档，找到相关问题的解决方案。
功能特性:
内容可以在后台随时编辑，前台显示，随时修改；
多级栏目，问题分类展示，采用树形目录结构，文件汇总可自动生成文件焦点；
类似于搜索框，在搜索栏输入关键词，找到相应的文章，并高亮显示搜索结果关键词；
使用类似word的编辑器，支持markdown，内容写入存储，支持数据备份输出；
多设备写作，内容可以直接通过微信、钉钉、QQ分享，复制、分享，嵌入app、产品、网站。
网站的访问权限可以自己设置。有三种方式:私有、公共和密码访问。可以针对特定人群随意改变模式。
一般来说，好的产品文档可以提高系统的完整性，改善用户体验，提高产品对系统的熟悉度，降低培训成本。
在一个好的系统中，产品人员以一个优秀的产品文档结束，而用户以一个优秀的帮助文档开始。
