For the complete documentation index, see llms.txt. This page is also available as Markdown.

内容缺口

找到你的文档未能回答的问题,按严重程度排序,并使用 GitBook Agent 将其补上

内容缺口处于 Beta 版,并且仅适用于 Ultimate 站点方案。

内容缺口会显示你的文档没有回答哪些问题。GitBook 会扫描访客在你的文档中提出的问题,以及你已连接来源中的支持工单、电子邮件、论坛和其他记录。它每天会将这些问题与你的内容进行比较,找出文档未回答的问题,并按严重程度进行排序。

从任何缺口出发,GitBook Agent 都可以创建一个将其补上的变更请求。

在你网站的侧边栏中,前往 改进 → 内容缺口.

The Content gaps screen showing summary tiles, the filter row, and a list of gaps with their topics and evidence counts

顶部的四个卡片显示 GitBook 找到了多少个差距、其中有多少属于高严重性、已有多少变更请求从差距中合并,以及哪个来源贡献最多。

GitBook 检测什么

GitBook 标记四种问题:

  • 内容缺口 当 GitBook 发现客户在询问与你的产品相关、而文档难以回答的问题时,就会出现,例如:

    • 客户向你的支持团队提问,而他们在文档中找不到答案。

    • 某个 API 端点缺少完整文档。

  • 过时内容 当你页面上的内容已被外部来源中的内容取代时,就会被检测为此类问题,例如:

    • 一次 SDK 更新更改了某个函数的签名。

    • 某个付费功能已移至免费层级,但文档尚未更新。

  • 错误内容 当文档站点上的内容明显有误时,就会被标记,例如:

    • 某篇指南指向已不再存在的 API,或指向已经停止支持的功能。

    • 外部来源,例如你的营销网站,与文档内容不一致。

  • 其他 涵盖不属于上述类别的问题。

工作原理

1

连接你的来源

当 GitBook 能将你的文档与你的客户已经提问的地方进行比较时,会发现更多缺口——例如你的支持工单系统、公开论坛或营销网站。有些来源在完成设置前需要额外的 API 密钥或身份验证。 了解有关连接的更多信息。

2

GitBook 每日扫描

GitBook 每天会检查一次你的来源,并将其发现与你已发布的内容进行比较。文档未能回答的每个问题都会成为一个缺口。

3

查看缺口

每个缺口都会说明问题、背后的证据,以及修复建议。按严重程度排序,找出最值得优先修复的缺口。

4

填写或拒绝

通过创建以下内容来补上一个缺口: 变更请求 从中填写,或拒绝你不想处理的项。GitBook 不会重新打开你已拒绝的缺口。

筛选列表

一个拥有大量历史内容的网站一次可能会暴露出成千上万个缺口。筛选列表,找出值得处理的那些:

筛选
选项
用它来

状态

打开, 已更改, 已拒绝, 已解决

将未处理的缺口与以下内容区分开来:已有变更请求涵盖的缺口、你的团队否决的建议,以及已合并的变更请求关闭的缺口。

严重程度

高, 中, 低

优先处理影响最大的缺口。

日期

最近 7 天, 最近 30 天

查看最近一次发布或支持请求激增暴露了什么。

主题

网站上的任何主题

专注于文档中的某个区域。主题的分组方式与 AI 助手报告中的分组方式相同。

类型

内容缺口、过时内容、错误内容、其他

将缺失的文档与出错的文档区分开来。

来源

任何已连接的来源

查看单个来源报告的内容,例如只有 Intercom 看到的缺口。

GitBook 代理

已处理,未处理

找出尚无人接手的缺口。

按严重性对筛选后的列表排序,将最具破坏性的差距置于顶部。

拒绝一个缺口会记录你的团队已考虑该建议并决定不采用,这样它会被排除在开放列表之外,但不会隐藏已作出该决定这一事实。按以下条件筛选 已解决 以找出已被某个已合并变更请求关闭的缺口。

审查缺口

每次审查一个差距都遵循相同的路径:

  1. 在“内容缺口”页面中,筛选出你想处理的缺口列表。

  2. 点击一个缺口将其打开。

  3. 阅读 问题, 证据,以及 建议 ,以判断这个缺口是否真实且值得填补。

  4. 打开关联的来源记录,亲自检查证据。

  5. 点击 创建变更请求返回,或 拒绝 如果这个缺口不值得填补。

  6. 审查 GitBook Agent 起草的变更请求,然后将其合并。

