为什么文档对 SaaS 至关重要:隐藏的投资回报率
文档是产品中唯一在人们都不值班时仍能发挥作用的部分。它在凌晨 3 点、搜索结果中、AI 助手里,以及评估过程的前十分钟内提供答案。本页面解释文档影响收入的机制,以及如何在自己的产品上进行衡量,而不是盲目相信行业平均值。
我们打造了 Docsbook。下面的每个数字都需要由你自行衡量——我们不会发布无法溯源的基准百分比。
糟糕的文档究竟会带来什么成本?#
糟糕的文档不会形成一项单独的成本。它会将成本转移到已有预算的三个团队:支持、工程师入职培训和销售。这就是为什么它在电子表格中不显眼,却在实际工作中代价高昂。
这三项转移,按大多数公司察觉到它们的顺序排列:
- 支持。 文档无法回答的问题会变成工单。你的支持团队把一天的时间花在充当一个更慢、更昂贵的搜索界面上,而这些知识本来就是你们已经掌握的。
- 入职培训。 找不到答案的新工程师会通过阅读源代码或询问同事来重新构建答案。这两种方式的成本都高于阅读页面,而且同事也要付出代价。
- 采用与评估。 无人找到的功能就是无人使用的功能。无法在前五分钟内回答“它能做到 X 吗?”的评估者会认为它做不到。
如何衡量糟糕文档对我自己产品造成的成本?#
衡量交接次数,而不是文档本身。以下四项数据,你本周都可以收集:
| 统计内容 | 数据所在位置 | 它能告诉你什么 |
|---|---|---|
| 答案已经存在于文档中的工单 | 支持收件箱,按标签统计一个月 | 有多少支持工作本质上是可查找性问题 |
| 在文档网站上搜索但没有返回结果的查询 | 文档网站搜索日志 | 读者使用的、但你的页面中没有出现的确切措辞 |
| 文档助手无法回答的问题 | AI 聊天日志 | 以读者的措辞表达出来的文档缺口 |
| 读者访问后立即离开的页面 | 文档分析数据 | 与查询匹配但没有回答查询的页面 |
前两项成本最低,也最有说服力。对工单添加标签并统计一个月,就能把“我们的文档还可以更好”变成一份带有具体数量的清单。
为什么这么多 SaaS 公司仍然会把这件事做错?#
在大多数组织中,没有人负责文档。工程团队在截止期限的压力下编写文档,市场团队不把它视为一种渠道,而支持团队只能被动承担后果,却无力解决根本原因。页面有所改进时,没有人的季度目标会因此发生变化,所以也就没有人编辑页面。
第二个原因是,在进行衡量之前,这项工作是隐形的。支持工单量会被报告;但“本来可以由某个页面避免的工单”默认不会在任何地方被报告。
2026 年的文档生态是什么样的?#
这些工具分为两大类,选错类别的代价,比在同一类别中选错产品更高。
| 类别 | 示例 | 你拥有的 | 你不拥有的 |
|---|---|---|---|
| 静态站点生成器 | Docusaurus、VitePress、MkDocs Material、Starlight | 主题和构建的完全控制权 | 托管、搜索、升级、AI 功能 |
| 托管平台 | Docsbook、GitBook、Mintlify、ReadMe | 内容 | 构建、托管、搜索、AI、分析 |
静态生成器的成本是工程时间,而无需订阅费。托管平台的成本是订阅费,而无需工程时间。当没有人负责内容时,两者都会以同样的方式失败。
如需详细的正面对比,请参阅2026 年的 Docusaurus 替代方案、GitBook 与 Docsbook 对比以及免费文档托管对比。
Docsbook 对此做了哪些改变?#
Docsbook 将 GitHub 仓库中已有的 Markdown 发布为文档网站,并报告读者如何使用这些内容。这里说的是机制,而不是承诺:
- 真实来源仍保留在 Git 中。 文档与发生变更的代码在同一个拉取请求中编辑,因此页面过时会在评审时暴露,而不是等客户发现。
- 机器也能读取网站内容。 Docsbook 发布
llms.txt并运行 MCP 服务器,因此当助手回答有关您产品的问题时,可以读取您的页面,而不是猜测。请参阅 用于文档的 MCP 服务器。 - 助手根据您已建立索引的页面回答。 原本会提交工单的读者,可以直接在页面上得到答案,并且答案会使用他们提问时的措辞。
- 分析会将缺口报告为问题。 失败的搜索和未得到回答的助手问题会以待撰写内容清单的形式呈现,并保留读者自己的措辞。请参阅 文档分析:需要跟踪什么。
我如何知道我的文档已经足够完善?#
用证据而非观点回答以下四个问题。每个问题都对应上表中的一项计数。
- 新开发者能否在不向他人求助的情况下获得第一个可运行的结果?
- 最常见的十个支持问题是否都能在某个页面上找到答案,并且每个问题都能通过客户使用的词语找到?
- 当有人提出关于你们产品的问题时,搜索引擎或 AI 助手会返回你的页面,还是会返回其他人的页面?
- 当读者在你的文档网站上搜索却一无所获时,是否有人能看到这次搜索?
如果其中任何一个问题没有答案,那么需要改进的是衡量方式,而不是重新设计。
Docsbook 的费用是多少?#
Docsbook 采用按需付费,而不是分级定价。每个项目都有自己的余额,该余额用于 AI 使用——网站本身、托管、阅读和搜索不会消耗余额。当前价格请查看 docsbook.io/pricing,该页面在每次请求时根据实时价格常量生成;博客文章中复制的价格可能会悄无声息地过时,因此请以该页面为准。
发布您现有的代码仓库,然后花一周时间查看失败的搜索。
后续步骤#
- 文档分析:需要跟踪的内容 — 本页面计数背后的指标
- 文档 SEO 指南 — 让页面在创建后能够被找到
- 如何让 ChatGPT 引用您的文档 — 面向助手的发现部分