前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >怎么写帮助文档?产品人看过来

怎么写帮助文档?产品人看过来

原创
作者头像
小炮
发布2022-04-29 10:33:14
4370
发布2022-04-29 10:33:14
举报
文章被收录于专栏:客户服务自动化

随着信息化的快速发展,对绝大部分企业来说,打造站点帮助中心已是当下势不可挡的发展趋势。

在互联网时代,很多软件都把用户习惯培养起来了。用户对大部分软件的使用都有一种“无师自通”的感觉。但是在To B软件面前,尤其是业务复杂且深入的大型To B软件,用户会显得有些束手无策。

那么这个时候,一份简单易懂的帮助手册就显得尤其重要。如果帮助文档写得好,不仅能够给用户留下良好印象,同时还能大大减小培训成本。产品帮助文档的篇幅有大有小,这个视产品的复杂度来定。

帮助文档其实大概有两类,一类是在网站上的“帮助中心”,帮助中心的问题是一些通用的问题,比如这款软件适合哪类规模的公司、产品的定价和版本选择等等入门问题;而帮助文档一般是内嵌在系统里的,着重于向用户展示业务操作步骤,用户可以边看边操作。

一、帮助中心

帮助中心是一个网站,客户可以在此找到问题的答案和问题的解决方案。帮助中心旨在解决品牌收到的许多常见查询,应该让客户能够轻松找到他们正在寻找的答案。

良好的帮助中心网站架构良好并精心呈现,使客户可以轻松浏览网站并找到他们要搜索的内容。

帮助中心应始终易于搜索,为客户提供品牌知识库的可访问版本,该帮助中心应以用户体验为核心。该站点通常会包含常见问题解答、文章和各种说明,所有内容都应具有易于理解。

帮助台中心有什么作用?

帮助台中心降低了与客户服务相关的成本,同时改善了客户体验。

帮助台中心为客户提供一直被问到的问题的答案,使消费者更容易访问他们需要的信息,而无需联系客户服务团队的成员。因此,可以快速处理常见查询,让客户服务团队有更多时间专注于需要他们注意的复杂问题。

帮助台中心为任何需要它们的人提供大量资源,使品牌能够改进其产品并优化客户旅程。

帮助中心结构

二、内嵌帮助文档

系统内嵌的帮助文档主要是帮助用户了解操作流程。尼尔森认为帮助文档的重点是“任何帮助信息都应该可以方便地搜索到,以用户的任务为核心,列出相应的步骤,但文字不要太多”。

软件里的内嵌的帮助文档看似简单,但其实细节也很多。有的软件的帮助文档的布局排版都非常随意,而且内容全部都是文字,或者全部都是图片,一眼看过去,密密麻麻,找不到重点。那么,内嵌的帮助文档应该要怎么写呢?

1. 流程清晰

产品在写帮助文档的时候,首先自己要非常熟悉流程以及各个流程中状态的变化。比如说,手工入账、管家结账,那么产品经理应该自己首先弄清楚什么时候会在手工入账产生记录,什么操作会改变账单的状态等等。

如果产品自己不清楚,自然而然在帮助文档里写的也是非常糊涂的。此外,如果一个流程牵扯到多个终端,那么也要写清楚在各个终端的操作会引发什么状态,即记录全流程。比如说手机端进行的操作会引发Web端的变化,这也要写清楚。

2. 文字要少

帮助文档中,文字不能太多,主要是描写步骤。然后辅助截图,以箭头指示操作按钮。

如果帮助文档文字太多,会影响用户的阅读体验,让用户没有耐心阅读下去。

3. 展示重要问题

我开始写产品文档的时候,容易将产品文档写成各个模块的说明文档。因为有一些模块是展示模块,不涉及流程,也没有复杂的功能,对于这些模块就是图片加上干巴巴几句介绍。这样就导致写出来的帮助文档篇幅很长,没有重点,可阅读性也不高。所以在写的时候,要思考用户最关心的问题是什么,以及这个模块里复杂的业务流程有哪些。

房源的查看、账单的查看,这些简单的问题,完全不需要介绍,用户自然而然地就知道。而对于那些录入房源、手工入账、提现放款这些稍微深一些的业务问题才是用户想看的。所以产品在写之前,可以提炼出自己所负责的模块的一些重要流程以及主要操作。然后在此基础上,想着怎样以最少的文字进行最全面的讲解。

4. 统一模板

尼尔森的交互原则中,有一条就是“一致性原则”。这对帮助文档也适用。由于一般会是不同的产品负责不同的模块,所以如果不在一开始的时候统一模板,这会导致最后呈现出来的效果很容易五花八门乱七八糟。

帮助文档的模板最好是使用统一的模板,然后在页面上展示公司姓名和logo。

样式其实有很多,有word、有ppt、有pdf文档。现在看下来,样式比较好的就是用ppt做好,然后转成pdf格式,这样的话,不管是页面展示还是在线观看,体验都更好一些。

5. 常见问题说明

内嵌的帮助文档也需要常见问题说明,尤其是一些常见的异常情况,更需要提醒。比如说一些隐性的限制,拒绝结算放款后第二天会自动进行结算发起放款申请,由于这些是通过定时任务来进行,很难在页面中告诉用户。所以可以在帮助文档中,解答用户的这些疑问。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、帮助中心
    • 帮助台中心有什么作用?
      • 帮助中心结构
      • 二、内嵌帮助文档
        • 1. 流程清晰
          • 2. 文字要少
            • 3. 展示重要问题
              • 4. 统一模板
                • 5. 常见问题说明
                领券
                问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档