message渠道

在 Slack、GitHub 和 Linear 中使用 GitBook Assistant 和 GitBook Agent

circle-exclamation

频道目前处于抢先体验阶段

频道将 GitBook AssistantGitBook Agent 带入到工作已经发生的工具中。

频道将 GitBook AssistantGitBook Agent 带入你团队已经在使用的工具中。连接后,你的团队可以提及 @GitBook 在 Slack、GitHub 或 Linear 中提问、发起变更请求,并保持文档更新——无需离开现有工作流程。

circle-info

频道将 GitBook AssistantGitBook Agent 带入你团队已经在使用的工具中。连接后,你的团队可以提及 @GitBook 在 Slack、GitHub 或 Linear 中提问、发起变更请求,并保持文档更新——无需离开现有工作流程。

添加频道时,你可以选择 GitBook 在该工具中的呈现方式。每个配置都有两种模式之一:

支持助手: GitBook Assistant 会直接在频道中回答你团队成员或访客的问题。提出问题,即可获得从文档中提取的答案。在 Slack 中,这些回复里的引用会链接到它们所引用文档的已发布网站 URL。例如,带引用的答案会链接到你的文档站点,而不是 app.gitbook.com.

协作者: GitBook Agent 会作为队友加入。提及 @GitBook 即可打开变更请求、请求编辑,或让文档与该工具中的动态保持同步。在 Slack 中,消息可以链接到 app.gitbook.com 当它们引用内部工作流上下文时,例如变更请求或草稿内容。当 Agent 从频道创建变更请求时,它会自动将其链接到原始线程、问题或拉取请求。

你可以为每个频道运行多个配置——例如,在面向客户的 Slack 频道中使用支持助手模式,在另一个频道中为你的文档团队使用协作者模式。

要添加频道,请打开你站点的 设置 并点击 频道.

当支持问题、错误报告或产品反馈始于 Slack、GitHub 或 Linear,并且你希望 GitBook 直接在原地回复时,请使用频道。

circle-info

想将 GitBook Assistant 嵌入到你的网站或产品中吗?

前往 嵌入到你的产品中 了解如何嵌入 GitBook Assistant。

可用频道

Slack

可用

Linear

可用

GitHub

可用

即将推出

Discord

计划中

Intercom

计划中

Microsoft Teams

计划中

Google Chat

计划中

概览

频道将 GitBook 连接到外部工作流。

它们让你可以:

  • 无需离开源对话即可回答问题。

  • 将现有文档上下文带入支持和产品工作流。

当对话开始于 GitBook 之外,但答案或后续处理属于你的文档流程时,请使用频道。

受支持的平台

频道目前支持以下平台:

  • Slack 用于对话和支持线程。

  • GitHub 用于问题、拉取请求上下文和讨论工作流。

  • Linear 用于问题跟踪和产品反馈工作流。

每个平台都使用相同的核心模型。

GitBook 会接收来自已连接平台的受支持事件,汇总你知识库中的上下文,并通过以下任一方式回复 GitBook AssistantGitBook Agent.

角色与权限

频道支持两种角色:

  • 协作者 — 可以进行更改。

  • 支持助手 — 提供只读信息。

根据频道需要执行的操作选择角色。

协作者

在以下情况下使用 协作者 当频道必须帮助将对话转化为文档工作时。

协作者频道可以使用 GitBook Agent 帮助在 GitBook 中创建或更新文档工作,例如发起或推进变更请求。

支持助手

在以下情况下使用 支持助手 当频道只需要回答问题时。

支持助手频道会使用现有文档和已连接的知识,以只读上下文进行回复。它不会修改内容。

工作原理

频道会处理来自你已连接平台的传入事件。

传入事件可以是新消息、提及、问题更新,或来自 Slack、GitHub 或 Linear 的其他受支持活动。

GitBook 按四个步骤处理这些事件:

1

接收事件

已连接的平台会通过你安装的频道向 GitBook 发送受支持的事件。

2

收集上下文

GitBook 会查找相关文档上下文以及站点可用的其他知识。

3

应用频道角色

如果该频道是 支持助手,GitBook 会返回只读信息。

如果该频道是 协作者,GitBook 还可以通过 GitBook Agent 将对话转化为文档工作。

4

在源工具中回复

回复会返回到 Slack、GitHub 或 Linear 中,因此工作流始终保持在同一处。

circle-info

具体支持的事件范围取决于平台和你的抢先体验开放进度。如果某个触发器在你的工作区中尚不可用,则它尚未公开记录。

安装与授权

要安装频道,请打开你的网站仪表板并选择 设置频道.

然后选择你要连接的平台。

每个平台都使用 OAuth 或应用安装流程。GitBook 会将你转到平台,你批准访问,然后返回 GitBook 完成设置。

circle-exclamation
1

开始安装

设置频道中,选择 Slack.

2

授权 Slack

如有需要,请登录 Slack。

然后选择你要安装频道的 Slack 工作区,并批准所请求的访问权限。

3

在 GitBook 中完成设置

在 Slack 将你重定向回来后,在 GitBook 中完成频道设置。

选择频道应使用的角色并保存配置。

反馈与反应

反应可让你的团队对频道回复快速反馈。

当你想表示某个回复是否有帮助时,请使用反应。

这些反馈有助于 GitBook 了解哪些回复在真实工作流中效果良好。

circle-info

具体的反应映射尚未记录,在抢先体验期间可能因平台而异。

最后更新于

这有帮助吗?