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

# 风格指南

样式指南是一个专门的空间，用于存放你团队的写作规则和约定。它是你网站内容应如何撰写的唯一事实来源——包括语气、术语、格式和结构。

样式指南面向两个对象：

* **你的团队** ——撰写者和审阅者可以共用一份关于如何写作的参考，因此无论谁编辑，文档都能保持一致。
* **GitBook Agent** ——Agent 会读取你的样式指南，并将其视为它在生成或编辑内容时必须遵循的事实来源。它会覆盖 Agent 自身的默认设置和通用写作约定。

{% hint style="info" %}
**样式指南目前处于早期访问阶段**

样式指南功能正在逐步推出。如果你在站点设置中还看不到它，这说明你的组织尚未启用该功能。
{% endhint %}

### 创建样式指南

打开你站点的 **设置** 并选择 **样式指南** 部分。如果你的站点还没有样式指南，你可以通过以下几种方式创建：

{% tabs %}
{% tab title="空白" %}
从一个空白空间开始，重新编写你的规则。
{% endtab %}

{% tab title="入门模板" %}
从一个内置模板开始，该模板已涵盖语气和风格、写作原则、格式和术语。根据你的团队调整每个部分——把它当作起点，而不是一成不变的规则手册。
{% endtab %}

{% tab title="导入" %}
将现有内容——例如你已经在其他工具中维护的样式指南——导入到新的样式指南空间中。
{% endtab %}
{% endtabs %}

第一次打开样式指南时，GitBook 会显示一段简短介绍，说明你可以像编辑其他空间一样编辑它。

### 样式指南中应包含什么

当样式指南记录的是那些容易出错或在团队中容易不一致的决定时，它最有用。常见部分包括：

* **语气和风格** ——你如何称呼读者，以及你的表达有多正式或多友好。
* **写作原则** ——时态、主动语态与被动语态、句子和段落长度。
* **格式** ——标题大小写、何时使用列表、步骤条、提示以及其他内容块。
* **术语** ——产品和功能名称、首选术语、如何处理缩写词。

{% hint style="warning" %}
**将主要规则放在第一页**

GitBook Agent 会将你的样式指南的 **第一页完整加载** 到每个任务的上下文中，因此该页面始终主导其工作。它只会根据需要，借助目录读取其他页面。把最重要的规则放在第一页，并使用其他页面补充细节，供 Agent 在相关时调取。
{% endhint %}

### 编辑样式指南

样式指南本质上是一个空间，因此你编辑它的方式与编辑其余文档的方式相同：

* **在 GitBook 中** ——在 [变更请求](/docs/documentation/zh/collaboration/change-requests.md)中进行修改，然后在准备好后合并。
* **使用 Git Sync** ——如果样式指南空间 [已同步到 GitHub 或 GitLab](/docs/documentation/zh/getting-started/git-sync.md)，就像在仓库中以 markdown 形式编辑它。

要打开你的样式指南，请使用 **样式指南** 站点侧边栏中的条目，或者 **编辑** 操作，位于 **站点设置 → 样式指南**.

### 在多个站点之间共享样式指南

样式指南属于你的组织，因此多个站点都可以依赖同一份样式指南。当你为尚未有样式指南的站点设置样式指南，并且你的组织已经有样式指南时，你可以：

* **使用现有样式指南** ——按原样附加，它会与其他使用它的站点共享。修改会应用于所有使用它的地方。
* **分叉它** ——为此站点创建一个专用副本（命名为 `样式指南 - {site name}`），你可以独立演进它。

要查看你组织中的每一份样式指南以及各自被哪些站点使用，请打开 **样式指南** 条目，位于你组织的侧边栏中。

### 解除样式指南关联

要停止某个站点使用它的样式指南，请打开 **站点设置 → 样式指南** 并选择 **解除关联**。解除关联会保留样式指南空间——它仍可能被其他站点使用。如果没有其他站点引用它，GitBook 会提供永久删除它的选项。

### GitBook Agent 如何使用你的样式指南

每当 GitBook Agent 在某个站点上撰写或编辑内容时，它都会读取该站点的样式指南，并将其作为事实来源来遵循。实际上：

* 在每个变更请求任务中，Agent 会预先加载样式指南的 **第一页** 及其目录，然后根据需要再调取其他部分。
* 你可以直接要求 Agent 按你的样式指南检查某个页面，使用 **根据样式指南检查一致性** 在 [优化菜单](/docs/documentation/zh/gitbook-agent/write-and-edit-with-ai.md#improve-page-content-with-gitbook-agent).

{% hint style="info" %}
样式指南是对站点级别 [自定义指令](/docs/documentation/zh/gitbook-agent/what-is-gitbook-agent.md#add-a-style-guide-and-custom-instructions) 的补充，你可以把它们提供给 GitBook Agent。自定义指令是简短、站点特定的指引；样式指南则是完整的、共享的写作规则文档。
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/documentation/zh/creating-content/styleguide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.