什么是 GitBook Agent?

与 AI 队友协作,保持你的文档准确、完整且最新

GitBook Agent 是一位 AI 队友,会与你并肩协作,帮助你保持文档准确、完整且最新。

Agent 与 GitBook 深度集成,因此你无需学习新的工作流程就能利用它——它会使用你已经熟悉的流程与你并肩协作。

如果你想在本地环境中使用 AI 助手编辑文档,你可以使用 GitBook 的 skill.md 文件.

GitBook Agent 能做什么?

GitBook Agent 可以:

  • 根据提示编写文档: 让 Agent 用最新信息更新某个页面,将文档中所有产品名称替换为新名称,或处理你需要的任何其他内容。

  • 将内容导入 GitBook: 在 Agent 聊天侧边栏中附加 PDF、Microsoft Word 文档等文件。Agent 可以提取内容并将其格式化为你空间中的页面。

  • 构思并实施更大的更改: 描述你需要什么,Agent 就会创建一个变更请求,解释其计划中的编辑,回应你的反馈,然后实施你们共同创建的方案。

  • 理解你的风格指南: 将你的风格指南添加到站点设置中,Agent 在编写或审核内容时会应用它。

  • 遵循自定义的站点级说明: 为某个站点向 Agent 提供具体说明,例如以特定方式添加链接,或避免特定的区块类型。

  • 翻译你的文档: 选择你想翻译的内容,选择一种语言,Agent 就会负责本地化你的文档。

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

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

自动文档建议

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

借助这些上下文,Agent 可以主动识别缺口,提出更新建议,并自动生成文档更改。因此,随着你的文档随产品不断演进,你的用户始终能在他们需要的时候、在他们需要的地方获取正确信息。

探索 GitBook Agent 的功能

添加风格指南和自定义说明

你可以通过添加团队的风格指南,或关于你希望它如何在某个站点上工作的具体说明来配置 GitBook Agent。每当它为该站点创建或编辑内容时,Agent 都会将这些内容作为上下文使用。

要添加风格指南或自定义说明,请打开你站点的 设置 然后选择 代理 标签页。将你的说明添加到自定义说明字段中。

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

自定义说明示例

下面是一个你可以在 GitBook Agent 设置中添加的自定义说明示例。

你是一名在 Stripe 工作的技术写作者。使用清晰、直接的语言,并优先保证准确性而非华丽辞藻。对于指南,始终以一句话概述介绍概念,并将内容拆分为结构清晰的章节。对于快速入门,始终使用步骤器,并让每一步都以动作为先且简洁明了。

常见问题

GitBook Agent 如何使用我的数据?

我们始终遵循数据保护实践,以保护你的数据隐私。

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

GitBook Agent 的费用是多少?

GitBook Agent 在测试版期间对所有方案免费。

翻译 按月附加购买,价格单独计算。访问 定价部分 了解更多。

我可以覆盖 GitBook Agent 输出的默认语气吗?

可以,你可以覆盖 GitBook Agent 的默认个性和语气。因此,如果你希望输出更详细,或者让它遵循特定风格或语气,只需告诉 Agent——无论是在站点级说明中,还是在变更请求中的单独提示里。

最后更新于

这有帮助吗?