TapCub 正式上线:统计、分析、客服一个平台免费用
产品动态

怎么写用户指南:结构、带注释的大纲和测试方法

怎么写出能减少支持工单的用户指南:从 90 天的工单出发,用带注释的大纲,按微软的规则写步骤,用五个人测试,并按每 1,000 名用户衡量结果。

林舟 发布于 2026 年 11 月 20 日 10 分钟阅读 产品动态
示例数据:同一时期,已覆盖的类别下降 44.0%,未覆盖的下降 12.5%,所以指南对这一变化的贡献约为 31 个百分点。示例数据

写用户指南,要从客户已经在问的问题出发:把最近 90 天的支持工单按任务归类,每个类别写一节,用固定的骨架(标题、开始之前、编号步骤、结果、如果没成功),找五个没见过产品的人来测试,再按每 1,000 名活跃用户衡量工单数,并和你没写文档的类别对比。示例里,四个章节覆盖了 70% 的工单。

读完你会知道

  • 先给工单排名靠前的类别写:示例里,四个任务章节覆盖了 400 张工单中的 70%
  • 步骤每步一个动作、一个有名字的控件、一个看得见的结果,因为用户一个页面只读大约 20%
  • 只把超出未覆盖类别的那部分算在指南头上:示例里是 −44.0% 对比 −12.5%,约 31 个百分点

用户指南是什么,和使用手册、教程有什么不同?

用户指南是以任务为单位的文档,一步一步告诉客户怎样用你的产品把一件事办成。检验标准很简单:一个带着目标的人打开它,照着做,不用问任何人就成功了。「用户指南」「用户手册」「帮助文章」这几个词有重叠,但内容的形态不同。

类型回答的问题读者典型形态
用户指南「我怎么做 X?」正在做事的人针对一个任务的编号步骤,并写明结果
教程「教我基础知识」新用户带着做一个真实项目的引导路径
参考文档「这个设置是做什么的?」有经验的用户字段、选项和限制的完整列表
故障排查「为什么不工作?」遇到困难的人症状、原因、解决办法

大多数「用户指南」失败,是因为想同时做这四件事。本文把指南当作任务文档,其余三类分开写并互相链接。衡量成功的不是页数,而是少收了多少支持工单:每一节都要对应客户真实会问的问题。怎么培训团队把客户引到正确的章节,见 客服培训。

怎么决定用户指南该写什么?

从人们已经在问的问题出发,而不是从功能清单出发。

  1. 收集最近 90 天的支持联系:工单、聊天、邮件。
  2. 给每一条归类。 类别不超过十个,用任务来命名(「重置密码」,而不是「账户问题」)。
  3. 计数并排序。 算出每类的占比和累计占比。
  4. 先给排名靠前的类别写。 能省下的工单就在那里。
  5. 留一个「其他」类。 如果它超过约 15%,说明你的分类太粗。

示例数据:90 天里有 400 张工单。

类别工单数占比累计
重置密码9624.0%24.0%
邀请团队成员7218.0%42.0%
连接数据源6416.0%58.0%
导出报表4812.0%70.0%
账单与发票4411.0%81.0%
通知设置307.5%88.5%
其他4611.5%100.0%

前四类占了 70% 的工单(96 + 72 + 64 + 48 = 280,280 ÷ 400 = 70%)。这就是指南的初版:四个任务章节,而不是四十个。别去写没人问的功能。

一份好的用户指南大纲长什么样?

每个任务都用同一副骨架,读者就能学会东西在哪里。每个部分都有它的作用,以及它针对的工单类型。

章节放什么规则针对
标题用用户的话说这个任务:「邀请团队成员」动词开头,不用产品术语搜索和导航
开始之前权限、前提条件、需要的时间只列会卡住任务的东西「我看不到按钮」类工单
步骤编号,每步一个动作,以看得见的结果结束3 到 9 步;更长的任务要拆开「怎么做……」类工单
结果做成了之后用户应当看到什么一句话,带上界面名称「成功了吗?」类工单
如果没成功两三个常见症状和解决办法症状、原因、解决办法重复联系
相关任务指向下一个可能任务的链接最多两三个后续工单

在任务章节之前放一段简短的快速开始:五步以内做到首次成功,不要让新用户把所有内容都读一遍。只有绕不开某个术语时才加术语表,否则把术语改写掉。

