什么是 GitBook Agent?
与 AI 团队成员协作,以保持您的文档准确、完整且最新
GitBook Agent 是一个与您并肩工作的 AI 团队成员,帮助您保持文档的准确性、完整性和时效性。
Agent 与 GitBook 深度集成,因此您无需学习新的工作流程即可利用它 —— 它会使用您已熟悉的流程与您协同工作。
如果您想在本地环境中使用 AI 助手编辑文档,您可以使用 GitBook 的 skill.md 文件.
GitBook Agent 能做什么?
GitBook Agent 可以:
根据提示撰写文档: 请求 Agent 使用最新信息更新页面,或将所有产品名称替换为新名称,或执行您需要的任何其他操作。
构思并实施更大范围的变更: 描述您的需求,Agent 将开启变更请求、解释其计划中的编辑、回应您的反馈,然后实施您们共同制定的计划。
理解您的风格指南: 将您的风格指南添加到组织设置中,Agent 在撰写或审查内容时将始终应用该指南。
遵循组织级别的自定义指示: 在组织级别向 Agent 提供具体指示,例如以特定方式添加链接,或避免使用特定类型的区块。
翻译您的文档: 选择要翻译的内容,选择一种语言,Agent 将负责本地化您的文档。
从评论中召唤: 向页面上的任意区块添加评论,输入 @gitbook 并告诉 Agent 您的需求。
审查变更请求: 将 Agent 添加为变更请求的审阅者。它可以作为文档的 linter,识别或修复错误、建议改进并标记与风格指南不符的地方。
自动文档建议
Agent 还可以连接到团队用于了解产品和用户需求的相同信号:来自已连接工具的支持对话、工单和线程。
在这些上下文的帮助下,Agent 可以主动识别漏洞、提出更新并自动生成文档更改。这样您的文档可以随着产品演进,用户也能在需要的时间和地点始终获得正确的信息。
自动文档建议处于早期访问阶段
前往 组织设置 → GitBook Agent 以申请访问权限。
探索 GitBook Agent 的功能
添加风格指南和自定义指示
您可以通过添加团队的风格指南或关于希望 Agent 如何与团队协作的具体指示来配置 GitBook Agent。Agent 在为组织创建或编辑内容时会将这些作为上下文使用。
要添加风格指南或自定义指示,请打开您的 组织设置 然后选择 GitBook Agent 部分。点击 设置 选项卡并在文本输入框中添加您的指示。
您也可以通过在变更请求中打开 GitBook Agent 聊天窗口,然后打开 操作 菜单 并选择 配置 GitBook Agent
.
自定义指示示例
以下是您可以在 GitBook Agent 设置中添加的自定义指示示例。
常见问题
最后更新于
这有帮助吗?