什么是 GitBook Agent?

与 AI 团队成员协作,保持您的文档准确、完整且保持最新

GitBook Agent 是一个 AI 团队成员,与您并肩工作,帮助您保持文档的准确、完整和最新。

Agent 深度集成在 GitBook 中,因此您无需学习新的工作流程即可使用它——它会使用您已经熟悉的流程与您协同工作。

GitBook Agent 能做什么?

GitBook Agent 可以:

  • 根据提示撰写文档: 请求 Agent 使用最新信息更新页面、将每次提及的产品名称替换为新名称,或执行您需要的任何其他操作。

  • 构思并实施更大范围的更改: 描述您的需求,Agent 会打开一个变更请求,解释其计划的编辑内容,回应您的反馈,然后实施你们共同制定的计划。

  • 理解您的风格指南: 将您的风格指南添加到组织设置中,Agent 在撰写或审阅内容时将始终应用该指南。

  • 遵循自定义的组织级指令: 在组织层面向 Agent 提供具体指令,例如以特定方式添加链接,或避免使用特定类型的区块。

  • 翻译您的文档: 选择您要翻译的内容,选定语言,Agent 将负责本地化您的文档。

  • 从评论中召唤: 在页面的任意区块添加评论,输入 @gitbook 并告诉 Agent 您需要什么。

  • 审阅变更请求: 将 Agent 添加为变更请求的审阅者。它可以充当文档风格检查器,识别或修复错误、建议改进并标记风格指南偏差。

自动文档建议

Agent 还可以连接到您的团队用于了解产品和用户需求的相同信号:支持对话、工单以及来自您已连接工具的线程。

在这些上下文下,Agent 可以主动识别空白、提出更新并自动生成文档更改。因此您的文档可以随产品演进,用户能够在需要的时间和地点获得正确的信息。

自动文档建议处于抢先体验阶段

前往 组织设置 → GitBook Agent 申请访问权限。

探索 GitBook Agent 的功能

添加风格指南和自定义指令

您可以通过添加团队的风格指南或关于如何与团队协作的具体指令来配置 GitBook Agent。Agent 在为组织创建或编辑内容时会将这些作为上下文使用。

要添加风格指南或自定义指令,请打开您的 组织设置 然后选择 GitBook Agent 部分。点击 设置 选项卡并在文本输入字段中添加您的指令。

您也可以通过在变更请求中打开 GitBook Agent 聊天窗口,然后打开 操作菜单 并选择 配置 GitBook Agent .

自定义指令示例

以下是您可以在 GitBook Agent 设置中添加的自定义指令示例。

您是 Stripe 的一名技术作者。使用清晰、直接的语言,优先保证准确性而非修饰。对于指南类内容,始终以一句话总结介绍概念,并将内容分成结构良好的章节。对于快速入门,始终使用步骤器,并保持每一步以动作为先且简明扼要。

常见问题

GitBook Agent 如何使用我的数据?

我们始终遵循数据保护做法以确保您的数据隐私。

GitBook Agent 不会将您的数据用于训练 AI 模型。我们仅为向您提供 GitBook AI 的功能之目的,将您添加到 GitBook Agent 的信息与 OpenAI 共享。有关更多信息,请查看 OpenAI 的隐私政策。

GitBook Agent 费用多少?

GitBook Agent 在测试期间对所有计划免费。

翻译 作为每月附加服务单独计费。访问 定价部分 以了解更多信息。

最后更新于

这有帮助吗?