A single content gap showing its status, severity, type, and topic, with Reject and Create change request actions above the motivation

缺口显示什么

打开一个差距后,会显示其名称、状态、严重性、类型和主题。状态是一个下拉菜单,因此你无需离开差距页面就可以更改它。在其下方, 动机 该部分将案例分为三部分展开说明:

  • 问题 说明文档没有解释什么,以及这会给读者带来什么结果。

  • 证据 说明 GitBook 发现了什么:目前哪些页面覆盖了该领域、它们遗漏了什么,以及来源记录显示人们在问什么。

  • 建议 提出要写什么以及放在哪里,包括要从哪些页面链接过来。

在“动机”下方,GitBook 会列出该发现所依据的来源记录——单独的支持对话、讨论或页面,每条都有链接,因此你可以打开原始内容完整阅读。

来源记录仅会显示你已连接的来源。来自支持对话的缺口只有在连接了相应支持平台时才会显示这些对话。参见 连接 来进行设置。

从缺口创建变更请求

当一个缺口可以自动修复时,横幅会说明该发现可以在变更请求中解决,并提供两个操作。

点击 创建变更请求 将这个缺口交给 GitBook Agent。Agent 会阅读该发现及其提到的页面,然后起草变更内容。当修复涉及多个页面时,一个缺口可以生成多个变更请求。

Agent 处理时,屏幕会显示进度,然后列出它生成的内容,并提供每一项的审查链接。从那里开始,它们的行为就像任何其他 变更请求 ——你会准确看到哪些内容发生了变化,并适用你常规的审查和合并规则。参见 使用 GitBook Agent 审查变更请求 ,了解 Agent 如何帮助审核它。

合并变更请求即可解决该缺口,并将其从队列中移除。按以下条件筛选 已解决 再次找到它。

拒绝缺口

点击 拒绝 当一个缺口不值得填补时——问题超出范围、页面已经回答了它,或者该发现误读了证据。拒绝会使该缺口保留在开放列表之外,而 GitBook 不会重新打开它。

更改缺口状态(包括拒绝它)需要该站点的编辑权限。你无法使用的操作会显示为禁用,并附带说明。

使用你自己的代理处理缺口

内容缺口页面上的所有内容也可通过以下方式获取: GitBook API 以及 GitBook MCP 服务器,因此你自己的代理或脚本可以在 GitBook 应用之外处理缺口。你的代理或脚本可以执行以下操作:

  • 列出某个站点的缺口,并查看每个缺口背后的证据:源记录、AI 助手提问以及它影响的页面。

  • 解决、拒绝或重新打开一个缺口。

  • 让 GitBook Agent 通过生成变更请求来修复缺口,正如 创建变更请求 它在应用中所做的那样。

  • 通过设置其 siteFindingId。当与该缺口关联的每个变更请求都合并后,该缺口即被解决。

设置

在“内容缺口”页面上,点击 设置 以查看 GitBook 会扫描哪些来源,以及每个来源贡献了什么。

来源

该 来源 列表显示每个正在摄取的连接、它已扫描的内容,以及有多少缺口来自它。每个来源都以自己的单位报告:网站以页面计,YouTube 频道以视频计,GitHub Discussions 以讨论计,支持平台以对话计。

你的文档本身就是一个来源。 AI 助手 会报告访客在你的网站上提出的未获回答的问题,以及由此产生的缺口。请查看 AI 助手 报告以完整查看这些问题。

每个来源都会显示在你为连接设置的标签下,因此两个网站连接会分别显示,而不会合并为一条记录。

点击 显示内容缺口 任意来源,即可将列表筛选为该来源的缺口。

连接

该 连接 部分显示你尚未连接的来源,例如 Zendesk、Freshdesk、Front、HubSpot、Zoho Desk、Pylon、GitHub Issues 和一个 MCP 服务器。

点击 管理连接 以打开“连接”页面,在那里你可以添加来源、检查同步状态和记录数量、设置搜索排名,并浏览 GitBook 已摄取的各个记录。参见 连接 了解每个连接器索引的内容以及如何设置它。

最后更新于

这有帮助吗?