> 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/zh/chuang-jian-nei-rong/styleguide.md).

# 写作风格指南

在专门的写作风格指南中定义团队的写作规则，并保持每位贡献者（无论是人类还是 GitBook Agent）风格一致。

样式指南包含你团队的写作规范：语气与风格、术语、格式和结构。它面向两个受众：

* **你的团队：** 撰稿人和审阅者共用一份参考资料，因此无论由谁编辑，文档都能保持一致。
* **GitBook Agent：** Agent 在撰写、编辑或审阅内容时，都会遵循你的风格指南。你的规则优先于它自身的默认设置。

GitBook Agent 会强制执行带有编号 ID 或明确且可检查的规则，并将其余内容视为指导建议。详情请参阅 [GitBook Agent 如何执行你的风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/how-gitbook-agent-enforces-your-style-guide.md).

## 开始使用

要设置样式指南，你需要该站点的管理员权限。

{% stepper %}
{% step %}
**设置样式指南**

点击 **风格指南** 在你的网站侧边栏中，然后点击 **开始设置**。你可以从模板开始，复用组织已有的风格指南，或导入自己的风格指南。请参阅 [选择起点](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/build-your-style-guide.md#choose-a-starting-point).
{% endstep %}

{% step %}
**填写模板**

逐一完成标记为 **需要你提供信息**的部分，例如产品名称、受众和词汇表，并为每条需要强制执行的规则分配一个 ID。请参阅 [编写风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/build-your-style-guide.md).
{% endstep %}

{% step %}
**运行你的首次检查**

打开风格指南，前往 **检查** 标签页，然后点击 **运行检查** 以审阅现有内容。你也可以在下次提交变更请求时，请求审阅风格指南。请参阅 [根据风格指南检查内容](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/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>构建你的风格指南</strong></td><td>选择起点，填写模板，并编写 Agent 可强制执行的规则</td><td><a href="https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/build-your-style-guide.md">构建你的风格指南</a></td></tr><tr><td><strong>根据样式指南检查内容</strong></td><td>审阅单个页面、变更请求或整个空间</td><td><a href="https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/check-content-against-your-style-guide.md">根据样式指南检查内容</a></td></tr><tr><td><strong>GitBook Agent 如何强制执行你的样式指南</strong></td><td>Agent 会读取、标记和更改什么</td><td><a href="https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide/how-gitbook-agent-enforces-your-style-guide.md">GitBook Agent 如何强制执行你的样式指南</a></td></tr></tbody></table>

## 编辑你的风格指南

点击 **风格指南** 在你的网站侧边栏中打开风格指南。你可以像编辑其他文档一样编辑它：在变更请求中进行修改，然后将其合并。

## 在站点之间共享风格指南

样式指南属于你的组织，因此多个站点可以使用同一个样式指南并遵循相同的规则。

创建样式指南后，GitBook 会建议将其链接到你组织中尚未拥有样式指南的其他站点。为某个站点设置时，你也可以选择一个现有的样式指南，无论是共享的还是已分叉的。

若要查看组织中的所有风格指南，以及各指南所应用的网站，请打开组织侧边栏中的 **风格指南** 。

### 解除风格指南关联

若要让网站停止使用其风格指南，请打开网站侧边栏中 **风格指南** 旁边的操作菜单，然后点击 **解除关联风格指南**。解除关联不会删除风格指南，因为其他网站可能仍在使用它。如果没有其他网站使用该指南，GitBook 会提示你将其永久删除。


---

# 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/zh/chuang-jian-nei-rong/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.
