> 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/create-content/styleguide.md).

# Style guide

Define your team's writing rules in a dedicated style guide and keep every contributor, human or GitBook Agent, consistent.

A style guide holds your team's writing rules: voice and tone, terminology, formatting, and structure. It serves two audiences:

* **Your team:** writers and reviewers share one reference, so documentation stays consistent no matter who edits it.
* **GitBook Agent:** the Agent follows your style guide whenever it writes, edits, or reviews content. Your rules override its own defaults.

GitBook Agent enforces rules that have a numbered ID or are definite and checkable, and treats the rest as guidance. For details, see [How GitBook Agent enforces your style guide](/docs/create-content/styleguide/how-gitbook-agent-enforces-your-style-guide.md).

## Get started

To set up a style guide, you need admin permissions on the site.

{% stepper %}
{% step %}
**Set up a style guide**

Click **Style guide** in your site's sidebar, then click **Set up**. Start from a template, reuse a style guide your organization already has, or import your own. See [Choose a starting point](/docs/create-content/styleguide/build-your-style-guide.md#choose-a-starting-point).
{% endstep %}

{% step %}
**Fill in the template**

Work through each section marked **Needs your input**, such as your product name, audience, and word list, and give every rule you want enforced an ID. See [Build your style guide](/docs/create-content/styleguide/build-your-style-guide.md).
{% endstep %}

{% step %}
**Run your first check**

Open your style guide, go to the **Checks** tab, and click **Run a check** to review existing content. You can also request a style guide review on your next change request. See [Check content against your style guide](/docs/create-content/styleguide/check-content-against-your-style-guide.md).
{% endstep %}
{% endstepper %}

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Build your style guide</strong></td><td>Choose a starting point, fill in the template, and write rules the Agent can enforce</td><td><a href="/docs/create-content/styleguide/build-your-style-guide.md">Build your style guide</a></td></tr><tr><td><strong>Check content against your style guide</strong></td><td>Review a page, a change request, or whole spaces</td><td><a href="/docs/create-content/styleguide/check-content-against-your-style-guide.md">Check content against your style guide</a></td></tr><tr><td><strong>How GitBook Agent enforces your style guide</strong></td><td>What the Agent reads, flags, and changes</td><td><a href="/docs/create-content/styleguide/how-gitbook-agent-enforces-your-style-guide.md">How GitBook Agent enforces your style guide</a></td></tr></tbody></table>

## Edit your style guide

Click **Style guide** in your site's sidebar to open your style guide. You edit it like the rest of your documentation: make your changes in a change request, then merge them.

## Share a style guide across sites

A style guide belongs to your organization, so several sites can use the same one and follow the same rules.

After you create a style guide, GitBook offers to link it to any other sites in your organization that don't have one yet. You can also choose an existing style guide, shared or forked, when you set one up for a site.

To see every style guide in your organization and the sites that use each one, open **Style guides** in your organization sidebar.

### Detach a style guide

To stop a site from using its style guide, open the actions menu next to **Style guide** in your site's sidebar and click **Detach style guide**. Detaching keeps the style guide, since other sites may still use it. If no other site uses it, GitBook offers to delete it permanently.


---

# 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/create-content/styleguide.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.
