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 のチャットウィンドウを開く
いつでも変更リクエスト内で Agent のチャットウィンドウを開くには、スペースヘッダーバーの GitBook Agent ボタンを押します。これでアプリの右側に Agent のチャットウィンドウが開きます。
ここで Agent に従わせるプロンプトを書けます — 指示に従いながら、Agent は何をしているかを説明し、作業が進むにつれて変更があなたのスペースに表示されます。
途中で追加の指示を出したり、手順を明確にしたり、スペースの内容を直接編集したりできるため、GitBook Agent と並行して作業できます。
GitBook Agent で変更リクエストを実装する
クリックして GitBook Agent の 編集 ボタンをスペースの右上でクリックすると、モーダルを開けます。
ここで、変更リクエストに含めたい内容を Agent に伝えるプロンプトを書き、変更の文脈として役立つ参照ページを追加できます。
クリックすると 変更リクエストを開始 すると、Agent があなたのために変更リクエストを開き、指示の実行を開始します。各段階で、Agent はアプリ右側のチャットウィンドウで何をしているかを伝えます。
完了したら、ページ上で直接自分で内容を編集することも、Agent にさらに指示して変更をさらに洗練させることもできます。
コメントで GitBook Agent にタグを付ける
Agent にページ上の特定のブロックを確認してほしい場合は、そのブロックにコメントでタグを付けて必要なことを伝えられます。単純に ブロックにコメント をクリックし、@gitbook をタグ付けして Agent にタグを付けたら、やってほしいことを伝えてください。
GitBook Agent はプロンプトに基づいてコンテンツを更新し、その後、何をしたかをコメントに返信します。
GitBook Agent でページコンテンツを改善する
この 改善 メニューでは、GitBook Agent にページコンテンツを改善するための一般的なアクションを実行させるプリセットを選べます。
アクセスできます 改善 メニューは、ページタイトルにカーソルを合わせるか、ページの アクションメニュー 
.
改善メニューから、Agent に次のことを指示できます：
ページにアイコンを追加する
その内容に基づいてページ説明を生成する
スペルと文法を修正する
他のページとの一貫性のために書き換える
SEO 向けに最適化する
要約と次のステップのセクションを追加する
関連トピックやページへのリンクを追加する
1つのページを複数のページに分割する
最初の2つのオプションは条件付きです — ページ内容に応じて変わります。そのため、ページにすでにアイコンと説明がある場合は、メニューにそれらの選択肢は表示されません。
任意のオプションを選ぶと、Agent はすぐに作業を開始します。
空のブロックに新しいコンテンツを作成する
GitBook Agent を使って、ページ上の任意の空行にコンテンツを作成できます。コードサンプル、テンプレート、ページ要約など、Markdown で整形されたあらゆる種類のコンテンツを作成できます。
押して スペース 任意の空行に、または / を選択し、 AI で書く と入力して GitBook Agent を起動します。
好きなプロンプトをすぐに入力し始められます。GitBook Agent はプロンプトを分析し、それに基づいてコンテンツを生成します。たとえば：
ドキュメントがプロダクトチームにとってなぜ重要なのかを説明する2段落の概要を書いてください。
または、提案されたプロンプトやプロンプトのスターターから1つ選ぶこともできます：
続きを書く – GitBook Agent は現在のページの内容を分析し、それに基づいてさらにコンテンツを生成します。
説明… – これを選んで、Agent に何を説明してほしいか伝えてください。これはページ内容に限定されないため、何でも説明させることができます。
要約 – ページ上のすべての内容を要約します。詳細な文書の末尾に TL;DR を書くときや、確認だけする人向けに冒頭に簡単な要約を追加するときに最適です。
これを説明する – 略語やその他の専門用語を含め、ページ上の複雑な情報をより簡単な言葉で説明します。読んでいるページに複雑な情報が多く含まれている場合や、技術に詳しくない人向けの説明を追加したい場合に最適です。
翻訳 – 現在のページを、あらかじめ定められた数の言語のいずれかに翻訳します。リストにない言語に翻訳したい場合は、プロンプトボックスにその言語を入力してください。
GitBook Agent 向けに効果的なプロンプトを書く
GitBook Agent は、指示を受けるのが得意なチームメイトのようなものです。最良の結果を得るには、明確な指示と文脈を与える必要があります。
良いプロンプトを書くための簡単なヒントをいくつか紹介します：
細かく分ける – Agent は、集中したタスクを完了するのが最も得意です。複雑なプロジェクトは小さな手順に分解し、1つずつ完了するよう Agent に依頼しましょう。
具体的にする – 次のような一般的なプロンプト：
@gitbook このページを改善しては一般的なベストプラクティスを適用しますが、より具体的な指示がないと、Agent は意図した目標を達成できない場合があります。成果に焦点を当てる – 顧客が抱えている特定の問題を聞いているなら、その問題、あるいは達成したい成果を Agent に伝えてください。Agent はそれらの成果に基づいて改善案を提案します。
直接指示する – 手順ガイドにステッパーブロックを使ってほしい場合や、展開可能なブロックをたくさん含む FAQ セクションを追加してほしい場合は、最初から正しい結果を得るために何をすべきかを正確に伝えてください。
より広い改善には幅広いプロンプトを使う – 誤字の修正、ページ全体での機能名の更新、ドキュメントから特定のブロックタイプの削除などの保守作業には、次のようなコマンドを使えます：
@gitbook v2.3.9 のすべての箇所を v2.4.0 に置き換えて.
最終更新
役に立ちましたか？