自動ドキュメント提案

GitBook Agent がバックグラウンドでどのように動作し、ドキュメントを最新に保つのかを学びます

この機能は現在早期アクセス中です

この機能は現在、さらなる開発のために少数のチームでテスト中です。移動先： 組織設定 → GitBook Agent でアクセスをリクエストしてください。

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

この文脈があれば、Agentはギャップを能動的に特定し、更新を提案し、ドキュメントの変更を自動で生成できます。

GitBook Agentは組織のコンテンツでトレーニングされているため、チームの執筆スタイル、構造、トーンを理解しています。また、あなたは カスタム指示を追加できます Agentに従わせるための指示を — その詳細は下記で説明します。

1

ソースを接続する

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

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

2

GitBook Agentがあなたのデータを解析する方法を確認する

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

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

GitBook Agentが解析するデータを確認するには、組織の設定に移動し、次を開いてください： データエクスプローラー タブ の GitBook Agent セクション。

3

GitBook Agentによって作成された変更リクエストを確認する

より多くのデータが流入すると、GitBook Agentは提案を行うのに十分な文脈を持つようになり、 変更リクエスト を関連するスペースで開くことで提案を行います。

GitBook Agentが開いた変更リクエストは他の変更リクエストと同様に編集できます — そしてチームの誰でも適切な 権限.

があればレビューできます。 また、 GitBook Agentにレビューを依頼することもできます

4

提案した変更をAgentに解析させるために。

GitBook Agentと共同で変更作業を行う

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

から開いているとき、GitBook Agentを開くと、その変更リクエストの文脈内で直接チャットして変更を行うことができます。 また、特定のブロックに コメント

を追加し、@gitbookをタグ付けしてGitBook Agentに変更を依頼することもできます。

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

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

GitBook Agentのためのカスタム指示を追加する に 従わせるカスタム指示を追加するには、組織の設定を開き、サイドバーで GitBook Agent ページを選択してください。

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