渠道
在 Slack、GitHub、Linear 和 Jira 中使用 AI Assistant 和 GitBook Agent
渠道带来 AI 助手 和 GitBook 代理 到你们团队已在使用的工具中。连接后,你的团队可以提及 @GitBook 在 Slack、GitHub 或 Linear 中提问、发起变更请求,并保持文档最新——无需离开现有工作流。
当你添加渠道时,可以选择 GitBook 在该工具中的显示方式。每个配置都以两种模式之一运行:
支持代理: AI 助手会直接在渠道中回答你的团队或访客的问题。提出一个问题,就会得到从文档中提取的答案。在 Slack 中,这些回复里的引用会链接到其所引用文档的已发布站点 URL。例如,被引用的答案会链接到你的文档站点,而不是 app.gitbook.com.
协作者: GitBook Agent 会以团队成员身份加入。提及 @GitBook 以发起变更请求、请求编辑,或让你的文档与该工具中的动态保持同步。在 Slack 中,消息可以链接到 app.gitbook.com 当它们引用内部工作流上下文时,例如变更请求或草稿内容。当 GitBook Agent 从渠道创建变更请求时,会自动将其链接到原始线程、问题或拉取请求。
每个渠道可以运行多个配置——例如,为面向客户的某个 Slack 渠道使用支持代理模式,而在另一个渠道为你的文档团队使用协作者模式。
要添加渠道,请打开你站点的 设置 并点击 渠道.
当支持问题、错误报告或产品反馈起始于 Slack、GitHub、Linear 或 Jira,且你希望 GitBook 直接在原处回复时,请使用渠道。
想要将 AI 助手嵌入你的网站或产品中?
前往 嵌入到你的产品中 了解如何嵌入 AI 助手。

可用渠道
Slack
Linear
GitHub
Jira
即将推出
概览
渠道将 GitBook 连接到外部工作流。
它们可以让你:
无需离开源对话即可回答问题。
将现有文档上下文带入支持和产品工作流。
使用……将重要对话转化为文档更新 GitBook 代理.
当对话始于 GitBook 之外,但答案或后续处理应纳入你的文档流程时,请使用渠道。
支持的平台
渠道支持以下平台:
Slack 用于对话和支持线程。
GitHub 用于问题、拉取请求上下文和讨论工作流。
Linear 用于问题跟踪和产品反馈工作流。
Jira 用于将工单转化为文档更新。
每个平台都使用相同的核心模型。
GitBook 会接收来自已连接平台的受支持事件,从你的知识库中收集上下文,并通过以下任一方式作出回应: AI 助手 或 GitBook 代理.
角色与权限
渠道支持两种角色:
协作者 — 可以进行更改。
支持代理 — 提供只读信息。
根据渠道需要执行的操作选择角色。
协作者
使用 协作者 当渠道需要帮助将对话转化为文档工作时。
协作者渠道可以使用 GitBook Agent 帮助在 GitBook 中创建或更新文档工作,例如发起或推进变更请求。
支持代理
使用 支持代理 当渠道只需要回答问题时。
支持代理渠道会使用现有文档和已连接的知识,以只读上下文进行回复。它不会更改内容。
工作原理
渠道会处理来自你已连接平台的传入事件。
传入事件可以是新消息、提及、问题更新,或来自 Slack、GitHub、Linear 或 Jira 的其他受支持活动。
GitBook 通过四个步骤处理这些事件:
安装与授权
要安装渠道,请打开你的站点仪表板并选择 设置 → 渠道.
然后选择你要连接的平台。
Slack、GitHub 和 Linear 使用 OAuth 或应用安装流程。GitBook 会将你跳转到该平台,你批准访问后,再返回 GitBook 完成设置。
将 Jira 连接到你的 GitBook 站点,然后添加 gitbook 标签到工单中。GitBook Agent 会使用该工单起草变更请求,供你的团队审阅。
开始前
你需要以下内容:
你需要拥有 GitBook 站点的管理员访问权限,且渠道可用、GitBook Agent 已启用且未暂停。
一个 Jira Cloud 站点、一个 Atlassian 账户邮箱,以及该账户的 API 令牌。该账户需要能够访问你要使用的项目,并拥有评论和链接问题的权限。
连接 Jira
连接你的 Jira 账户
输入以下详细信息:
Jira 站点 URL: 你的 Jira Cloud URL,例如
https://your-site.atlassian.net.账户邮箱: 创建该令牌的 Atlassian 账户的电子邮箱地址。
Jira API 令牌: 在 Atlassian 中创建 API 令牌,然后粘贴到这里。
点击 连接 Jira。连接成功后,GitBook 会显示可用项目。
从工单创建变更请求
可选:从 Jira 请求另一次编辑
在变更请求处于打开状态时,添加包含以下内容的评论 @gitbook 以及你想要的更改。例如:
@gitbook 添加一条注释,说明旧 API 密钥何时失效。
GitBook Agent 会更新关联的草稿,并在 Jira 中发布一条更新评论。仅编辑工单标题或描述不会请求另一轮编辑。
反馈与表情回应
表情回应可让你的团队快速对渠道回复进行反馈。
当你想表明某个回复是否有帮助时,请使用表情回应。
这些反馈有助于 GitBook 了解哪些回复在真实工作流中表现良好。
最后更新于
这有帮助吗?