章节放什么针对的工单类型
标题用用户的话说任务,动词开头搜索和导航
开始之前会卡住任务的权限和前提条件「我看不到按钮」
步骤3 到 9 个编号步骤,每步一个动作「怎么做……」
结果做成之后用户应当看到什么「成功了吗?」
如果没成功2 到 3 个症状,带原因和解决办法重复联系
相关任务指向下一个可能任务的两三个链接后续工单

每个任务都用同一副骨架,读者就能学会东西在哪里。

步骤该怎么写?

读者不是在读,而是在扫。Nielsen Norman Group 对 25 位用户的 45,237 次页面浏览(2005 年采集)做的研究发现,用户一次访问中,在一个普通网页上最多只有时间读 28% 的文字,更可能是 20%(Nielsen Norman Group)。要这样写:让他们读到的那 20%,正好是步骤里的动词和按钮。

微软的风格指南对分步说明给出了具体规则(Microsoft Style Guide):

  • 多步骤流程用编号列表,每条指令单独一步;在界面同一位置发生的几个短步骤可以合并。
  • 如果可能引起混淆,先说明操作发生在哪里,再描述操作。
  • 每一步以祈使动词开头,写成完整的句子。
  • 写出完成流程的那个动作,比如选择 应用。
  • 不要让人应接不暇:尽量让所有步骤放在同一屏里。
  • 标题保持平行结构,引导句不要重复标题。

改写示例。改前:「用户应当导航到设置区域,然后会找到可以点击的添加团队成员的选项。」改后:

  1. 在左侧菜单里选择 设置。
  2. 选择 团队,再选择 邀请成员。
  3. 输入对方的邮箱地址并选择角色。
  4. 选择 发送邀请。对方会以 待接受 的状态出现在列表里。

「改后」的版本有四个动词、四个有名字的控件和一个看得见的结果。按这个标准检查每一步:是不是一个动作、一个有名字的控件,并且在最后有一个可观察的结果?

「如果没成功」这一部分怎么写?

写成症状表,因为人们按眼前看到的东西去搜。

症状可能的原因解决办法
「邀请成员」是灰色的你的角色没有邀请权限请管理员修改你的角色,或者让他来发邀请
邀请已发送,但对方没收到地址错误,或被垃圾邮件过滤检查地址;请对方查看垃圾邮件;重新发送
同一个人出现了两次向不同的地址发了两次邀请在 团队 里移除没用的那条

两条规则:每个症状都是读者能观察到的东西,每个解决办法都是一个动作,而不是建议(「填邮箱地址时要小心」)。如果指南上线后某个症状仍不断产生工单,说明解决办法写错了,或者症状描述得不够具体。

发布之前怎么测试用户指南?

把指南交给没见过这个产品的人,然后看着他做。Nielsen 的可用性测试模型认为,n 位测试者发现的问题比例是 1 − (1 − L)ⁿ,L 是单个测试者发现的比例;L = 31% 时,五位测试者发现约 84%(该文四舍五入为 85%)(Nielsen Norman Group,2000 年)。五个人、逐个进行,对一份指南来说是个合理的规模。

每个任务的测试流程:

  1. 给对方目标(「添加一位团队成员」),而不是步骤。
  2. 只让他们用指南。不要帮忙;在每次犹豫处做记录。
  3. 记录 不靠帮助完成(是或否)、完成用时,以及 他们停顿或出错的那一步。
  4. 在每个停顿处改指南,而不是改人。
  5. 用新的测试者重新测试改过的步骤。

一个实用的标准:五人中至少四人不靠帮助完成。如果五人中有两人在第 3 步卡住,第 3 步就是缺陷所在。

怎么知道指南有没有减少支持工单?

原始的工单数会误导人,因为你的用户基数在变。按每 1,000 名活跃用户做归一化,并和你没碰过的类别对比。

示例数据:指南之前,400 张工单、20,000 名活跃用户,也就是 400 ÷ 20,000 × 1,000 = 每 1,000 人 20.0 张。之后,310 张工单、22,000 名活跃用户:310 ÷ 22,000 × 1,000 = 每 1,000 人 14.1 张,下降 29.5%。(原始数量只下降了 22.5%,因为用户基数变大了。)按类别:

类别是否写了指南之前,每 1,000 人之后,每 1,000 人变化
重置密码是4.801.82−62.1%
邀请团队成员是3.602.50−30.6%
导出报表是2.401.73−28.0%
已覆盖:三个类别10.806.05−44.0%
连接数据源否3.202.82−11.9%
账单与发票否2.201.91−13.2%
通知设置否1.501.27−15.2%
其他否2.302.05−11.1%
未覆盖:四个类别9.208.05−12.5%

