写点什么

建立客户忠诚,从编辑产品帮助文档开始!

作者:Baklib
  • 2022-10-26
    四川
  • 本文字数:1330 字

    阅读完需:约 4 分钟

使用产品时,经常会遇到问题,需要查阅说明书和使用说明。

对于线上产品来说,帮助文档一般都是有帮助文档的,帮助文档主要是针对用户在操作过程中遇到的各种问题进行详细的解答,同时也是对产品和技术的全面说明。



产品说明文档为什么需要?

  • 帮助用户解决问题。

  • 引导用户的反应。

  • 降低客户服务压力,培训新客户。

  • 树立良好品牌形象。

  • 对产品网络营销有帮助。

  • 有助于网站搜索引擎优化。



应该如何编写帮助文档?

1.流程清晰

产品在编写帮助文档时,首先要对流程和状态的变化了如指掌。比方说,手工记账,管家结账,那么产品经理首先要搞清楚什么时候手工记账,什么操作会改变帐单状态等等。

如果产品本身并不清楚,那么在帮助文档中自然会写得非常混乱。另外,如果一个过程涉及多个终端,那么也要写清楚各个终端的操作所引发的状态,也就是记录整个流程。比如手机上的操作,会引起 Web 端的变化。

2.概要

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

如果帮助文档中的文字太多,将会影响用户阅读体验,使用户失去阅读的耐心。

3.突出常见问题

有几个模块是展示模块,没有流程,没有复杂的功能,只有图片和简单的介绍。这样一来,帮助文档就会变得冗长、缺乏重点、缺乏可读性。因此,在写文章时,要考虑哪些问题是用户最关心的,哪些是这个模块中复杂的业务流程。

查看房源、查看账单,这些简单的问题,根本不用介绍,就能让用户知道。用户想要看到的,就是录入房源、手工录入、提现放款等更深层次的业务。所以在写产品之前,可以将自己负责的模块的一些重要流程和主要操作都给提炼出来。然后根据这一点,思考如何用最少的文字来做最全面的解释。

4.统一模板

尼尔森的交互原则之一,就是“一致性原则”。这同样适用于帮助文档。因为不同的产品负责不同的模块,如果不统一模板的话,最终的效果就会变得乱七八糟。

帮助文档模板最好使用统一模板,然后将公司名称和 logo 显示在页面上。

有 Word,有 ppt,也有 pdf 文档。现在看来,最好的就是用 PPT 做出来,然后变成 pdf 格式,这样无论是在网页上,还是在网上观看,都会有很好的体验。



5.常见问题

内嵌的帮助文档还需要一些常见的问题说明,特别是一些需要提醒的常见异常。比如一些隐藏的限制,比如拒绝结算,第二天就会自动启动贷款申请,因为这些都是有时间限制的,所以很难在页面上显示出来。因此,用户的这些问题可以通过帮助文档来解答。

帮助文档制作工具

Baklib 是一个中国在线文本编辑与托管工具,不仅为企业用户提供 FAQ 帮助文档,同时也为企业用户编写知识库,产品手册,帮助中心,发行指南。对于爱好写作的用户,可以写日记手帐和个人博客,功能超赞。独立域名、多种模板支持将创作内容按模板导成各种漂亮界面,让内容分享更加方便,更有利于形成个人品牌口碑。

测评:

  • 易于编辑和清晰的结构。

  • 丰富的展示模板,友好的排版界面。

  • 具有很强的文本检索能力。

  • 展示设置自由度高。

  • 独立域名。

  • 无需下载,多端适配。

还可用于常见问题,知识库,发行说明,个人博客等等。

总体来说,一个好的产品文档可以提升系统的完整性,提高用户的体验,增加产品的熟悉度,降低培训成本。一个好的系统,产品人员最终会写出一份优秀的产品文档,而用户则会从一份优秀的帮助文档开始。

Baklib 使用地址:https://www.baklib.com/

用户头像

Baklib

关注

还未添加个人签名 2022-07-04 加入

还未添加个人简介

评论

发布
暂无评论
建立客户忠诚,从编辑产品帮助文档开始!_帮助文档_Baklib_InfoQ写作社区