> 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/gitbook-dai-li/overview.md).

# 概览

与 AI 队友协作，让你的文档保持准确、完整并及时更新

GitBook Agent 是一个与你并肩工作的 AI 搭档。它帮助你保持文档准确、完整且最新。GitBook Agent 与 GitBook 深度集成。你无需采用新的工作流程即可使用它。

{% hint style="info" %}
如果你使用 AI 助手在本地编辑文档，请使用 [GitBook 的 skill.md 文件](https://gitbook.com/docs/documentation/zh/docs-as-code/ai-coding-assistants-and-skillmd.md).
{% endhint %}

### GitBook Agent 可以做什么？

GitBook Agent 可以：

* **根据提示词编写文档：** 让 GitBook Agent 更新页面、重命名产品，或进行任何其他所需的更改。
* **将内容导入 GitBook：** 在 GitBook Agent 对话中附加 PDF 和 Microsoft Word 文档等文件。GitBook Agent 会提取内容并将其整理为你所在分区中的页面。
* **规划并实施较大的更改：** 描述你的需求。GitBook Agent 会发起变更请求、说明所做的编辑、回应反馈，并实施你们共同制定的计划。
* **遵循你的风格指南：** 在 [风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md)中定义团队的写作规则，GitBook Agent 在撰写或审核内容时会将其视为权威依据。
* **遵循自定义的网站级指令：** 向 GitBook Agent 提供特定于网站的指令，例如如何添加链接或应避免使用哪些区块类型。
* **翻译文档：** 选择要翻译的内容并指定语言，GitBook Agent 就会将文档本地化。
* **通过评论唤起：** 在页面上的任意区块添加评论，输入 `@gitbook`，然后告诉 GitBook Agent 你的需求。
* **审阅变更请求：** 将 GitBook Agent 添加为变更请求的审阅者。它可以充当文档检查工具，标记风格指南问题，并建议修正或直接修复错误。

#### 自动文档建议

{% hint style="warning" %}
**内容缺口功能处于测试版。**

前往 [内容缺口](https://gitbook.com/docs/documentation/zh/analytics/content-gaps.md) 了解更多。
{% endhint %}

GitBook Agent 还可以连接到你团队用来了解产品和客户需求的信号：来自已连接工具的支持对话、工单和线程。

借助这些上下文，GitBook Agent 可以识别空白、提出更新建议，并自动生成文档更改。

随着你的文档随产品不断演进，客户会在需要时获得正确的信息。

### 探索 GitBook Agent 的功能

<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>使用 GitBook Agent 撰写</strong></td><td>根据提示创建内容，或编辑单个块</td><td><a href="https://gitbook.com/docs/documentation/zh/gitbook-dai-li/write-and-edit-with-ai.md">使用 GitBook Agent 编写</a></td></tr><tr><td><strong>使用 GitBook Agent 审阅</strong></td><td>让 GitBook Agent 检查你的拼写、语法和风格</td><td><a href="https://gitbook.com/docs/documentation/zh/gitbook-dai-li/review-change-requests-with-gitbook-agent.md">使用 GitBook Agent 审查变更请求</a></td></tr><tr><td><strong>翻译你的文档站点</strong></td><td>GitBook Agent 可以创建自动更新的本地化版本</td><td><a href="https://gitbook.com/docs/documentation/zh/gitbook-dai-li/translations.md">翻译</a></td></tr></tbody></table>

### 添加风格指南和自定义说明

您可以使用团队的样式指南和站点特定说明来配置 GitBook Agent。每当 GitBook Agent 为该站点创建或编辑内容时，它都会同时使用这两者。如果它们冲突，则以样式指南为准。

* **风格指南：** 点击 **风格指南** （位于站点侧边栏中），然后点击 **设置**。在此填写你希望 GitBook Agent 遵循的写作规则。详情请参阅 [风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md).
* **自定义指令：** 打开站点的 **设置 → Agents** ，然后在自定义指令字段中添加指令。可用于设置站点专属要求，例如如何添加链接或应避免使用哪些块类型。

你也可以从变更请求中打开 **Agents** 设置。打开 GitBook Agent，然后打开 **对话选项** 并点击 **配置 GitBook Agent** <picture><source srcset="broken://files/CG9bVSmdbJnQxrYiNbRI" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-5b92a51c6dfeecba3e53103f6e8d553bf798e57b%2F25_01_10_settings_icon_light.svg?alt=media" alt=""></picture>.

#### 自定义说明示例

下面是一个你可以在 GitBook Agent 设置中添加的自定义说明示例。

{% code overflow="wrap" %}

```
你是一名 Stripe 的技术写作者。使用清晰、直接的语言，把准确性放在润色之上。对于指南，始终先用一句话总结概念，然后将内容拆分为结构良好的各个部分。对于快速入门，始终使用步骤器，并让每一步都以动作为先且简洁明了。
```

{% endcode %}

### 常见问题

<details>

<summary>GitBook Agent 如何使用我的数据？</summary>

我们遵循数据保护实践，以保护你的数据隐私。

GitBook Agent 不会使用你的数据来训练 AI 模型。我们仅为提供 GitBook Agent 而与 OpenAI 共享你添加到 GitBook Agent 的信息。更多信息请参阅 OpenAI 的隐私政策。

</details>

<details>

<summary>GitBook Agent 的费用是多少？</summary>

GitBook Agent 在测试期间对所有套餐免费。如果你不是 Pro 计划且不在试用期内，免费使用包括每周 10 条消息。

[翻译](https://gitbook.com/docs/documentation/zh/gitbook-dai-li/translations.md) 按月作为附加服务单独计费。访问 [定价部分](https://gitbook.com/docs/documentation/zh/gitbook-dai-li/translations.md#pricing) 了解详情。

</details>

<details>

<summary>我可以覆盖 GitBook Agent 输出的默认语气吗？</summary>

可以。你可以覆盖 GitBook Agent 的默认个性和语气。

如果你希望获得更详细的输出，或特定的风格或语气，请在站点级说明中或变更请求中的提示里告诉 GitBook Agent。

</details>


---

# 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/gitbook-dai-li/overview.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.
