自動ドキュメント提案

ドキュメントを最新に保つためにGitBook Agentがバックグラウンドでどのように動作するかを学ぶ

この機能は現在アーリーアクセス中です

へ移動してください 組織設定 → GitBook Agent でアクセスをリクエストしてください。

GitBook Agent は 同じシグナルに接続できます サポートの会話、Slack スレッド、GitHub の issue など、あなたのチームが製品やユーザーのニーズを理解するために使用するシグナルに接続できます。

このコンテキストにより、Agent はギャップを能動的に特定し、更新を提案し、ドキュメントの変更を自動的に生成できます。

GitBook Agent は組織のコンテンツでトレーニングされているため、チームの文体、構成、トーンに関するコンテキストを持っています。そして、あなたは カスタム指示を追加できます Agent が従うための — 詳しくは下記をご覧ください。

1

ソースを接続する

GitBook Agent にドキュメントの自動改善を提案させるには、まず ソースを接続する必要があります.

1つ以上のソースを接続すると、Agent はバックグラウンドでデータの収集と分析を開始します。

2

GitBook Agent がデータをどのように分析するかを確認する

ソースを接続すると、GitBook Agent はその文脈情報を会話、課題、トピックに分類します。

これらを組み合わせてドキュメントの自動改善を提案し、それらは変更リクエストとして開かれます。

GitBook Agent が分析するデータを確認するには、組織の設定に移動し、次を開いてください。 データエクスプローラー タブをクリックします を有効にすると、 GitBook エージェント セクションから選択します。

3

GitBook Agent による変更リクエストを確認する

より多くのデータが流入するにつれて、GitBook Agent は提案を行うのに十分なコンテキストを得られるようになり — 新しい 変更リクエスト を関連するスペースで開きます。

GitBook Agent によって開かれた変更リクエストは、他の変更リクエストと同様に編集でき、チーム内の誰でも適切な 権限.

また、 GitBook Agent にレビューを依頼する を持っていれば、Agent に対して自分が提案した変更を分析させることができます。

4

変更について GitBook Agent と共同作業する

GitBook Agent はライティングパートナーとしても機能し、変更リクエスト内の内容を計画、作成、書き直し、更新することを可能にします。

次のからの変更リクエストを確認する際に 変更リクエスト画面、GitBook Agent を開くと、取り組んでいる変更リクエストのコンテキスト内で直接チャットして変更を行うことができます。

また、特定のブロックに コメント を追加し、@gitbook にタグ付けして GitBook Agent に変更を依頼することもできます。

GitBook Agent が変更できる公開サイトを追加または削除する

デフォルトでは、GitBook Agent は公開中のドキュメントサイトのいずれに対しても変更リクエストを作成できるアクセス権を持ちます。GitBook Agent の設定画面で、Agent に提案を行ってほしいサイトを選択できます。

GitBook Agent のカスタム指示を追加する

フィールドにリンクのメールアドレスを入力してメールを書けるようにしたいときに便利です。 GitBook Agent に従わせるカスタム指示を追加する には、組織の設定を開き、サイドバーで GitBook エージェント ページを選択してください。

ここから、Agent があなたのドキュメントサイトの変更リクエストを準備、分析、生成する際に常に使用するカスタム指示を記述できます。