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 は指示に従いながら、自分が何をしているかを説明し、作業が進むにつれて変更内容があなたのスペースに表示されます。
追加の指示を与えたり、手順を明確にしたり、スペースのコンテンツを直接編集したりをいつでも行え、GitBook Agent と並行して作業できます。
GitBook Agent で変更リクエストを実装する
次のボタンをクリックします GitBook エージェント の 編集 ボタンをスペースの右上にあるでモーダルを開きます。
ここでは、変更リクエストに含めたい内容を 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 段落の概要を書いてください。
または、提案されたプロンプトやプロンプトの開始文のいずれかを選ぶこともできます：
続きを書く – GitBook Agent は現在のページのコンテンツを分析し、それに基づいて追加のコンテンツを生成します。
説明する… – これを選び、その後 GitBook Agent に何を説明してほしいかを伝えてください。これはページのコンテンツに限定されないため、何についてでも説明を求めることができます。
要約する – ページ上のすべてのコンテンツを要約します。詳細なドキュメントの末尾に TL;DR を書くときや、チェックするだけの人向けに上部へ簡単な要約を追加するときに最適です。
これを説明する – ページ上の複雑な情報を、略語やその他の専門用語の説明を含め、より簡単な言葉で説明します。読んでいるページに複雑な情報が多い場合や、より技術的でない人向けの解説を追加したい場合に最適です。
翻訳 – 現在のページを、指定された言語のいずれかに翻訳します。リストにない言語へ翻訳したい場合は、プロンプト बॉक्सにその言語を入力するだけです。
GitBook Agent 向けに効果的なプロンプトを書く
GitBook Agent は、指示に従うのが得意なチームメイトのような存在です。最良の結果を得るには、明確な指示と文脈を与える必要があります。
良いプロンプトを書くための簡単なヒントをいくつか紹介します：
分解する – Agent は、焦点を絞ったタスクの完了が最も得意です。複雑なプロジェクトを小さなステップに分け、1 つずつ完了するよう Agent に依頼しましょう。
具体的にする – 次のような一般的なプロンプト
@gitbook このページを改善しては一般的なベストプラクティスを適用しますが、より具体的な指示がなければ、Agent はあなたが意図した目標を達成できない場合があります。成果に焦点を当てる – 顧客が抱えている特定の問題について聞いているなら、その問題、または達成したい成果を Agent に伝えてください。Agent はその成果に基づいて改善案を提案します。
直接的な指示を与える – 手順ガイドにステッパーブロックを使ってほしい場合や、たくさんの展開可能なブロックを含む FAQ セクションを追加したい場合は、最初から正しい結果を得るために、何をすべきかを正確に伝えてください。
広い改善には広めのプロンプトを使う – 誤字修正、ページ全体での機能名の更新、ドキュメントから特定のブロックタイプの削除などの保守作業には、次のようなコマンドを使えます
@gitbook の v2.3.9 のすべてのインスタンスを v2.4.0 に置き換えて.
最終更新
役に立ちましたか？