For the complete documentation index, see llms.txt. This page is also available as Markdown.

渠道

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

Channels 目前处于抢先体验阶段

此功能可在 终极站点方案.

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

当你添加一个 Channel 时,你可以选择 GitBook 在该工具中的呈现方式。每个配置运行于以下两种模式之一:

支持代理: GitBook Assistant 直接在该 Channel 中回答你的团队或访客的问题。提出一个问题,就能得到从文档中提取的答案。在 Slack 中,这些回复里的引用会链接到其所引用文档的已发布站点 URL。例如,被引用的答案会链接到你的文档站点,而不是 app.gitbook.com.

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

你可以为每个 Channel 运行多个配置——例如,面向客户的某个 Slack Channel 使用支持代理模式,而为你的文档团队的另一个 Channel 使用协作者模式。

要添加一个 Channel,请打开你站点的 设置 并点击 Channels.

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

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

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

可用的 Channels

Slack

可用

Linear

可用

GitHub

可用

即将推出

Discord

计划中

Intercom

计划中

Microsoft Teams

计划中

Google Chat

计划中

概览

Channels 将 GitBook 连接到外部工作流。

它们可以让你:

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

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

  • 将重要对话转化为文档更新,使用 GitBook Agent.

当对话始于 GitBook 之外,但答案或后续处理应纳入你的文档流程时,请使用 Channels。

支持的平台

Channels 目前支持以下平台:

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

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

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

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

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

角色与权限

Channels 支持两种角色:

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

  • 支持代理 ——提供只读信息。

根据该 Channel 需要执行的操作选择角色。

协作者

使用 协作者 当该 Channel 必须帮助把对话转化为文档工作时。

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

支持代理

使用 支持代理 当该 Channel 只需要回答问题时。

支持代理 Channel 会使用现有文档和已连接的知识,以只读上下文进行回复。它不会更改内容。

工作原理

Channels 处理来自已连接平台的传入事件。

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

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

1

接收事件

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

2

收集上下文

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

3

应用 Channel 角色

如果该 Channel 是一个 支持代理,GitBook 会返回只读信息。

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

4

在源工具中回复

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

精确的事件覆盖范围取决于平台以及你的抢先体验开放进度。如果某个触发器在你的工作区中尚不可用,则它尚未公开文档化。

安装与授权

要安装一个 Channel,请打开你的站点仪表板并选择 设置Channels.

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

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

1

开始安装

设置Channels,选择 Slack.

2

授权 Slack

如有需要,请登录 Slack。

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

3

在 GitBook 中完成设置

Slack 重定向回你之后,请在 GitBook 中完成 Channel 设置。

选择该 Channel 应使用的角色并保存配置。

1

开始安装

设置Channels,选择 GitHub.

2

授权 GitHub

如有需要,请登录 GitHub。

然后选择你要安装 GitBook 应用的个人账户或组织,并批准请求的访问权限。

3

在 GitBook 中完成设置

GitHub 重定向回你之后,请在 GitBook 中完成 Channel 设置。

选择该 Channel 应使用的角色并保存配置。

1

开始安装

设置Channels,选择 Linear.

2

授权 Linear

如有需要,请登录 Linear。

然后选择你要连接的 Linear 工作区,并批准请求的访问权限。

3

在 GitBook 中完成设置

Linear 重定向回你之后,请在 GitBook 中完成 Channel 设置。

选择该 Channel 应使用的角色并保存配置。

反馈与表情回应

表情回应可让你的团队对 Channel 回复快速反馈。

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

这些反馈有助于 GitBook 理解哪些回复在真实工作流中表现良好。

具体的表情映射尚未文档化,并且在抢先体验期间可能因平台而异。

最后更新于

这有帮助吗?