自动改进文档

识别文档中错误和过时的页面，审查发现的问题，并通过 GitBook Agent 自动修复

此功能目前处于抢先体验阶段。

我们正在逐步开放访问权限。请继续关注以下功能的更多进展。

GitBook Agent 可以识别文档中的问题——例如内容缺口、过时页面和错误信息——并提出并实施改进建议。

GitBook Agent 可以检测什么？

• 内容缺口 当 GitBook 发现用户就你的产品提出文档难以回答的问题时，就会出现，例如：

  • 客户向支持团队提问，而他们在文档中找不到答案。
  • 某个 API 端点缺少完整文档。
• 过时内容 当你页面上的内容已被外部来源中的内容所取代时，会被检测为过时内容，例如：

  • 一次 SDK 更新更改了函数签名。
  • 某个付费功能已移至免费层级，但文档尚未更新。
• 错误内容 当文档站点上的内容明显错误时，会被标记，例如：

  • 某个指南指向已不再存在的 API，或该功能已被弃用。
  • 诸如你的营销网站等外部来源与文档不一致。

识别原理

1

连接数据源

当 GitBook Agent 连接到外部来源，例如你的支持工单系统、公开论坛或营销网站时，效果最佳。某些来源在完成设置之前需要额外的 API 密钥或身份验证。 了解更多关于我们的连接。

2

GitBook Agent 生成发现

GitBook 会定期审阅你的数据源，并根据结果生成发现。GitBook 会汇总这些发现，供你的团队审阅。 了解更多关于我们如何摄取数据。

3

审阅你的发现

审阅你的发现以开始修复问题。每个发现都包含问题摘要、所属主题、支持证据，以及 GitBook 用作上下文的页面链接。

4

修复或归档

某些发现可以由 GitBook Agent 自动修复。此选项可用时，你可以创建 变更请求 并直接从该发现中发起。你也可以将不想保留在活动列表中的发现归档。

要申请使用 GitBook Agent 的自动文档改进功能，请打开你站点的 设置.

自动修复

当某个发现支持自动修复时，GitBook 会显示一个 创建变更请求 操作，以便 GitBook Agent 生成一个建议修复供你的团队审阅。若要跳过该建议，请改为归档该发现。GitBook 不会重新打开你已归档的发现。