什么是 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 设置中添加的自定义指令示例。
常见问题解答
最后更新于
这有帮助吗?