> 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/check-content-against-your-style-guide.md).

# コンテンツをスタイルガイドと照合する

GitBook Agent で、ページ、変更リクエスト、またはスペース全体をスタイルガイドに照らしてレビューします。

GitBook Agent は、コンテンツの作成や編集を行うたびにスタイルガイドに従います。既存のコンテンツや、マージ前の変更を確認するには、3つのチェックのいずれかを使用します:

| チェック                                                              | 対象           | Agent の動作                       | こんなときに使います               |
| ----------------------------------------------------------------- | ------------ | ------------------------------- | ------------------------ |
| [ページチェック](#check-a-page)                                          | 1ページ         | コメントを残し、何も変更しません                | ページを編集中です                |
| [変更リクエストのレビュー](#request-a-style-guide-review-on-a-change-request) | 変更リクエスト内の変更  | 変更を要求し、違反しているルールを引用します          | 変更のレビュー準備ができています         |
| [サイトチェック](#run-a-style-guide-check-across-your-site)              | 一度に最大3つのスペース | 見つけた内容を、スペースごとに1つの変更リクエストで修正します | 既存のコンテンツをスタイルガイドに従わせたいとき |

{% hint style="info" %}
チェックでは GitBook AI を使用するため、組織で有効にする必要があります。
{% endhint %}

## ページをチェックする

ページの作業中は、 **スタイルガイドとの一貫性を確認** の **改善** メニューを使うか、チャットでGitBook Agentに依頼してください。Agentはスタイルガイドに照らしてページをレビューし、確認した内容をまとめたコメントを残します。ページ自体は変更しません。

## 変更リクエストでスタイルガイドのレビューを依頼する

サイトにスタイルガイドがある場合、GitBook Agentは変更リクエストの推奨レビュアーとして表示され、 **スタイルガイドレビュー**.

1. 変更リクエストで、 **レビューを依頼**.
2. 変更内容のタイトルと説明を入力するか、 **生成** をクリックすると、Agentが作成します。
3. 「 **レビュアー**」の下で、 **リクエスト** の横にある **GitBook Agent**をクリックします。ほかのレビュアーを追加することも、リストを空のままにして組織内のすべてのレビュアーに通知することもできます。

エージェントは変更をスタイルガイドに照らしてレビューします。違反が見つかると、変更を要求し、それぞれの違反の根拠となるルールを引用します。

## サイト全体でスタイルガイドチェックを実行する

サイトチェックは、選択したスペースのすべてのページをレビューし、見つけた内容を修正します。サイトと、チェックする各スペースで編集権限が必要です。

1. スタイルガイドを開き、 **チェック** タブに移動して、 **チェックを実行**.
2. チェックするスペースを選択します。一度に最大3つのスペースをチェックできます。
3. 各スペースごとに GitBook Agent が開いた変更リクエストをレビューしてマージします。

チェックで何かが修正されると、その変更リクエストはレビュー準備完了としてマークされます。何も見つからなければ、その変更リクエストはアーカイブされるため、空の下書きが残りません。

「 **チェック** 」タブには、サイト独自の構成に沿ってサイトのスペースが一覧表示され、それぞれのチェック状態も確認できます。

* 変更リクエストのステータス、またはチェック実行中はスピナー
* チェックが最後に実行された日時
* チェック後にスタイルガイドを変更すると表示される「 **スタイルガイドが編集されました** 」バッジ

行をクリックして、その変更リクエストを開きます。

各スペースには、一度に1つのチェック用変更リクエストがあります。スペースの変更リクエストがまだ開いている状態で再度チェックを実行すると、エージェントはその変更リクエストを更新し、現在のページをチェックします。新しい変更リクエストが開くのは、前のものがマージまたはアーカイブされた後のみです。

## トラブルシューティング

### ルールがフラグ付けされない

GitBook Agent は、実行可能なルールのみをフラグ付けします。次の点を確認してください:

* 番号付きIDがある、または明確でチェック可能な指示である
* まだプレースホルダーテキストが残っていない
* そのテキストを対象とする例外がない

ルールが最初のページ以外にある場合、エージェントはそのページのトピックにタスクが関わるときにのみそれを読みます。重要なルールは最初のページに移動してください。

### カスタム指示内のルールはレビューで適用されません

GitBook Agentは、スタイルガイドに照らしてスタイルのみをレビューします。指摘してほしい執筆ルールは、カスタム指示からスタイルガイドに移してください。詳しくは、 [スタイルガイドとカスタム指示](https://gitbook.com/docs/documentation/ja-gitbook-documentation/kontentsuwosuru/styleguide/how-gitbook-agent-enforces-your-style-guide.md#style-guides-and-custom-instructions).

### レビューにはいくつかの問題しか表示されません

エージェントは、重要なものから順に、1回あたり約5件のフラグを目指します。さらに問題がある場合は、その件数を表示します。フラグ付けされた問題を修正して再度レビューを依頼すると、残りが表示されます。


---

# 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/check-content-against-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.
