干货分享丨这应该是全网对“在线帮助文档”讲得最清楚的一篇文章

在线帮助文档/指南为用户了解企业的产品/服务带来了极大的便利，因为用户可以在几乎任何地方轻松访问。与印刷版用户指南和手册不同，在线手册可通过智能手机和平板电脑等移动设备进行访问。优化了传统文档不便携带、不易查阅等问题。

小编之所以编辑这篇文章，是发现国内的很多产品方压根没把“在线帮助文档”当回事，觉得这个东西没有任何实际作用顶多是个面子工程。

但作为管理者有没有思考过每天市面上会新出多少工具？用户的学习时间有限如果你的产品不是刚需，又有多少人愿意花大把的时间去学习。

如果你不缩短用户的学习时间，那么你获得的资源将大打折扣。而在线的帮助文档能在用户使用产品的过程中，简化了用户的学习时间，快速的上手产品（简单易上手的产品，用户才能更容易的发现它的价值）。

Forrester Research最新的客户生命周期调查发现，购买者现在使用公司网站在线帮助指南/文档的频率，与通过电话/在线客服/邮件与产品方沟通的频率相同。可以看出在线帮助文档在整个产品运营中发挥的作用越来越大。

当然只有正确编写在线用户指南和手册，使其有效且易于使用才能发挥在线帮助文档的作用。那么在编写在线用户指南和文档时应该考虑什么呢？小编给大家带来7条优化建议，使您的文档更加人性化。

编写在线帮助文档/指南时需要注意的事项

1.编写在线帮助文档考虑移动端适配

现在都2020年了，如果说你做的帮助中心只考虑到PC（电脑端）的适配我觉得很可笑了。在线帮助中心的优势是，可以在几乎任何地方采用任何设备都可以轻松访问。如果不考虑手机端的适配问题那帮助中心的作用将大打折扣。作为在线帮助文档的创作者，需要优先针对市面上的主力机型做好适配（重点）！！！

2.编写在线帮助文档考虑页面的色块布置

一个好的色块布局不会让这个画面有种跳出感觉，会给人一种沉浸式的体验，在线帮助文档作为一个内容的聚合体，如果你的画面弄的五颜六色视觉冲击力极强，很难让用户留下来好好去观看里面的具体内容。

建议在线帮助文档色块设置上要偏柔和点，和人感觉日式的哪种设计比较妥当。平时大家在生活中也能明显感觉出来，快餐店播放的歌曲都是那种重金属摇头嗨，而小酒馆则是那种抒情柔美的歌偏多。

3.编写在线帮助文档考虑页面的排版布局

排版布局对于帮助中心的重要性不言而喻，作为产品方我们应该快速的为用户梳理产品的整体结构，而不是傻兮兮的将产品功能全部罗列出来单个解释。一个合格的在线帮助文档我觉得需要包括以下三块：

产品更新动态：主动告知用户产品最近的更新功能，让用户知晓新功能的同时也告诉他们产品一直在更新迭代。

产品系统化的介绍：对于新手用户可以做个快速认知产品的一个专题，对于老用户将产品整体的一个功能做清晰的介绍。

重点问题知识库：用户提及的高频常见问题（可以从客服处收集），产品使用上的小技巧或者产品操作难点讲解。

4.在线帮助文档内容上少文字多图片和视频

大多数时候，记住所看到的东西要比阅读的东西容易。这是因为大脑处理视觉效果的速度比文字处理快60,000倍。您可以为产品用户执行相同的操作。有时，您只需要一张图片即可告诉用户如何解决问题或正确使用产品。

随着短视频的兴起，用户的阅读习惯受到很大的波动，如果能用视频的形式去代替冗长的文字，将是最有效的办法。这里呢小编推荐个录屏的工具吧Screen Flow，感兴趣的可以去了解下，可以录屏录声音剪辑起来也很方便（这是一款国外的产品，可以去搜搜破解版）。

5.注意单篇帮助内容之间的链接和导读

