> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/ja-gitbook-documentation/gitbook-agent/write-and-edit-with-ai.md).
# GitBook Agent で執筆
GitBook Agent は、GitBook のドキュメント用コンテンツを生成する強力なツールです。
Agent は、ページ上の短い文章を書くことから、既存のブロックを編集したり、新しいページを作成したりすることまで、変更リクエスト内であらゆることができます。
{% hint style="info" %}
#### GitBook Agent はスタイルガイドに従います
チームのライティングルールを [スタイルガイド](/docs/documentation/ja-gitbook-documentation/kontentsuwo/styleguide.md)に定義すると、Agent はあなたが助けを求めるたびにそれを信頼できる情報源として扱います。スタイルガイドの **最初のページ** を、あらゆるタスクでコンテキストに読み込むので、主なルールはそこにまとめておきましょう。
また、 [短いカスタム指示を追加する](/docs/documentation/ja-gitbook-documentation/gitbook-agent/overview.md#add-a-style-guide-and-custom-instructions) をサイトレベルで。
{% endhint %}
### GitBook Agent で何ができますか？
GitBook Agent は GitBook アプリに深く統合されているため、エディターで作成できるブロックや、セクション全体のより広いコンテンツを理解しています。
つまり、Agent は次の用途に使えます：
* プロンプトに基づいて新しいコンテンツを書く
* 既存のページを検索して特定のコンテンツを更新する
* GitBook のさまざまなブロックを最大限に活用できるようコンテンツを書式設定する
* コードサンプルを更新する
* ページ間でコンテンツを移動する
* 特定の場所に新しいページを追加する
### GitBook Agent の使い方
GitBook Agent にはいくつかの使い方があります：
* 既存の変更リクエスト内で Agent を開き、必要なことを伝える
* GitBook Agent で新しい変更リクエストを計画し、実装する
* ブロックへのコメントで Agent をタグ付けする
* ページの空行に新しいコンテンツを作成する
それぞれの仕組みを見ていきましょう。
#### 任意の変更リクエストで GitBook Agent のチャットウィンドウを開く
変更リクエスト内の Agent のチャットウィンドウは、いつでも **GitBook Agent** ボタンをセクションのヘッダーバーでクリックすると開けます。これで、アプリ右側に Agent のチャットウィンドウが開きます。
変更リクエストで GitBook 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段落の概要を書いてください。
または、提案されたプロンプトやプロンプトの始め方から1つ選べます：
* **書き続ける** – GitBook Agent は現在のページの内容を分析し、それに基づいてさらにコンテンツを生成します。
* **説明する…** – これを選び、Agent に何を説明してほしいかを伝えてください。これはページの内容に制限されないため、何でも説明してもらえます。
* **要約する** – ページ上のすべてのコンテンツを要約します。これは、詳細なドキュメントの下部に TL;DR を書いたり、さっと確認する人向けに上部に簡単な要約を追加したりするのに最適です。
* **これを説明する** – 略語やその他の専門用語の説明を含め、ページ上の複雑な情報をより簡単な言葉で説明します。読んでいるページに複雑な情報が多く含まれている場合や、技術に詳しくない人向けの説明を追加したい場合に最適です。
* **翻訳する** – 現在のページを、あらかじめ用意された複数の言語のいずれかに翻訳します。リストにない言語に翻訳したい場合は、プロンプトボックスに直接入力してください。
### GitBook Agent 向けの効果的なプロンプトの書き方
GitBook Agent は、指示に従うのが得意なチームメイトのような存在です。最良の結果を得るには、明確な指示とコンテキストを与える必要があります。
良いプロンプトを書くための簡単なヒントをご紹介します：
* **分解する** – Agent は、焦点の絞られたタスクを完了するのが最も得意です。複雑なプロジェクトを小さなステップに分け、1つずつ完了するように Agent に依頼しましょう。
* **具体的にする** – 次のような一般的なプロンプト `@gitbook このページを改善して` は一般的なベストプラクティスを適用しますが、より具体的な指示がないと Agent は意図した目標を達成できないかもしれません。
* **成果に焦点を当てる** – 顧客が抱えている特定の問題を聞いているなら、その問題や達成したい成果について Agent に伝えてください。Agent はそれらの成果に基づいて改善案を提案します。
* **直接的な指示を与える** – Agent に手順を追って説明するガイドのためにステッパーブロックを使ってほしい場合や、展開可能なブロックをたくさん含む FAQ セクションを追加したい場合は、最初から正しい結果が得られるよう、何をすべきかを正確に伝えてください。
* **幅広い改善には広めのプロンプトを使う** – タイポの修正、ページ全体での機能名の更新、ドキュメントから特定のブロックタイプの削除といった保守作業には、次のようなコマンドを使えます `@gitbook v2.3.9 のすべてのインスタンスを v2.4.0 に置き換えて`.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://gitbook.com/docs/documentation/ja-gitbook-documentation/gitbook-agent/write-and-edit-with-ai.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.