写点什么

如何撰写出有效的帮助文档内容?

作者:小炮
  • 2022 年 4 月 15 日
  • 本文字数:1465 字

    阅读完需:约 5 分钟

帮助文档很重要。

对于用户来说,帮助文档是一个用户帮助中心,可以通过帮助页面查询到产品的操作指南,产品的使用方法、介绍,还有一些产品的典型案例参考,是产品不可或缺的文档。

对于公司来说,它是一个客服知识库,一方面能够帮助客户自助查询解决方案,减少客服工作量,另一方面他可以作为内部的培训手册,帮助新员工更快更好的上手使用产品,减少培训成本。  


所以本篇主要讨论“帮助文档内容的编写”,在搭建帮助中心时,其内容应该包括哪些方面?应该使用什么结构?小编为大家提供了好用的帮助文档内容模版,往下看。

5 个最常见的帮助文档内容模板

提前制作好站点模块,只需要查看内容的结构,适当插入产品或者服务信息,帮助你更好的写出知识库内容,下方小鸟为大家收集了 5 个常见的知识库文章模板,帮助你更好的完善内容。

1.常见问题解答部分

知识库文章模板中,FAQ 页面是常见的板块之一,通常包含现有客户或者访问者的常见问题,这种知识库文章格式通常是以“问答”的形式出现,为客户提供能够进行自助服务的页面内容,当你看到一个问题,立即就可以得到答案,页面的布局是这样的:

  • 标题:问题

  • 简介:标题中问题的细节或者文章内容的简短描述

  • 答案


问题模块,确保没有多余的信息,所说的一切都是重点,可以当客户服务团队提供相应的问答及解决方法,进行内容完善,做出一个有用的常见问题页面。

2.操作类文章

操作类内容主要是向客户介绍操作步骤或者流程,这种被称为操作指南或者教程,比如我们的产品 Baklib 就有相关操作指南和教程,可以查看所有重要步骤的说明文档及视频,以保证客户能够很快上手,模板如下:

  • 标题,本文内容的主旨

  • 简介,用 2-3 句简单介绍本文内容

  • 内容,展示应该如何实现某个效果或者使用某个功能,例如使用步骤一、步骤二、步骤三......这样的流程

  • 总结,总结相关信息并提供进一步说明(附加材料) 


公司及产品介绍

为了方便客户更快了解你的公司或者产品服务,一般此类内容都会附上图片、视频、gif 等,模版如下:

  • 标题,例如,“开始使用 [产品]”

  • 介绍,展示品牌的基本情况或历史 

  • 内容,可以在其中列出可以帮助用户更快进行的步骤或说明

  • 一个小型知识库部分,包含有关产品或服务的一些常见问题

  • 总结,可以在其中指定可能有帮助的其他公司资源 

这个知识库模版可以包含各种演练、教程,甚至常见问题解答的简短版本,换句话说,可以将客户关心的内容放入其中。

4.问题解决指南

想象一下,客户在使用中,突然遇到一些问题,他们通常都会尝试与客服取得联系,若没有及时的进行回应,最坏的结果就是失去这个客户,“问题解决指南”介于常见问题解答部分和操作方法部分之间,你可以将其添加到你的知识库中,在各个页面中留下它的链接,方便用户在使用的时候遇到相应的问题没有办法解决,他的结构包括:

  • 标题,你在其中命名问题 

  • 快速介绍, 首先列出可能发生这种情况的原因

  • 主体,你提供问题解决方案的地方 

  • 结论,你在其中提到了一些解决问题的替代方法

注:在编写此文档的时候,记住保持其简单的结构话,使用分步说明屏幕截图以及其他视觉元素来为你的客户节约时间,留下联系方式,让客户在无法解决问题的时候能够与你的客服团队取得联系。

5.产品或服务描述

为潜在客户提供产品的介绍,包括详细的功能及细节描述,帮助客户更加深入地了解你的品牌,可以按照下列的架构撰写:

  • 标题,你提到产品功能/用例/等的地方 

  • 文章的简短描述

  • 关于提到的功能的详细介绍,可以是视频、图片等展现形式。

  • 结论,你可能希望提供有关你的产品或服务的其他材料,并提供你的联系方式

以上就是为大家提供的几种帮助文档的模板,希望对大家编写自己的帮助文档有所帮助。

用户头像

小炮

关注

不甘于此 2022.02.24 加入

一个向着产品经理进发的小运营,分享自己的经验和感受

评论

发布
暂无评论
如何撰写出有效的帮助文档内容?_帮助文档_小炮_InfoQ写作平台