> 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-agent/overview.md).

# 概览

GitBook Agent 是一位与您并肩工作的 AI 队友。它帮助您保持文档准确、完整且最新。GitBook Agent 深度集成于 GitBook 中。您无需新的工作流程即可使用它。

{% hint style="info" %}
如果您使用 AI 助手在本地编辑文档，请使用 [GitBook 的 skill.md 文件](/docs/documentation/zh/wen-dang-ji-dai-ma/ai-coding-assistants-and-skillmd.md).
{% endhint %}

### GitBook Agent 能做什么？

GitBook Agent 可以：

* **根据提示编写文档：** 让 GitBook Agent 更新某个页面、重命名某个产品，或执行您需要的任何其他更改。
* **将内容导入 GitBook：** 在 GitBook Agent 聊天侧边栏中附加 PDF 和 Microsoft Word 文档等文件。GitBook Agent 会提取内容并将其格式化为您分区中的页面。
* **规划并实施更大的更改：** 描述您需要什么。GitBook Agent 会打开一个变更请求，解释它所做的编辑，响应反馈，并实施您共同创建的计划。
* **遵循您的样式指南：** 在一个中定义你团队的写作规则 [风格指南](/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md)，并且 GitBook Agent 在编写或审阅内容时会将其视为唯一可信来源。
* **遵循自定义的站点级说明：** 向 GitBook Agent 提供站点专属说明，例如如何添加链接或应避免哪些区块类型。
* **翻译您的文档：** 选择要翻译的内容，选择一种语言，GitBook Agent 就会本地化您的文档。
* **通过评论召唤：** 在页面上的任意区块添加评论，输入 `@gitbook`，并告诉 GitBook Agent 您需要什么。
* **审阅变更请求：** 在您的变更请求中将 GitBook Agent 添加为审阅者。它可以充当文档检查器，标记样式指南问题，并建议或修复错误。

#### 自动文档建议

{% hint style="warning" %}
**自动文档建议目前处于早期访问阶段**

前往 [自动文档改进](/docs/documentation/zh/gitbook-agent/automatic-docs-improvements.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="/pages/a47919b6edcf8b0f45ffa22377d52becea6544de">/pages/a47919b6edcf8b0f45ffa22377d52becea6544de</a></td></tr><tr><td><strong>使用 GitBook Agent 审阅</strong></td><td>让 GitBook Agent 检查您的作品中的拼写、语法和风格</td><td><a href="/pages/7e087e2d7715580040d4eabdc7a47d4f423fc7bf">/pages/7e087e2d7715580040d4eabdc7a47d4f423fc7bf</a></td></tr><tr><td><strong>翻译您的文档站点</strong></td><td>GitBook Agent 可以创建自动更新的本地化版本</td><td><a href="/pages/dd016bc5bf4a2bc46275e16bf58ac27690862969">/pages/dd016bc5bf4a2bc46275e16bf58ac27690862969</a></td></tr></tbody></table>

### 添加样式指南和自定义说明

您可以使用团队的样式指南或站点专属说明来配置 GitBook Agent。

每当 GitBook Agent 为该站点创建或编辑内容时，都会使用这些上下文。

要添加样式指南或自定义说明，请打开您站点的 **设置**，在 **常规** 站点侧边栏中的 **智能体**。在自定义说明字段中添加您的说明。

您也可以从变更请求中打开此界面。打开 GitBook Agent 聊天窗口，然后打开 **操作菜单** <picture><source srcset="/files/YjlF3Z9KMYv9aQiFzZKD" media="(prefers-color-scheme: dark)"><img src="/files/d05670ba93b683794fb3fe95a9fc7ab5c7fceafd" alt=""></picture> 并点击 **配置 GitBook Agent** <picture><source srcset="/files/CG9bVSmdbJnQxrYiNbRI" media="(prefers-color-scheme: dark)"><img src="/files/9bcd313f64920f73d3606c61b9fbde5ddf8e3f6b" alt=""></picture>.

#### 自定义说明示例

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

{% code overflow="wrap" %}

```
你是 Stripe 的技术写作者。使用清晰、直接的语言，并优先保证准确性，而非文采。对于指南，请始终用一句话概述介绍概念，并将内容拆分为结构良好的章节。对于快速入门，请始终使用步骤引导器，并保持每一步都以动作开头且简洁。
```

{% endcode %}

### FAQ

<details>

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

我们遵循数据保护实践来保护您的数据隐私。

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

</details>

<details>

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

GitBook Agent 在 beta 阶段对所有方案免费。如果您不在 Pro 方案且未处于试用期，免费使用包含每周 10 条消息。

[翻译](/docs/documentation/zh/gitbook-agent/translations.md) 按月附加功能单独计费。请访问 [定价部分](/docs/documentation/zh/gitbook-agent/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 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/gitbook-agent/overview.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.