没有指南的类别也下降了 12.5%。这就是你的对照:其他因素也变了(产品修复、季节性回落、更好的新手引导邮件)。指南的效果是多出来的部分:−44.0% 对比 −12.5%,约 31 个百分点。把这个算在指南头上,而不是全部的 44%。

在工单数之外,再配两个辅助数字:指南页面的浏览量,以及这些访问中没有产生联系的有多少。被读了却仍然产生工单的指南,步骤不够清楚;没人打开的指南,是可发现性的问题。

app.tapcub.com

每 1,000 名活跃用户的工单数,之前与之后

示例数据
已覆盖的类别,之前10.80
已覆盖的类别,之后6.05
未覆盖的类别,之前9.20
未覆盖的类别,之后8.05
示例数据
示例数据:同一时期,已覆盖的类别下降 44.0%,未覆盖的下降 12.5%,所以指南对这一变化的贡献约为 31 个百分点。

怎样用 TapCub 把指南和客户的问题连起来

TapCub 不写也不托管你的指南。如果你在同一个网站、同一个访客 ID 上使用 TapCub 在线客服,它能帮你找到该写什么,并看出它有没有用。同样的「从工单出发」办法,也适用于聊天对话:

  1. 找出问题。 转到真人的聊天会标明原因:没有匹配的知识、模型答不上、访客要求、轮次上限或坐席接手。在知识库的 草稿收件箱 里,从对话生成 会把最近 30 天已解决对话里的访客问题和坐席回复,整理成问答草稿(每个站点每 24 小时一次,每批 1 次 AI 调用);在你批准之前,什么都不会上线。
  2. 看哪些页面引出了问题。 客服 › 客服报表 列出前 10 个热门页面,即访客开始聊天时所在的页面。聊天开始次数多的任务页,旁边需要一份更清楚的指南。
  3. 把答案放在问题出现的地方。 在 客服 › 知识库 里,置顶的问答会显示在访客端的 FAQ 里。打开答案不建会话、不占额度;只有点「没解决」或要求人工,才会开启会话。
  4. 看效果。 同一个报表页显示知识库命中率和会话数。网站统计 › 页面 显示指南页本身的浏览量。
  5. 清楚边界。 TapCub 不统计你的客服系统里的工单;这些数字要从你自己的系统取,并像上面那样按每 1,000 名活跃用户归一化。如果网站还没有聊天,先看 启用在线客服。

FAQ

怎么写用户指南?

从客户已经在问的问题出发:把最近 90 天的工单分类,先给排名靠前的类别写。每个任务都用用户的话做标题,加一个简短的「开始之前」、每步一个动作的编号步骤、一句结果说明和一张「如果没成功」的表。用五个没见过产品的人来测试。

用户指南应该包含什么?

五步以内的快速开始、按固定骨架写的每个任务一节、一张问题症状表、指向相关任务的链接,以及仅在需要时才有的简短术语表。别写没人问的功能;示例里,四个任务章节就覆盖了 70% 的工单。

用户指南和用户手册有什么区别?

实践中两个词有重叠。用户指南通常指以任务为单位的说明(「我怎么做 X」),手册则还可能包含参考资料,比如完整的选项列表和规格。重要的是每个页面只服务一种读者需求:做一件事、学基础、查东西,或者排除故障。

用户指南该写多长?

任务需要多长就多长,不要更长。每个任务 3 到 9 步,更长的就拆开。微软的风格指南建议尽量让一个流程的所有步骤放在同一屏里。读者是扫读的,有研究发现,他们在一个页面上最多读大约 28% 的文字。

怎么知道用户指南有没有用?

发布之前用五个人测试;发布之后,比较已覆盖类别和没写文档的类别每 1,000 名活跃用户的工单数。示例里,已覆盖的类别下降 44.0%,未覆盖的下降 12.5%,所以指南的贡献约为 31 个百分点。

资料来源

归档:产品动态

这篇文章对你有帮助吗?

我们会根据反馈修改和补充这篇内容。

林舟

产品体验专员

关注产品体验、功能使用与增长实践,喜欢把复杂流程拆成清晰步骤,让分析结果更容易用到日常决策中。

从真实的问题里找出该写什么

热门页面、转人工的原因,以及已解决聊天生成的草稿答案,和你的统计在同一个网站、同一个访客 ID 上。

看清数据,找到增长。

每一次点击,都有数据依据。装好一行代码,1 分钟看到第一批数据。

无需信用卡 · 统计与客服都有免费版 · 统计无 Cookie