> 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/kontentsuwosuru/styleguide/how-gitbook-agent-enforces-your-style-guide.md).

# GitBook Agent がスタイルガイドを適用する方法

GitBook Agent がスタイルガイドをどのように読み取り、コンテンツをレビュー・編集する際にそのルールを適用するか。

GitBook Agent がスタイルガイドに沿って作業するとき、その役割は文章全般を改善することではなく、コンテンツをあなたのルールに従わせることです。正確かつ保守的に設計されており、同じコンテンツをチェックするたびに同じ問題を見つけることを目指します。

## Agent が読むもの

* **すべてのタスクで、最初のページを読み込みます。** エージェントは、コンテンツの執筆、編集、レビューを行うたびに、スタイルガイドの最初のページを全文読み込みます。
* **関連する場合は、ほかのページも読み込みます。** エージェントは、単語リストやコンテンツタイプなど、別のページで扱われている内容を執筆またはレビューする前に、目次からそのページを読み込みます。
* **それ以外は何も読み込みません。** エージェントがルールの参照元とするのは、あなたのスタイルガイドだけです。上位のガイド、優れたスタイルに関する一般知識、その他のスタイルガイドに基づくルールは適用しません。スタイルガイドでGoogleまたはMicrosoftのガイドをベースとして挙げている場合、エージェントはそれを人向けの参考情報として扱い、ルールとしては適用しません。

あなたの編集が常に優先されます。ルールを変更すれば Agent はあなたの版に従い、ルールを削除すれば Agent はその適用をやめます。

## Agent が適用するルール

ルールの書き方によって、Agent の動作が決まります。

| 書いた内容              | 例                   | Agent の動作                                                                        |
| ------------------ | ------------------- | -------------------------------------------------------------------------------- |
| 番号付き ID のあるルール     | `G-11`：シリアルカンマを使用する | 違反を検出し、ID を引用します。編集時には修正します。                                                     |
| ID のない、明確で検証可能なルール | 「セミコロンは決して使わない。」    | 違反を検出し、短い引用付きでルールを示します。編集時には修正します。                                               |
| 指針                 | あなたの文体とトーンの説明       | 新しいテキストを書くときに適用します。既存のテキストについては提案としてのみ示し、フラグとしては示しません。                           |
| まだプレースホルダーのままのルール  | `[ルールを追加]`          | プレースホルダーを置き換えるまで無視します。スタイルガイドの大半がプレースホルダーの場合、Agent はチェック対象が完成済みのルールだけであることを伝えます。 |

Agent は各ルールの例外も尊重します。「実行主体が不明な場合は受動態でよい」のような、記載された例外に当てはまるテキストは違反ではありません。

エージェントが適用できるルールの書き方については、 [スタイルガイドを作成する](https://gitbook.com/docs/documentation/ja-gitbook-documentation/kontentsuwosuru/styleguide/build-your-style-guide.md#write-rules-the-agent-can-enforce).

## Agent がレビューする際

レビュー中、Agent は問題をフラグ付けするだけで、何も変更しません。各フラグには、ルール、問題の場所、何が問題か、修正方法が示されます。たとえば:

| 項目       | 例                                                        |
| -------- | -------------------------------------------------------- |
| ルール      | `G-10`：能動態を使用する                                          |
| Location | 「Rotate your API key": 「キーは 90 日ごとにシステムによってローテーションされます。」 |
| 問題       | 実行主体がわかっているのに受動態になっている。                                  |
| 修正       | 「システムは 90 日ごとにキーをローテーションします。」                            |

Agent は 1 回のチェックにつきおよそ 5 件のフラグを目指すため、最も重要な問題が最初に来ます。ほかにも問題がある場合は、その旨を伝え、件数を示します。フラグはカテゴリごとに、次の順で並びます。語句と用語、書式と句読点、文法、手順。各カテゴリ内では、ページ順に従います。

指針はフラグとして表示されることはありません。代わりに、Agent は 1 回につき短い「人の目で確認する価値あり」メモを、最大 1 件追加します。

## Agent が編集する際

コンテンツの修正やスタイルガイドへの整合を Agent に依頼すると、修正が明確な箇所にはルールを適用します。ルールが 2 つの妥当な結果を許す場合は、Agent はテキストを変更せず、提案として挙げます。

編集後、Agent は変更内容をルールごとに件数付きで要約します。たとえば、「G-7: 'click on' を 'click' に置き換え、6 か所。」のようになります。指針に基づく提案は、最後に短い一覧で表示されます。

## Agent が決して変更しないもの

レビューでも編集でも、Agent は次のものをフラグ付けしたり変更したりしません:

* コードブロック、インラインコード、コマンド出力、API や製品識別子の中のコンテンツ
* 直接引用と引用された資料
* ルールの例外で除外されたテキスト
* コンテンツの意味や事実

Agent はルールを記載どおりに適用します。コンテンツに合わせてルールを和らげたり、強めたり、解釈し直したりはしません。ルールがあいまいな場合、Agent は字義どおりに適用し、そのあいまいさを「人の目で確認する価値あり」メモに記します。

## スタイルガイドがない場合

サイトにスタイルガイドがない場合、Agent は文体のレビューを行いません。変更依頼では、誤字脱字、矛盾、誤った指示、未完了のセクションなど、明確で客観的な問題についてのみコメントします。

## スタイルガイドとカスタム指示

カスタム指示は、GitBook Agent 向けの短いサイト固有の指示です。スタイルガイドは、文章ルールをまとめた完全な共有セットです。Agent は両方を使用しますが、競合する場合はスタイルガイドが優先されます。

適用したい文章ルールはスタイルガイドに入れてください。リンクの追加方法や避けるべきブロックタイプなど、ほかの指示にはカスタム指示を使ってください。


---

# 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/kontentsuwosuru/styleguide/how-gitbook-agent-enforces-your-style-guide.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.
