在互联网时代，许多软件都注重培养用户习惯。在面对大多数应用程序时，用户“无师自通”。但面对 ToB软件，特别是那些业务繁杂、深度较大的大型 ToB软件，用户就会感到不知所措。在这种情况下，一本简单易懂的帮助手册就变得尤为重要。如果帮助文档写得很好，不仅会从用户那里赚取良好的口碑，还能够节约部分培训成本。

因此怎样编写一个有效的产品协助文件？这正是本文将要探讨的内容。

帮助文档制作的要点
从客户的角度出发来创建帮助文档，以下是一些可以参照的客户类型，可以针对以下三种类型的用户撰写帮助文档：

客户角色”小白”–不懂如何使用产品的用户，需要详细讲解每个操作步骤，每个功能的细节；
客户角色”百事通”，对技术一窍不通，但对各种功能的运用非常熟悉的用户，可以利用视频演示等方式。
客户角色”朋友”——他们是产品的忠实用户，通过使用产品会提供真实的反馈和意见，他们懂得一些技术，可以在很大程度上帮助产品商优化产品，他们喜欢简洁、快速地解决他们的问题。
这三个方面都是有助于文档内容编写的，他们的反馈建议可以让产品在内容上得到持续的优化，使其成为被大众所喜爱的帮助文档。

协助文件编写原则
1、流程清晰
当一个产品在编写一个辅助文件时，他必须对整个过程和每个过程的状态都很熟悉。例如，手工记账，管家结账，那么，产品经理自己就得先确定手工记账的时间，以及哪些操作会影响帐目状况，等等。如果产品本身不明白，那么在帮助文档中自然也会很混乱。

另外，当一个过程涉及多个终端时，也要把每个终端的动作都写下来，这样就可以把整个过程都记录下来。比如在手机上做了什么，会引起 Web的改变，这些都要写得很明白。

2、文字简短
在帮助文档中，文字不能太多，主要是描述步骤，辅助截图，箭头表示操作按键等更形象化的内容。

如果帮助文档的文字过多，将会影响读用户的阅读体验，使他们失去继续阅读的兴趣。

3、展示重要问题
写作时，思考用户最关心的问题是什么，并且在该模块中有哪些复杂的商业过程。查看房源、查看账单，这些都是很基础的事情，根本不用做任何的介绍，就能让使用者明白。至于那些录入房源、手工入账、提现放款等等更深层的业务问题才是用户想看的。

因此，在编写产品帮助文档之前，可以将自己负责的模块的关键步骤和关键流程都给总结出来。接着，再考虑如何用最少的文字来进行最全面的解释。

4、统一模板
尼尔森的互动原理之一就是“一致性原则”。这对帮助文档同样适用。

因为每个产品都有自己的模块，如果不能一开始就把模板统一起来，那么最终的结果就会变得千奇百怪。

帮助文件的模板更好是采用统一的模板，并将公司名称和商标显示在页面上。

5、常见问题说明
内嵌的帮助文档还需要有常见的问题说明，特别是一些常见的异常事件。比如说一些隐藏的条件，拒绝支付贷款后第二天会自动进行支付发起放款申请，因为这是通过定时任务来进行，很难在网页中告诉用户。所以可以在帮助文件中解答用户的这些疑问。

Baklib在线帮助文档生成平台
Baklib使用方便、易上手、轻松搭建帮助文档、多种主题模板、一键免费切换、可嵌入网页、用户可直接通过访问帮助文档查找相关问题解决方案。

功能特点：

内容可以在后台随时编辑，前台显示，随时修改；
多层次栏目，问题分类显示，使用树型目录结构，文件概要能自动产生文件重点；
与百度相似的搜索框，在搜索栏中输入关键字即可查找对应的文章，并突出显示搜索结果关键字；
使用与 word相似的编辑器，支持markdown，内容即写即存，并支持数据的备份和输出；
多设备写作，内容可以直接通过微信、钉钉、 QQ分享，还可以复制、分享，还可以嵌入到 APP、产品、网站中。
网站的访问权限可以自行设定，有三种方式：私密、公开、密码访问。可以针对特定的人群随意改变模式。
总体而言，一个好的产品文档能够提升系统的完整度、提高用户体验度、产品对系统的熟悉度、还能降低培训成本。

一个好系统，产品人员是以一份优秀的的产品文档结束的，而用户则会从一份优秀的帮助文档开始。