GitBook Agent で書く

GitBook Agent を使って、ページ用のコンテンツを生成・構築します

GitBook Agent は、GitBook 内のドキュメント用コンテンツを生成するための強力なツールです。

Agent は、ページ上の短いテキストセクションの作成から、既存ブロックの編集、新しいページやセクションの作成などを変更リクエスト内で行うことまで、あらゆることができます。

GitBook Agent はあなたのスタイルガイドに従います

あなたは 独自のスタイルガイドとカスタム指示を追加できます サイトレベルで設定できるため、Agent に支援を依頼するときは常に、あなたのトーンやスタイルに合わせてくれます。

GitBook Agent で何ができますか？

GitBook Agent は GitBook アプリに深く統合されているため、エディタで作成できるブロックや、スペース内のより広いコンテンツを理解しています。

つまり、Agent を使って次のことができます：

• プロンプトに基づいて新しいコンテンツを書く

• 既存のページを検索して特定のコンテンツを更新する

• GitBook のさまざまなブロックを最大限活用できるようにコンテンツを再フォーマットする

• コードサンプルを更新する

• ページ間でコンテンツを移動する

• 特定の場所に新しいページを追加する

GitBook Agent とやり取りする方法

GitBook Agent を使う方法はいくつかあります：

• 既存の変更リクエスト内で Agent を開き、必要なことを伝える

• GitBook Agent で新しい変更リクエストを計画して実装する

• ブロックへのコメントで Agent をタグ付けする

• ページの空行に新しいコンテンツを作成する

これらを順に見て、どのように機能するかを確認しましょう。

任意の変更リクエストで GitBook Agent のチャットウィンドウを開く

変更リクエストでは、いつでも GitBook Agent ボタンをスペースのヘッダーバーで押すことで Agent のチャットウィンドウを開けます。これにより、アプリの右側に Agent のチャットウィンドウが表示されます。

変更リクエストで GitBook Agent を開く

ここでは Agent に従わせるためのプロンプトを書くことができます。Agent は指示に従いながら何をしているかを説明し、作業中の変更はスペース内に表示されます。

追加の指示を出したり手順を明確にしたり、任意の時点でスペースのコンテンツを直接編集したりできるため、GitBook Agent と並行して作業できます。

GitBook Agent で変更リクエストを実装する

クリックします GitBook Agent のセクション 編集 スペース右上のボタンを押してモーダルを開きます。

ここでは、変更リクエストに含めたい内容を Agent に伝えるためのプロンプトを書き、その後、変更の文脈として役立つ可能性のある参考ページを追加できます。

をクリックすると 変更リクエストを開始 Agent はあなたのために変更リクエストを開き、指示の実行を開始します。各段階で、Agent はアプリ右側のチャットウィンドウで何をしているかを伝えます。

完了したら、ページ上で自分で直接コンテンツを編集することも、変更をさらに洗練させるために Agent に追加の指示を出すこともできます。

コメントで GitBook Agent をタグ付けする

ページ上の特定のブロックを Agent に確認してほしい場合は、コメントでタグ付けして必要なことを伝えることができます。 ブロックにコメント をクリックし、@gitbook を付けて Agent をタグ付けしてから、実行してほしいことを伝えてください。

GitBook Agent はプロンプトに基づいてコンテンツを更新し、その後、何を行ったかをあなたのコメントに返信して伝えます。

GitBook Agent でページコンテンツを改善する

この 改善 メニューでは、ページコンテンツを改善するための一般的な操作を GitBook Agent に実行させるプリセットを選択できます。

この 改善 メニューには、ページタイトルにカーソルを合わせるか、ページの アクションメニュー .

を開くことでエディタからアクセスできます。Improve メニューから、Agent に次のことを指示できます：

• ページにアイコンを追加する

• コンテンツに基づいてページ説明を生成する

• スペルと文法を修正する

• 他のページとの一貫性が出るように書き直す

• SEO 向けに最適化する

• 要約と次のステップのセクションを追加する

• 関連するトピックやページへのリンクを追加する

• 1 つのページを複数のページに分割する

最初の 2 つのオプションは条件付きです。ページ内容に応じて変化します。つまり、ページにすでにアイコンと説明がある場合、それらの選択肢はメニューに表示されません。

いずれかのオプションを選択すると、Agent はすぐにそのタスクに取りかかります。

空のブロックに新しいコンテンツを作成する

GitBook Agent を使って、ページ上の任意の空行にコンテンツを作成できます。コードサンプル、テンプレート、ページ要約など、あらゆる種類のコンテンツを Markdown 形式で作成できます。

押します スペース 任意の空行で、または / と入力して AI で作成 を選ぶと GitBook Agent を起動できます。

すぐに任意のプロンプトを入力し始められます。GitBook Agent はプロンプトを分析し、それに基づいてコンテンツを生成します。たとえば：

プロダクトチームにとってドキュメントが重要な理由を説明する 2 段落の概要を書いてください。

または、提案されたプロンプトやプロンプトの書き出しの中から 1 つを選ぶこともできます：

• 書き続ける – GitBook Agent は現在のページのコンテンツを分析し、それに基づいてさらにコンテンツを生成します。

• 説明する… – これを選んでから、説明してほしい内容を GitBook Agent に伝えます。これはページ上のコンテンツに制限されないため、何でも説明してもらえます。

• 要約する – ページ上のすべてのコンテンツを要約します。詳細なドキュメントの下部に TL;DR を書いたり、ざっと確認する人のために上部に簡単な要約を追加したりするのに最適です。

• これを説明 – これにより、ページ上の複雑な情報がより簡単な言葉で説明されます。頭字語やその他の専門用語の説明も含まれます。読んでいるページに複雑な情報が多い場合や、技術に詳しくない人向けの解説を追加したい場合に最適です。

• 翻訳する – 現在のページを、用意された言語のいずれかに翻訳します。リストにない言語へ翻訳したい場合は、プロンプトボックスにその言語を入力するだけです。

GitBook Agent 向けに効果的なプロンプトを書く

GitBook Agent は、指示を受けるのが得意なチームメイトのようなものです。最良の結果を得るには、明確な指示と文脈を与える必要があります。

良いプロンプトを書くための簡単なヒントをいくつか紹介します：

• 細かく分ける – Agent は、焦点の絞られたタスクを完了するのが最も得意です。複雑なプロジェクトは小さなステップに分解し、1 回に 1 つずつ完了するよう Agent に依頼しましょう。

• 具体的にする – 次のような一般的なプロンプト @gitbook このページを改善して では一般的なベストプラクティスが適用されますが、より具体的な指示がなければ、Agent はあなたが意図した目標を達成できない可能性があります。

• 結果に焦点を当てる – 顧客が抱えている特定の問題について聞いている場合は、その問題、または達成したい結果を Agent に伝えましょう。Agent はそれらの結果に基づいて改善案を提案します。

• 直接的に指示する – ステップごとのガイドに stepper ブロックを使ってほしい場合や、展開可能なブロックを多数含む FAQ セクションを追加してほしい場合は、最初から適切な結果を得るために、何をしてほしいのかを正確に伝えましょう。

• より広範な改善には広いプロンプトを使う – タイポの修正、ページ全体での機能名の更新、ドキュメントから特定のブロックタイプを削除するようなメンテナンスタスクには、次のようなコマンドを使えます @gitbook v2.3.9 のすべての出現箇所を v2.4.0 に置き換えて.