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

概览

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

GitBook Agent 是一位与您并肩工作的 AI 队友。它帮助您保持文档准确、完整且及时更新。GitBook Agent 深度集成在 GitBook 中。您无需采用新的工作流程即可使用它。

如果您使用 AI 助手在本地编辑文档,请使用 GitBook 的 skill.md 文件.

GitBook Agent 能做什么?

GitBook Agent 可以:

  • 根据提示编写文档: 让 GitBook Agent 更新页面、重命名产品,或进行您需要的任何其他更改。

  • 将内容导入 GitBook: 在 GitBook Agent 聊天侧边栏中附加 PDF 和 Microsoft Word 文档等文件。GitBook Agent 会提取内容并将其整理成您章节中的页面。

  • 规划并实施更大的更改: 描述您的需求。GitBook Agent 会创建一个变更请求,说明其编辑内容,回应反馈,并落实您共同制定的计划。

  • 遵循您的风格指南: 在一个中定义你团队的写作规则 风格指南,GitBook Agent 在编写或审阅内容时会将其视为权威来源。

  • 遵循自定义的网站级说明: 向 GitBook Agent 提供站点特定说明,例如如何添加链接或应避免哪些区块类型。

  • 翻译您的文档: 选择您要翻译的内容,选择一种语言,GitBook Agent 会将您的文档本地化。

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

  • 审查变更请求: 在您的变更请求中将 GitBook Agent 添加为审阅者。它可以充当文档检查器,标记风格指南问题,并建议或修正错误。

自动文档建议

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

有了这些上下文,GitBook Agent 可以识别缺口、提出更新建议,并自动生成文档更改。

随着您的文档随产品不断演进,您的客户会在需要时获得正确的信息。

探索 GitBook Agent 的功能

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

您可以使用团队的风格指南或站点特定说明来配置 GitBook Agent。

每当 GitBook Agent 为该站点创建或编辑内容时,都会使用这些上下文。

要添加风格指南或自定义说明,请打开您站点的 设置,在 常规 在网站侧边栏中,然后点击 代理。在自定义说明字段中添加您的说明。

您也可以从变更请求中打开此界面。打开 GitBook Agent 聊天窗口,然后打开 操作菜单 并点击 配置 GitBook Agent .

自定义说明示例

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

常见问题

GitBook Agent 如何使用我的数据?

我们遵循数据保护实践,以确保您的数据保持私密。

GitBook Agent 不会使用您的数据来训练 AI 模型。我们仅会将您添加到 GitBook Agent 的信息与 OpenAI 共享,以提供 GitBook Agent 服务。更多信息请参阅 OpenAI 的隐私政策。

GitBook Agent 多少钱?

GitBook Agent 在测试阶段对所有套餐均免费。如果您不是 Pro 版用户且不在试用期内,免费使用额度为每周 10 条消息。

翻译 作为按月附加项单独计费。访问 定价部分 了解更多。

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

可以。您可以覆盖 GitBook Agent 的默认个性和语气。

如果您希望输出更详细,或采用特定的风格或语气,请在站点级说明中,或在变更请求中的提示里告诉 GitBook Agent。

最后更新于

这有帮助吗?