关于软件系统的帮助文档页面，你该知道的那些事儿

作者：Baklib

2022-10-28
四川
本文字数：2054 字
阅读完需：约 7 分钟

随着互联网的发展，科技慢慢融入我们日常生活中，各种软件深入我们的生活、工作学习中。用户第一次接触一个产品软件，对于使用方法、功能特点、操作习惯等都不熟悉，这时候帮助文档都作用就发挥出来了，软件系统不断更新迭代，用户也可以直接访问帮助文档查看到相关内容。

帮助文档一方面能够帮助新用户快速上手使用你的产品，给到新用户很好的使用体验，它是用户和产品之间很好的一个沟通方式，通过帮助文档的访问数据以及文章阅读，能够了解产品目前的状况以及需要优化的地方；另一方面这是一个很好的机会宣传产品以及公司，用户目前遇到问题，很多时候都是直接百度或者通过其他搜索引擎获得答案，做好帮助文档的 seo 优化也是一个很好的方式宣传，对内而言，帮助新员工了解产品，快速上手投入工作，减少培训成本，特别是对于客服部门，大大减少了客户咨询工作量，减少工作压力。

那么怎么写软件系统帮助文档？帮助文档应该怎么做？怎么引导用户使用帮助文档呢？小鸟精心为大家总结了以下几点。

帮助文档内容

对于一个软件产品系统来说，要让用户知道你的产品能做什么，怎么使用，以及遇到问题应该怎么解决，主要围绕这三方面来填写内容。

1.产品说明

产品的简介，一段话简要概括产品的研发目的，使用场景等信息。可以直接放在帮助文档的首页，让用户一进来就能直观的看到。

2.操作指南

用步骤一、二、三的方式展示出怎么快速上手使用产品，内容简洁步骤清晰，不需要添加太多描述性的话语。

3.产品功能介绍

对于产品的特点功能进行介绍，包括这个功能的作用，能够用在什么地方，使用方法，进行简单罗列，最好每个功能单独放出来介绍，适当在帮助文档中添加链接的方式引导到别的文章。

4.常见问题

这是帮助文档很重要到一部分，每个问题单独列出来，文字通俗易懂，流程清晰，文字要少，操作步骤类到尽量用图文结合或者视频文字结合的方式，减少用户的阅读难度。

5.应用案例

这方面的内容可以放在帮助文档里面，也可以直接放在产品官网单独列出来，帮助用户了解你的产品，并且放上优秀案例，增加用户对产品的信任感，促进转化付费。

确定了帮助文档的内容，那么帮助文档应该怎么做呢？

帮助文档有很多种制作方式，主要有以下几种：

WIKI

Wiki 是一种在网络上开放且可供多人协同创作的超文本，支持面向社群的协作式写作，Wiki 站点可以有多人（甚至任何访问者）维护，每个人都可以发表自己的意见，或者对共同的主题进行扩展与探讨。

其内容具有极高的关联性，初始架构不好的话可能会造成内容结构零散，不好阅读；Wiki 语法标准不一样，不同的 wiki 系统采用的语法不一致，造成作者编辑困难；并且结构和页面展示形式较难调整。使用 wiki 的时候需要遵循一定的准则，精心的编写维护。

CHM 帮助文档

CHM 帮助文档是微软早起开发的基于 HTML 文件特性的帮助文件系统，有着简洁的浏览界面，方便的检索功能，随后被广泛应用。但是 chm 帮助文档的操作相对比较复杂，需要专门的编程人员以及软件协助制作，不懂代码的人不易上手使用，有的时候还会出现文件、素材丢失的问题，内容更改相对比较困难。

SaaS 类软件工具

专业的帮助文档搭建工具，典型的有 Baklib-专业的在线帮助文档制作平台，这种软件工具收费相对较低，操作难敌低，后期的运营比较方便，提供一站式的帮助文档制作服务。

怎么引导用户使用帮助文档

帮助文档建立好了，但是用户不去使用，发挥的作用小之又小，可能是因为用户还没有发现帮助文档的存在。据研究表明，很多用户更喜欢遇到问题后，自助式的解决方式，而不是去找客服人员咨询。

将帮助文档嵌入到产品内部，是一个很好的方式，放在用户能够一眼看到的位置；当用户遇到问题咨询客服时，回答的时候尽量带上帮助文档相关内容，不仅能够帮助客服节省时间，还能提高客服工作效率；当产品更新迭代后，主动将更新内容放在帮助文档中，并且向用户发送消息，引导用户查看；产品出现问题时，帮助文档主动弹出相关帮助文档引导用户查看使用。