チャネル
Slack、GitHub、LinearでGitBook AssistantとGitBook Agentを使います
この機能は〜で利用できます アルティメットサイトプラン.
Channelsがもたらすのは GitBook Assistant および GitBook Agent チームがすでに使っているツール内で利用できます。接続すると、チームは次のようにメンションできます @GitBook Slack、GitHub、またはLinearで、質問したり、変更リクエストを開いたり、ドキュメントを最新に保ったりできます — 既存のワークフローを離れることなく。
チャネルを追加すると、そのツール内でGitBookをどのように表示するかを選べます。各設定は次の2つのモードのいずれかで動作します：
サポートエージェント： GitBook Assistantは、チームメンバーや訪問者からの質問にチャネル内で直接答えます。質問すると、ドキュメントから取得した回答が返ってきます。Slackでは、これらの返信内の引用は、参照するドキュメントの公開サイトURLにリンクします。たとえば、引用された回答は、あなたのドキュメントサイトではなく app.gitbook.com.
コラボレーター： GitBook Agentがチームメイトとして参加します。次のようにメンションしてください @GitBook 変更リクエストを開いたり、編集を依頼したり、そのツールで起きていることに合わせてドキュメントを同期させたりできます。Slackでは、メッセージは次の内容にリンクできます app.gitbook.com 変更リクエストや下書きコンテンツなど、内部ワークフローの文脈を参照する場合です。Agentがチャネルから変更リクエストを作成すると、元のスレッド、issue、またはプルリクエストに自動的にリンクされます。
チャネルごとに複数の設定を実行できます。たとえば、顧客向けのSlackチャネルではSupport Agentモード、ドキュメントチーム向けの別のチャネルではCollaboratorモードを使えます。
チャネルを追加するには、サイトの 設定 を開き、次をクリックします Channels.
サポートの質問、バグ報告、製品フィードバックがSlack、GitHub、またはLinearで始まり、その場でGitBookに応答してほしいときにChannelsを使います。
GitBook AssistantをWebサイトや製品に埋め込みたいですか？
次へ進んで 製品に埋め込む GitBook Assistantの埋め込み方法をご確認ください。
利用可能なチャネル
Slack
Linear
GitHub
近日公開
概要
ChannelsはGitBookを外部ワークフローに接続します。
次のことができます：
元の会話を離れずに質問に答える。
既存のドキュメントの文脈をサポートや製品のワークフローに取り込む。
重要な会話を次の方法でドキュメント更新に変える： GitBook Agent.
会話がGitBookの外で始まり、回答やフォローアップをドキュメントのプロセスに組み込みたいときにChannelsを使います。
対応プラットフォーム
Channelsは現在、次のプラットフォームをサポートしています：
Slack 会話やサポートスレッド向け。
GitHub issue、プルリクエストの文脈、ディスカッションのワークフロー向け。
Linear issue追跡や製品フィードバックのワークフロー向け。
各プラットフォームは同じコアモデルを使用します。
GitBookは接続したプラットフォームから対応イベントを受け取り、ナレッジから文脈を収集し、次のいずれかを通じて応答します GitBook Assistant または GitBook Agent.
役割と権限
Channelsは2つの役割をサポートしています：
コラボレーター — 変更を加えられます。
サポートエージェント — 読み取り専用の情報を提供します。
チャネルが何をする必要があるかに応じて役割を選んでください。
コラボレーター
を使用して コラボレーター チャネルが会話をドキュメント作業に変えるのを手伝う必要があるとき。
コラボレーターのチャネルは、GitBook Agentを使って、変更リクエストの作成や進行など、GitBook内でのドキュメント作業の作成・更新を支援できます。
サポートエージェント
を使用して サポートエージェント チャネルが質問に答えるだけでよいとき。
サポートエージェントのチャネルは、既存のドキュメントと接続されたナレッジを使って、読み取り専用の文脈で返信します。コンテンツの変更は行いません。
仕組み
Channelsは接続されたプラットフォームからの受信イベントを処理します。
受信イベントには、新しいメッセージ、メンション、issue更新、またはSlack、GitHub、Linearからのその他の対応アクティビティが含まれます。
GitBookはそれらのイベントを4つのステップで処理します：
正確なイベントの対応範囲は、プラットフォームと早期アクセスの展開状況によって異なります。トリガーがまだワークスペースで利用できない場合、公開ドキュメントにはまだ記載されていません。
インストールと認証
チャネルをインストールするには、サイトのダッシュボードを開き、次を選択します 設定 → Channels.
次に、接続したいプラットフォームを選びます。
各プラットフォームはOAuthまたはアプリのインストールフローを使用します。GitBookからプラットフォームへ移動し、アクセスを承認すると、GitBookに戻ってセットアップを完了します。
プラットフォーム固有の権限スコープや管理者要件は、まだ完全には文書化されていません。
アクセスを承認する前に、認証画面をよく確認してください。
フィードバックとリアクション
リアクションを使うと、チームはチャネルの返信に素早くフィードバックできます。
返信が役立ったかどうかを示したいときにリアクションを使います。
そのフィードバックにより、GitBookは実際のワークフローでどの返信がうまく機能しているかを把握できます。
正確なリアクションの対応はまだ文書化されておらず、早期アクセス期間中はプラットフォームによって異なる場合があります。
最終更新
役に立ちましたか？