撰写有效帮助文档的7大秘诀

互联网的发展让各种软件的入门门槛不断降低，现在，在B站上你几乎可以搜索到大多数软件的视频教学，并且这其中的部分质量也是非常的高。当然如果你愿意为知识付费，在淘宝上搜索相应的课程能够获得更加优质的课程体系，并且此类课程大多还伴随着一系列的售后服务，比如问答群之类的。

但是我发现伴随着教学视频的兴起，有个非常实用，高效而且官方的东西逐渐被忽略，那就是——官方的

帮助文档

。

帮助文档主要是由官方来进行编写的软件使用文档。此类帮助文档往往覆盖的内容极为宽泛，可以说是软件使用的“百科全书”。

帮助文档的编写方法

一、了解用户痛点并收集到帮助中心

要编写帮助中心内容，我们需要了解客户会提出关于产品操作的什么问题，可以通过四种方式进行收集：建立反馈表单、通过客户群反馈、在线客服收集问题、用户在社交媒体上的反馈。

二、假装客户一无所知

帮助中心内容需要通俗易懂，假装读者一无所知，换掉专业的技术语言。比如以下操作解释，相对第二种更能让客户理解：

• 连接相机后，导入照片

• 连接相机后，单击菜单>文件>添加照片>导入>全部导入

面对需要使用复杂文字解释时，尽量用图片或者视频代替

三、结构清晰方便预览

将相关问题进行分类，通过块级的形式展现出来，会使得帮助结构更为清晰客观。

四、多设置快捷导航

用户打开一篇文章后，面对大量的内容介绍会使得他迷茫困扰，通过合理的文章导航设置会大大降低阅读的难度。

五、提供更多快捷查找服务

除了在帮助页面中设置随处可见的搜索框，搜索机制上也许做到优化。例如全局检索、搜索关键词高亮等设置。

为了更好的引导用户，设置常见问题也是必不可少的。

六、多端适配

除了很多人的上网场景逐步转向手机、IPad，在优化帮助页面展示时，也应该考虑到移动端适配的问题，，做到一次制作多场景使用。

七、及时的数据反馈

准确的数据反馈可以帮助产品方及时调整帮助页面，例如文章的阅读数量，设置更新时间和人员记录更方便管理，并且及时对内容进行调整。

帮助文档的制作工具

在线帮助文档工具推荐-Baklib。这是一款基于web的在线文档管理工具，对外可制作产品帮助中心，对内可用户制作知识库。

使用Baklib在10分钟内就可制作出一个简约实用的帮助文档页面：设定目标并确定目标受众，为企业创建一个视觉上引人入胜且信息丰富的在线帮助平台。选择帮助文档模版，根据产品定位进行展示界面设置，以使帮助中心具最佳的效果。添加帮助中心内容，一键发布一个好看的帮助文档页面就出来了。

使用链接：https://www.baklib.com/?utm_content=21&utm_source=infoq