チャネル

Slack、GitHub、LinearでGitBook AssistantとGitBook Agentを使用します

チャンネルは現在早期アクセス中です

チャンネルへのアクセスは少しずつ提供されています。以下の機能の進捗については、続報をお待ちください。

チャンネルがもたらす GitBookアシスタント と GitBookエージェント を、すでに作業が行われているツールに持ち込みます。

チャンネルがもたらす GitBookアシスタント と GitBookエージェント を、チームがすでに使っているツールに持ち込みます。接続すると、チームは @GitBook をSlack、GitHub、またはLinearでメンションして、質問をしたり、変更リクエストを開いたり、既存のワークフローを離れずにドキュメントを最新に保ったりできます。

この機能は〜で利用できます アルティメットサイトプラン.

チャンネルがもたらす GitBookアシスタント と GitBookエージェント を、チームがすでに使っているツールに持ち込みます。接続すると、チームは @GitBook をSlack、GitHub、またはLinearでメンションして、質問をしたり、変更リクエストを開いたり、既存のワークフローを離れずにドキュメントを最新に保ったりできます。

チャンネルを追加すると、GitBookをそのツールにどのように表示するかを選べます。各構成は、次の2つのモードのいずれかで動作します。

サポートエージェント: GitBookアシスタントが、チームや訪問者からの質問にチャンネル内で直接答えます。質問をすると、ドキュメントから引き出された回答が返ってきます。Slackでは、これらの返信内の引用は、参照しているドキュメントの公開サイトURLにリンクします。たとえば、引用された回答は、 app.gitbook.com.

コラボレーター: GitBookエージェントがチームメイトとして参加します。 @GitBook メンションして app.gitbook.com 、変更リクエストを開いたり、編集を依頼したり、そのツールで起きていることに合わせてドキュメントを同期したりできます。Slackでは、メッセージは

1つのチャンネルごとに複数の構成を実行できます。たとえば、顧客向けのSlackチャンネルではサポートエージェントモードを使い、ドキュメントチーム向けの別のチャンネルではコラボレーターモードを使う、といった具合です。

チャンネルを追加するには、サイトの 設定 を開いて チャンネル.

サポートの質問、バグ報告、または製品フィードバックがSlack、GitHub、Linearで始まり、GitBookにその場で応答してほしい場合は、Channelsを使います。

GitBookアシスタントをウェブサイトや製品に埋め込みたいですか？

こちらへ 製品に埋め込む GitBookアシスタントの埋め込み方法を確認してください。

利用可能なチャンネル

Slack

利用可能

Linear

利用可能

GitHub

利用可能

近日公開

Discord

予定

Intercom

予定

Microsoft Teams

予定

Google Chat

予定

チャンネルをリクエスト

概要

チャンネルはGitBookを外部ワークフローに接続します。

できること:

• 元の会話から離れずに質問に答えられます。

• 既存のドキュメントの文脈を、サポートや製品のワークフローに持ち込めます。

• 重要な会話をドキュメント更新に変えるには GitBookエージェント.

会話がGitBookの外で始まっていても、答えやフォローアップがドキュメントのプロセスに属する場合にChannelsを使います。

対応プラットフォーム

チャンネルは現在、次のプラットフォームをサポートしています:

• Slack 会話やサポートスレッド向けです。

• GitHub Issue、プルリクエストの文脈、ディスカッションのワークフロー向けです。

• Linear Issue追跡と製品フィードバックのワークフロー向けです。

各プラットフォームは同じコアモデルを使用します。

GitBookは接続されたプラットフォームからサポート対象のイベントを受け取り、ナレッジからコンテキストを収集し、次のいずれかで応答します GitBookアシスタント または GitBookエージェント.

ロールと権限

チャンネルは次の2つのロールをサポートします:

• コラボレーター — 変更を加えられます。

• サポートエージェント — 読み取り専用の情報を提供します。

チャンネルに必要な役割に応じてロールを選択してください。

コラボレーター

使用してください コラボレーター チャンネルが会話をドキュメント作業に変えるのを手伝う必要があるときに。

コラボレーターチャンネルは、GitBook Agentを使って、変更リクエストの作成や進行など、GitBook内のドキュメント作業の作成や更新を支援できます。

サポートエージェント

使用してください サポートエージェント チャンネルが質問に答えるだけでよいときに。

サポートエージェントチャンネルは、既存のドキュメントと接続されたナレッジを使って、読み取り専用の文脈で返信します。内容の変更は行いません。

仕組み

チャンネルは、接続されたプラットフォームから届くイベントを処理します。

受信イベントには、新しいメッセージ、メンション、Issueの更新、またはSlack、GitHub、Linearからのその他のサポート対象アクティビティが含まれます。

GitBookはこれらのイベントを4つのステップで処理します:

1

イベントを受信する

接続されたプラットフォームは、インストールしたチャンネルを通じて、サポート対象のイベントをGitBookに送信します。

2

コンテキストを収集する

GitBookは、関連するドキュメントの文脈や、サイトで利用可能なその他のナレッジを探します。

3

チャンネルのロールを適用する

チャンネルが サポートエージェントサポートエージェントの場合

チャンネルが コラボレーターコラボレーターの場合は、GitBook Agentを通じて会話をドキュメント作業に変えることもできます。

4

元のツールで返信する

応答はSlack、GitHub、またはLinearに戻って表示されるため、ワークフローを1か所に保てます。

正確なイベント範囲は、プラットフォームと早期アクセスの展開状況によって異なります。ワークスペースでまだトリガーが利用できない場合は、公開ドキュメントには記載されていません。

インストールと認可

チャンネルをインストールするには、サイトのダッシュボードを開いて 設定 → チャンネル.

次に、接続したいプラットフォームを選択します。

各プラットフォームはOAuthまたはアプリのインストールフローを使用します。GitBookがプラットフォームに案内し、アクセスを承認してから、GitBookに戻って設定を完了します。

プラットフォーム固有の権限スコープや管理者要件は、まだ完全には文書化されていません。

アクセスを承認する前に、認可画面を注意深く確認してください。

Slack

1

インストールを開始

で 設定 → チャンネル、選択し Slack.

2

Slackを認可

必要に応じてSlackにサインインしてください。

次に、チャンネルをインストールしたいSlackワークスペースを選び、求められたアクセスを承認します。

3

GitBookでセットアップを完了

Slackが戻るようにリダイレクトしたら、GitBookでチャンネルのセットアップを完了します。

チャンネルに使わせるロールを選び、設定を保存します。

GitHub

Linear

フィードバックとリアクション

リアクションを使うと、チームはチャンネルの返信にすばやくフィードバックできます。

応答が役に立ったかどうかを示したいときにリアクションを使います。

そのフィードバックは、GitBookが実際のワークフローでどの応答がうまく機能しているかを理解するのに役立ちます。

正確なリアクションの対応付けはまだ文書化されておらず、早期アクセス期間中はプラットフォームによって異なる場合があります。