> 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-jento/write-and-edit-with-ai.md).

# GitBook Agent で執筆する

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

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

エージェントは、ページ上に短い文章を書くことから、既存ブロックの編集、新しいページの作成まで、変更リクエスト内でさまざまなことができます。

{% hint style="info" %}

#### GitBook Agent はスタイルガイドに従います

チームの執筆ルールを [スタイルガイド](https://gitbook.com/docs/documentation/ja-gitbook-documentation/kontentsuwosuru/styleguide.md)に定めておくと、Agent は支援を依頼されたときに常にそれを正として扱います。Agent はタスクのたびにスタイルガイドの **最初のページ** をコンテキストに読み込むため、重要なルールはそこに記載してください。

サイト単位で [短いカスタム指示を追加](https://gitbook.com/docs/documentation/ja-gitbook-documentation/gitbook-jento/overview.md#add-a-style-guide-and-custom-instructions) することもできます。
{% endhint %}

### GitBook Agent は何ができますか？

GitBook Agent は GitBook アプリに深く統合されているため、エディタで作成できるブロックや、セクション全体のコンテンツを理解できます。

つまり、エージェントを使って次のことができます:

* プロンプトに基づいて新しいコンテンツを書く
* 既存のページを検索して特定のコンテンツを更新する
* GitBook のさまざまなブロックを最大限に活かすようにコンテンツを再フォーマットする
* コードサンプルを更新する
* ページ間でコンテンツを移動する
* 特定の場所に新しいページを追加する

### GitBook Agent の使い方

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

* GitBookのどこからでもAgentを開いて、必要なことを伝えましょう
* GitBook Agent で新しい変更リクエストを計画して実装する
* ブロックへのコメントでエージェントをタグ付けする
* ページの空行に新しいコンテンツを作成する

それぞれがどのように機能するか見ていきましょう。

#### GitBook Agentを開く

GitBook Agent は変更リクエスト内だけでなく、組織内のどこからでも利用できます。アプリ右下の **Agent** をクリックすると、新しい会話が開きます。ページを移動しても会話は続きます。

新しい会話では、たとえば次のような開始用プロンプトがいくつか提示されます。 **このスペースでは何を扱っていますか？** または **古くなったコンテンツを探す**。GitBook Agent は現在開いているスペースを読み取り、編集を依頼すると変更リクエストを開きます。

会話はそれぞれ、 **Agent** ボタンの横にタブとして開きます。会話ヘッダーのボタンを使って、次の操作ができます。

* **サイドパネルに固定：** 作業中も Agent を表示しておく
* **最小化：** 会話を非表示にし、後で再開する
* **閉じる：** 会話を閉じる

過去の会話を探すには、 **Agent** ボタンの横にあるチャット履歴アイコンをクリックします。会話は日付ごとにまとめられており、名前で絞り込むこともできます。

GitBook Agentが各会話に名前を付けます。名前を変更するには、会話上部の名前をクリックして新しい名前を入力してください。

エディターから Agent を開くこともできます。テキストを選択する、空のブロックを作成する、ページヘッダーの **改善** を使う、またはコメントのアクションを使います。会話は、ページと選択範囲が添付された状態で開きます。

Agentはあなたの権限に基づいて動作します。読める内容のみを読み取り、編集やコメントもできる場所でのみ行います。

Agentに従わせるプロンプトを書いてください。指示に従いながら何をしているかを説明し、作業中の変更はあなたのセクションに表示されます。

追加の指示を出したり、手順を明確にしたり、いつでもセクションのコンテンツを直接編集したりできるため、GitBook Agent と並行して作業できます。

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

クリック **編集** をセクションヘッダーでクリックすると、変更リクエストのダイアログが開きます。

変更リクエストの **タイトル** を入力し、変更したい内容を **説明**に記述します。GitBook Agent はどちらの内容も参照します。

クリックして **GitBook Agent で実装**します。GitBook が変更リクエストを作成すると、Agent が指示に従って作業を開始します。各段階で、Agent は会話の中で何をしているかを伝えます。

完了したら、ページ上で自分でコンテンツを直接編集するか、エージェントにさらに指示して変更を引き続き調整できます。

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

ページ上の特定のブロックを Agent にレビューしてもらいたい場合は、コメントでそのブロックにタグを付け、必要な内容を伝えてください。「 **ブロックにコメント** 」をクリックして @gitbook をタグ付けすると Agent にメンションできます。その後、実行してほしい内容を伝えてください。

GitBook Agent はプロンプトに基づいてコンテンツを更新し、その後、行った内容をコメントで返信します。

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

<figure><img src="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-9e09b8690b432a41c9d3afcef8cdfdef1fd07eac%2F26_01_14_improve_page_actions.png?alt=media" alt=""><figcaption></figcaption></figure>

「 **改善** 」メニューには、ページの内容を改善するための一般的な操作をGitBook Agentに指示するプリセットが用意されています。

エディターでページタイトルにカーソルを合わせるか、ページの **改善** メニューを、 **アクションメニューから開くことで利用できます。** <picture><source srcset="broken://files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-aabbca522107ef561981bdfe5af94605b31e0920%2F25_01_10_actions_icon_light.svg?alt=media" alt=""></picture>.

Improve メニューから、エージェントに次のことを指示できます:

* ページにアイコンを追加する
* 内容に基づいてページ説明を生成する
* スペルと文法を修正する
* 他のページと一貫性があるように書き直す
* SEO 向けに最適化する
* 要約と次のステップのセクションを追加する
* 関連トピックやページへのリンクを追加する
* 1つのページを複数のページに分割する

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

どのオプションをクリックしても、エージェントがすぐに作業を開始します。

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

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

空行で `Space` を押すか、 `/` と入力して「 **AIで執筆** 」を選択すると、GitBook Agentが起動します。

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

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

あるいは、提案されたプロンプトやプロンプトスターターのいずれかを選べます:

* **続きを書く** – GitBook Agentが現在のページの内容を分析し、それに基づいて続きを生成します。
* **説明する…** – これを選択し、GitBook Agentに説明してほしいことを伝えます。ページの内容に限定されないため、どのようなことでも説明を求めることができます。
* **要約する** – ページの内容をすべて要約します。詳細なドキュメントの末尾に概要を書く場合や、内容をざっと確認したい人のために冒頭に簡単な要約を追加する場合に便利です。
* **これを説明する** – ページの複雑な情報を、頭字語やその他の専門用語の説明も含め、よりわかりやすい言葉で説明します。読んでいるページに複雑な情報が多い場合や、技術に詳しくない人向けの説明を追加したい場合に最適です。
* **翻訳する** – 現在のページを、用意されているいずれかの言語に翻訳します。リストにない言語に翻訳したい場合は、プロンプトボックスにその言語を入力してください。

### GitBook Agent に効果的なプロンプトを書く <a href="#write-effective-prompts" id="write-effective-prompts"></a>

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

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

* **作業を分割する** – エージェントは、範囲を絞ったタスクの実行を得意とします。複雑なプロジェクトは小さなステップに分割し、エージェントに一度に1つずつ依頼してください。
* **具体的に指示する** – 次のような一般的なプロンプトは、 `@gitbook improve this page` 一般的なベストプラクティスを適用しますが、より具体的な指示がないと、Agentは意図した目標を達成できない場合があります。
* **成果に焦点を当てる** – 顧客が抱えている具体的な問題について聞いた場合は、その問題や達成したい成果をAgentに伝えましょう。Agentは、それらの成果に基づいて改善案を提案します。
* **具体的に指示する** – 手順ガイドにステッパーブロックを使ってほしい場合や、展開可能なブロックを複数使った FAQ セクションを追加してほしい場合は、最初から意図した結果が得られるよう、具体的に指示してください。
* **広範な改善には大まかなプロンプトを使う** – 誤字の修正、ページ全体での機能名の更新、ドキュメントから特定のブロックタイプを削除するといったメンテナンス作業には、次のようなコマンドを使えます。 `@gitbook replace all instances of v2.3.9 with 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/ja-gitbook-documentation/gitbook-jento/write-and-edit-with-ai.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