帮助文档中的每一篇内容都不是孤立存在的，在向用户介绍产品单个产品功能的时候，都会存在一个或多个与之关联的功能。使用内容关联的形式不仅可以帮助用户加深对产品的理解，而且会使得单篇文章内容不会显得太冗长。（长篇大论的阅读性质极低）

如果单篇内容过多的话，除了标题、有序无序、文字加粗/颜色等设置外，最好加入文章导读的功能。可以快速帮助用户理清文章结构将大大提升阅读体验！

6.编写在线帮助文档需提供精准有效的搜索功能

上面我们也讲到，在线帮助文档作为一个内容的聚合体，光做好一个内容的分类还是不够的。得加上一个精准有效的搜索功能。这样一方面解决了人的惰性问题，二方面提升了使用者的效率。

在我看来结构化内容是给新手使用的，因为他们不知道要要找什么问题。搜索功能呢更受老用户青睐，因为他们知道要找的问题是什么，通过搜索的设置则能帮助他们更快的找到内容。提高用户效率的同时，也将用户的好感度维系起来。

具体功能的实现上建议搜索功能精准，界面清晰。

7.编写在线帮助文档需注意用户的反馈不断优化内容

在线帮助文档/指南需要随着产品的更新迭代、收集到的用户反馈不断做优化。如果你发现一个帮助文档很久都没更新那代表这个产品可能再走下坡路了。这里在重点强调下帮助文档不是面子工程，把它建设好了会给产品带来巨大的优化和推动作用。

具体功能的实现上建议在每篇内容下面，添加用户反馈的功能插件（有用无用）。或者直接放一个反馈表单供用户使用。通过反馈的数据观察也能看到在线帮助文档的使用量，和用户对于产品的态度。

好了以上就是小编总结的建设在线帮助文档需要注意的7个事项，觉得有用的话可以收藏起来。结尾小编给大家讲下在线帮助文档的常见搭建形式，如果想搭建的可以看看哦！

在线帮助文档的搭建形式

常见的在线帮助文档搭建，小编总结为以下4类（欢迎补充）

wiki：是一种在网络上开放且可供多人协同创作的超文本系统，典型的工具有Gitbook、Docsify...

网页搭建：技术通过Html语言自己搭建或找企业建站公司。

CHM：CHM 文件格式是微软于 1998 年推出的基于 HTML 文件特性的帮助文件系统，现在常用的电子书格式。

SaaS类工具：专业的帮助文档搭建工具，按需收费的SaaS模式，典型的工具有Baklib、看云...

推荐一款我比较喜欢的在线帮助文档建设工具-Baklib。这是国内一款基于Web应用的在线帮助文档制作工具，对于企业来说做在线的产品说明书、FAQ、帮助中心、知识库，员工培训手册来说都非常不错，可做到随时编辑随时更新发布。员工可以对产品认知更清晰，用户可以在售前售后都能更快捷、方便地了解产品。

产品优势

一款好的企业在线帮助文档工具，要让内部搭建员工用的简单，外部访问的客户看着舒服（在线帮助文档好看是重点）。产品优势上我总结了以下4点。

• 操作上：这款工具在操作上无需构建文档框架（每个主题都有对应的展示框架 现在的话有15个主题都是针对帮助文档场景），写完文档直接发布，简单方便学习成本低。
• 外部展示上：Baklib提供了多种对外的展示主题支持手机端的适配，可以随意地切换变更颜色，支持页面页脚、独立域名的添加...
• 细节：提供了很多实用的插件包括全局搜索、用户反馈功能、文章导读、帮助站点的访问统计、站点导航...
• 编辑器：丰富的富文本+Markdown让编辑更加轻松（支持视频、图片、文件上传）

这是目前我体验到的使用最简单，展示效果最好的一款了不论是对内的知识协同和对外的产品操作讲解，用这款工具就最为合适。

产品实用地址：https://www.baklib.com/?utm_content=6&utm_source=CSDN

总结

2020年了，如果作为企业管理人员还在一个劲的只想打磨产品，忽视用户使用体验，那无疑是一条腿走路。而在线帮助文档的设置，是最切实有效且成本最低的方法