> 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/write-and-edit-with-ai.md).

# 使用 GitBook Agent 编写

使用 GitBook Agent 为你的页面生成并构建内容

GitBook Agent 是一个功能强大的工具，可用于为你在 GitBook 中的文档生成内容。

Agent 可以在变更请求中完成从在页面上撰写短段文本，到编辑现有区块、创建新页面等各种工作。

{% hint style="info" %}

#### GitBook Agent 会遵循你的风格指南

在 [风格指南](https://gitbook.com/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md)中定义团队的写作规则。每当你请求 Agent 协助时，它都会将该指南视为权威依据。它会在每项任务中将风格指南的 **第一页** 载入上下文，因此请将主要规则放在这一页。

你还可以 [添加简短的自定义指令](https://gitbook.com/docs/documentation/zh/gitbook-dai-li/overview.md#add-a-style-guide-and-custom-instructions) ，使其在整个站点生效。
{% endhint %}

### GitBook Agent 可以做什么？

GitBook Agent 与 GitBook 应用深度集成，因此它能理解你在编辑器中可以创建的区块，以及你章节中的更广泛内容。

这意味着你可以使用 Agent 来：

* 根据你的提示撰写新内容
* 搜索现有页面并更新特定内容
* 重新格式化内容，以充分利用 GitBook 的不同区块
* 更新代码示例
* 在页面之间移动内容
* 在特定位置添加新页面

### 如何与 GitBook Agent 交互

与 GitBook Agent 协作有几种方式：

* 你可以在 GitBook 的任何位置打开 Agent，并告诉它你的需求
* 使用 GitBook Agent 规划并实施一个新的变更请求
* 在区块的评论中标记 Agent
* 在页面上的空白行创建新内容

让我们逐一了解这些方式，看看它们如何工作。

#### 打开 GitBook Agent

GitBook Agent 在组织中的任何位置都可使用，不仅限于变更请求。点击应用右下角的 **Agent** 即可开启新对话。切换页面时，对话会继续运行。

新对话会提供一些入门提示，例如 **这个空间涵盖哪些内容？** 或 **查找过时内容**。GitBook Agent 会读取你所在的空间，并在你要求修改时创建变更请求。

每个对话都会作为标签页打开，位于 **Agent** 按钮旁边。使用对话标题栏中的按钮可以：

* **固定为侧边栏：** 工作时让 Agent 保持在视野中
* **最小化：** 隐藏对话，稍后再回来查看
* **关闭：** 关闭对话

要查找之前的对话，请点击 **Agent** 按钮旁边的聊天记录图标。对话按日期分组，你也可以按名称筛选。

GitBook Agent 会为你给每个对话命名。要重命名，请点击对话顶部的名称并输入新名称。

你也可以从编辑器中打开 Agent。选中文本、开始一个空白区块、使用页面标题栏中的 **改进** ，或使用评论中的操作。打开的对话会自动附上当前页面和你选中的内容。

Agent 会根据你的权限工作。它只读取你有权限读取的内容，并且只在你有权限的位置进行编辑和评论。

编写一条让 Agent 遵循的提示——它会在执行你的指示时解释自己正在做什么，修改会在它工作时显示在你的部分中。

你可以随时给出后续指令、澄清步骤，或直接编辑你章节中的内容，从而与 GitBook Agent 协同工作。

#### 使用 GitBook Agent 实施变更请求

点击 **编辑** （位于章节标题中）以打开变更请求对话框。

输入 **标题** 作为变更请求的标题，并在 **描述**中说明你希望进行哪些更改。GitBook Agent 会同时参考这两项内容。

点击 **使用 GitBook Agent 实施**。GitBook 会创建变更请求，Agent 随即开始执行你的指示。在整个过程中，Agent 会在对话中告知你它正在做什么。

完成后，你可以直接在页面上自行编辑内容，或者给 Agent 更多指令，继续优化你的更改。

#### 在评论中标记 GitBook Agent

如果你希望 Agent 审阅页面上的特定区块，可以在评论中标记该区块，并告诉它你的需求。点击 **评论区块** 并标记 @gitbook 来提及 Agent，然后告诉它你希望它做什么。

GitBook Agent 会根据你的提示更新内容，然后回复你的评论，告诉你它做了什么。

#### 使用 GitBook Agent 改进页面内容

<figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-9e09b8690b432a41c9d3afcef8cdfdef1fd07eac%2F26_01_14_improve_page_actions.png?alt=media" alt=""><figcaption></figcaption></figure>

通过 **改进** 菜单，你可以选择预设，让 GitBook Agent 执行常见操作以改进页面内容。

在编辑器中，将鼠标悬停在页面标题上，或打开页面的 **改进** 菜单，即可访问该菜单；你也可以通过页面的 **操作菜单访问** <picture><source srcset="broken://files/YjlF3Z9KMYv9aQiFzZKD" 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-aabbca522107ef561981bdfe5af94605b31e0920%2F25_01_10_actions_icon_light.svg?alt=media" alt=""></picture>.

在“优化”菜单中，你可以让 Agent 执行以下操作：

* 为页面添加图标
* 根据页面内容生成页面描述
* 修复拼写和语法
* 重写以与其他页面保持一致
* 针对 SEO 进行优化
* 添加摘要和下一步部分
* 链接到相关主题和页面
* 将单个页面拆分为多个页面

前两个选项是条件性的——它们会根据你的页面内容而变化。因此，如果你的页面已经有图标和描述，你就不会在菜单中看到这些选项。

点击任意选项，Agent 就会立即开始处理你的任务。

#### 在空白区块中创建新内容

你可以使用 GitBook Agent 在页面上的任意空白行创建内容。它可以创建各种类型的内容——以 Markdown 格式排版——包括代码示例、模板、页面摘要等。

在任意空行按 `Space` ，或输入 `/` 并选择 **使用 AI 写作** ，即可启动 GitBook Agent。

你可以立即开始输入任何你想要的提示。GitBook Agent 会分析提示并据此生成内容。例如：

> 给我写一段两段式概述，解释为什么文档对产品团队很重要。

或者，你也可以从建议的提示或提示开头中选择一个：

* **继续写作** ——GitBook Agent 会分析当前页面的内容，并据此生成更多内容。
* **解释…** ——选择此项后，告诉 GitBook Agent 你想让它解释什么。这不受页面内容的限制，因此你可以让它解释任何内容。
* **总结** ——总结页面上的所有内容。这非常适合在详细文档的末尾撰写简要总结，或在开头添加摘要，方便读者快速了解内容。
* **解释此内容** ——用更简单的语言解释页面上的复杂信息，包括解释首字母缩略词和其他术语。如果你正在阅读的页面包含大量复杂信息，或者你想为技术背景较少的读者添加说明，这个功能非常合适。
* **翻译** ——将当前页面翻译成多种指定语言之一。如果你想翻译成列表中没有的语言，只需将该语言输入提示框即可。

### 为 GitBook Agent 编写有效提示 <a href="#write-effective-prompts" id="write-effective-prompts"></a>

GitBook Agent 就像一个很擅长接受指令的队友。你需要给它清晰的说明和上下文，才能获得最佳结果。

以下是编写优秀提示的一些快速技巧：

* **拆分任务** ——Agent 最擅长完成目标明确的任务。将复杂项目拆分成较小的步骤，让 Agent 一次完成一个步骤。
* **明确具体** – 像 `@gitbook improve this page` 这样的通用提示会采用通用最佳实践，但如果没有更具体的指导，Agent 可能无法实现你心目中的目标。
* **聚焦于预期成果** – 如果你了解到客户遇到的某个具体问题，请告诉 Agent 这些问题，或说明你想要达成的成果。它会根据这些成果提出改进建议。
* **给出明确指示** – 如果你希望 Agent 使用步骤导航区块制作分步指南，或添加包含多个可展开区块的常见问题解答部分，请明确告诉它要做什么，以便一次就获得理想结果。
* **使用宽泛提示进行更全面的改进** – 对于修正拼写错误、在多个页面中更新功能名称，或从文档中移除特定内容块类型等维护任务，你可以使用如下命令： `@gitbook replace all instances of v2.3.9 with v2.4.0`.


---

# 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/write-and-edit-with-ai.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.
