> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/gitbook-dai-li/channels.md).

# 渠道

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

{% hint style="warning" %}

#### 渠道处于早期访问阶段

我们正在逐步开放渠道访问权限。请继续关注下方功能的更多进展。
{% endhint %}

渠道带来 [AI 助手](/docs/documentation/zh/ai-for-your-readers/gitbook-ai-assistant.md) 和 [GitBook 代理](/docs/documentation/zh/gitbook-dai-li/overview.md) 到你们团队已在使用的工具中。连接后，你的团队可以提及 `@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 直接在原处回复时，请使用渠道。

{% hint style="info" %}

#### 想要将 AI 助手嵌入你的网站或产品中？

前往 [嵌入到你的产品中](/docs/documentation/zh/publish/embedding.md) 了解如何嵌入 AI 助手。
{% endhint %}

<figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FvdGn4ibGuysRhvoOiAkI%2F26_05_01_channels%402x.png?alt=media&amp;token=e6cececa-7769-4e66-8f27-2995a822c946" alt=""><figcaption></figcaption></figure>

### 可用渠道

<table data-view="cards"><thead><tr><th></th><th><select><option value="mjZVekTsgGQo" label="进行中" color="blue"></option><option value="exlMMXLVjkth" label="已计划" color="blue"></option><option value="WK4vEyJjJM8h" label="可用" color="blue"></option></select></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Slack</strong></td><td><span data-option="WK4vEyJjJM8h">可用</span></td><td></td><td></td></tr><tr><td><strong>Linear</strong></td><td><span data-option="WK4vEyJjJM8h">可用</span></td><td></td><td></td></tr><tr><td><strong>GitHub</strong></td><td><span data-option="WK4vEyJjJM8h">可用</span></td><td></td><td></td></tr><tr><td><strong>Jira</strong></td><td><span data-option="WK4vEyJjJM8h">可用</span></td><td></td><td></td></tr></tbody></table>

### 即将推出

<table data-view="cards"><thead><tr><th></th><th><select><option value="mjZVekTsgGQo" label="进行中" color="blue"></option><option value="exlMMXLVjkth" label="已计划" color="blue"></option><option value="WK4vEyJjJM8h" label="可用" color="blue"></option></select></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Discord</strong></td><td><span data-option="exlMMXLVjkth">已计划</span></td><td></td><td></td></tr><tr><td><strong>Intercom</strong></td><td><span data-option="exlMMXLVjkth">已计划</span></td><td></td><td></td></tr><tr><td><strong>Microsoft Teams</strong></td><td><span data-option="exlMMXLVjkth">已计划</span></td><td></td><td></td></tr><tr><td><strong>Google Chat</strong></td><td><span data-option="exlMMXLVjkth">已计划</span></td><td></td><td></td></tr><tr><td><strong>请求新增渠道</strong></td><td></td><td><i class="fa-arrow-up-right-from-square">:arrow-up-right-from-square:</i></td><td><a href="https://github.com/orgs/GitbookIO/discussions/new?category=feature-requests">https://github.com/orgs/GitbookIO/discussions/new?category=feature-requests</a></td></tr></tbody></table>

### 概览

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

它们可以让你：

* 无需离开源对话即可回答问题。
* 将现有文档上下文带入支持和产品工作流。
* 使用……将重要对话转化为文档更新 [GitBook 代理](/docs/documentation/zh/gitbook-dai-li/overview.md).

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

### 支持的平台

渠道支持以下平台：

* **Slack** 用于对话和支持线程。
* **GitHub** 用于问题、拉取请求上下文和讨论工作流。
* **Linear** 用于问题跟踪和产品反馈工作流。
* **Jira** 用于将工单转化为文档更新。

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

GitBook 会接收来自已连接平台的受支持事件，从你的知识库中收集上下文，并通过以下任一方式作出回应： [AI 助手](/docs/documentation/zh/ai-for-your-readers/gitbook-ai-assistant.md) 或 [GitBook 代理](/docs/documentation/zh/gitbook-dai-li/overview.md).

### 角色与权限

渠道支持两种角色：

* **协作者** — 可以进行更改。
* **支持代理** — 提供只读信息。

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

#### 协作者

使用 **协作者** 当渠道需要帮助将对话转化为文档工作时。

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

#### 支持代理

使用 **支持代理** 当渠道只需要回答问题时。

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

### 工作原理

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

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

GitBook 通过四个步骤处理这些事件：

{% stepper %}
{% step %}

### 接收事件

已连接的平台会通过你安装的渠道向 GitBook 发送受支持事件。
{% endstep %}

{% step %}

### 收集上下文

GitBook 会查找相关的文档上下文以及站点可用的任何其他知识。
{% endstep %}

{% step %}

### 应用渠道角色

如果该渠道是 **支持代理**，GitBook 会返回只读信息。

如果该渠道是 **协作者**，GitBook 还可以通过 GitBook Agent 将对话转化为文档工作。
{% endstep %}

{% step %}

### 在源工具中回复

回复会显示回 Slack、GitHub、Linear 或 Jira 中，因此工作流始终保留在一个地方。
{% endstep %}
{% endstepper %}

{% hint style="info" %}
具体事件覆盖范围取决于平台以及你的早期访问开放进度。如果某个触发器在你的工作区中尚不可用，说明它尚未公开文档化。
{% endhint %}

### 安装与授权

要安装渠道，请打开你的站点仪表板并选择 **设置 → 渠道**.

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

Slack、GitHub 和 Linear 使用 OAuth 或应用安装流程。GitBook 会将你跳转到该平台，你批准访问后，再返回 GitBook 完成设置。

{% hint style="warning" %}
各平台特定的权限范围和管理员要求尚未完整记录。

在批准访问之前，请仔细查看授权界面。
{% endhint %}

{% tabs %}
{% tab title="Slack" %}
{% stepper %}
{% step %}

### 开始安装

在 **设置 → 渠道**，选择 **Slack**.
{% endstep %}

{% step %}

### 授权 Slack

如有需要，请登录 Slack。

然后选择你要安装该渠道的 Slack 工作区，并批准所请求的访问权限。
{% endstep %}

{% step %}

### 在 GitBook 中完成设置

Slack 重定向你返回后，在 GitBook 中完成渠道设置。

选择该渠道应使用的角色并保存配置。
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="GitHub" %}
{% stepper %}
{% step %}

### 开始安装

在 **设置 → 渠道**，选择 **GitHub**.
{% endstep %}

{% step %}

### 授权 GitHub

如有需要，请登录 GitHub。

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

{% step %}

### 在 GitBook 中完成设置

GitHub 重定向你返回后，在 GitBook 中完成渠道设置。

选择该渠道应使用的角色并保存配置。
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Linear" %}
{% stepper %}
{% step %}

### 开始安装

在 **设置 → 渠道**，选择 **Linear**.
{% endstep %}

{% step %}

### 授权 Linear

如有需要，请登录 Linear。

然后选择你要连接的 Linear 工作区，并批准所请求的访问权限。
{% endstep %}

{% step %}

### 在 GitBook 中完成设置

Linear 重定向你返回后，在 GitBook 中完成渠道设置。

选择该渠道应使用的角色并保存配置。
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Jira" %}
将 Jira 连接到你的 GitBook 站点，然后添加 `gitbook` 标签到工单中。GitBook Agent 会使用该工单起草变更请求，供你的团队审阅。

#### 开始前

你需要以下内容：

* 你需要拥有 GitBook 站点的管理员访问权限，且渠道可用、GitBook Agent 已启用且未暂停。
* 一个 Jira Cloud 站点、一个 Atlassian 账户邮箱，以及该账户的 API 令牌。该账户需要能够访问你要使用的项目，并拥有评论和链接问题的权限。

#### 连接 Jira

{% stepper %}
{% step %}

### 开始设置

打开你站点的 **设置 → 渠道**。在 **Jira**下，点击 **添加配置**.

Jira 使用 **协作者** 角色来帮助你的团队维护文档。
{% endstep %}

{% step %}

### 连接你的 Jira 账户

输入以下详细信息：

* **Jira 站点 URL：** 你的 Jira Cloud URL，例如 `https://your-site.atlassian.net`.
* **账户邮箱：** 创建该令牌的 Atlassian 账户的电子邮箱地址。
* **Jira API 令牌：** [在 Atlassian 中创建 API 令牌](https://id.atlassian.com/manage-profile/security/api-tokens)，然后粘贴到这里。

点击 **连接 Jira**。连接成功后，GitBook 会显示可用项目。
{% endstep %}

{% step %}

### 在 GitBook 中完成设置

选择你希望 GitBook 处理的项目。若保持选择为空，则包含连接账户可访问的所有项目。只有带有标签的 issue `gitbook` 才会启动文档工作。

设置 **合并时的 Jira 状态** ，对应 **完成**，或你项目工作流中的等效状态，这样合并变更请求时也会完成该工单。点击 **保存**。GitBook 会显示“Jira 配置已保存”消息进行确认。
{% endstep %}
{% endstepper %}

#### 从工单创建变更请求

{% stepper %}
{% step %}

### 描述文档变更

在你的配置所覆盖的项目中打开或创建一个 Jira 工单。给它一个清晰的标题，并描述文档应写什么。

例如，使用标题“记录 API 密钥轮换”，并包含轮换步骤、可执行人员以及旧密钥会发生什么。
{% endstep %}

{% step %}

### 将 `gitbook` label

添加 `gitbook` 添加到工单标签中并保存。

GitBook Agent 会根据工单标题和描述起草变更请求，然后在 Jira 中添加评论和指向该变更请求的链接。
{% endstep %}

{% step %}

### 审阅草稿

通过 Jira 中的链接在 GitBook 中打开该变更请求。审阅建议的更改，进行任何编辑，并在文档准备就绪时合并。
{% endstep %}
{% endstepper %}

#### 可选：从 Jira 请求另一次编辑

在变更请求处于打开状态时，添加包含以下内容的评论 `@gitbook` 以及你想要的更改。例如：

> @gitbook 添加一条注释，说明旧 API 密钥何时失效。

GitBook Agent 会更新关联的草稿，并在 Jira 中发布一条更新评论。仅编辑工单标题或描述不会请求另一轮编辑。
{% endtab %}
{% endtabs %}

### 反馈与表情回应

表情回应可让你的团队快速对渠道回复进行反馈。

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

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

{% hint style="info" %}
具体的表情映射尚未记录，并且在早期访问阶段可能因平台而异。
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/zh/gitbook-dai-li/channels.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.