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