在互联网时代，许多软件都重视造就用户习惯。在面对大多数应用程序时，用户“无师自通”。但面对 ToB 软件，特地是那些业务繁冗、深度较大的大型 ToB 软件，用户就会感到手足无措。在这种状况下，一本简略易懂的帮忙手册就变得尤为重要。如果帮忙文档写得很好，不仅会从用户那里赚取良好的口碑，还可能节约局部培训老本。
因而怎么编写一个无效的产品帮助文件？这正是本文将要探讨的内容。
帮忙文档制作的要点
从客户的角度登程来创立帮忙文档，以下是一些能够参照的客户类型，能够针对以下三种类型的用户撰写帮忙文档：
- 客户角色 ” 小白 ” – 不懂如何应用产品的用户，须要具体解说每个操作步骤，每个性能的细节；
<!—->
- 客户角色 ” 百事通 ”，对技术无所不通，但对各种性能的使用十分相熟的用户，能够利用视频演示等形式。
<!—->
- 客户角色 ” 敌人 ” ——他们是产品的忠诚用户，通过应用产品会提供实在的反馈和意见，他们懂得一些技术，能够在很大水平上帮忙产品商优化产品，他们喜爱简洁、疾速地解决他们的问题。
这三个方面都是有助于文档内容编写的，他们的反馈倡议能够让产品在内容上失去继续的优化，使其成为被公众所青睐的帮忙文档。
帮助文件编写准则
1、流程清晰
当一个产品在编写一个辅助文件时，他必须对整个过程和每个过程的状态都很相熟。例如，手工记账，管家结账，那么，产品经理本人就得先确定手工记账的工夫，以及哪些操作会影响帐目情况，等等。如果产品自身不明确，那么在帮忙文档中天然也会很凌乱。
另外，当一个过程波及多个终端时，也要把每个终端的动作都写下来，这样就能够把整个过程都记录下来。比方在手机上做了什么，会引起 Web 的扭转，这些都要写得很明确。
2、文字简短
在帮忙文档中，文字不能太多，次要是形容步骤，辅助截图，箭头示意操作按键等更形象化的内容。
如果帮忙文档的文字过多，将会影响读用户的浏览体验，使他们失去持续浏览的趣味。
3、展现重要问题
写作时，思考用户最关怀的问题是什么，并且在该模块中有哪些简单的商业过程。查看房源、查看账单，这些都是很根底的事件，基本不必做任何的介绍，就能让使用者明确。至于那些录入房源、手工入账、提现放款等等更深层的业务问题才是用户想看的。
因而，在编写产品帮忙文档之前，能够将本人负责的模块的关键步骤和要害流程都给总结进去。接着，再思考如何用起码的文字来进行最全面的解释。
4、对立模板
尼尔森的互动原理之一就是“一致性准则”。这对帮忙文档同样实用。
因为每个产品都有本人的模块，如果不能一开始就把模板对立起来，那么最终的后果就会变得千奇百怪。
帮助文件的模板最好是采纳对立的模板，并将公司名称和商标显示在页面上。
5、常见问题阐明
内嵌的帮忙文档还须要有常见的问题阐明，特地是一些常见的异样事件。比如说一些暗藏的条件，回绝领取贷款后第二天会主动进行领取发动放款申请，因为这是通过定时工作来进行，很难在网页中通知用户。所以能够在帮助文件中解答用户的这些疑难。
Baklib 在线帮忙文档生成平台
Baklib 使用方便、易上手、轻松搭建帮忙文档、多种主题模板、一键收费切换、可嵌入网页、用户可间接通过拜访帮忙文档查找相干问题解决方案。
性能特点 ：
- 内容能够在后盾随时编辑 ，前台显示，随时批改；
<!—->
- 多层次栏目 ，问题分类显示，应用树型目录构造，文件概要能主动产生文件重点；
<!—->
- 与百度类似的搜寻框 ，在搜寻栏中输出关键字即可查找对应的文章，并突出显示搜寻后果关键字；
<!—->
- 应用与 word 类似的编辑器 ，反对 markdown，内容即写即存，并反对数据的备份和输入；
<!—->
- 多设施写作 ，内容能够间接通过微信、钉钉、QQ 分享，还能够复制、分享，还能够嵌入到 app、产品、网站中。
<!—->
- 网站的拜访权限能够自行设定 ，有三种形式：私密、公开、明码拜访。能够针对特定的人群随便扭转模式。
总体而言，一个好的产品文档可能晋升零碎的残缺度、进步用户体验度、产品对系统的相熟度、还能升高培训老本。
一个好零碎，产品人员是以一份优良的的产品文档完结的，而用户则会从一份优良的帮忙文档开始。