自动文档建议

了解 GitBook Agent 如何在后台工作以保持文档更新

此功能当前处于早期访问阶段

我们目前正在与少量团队测试此功能，以便进一步开发。前往 组织设置 → GitBook 代理 以请求访问权限。

GitBook 代理可以 连接到相同的信号源 您的团队用来了解产品和用户需求的信号：支持对话、Slack 线程、GitHub 问题等。

基于这些上下文，代理可以主动识别空白、提出更新并自动生成文档更改。

GitBook 代理会在您组织的内容上进行训练，这意味着它了解您团队的写作风格、结构和语气。您还可以 添加自定义指令 供代理遵循——更多内容见下文。

1

连接一个来源

要允许 GitBook 代理建议自动文档改进，您首先需要 连接一个来源.

在您连接一个或多个来源后，代理将开始在后台收集和分析您的数据。

2

探索 GitBook 代理如何分析您的数据

连接来源后，GitBook 代理会将该上下文信息分类为对话、问题和主题。

它将这些信息结合使用，以建议对您的文档的自动改进，这些改进会以变更请求的形式打开。

要查看 GitBook 代理分析的数据，请前往您组织的设置，然后打开 数据浏览器 选项卡 在 GitBook 代理 部分。

3

查看 GitBook 代理提出的变更请求

随着更多数据流入，GitBook 代理将获得足够的上下文开始提出建议——通过在相关空间中打开新的 变更请求 。

您可以像处理其他变更请求一样编辑由 GitBook 代理打开的变更请求——并且只要拥有相应的 权限.

您也可以 向 GitBook 代理请求审查 以让其分析它所建议的更改。

4

与 GitBook 代理协作处理更改

GitBook 代理还可以作为撰写伙伴，允许您在变更请求内规划、撰写、重写或更新任何内容。

在从 变更请求屏幕查看变更请求时，打开 GitBook 代理将允许您直接与其聊天，以在您正在处理的变更请求的上下文中进行更改。

您还可以添加 评论 到特定块，并@gitbook 标记以请求 GitBook 代理进行更改。

为 GitBook 代理添加或移除可修改的已发布站点

默认情况下，GitBook 代理将有权在您任何已发布的文档站点中创建变更请求。在 GitBook 代理的设置界面中，您可以选择希望代理提出建议更改的站点。

为 GitBook 代理添加自定义指令

要 为 GitBook 代理添加自定义指令 以供遵循，请打开您组织的设置并在侧边栏中选择 GitBook 代理 页面。

在此处，您可以编写自定义指令，代理在为您的文档站点准备、分析和生成变更请求时将会使用这些指令。