mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2d1295d0c0
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
169 lines
8.5 KiB
Plaintext
169 lines
8.5 KiB
Plaintext
---
|
|
title: "如何衡量和提升文档质量"
|
|
sidebarTitle: "改善你的文档"
|
|
description: "使用分析数据、用户反馈和内容审计来识别文档中的不足，并改善对用户最重要的页面。"
|
|
keywords: ["文档质量", "文档指标", "改善文档", "内容分析", "文档反馈"]
|
|
---
|
|
|
|
好的文档永远不会完成。产品在变化，用户的需求在演进，六个月前有效的内容可能已经不再反映产品的实际行为。系统地衡量文档有助于你将改进工作集中在影响最大的地方，而不是靠猜测。
|
|
|
|
本指南介绍如何使用定量指标、定性反馈和业务信号来找到并修复最重要的页面。
|
|
|
|
<div id="use-quantitative-metrics">
|
|
## 使用定量指标
|
|
</div>
|
|
|
|
分析数据为你提供文档表现的全局视图。最有用的指标是信号，而非答案——它们告诉你去哪里看，而不是具体要修复什么。
|
|
|
|
<div id="page-views-and-traffic">
|
|
### 页面浏览量和流量
|
|
</div>
|
|
|
|
高流量页面是你最重要的文档投资。一个月浏览量为 10,000 的页面上的问题，影响的用户远多于一个浏览量为 200 的页面上的相同问题。
|
|
|
|
注意以下情况：
|
|
- **错误或故障排除页面上出现意外的高流量。** 用户不应该需要不断阅读关于错误的内容。这些页面上的高流量通常预示着产品用户体验存在问题，值得向你的团队报告。
|
|
- **你预期热门的页面流量却很低。** 如果一个关键的入门页面浏览量很少，用户可能找不到它——检查你的导航和内部链接。
|
|
|
|
<div id="time-on-page">
|
|
### 页面停留时间
|
|
</div>
|
|
|
|
页面停留时间长可能意味着用户投入或困惑。停留时间短可能意味着用户立即找到了所需内容，或者放弃离开了。
|
|
|
|
结合上下文解读页面停留时间：
|
|
- 较长的参考页面应该有较短的平均停留时间——用户在快速浏览
|
|
- 教程内容应该有较长的停留时间——用户在按步骤操作
|
|
- 如果一个简单的操作指南页面停留时间异常长，用户可能在完成任务时遇到了困难
|
|
|
|
<div id="bounce-rate">
|
|
### 跳出率
|
|
</div>
|
|
|
|
跳出率衡量的是访问一个页面后未继续浏览就离开的用户。高跳出率本身并不是坏事——找到所需内容后返回工作的用户代表了一次成功的交互。
|
|
|
|
将跳出率与反馈评分结合起来正确解读。高跳出率加低评分意味着失败。高跳出率加高评分意味着成功。
|
|
|
|
<div id="correlate-traffic-and-satisfaction">
|
|
### 关联流量与满意度
|
|
</div>
|
|
|
|
Mintlify 的分析功能让你可以将反馈评分与流量数据一起查看。用此来确定优先级：
|
|
|
|
- **高流量、低满意度：** 用户体验差的热门页面。优先修复这些——它们影响最多的用户。
|
|
- **低流量、高满意度：** 内容有效但未被发现。检查导航和内部链接是否在引导用户访问这些页面。
|
|
- **高流量、高满意度：** 你表现最好的页面。审查它们以寻找可应用于其他地方的模式。
|
|
|
|
<div id="collect-qualitative-feedback">
|
|
## 收集定性反馈
|
|
</div>
|
|
|
|
数字告诉你有问题。定性反馈告诉你问题是什么。
|
|
|
|
<div id="in-page-ratings-and-comments">
|
|
### 页面内评分和评论
|
|
</div>
|
|
|
|
在你的文档页面上启用反馈功能，让读者能够在内容不正确时发出信号。开放式评论字段可以揭示具体问题——不清晰的步骤、过时的截图、缺失的信息——这些是仅靠评分无法识别的。
|
|
|
|
查看[反馈](/zh/optimize/feedback)了解如何配置反馈收集。
|
|
|
|
<div id="stakeholder-input">
|
|
### 利益相关者的意见
|
|
</div>
|
|
|
|
最接近用户的团队拥有分析数据无法揭示的信息：
|
|
|
|
- **支持团队**知道哪些文档主题产生最多的工单，以及用户在哪里经常遇到困难
|
|
- **客户成功团队**看到新用户在入职过程中在哪些页面上遇到困难
|
|
- **工程团队**知道文档何时描述了已更改的行为
|
|
|
|
与这些团队定期同步——即使是每月或每季度一次——可以揭示仅靠用户数据无法发现的差距。
|
|
|
|
<div id="user-research">
|
|
### 用户研究
|
|
</div>
|
|
|
|
与用户的直接对话提供了分析数据和评分无法提供的深度。让用户仅使用文档完成特定任务，并讲述他们的思考过程。他们关于去哪里查找以及在哪里感到困惑的直觉，揭示了对于熟悉产品的人来说难以察觉的结构和术语问题。
|
|
|
|
查看[了解你的受众](/zh/guides/understand-your-audience)获取更多研究方法。
|
|
|
|
<div id="align-documentation-with-business-goals">
|
|
## 将文档与业务目标对齐
|
|
</div>
|
|
|
|
文档质量也会反映在业务指标中。将文档工作与业务成果联系起来，有助于论证文档投资的价值。
|
|
|
|
<div id="support-efficiency">
|
|
### 支持效率
|
|
</div>
|
|
|
|
跟踪文档改进是否减少了特定主题的支持工单数量。当一份操作指南显著改进后，该主题的工单数量应该下降。这使得文档的投资回报率变得可见且可衡量。
|
|
|
|
<div id="user-onboarding-and-activation">
|
|
### 用户入职和激活
|
|
</div>
|
|
|
|
文档通常是新用户激活产品的关键路径。如果入职分析显示用户在某个特定步骤流失，那么该步骤的文档很可能是原因。
|
|
|
|
<div id="retention-signals">
|
|
### 留存信号
|
|
</div>
|
|
|
|
持续不准确或不完整的文档会侵蚀用户对产品的信任，而不仅仅是对文档的信任。遇到错误文档的用户会失去对产品本身可靠性的信心。文档质量是产品质量的一部分。
|
|
|
|
<div id="prioritize-and-act">
|
|
## 确定优先级并采取行动
|
|
</div>
|
|
|
|
衡量只有在推动行动时才有用。以下是一些决定优先修复什么的方法：
|
|
|
|
- **优先修复高流量问题。** 同样一小时的改进工作，在月浏览量为 5,000 的页面上影响的用户远多于浏览量为 50 的页面。
|
|
- **回应具体反馈。** 当用户留下具体评论——"这个示例不起作用"或"这个步骤缺少信息"——这些是高精度信号，只需很少的调查就可以采取行动。
|
|
- **专注于关键用户旅程。** 确定对你产品成功最关键的三到五个任务，并确保支持这些任务的文档在你担心其他内容之前是出色的。
|
|
|
|
<Tip>
|
|
使用[自动化](/zh/automations)来自动处理重复性改进——例如为被低反馈评分标记的页面打开包含建议修复的拉取请求。
|
|
</Tip>
|
|
|
|
<div id="frequently-asked-questions">
|
|
## 常见问题
|
|
</div>
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="如何知道应该优先处理哪些文档页面？">
|
|
从高流量和低满意度评分的交集开始。这些页面影响最多的用户，并且有最清晰的信号表明某些内容不正确。如果你还没有反馈评分，从你的支持团队开始——他们不需要任何分析设置就知道哪些页面最容易让人困惑。
|
|
</Accordion>
|
|
|
|
<Accordion title="什么是好的文档满意度评分？">
|
|
没有通用的基准。随时间跟踪你自己的基线，将持续改进作为目标。一个被 80% 用户正面评价的页面对于重要内容来说是一个合理的目标。比绝对分数更重要的是趋势方向，以及你最重要的页面与平均水平的对比。
|
|
</Accordion>
|
|
|
|
<Accordion title="应该多久审查一次文档指标？">
|
|
每月审查高流量页面和整体满意度趋势。每季度进行更深入的内容审计，查看导航模式、无结果的搜索查询以及最近未更新的页面。除非你刚刚发布了重大变更，否则不需要实时审查。
|
|
</Accordion>
|
|
|
|
<Accordion title="如果用户给出了负面反馈但没有解释原因，我该怎么办？">
|
|
从分析角度审视该页面。页面停留时间长加上负面评分通常意味着用户在按照说明操作时遇到了困难。页面停留时间短加上负面评分通常意味着用户没有找到他们要找的内容。将该页面的支持工单主题进行交叉对比以获得更具体的信号。当你无法从数据中诊断问题时，一次简短的用户访谈就能快速找到答案。
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
<div id="related-pages">
|
|
## 相关页面
|
|
</div>
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="分析概览" icon="chart-line" href="/zh/optimize/analytics">
|
|
查看分析数据并跟踪文档表现。
|
|
</Card>
|
|
<Card title="反馈" icon="message-square" href="/zh/optimize/feedback">
|
|
收集和分析用户对你文档的反馈。
|
|
</Card>
|
|
<Card title="了解你的受众" icon="users" href="/zh/guides/understand-your-audience">
|
|
研究并定义你的文档受众。
|
|
</Card>
|
|
<Card title="SEO" icon="search" href="/zh/guides/seo">
|
|
为搜索引擎优化你的文档。
|
|
</Card>
|
|
</CardGroup>
|