# 使用 GitBook Agent 撰写

GitBook Agent 是一个用于为您的 GitBook 文档生成内容的强大工具。

该 Agent 可以完成从在页面上撰写小段文本、编辑现有块到在变更请求中创建新页面、章节等一切工作。

{% hint style="info" %}

### GitBook Agent 遵循您的风格指南

您可以 [添加您自己的风格指南和自定义指令](https://gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs/documentation/zh/what-is-gitbook-agent#add-a-style-guide-and-custom-instructions) 以组织级别添加 —— 因此每当您请求帮助时，Agent 都会始终匹配您的语气和风格。
{% endhint %}

### GitBook Agent 能做什么？

GitBook Agent 与 GitBook 应用深度集成，因此它理解编辑器中您可以创建的块以及空间的更广泛内容。

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

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

### 如何与 GitBook Agent 交互

有几种方式可以与 GitBook Agent 协作：

* 在现有变更请求中打开 Agent 并告诉它您的需求
* 使用 GitBook Agent 规划并实施新的变更请求
* 在块的评论中标记 Agent
* 在页面的空白行上创建新内容

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

#### 在任何变更请求中打开 GitBook Agent 聊天窗口

您可以随时在变更请求中通过点击 **GitBook Agent** 按钮（位于空间标题栏）来打开 Agent 聊天窗口。这样会在应用右侧打开 Agent 的聊天窗口。

<div data-with-frame="true"><figure><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FPQtoLdPQWjOsz0vdowMn%2FCleanShot%202025-12-08%20at%2021.41.29%402x.png?alt=media&#x26;token=d3ea84f8-723e-463c-b84b-be6f02db490a" alt=""><figcaption><p>在变更请求中打开 GitBook Agent</p></figcaption></figure></div>

在这里您可以为 Agent 编写一个提示来遵循——它在执行您的指令时会解释它正在做什么，随着其工作的进行，更改会出现在您的空间中。

您可以随时给出后续指示或澄清步骤，或直接编辑空间内容，允许您与 GitBook Agent 并肩工作。

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

点击 **GitBook Agent** 部分的 **编辑** 按钮（位于空间右上角）以打开一个模态窗口。

在这里您可以编写提示，告诉 Agent 您希望变更请求包含什么，然后添加可能作为更改上下文有用的参考页面。

一旦您点击 **开始变更请求** 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%2FFTJDHOlJcYyh2M3tK6Xe%2Fpage-actions.png?alt=media&#x26;token=65358b13-2bef-4fda-bbe6-9308b7daba6f" alt=""><figcaption></figcaption></figure>

该 **改进** 菜单为您提供一组预设，指示 GitBook Agent 执行常见操作以改善您的页面内容。

您可以从编辑器中通过将鼠标悬停在页面标题上，或通过打开页面的 **改进** 菜单来访问该菜单 **操作菜单** <picture><source srcset="broken-reference" media="(prefers-color-scheme: dark)"><img src="https://2111890564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2F89MTSo5XRpPMVr1T0rxS%2Factions.svg?alt=media&#x26;token=2b5d001e-560a-4f29-8d22-de8163725ca1" alt=""></picture>.

在「改进」菜单中，您可以指示 Agent 执行以下操作：

* 为页面添加图标
* 根据页面内容生成页面描述
* 修正拼写和语法
* 为与其他页面保持一致而改写
* 为 SEO 优化
* 添加摘要和后续步骤部分
* 链接到相关主题和页面
* 将单页拆分为多页

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

选择任一选项，Agent 会立即开始执行您的任务。

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

您可以使用 GitBook Agent 在页面的任何空行上创建内容。它可以创建各种格式为 Markdown 的内容——包括代码示例、模板、页面摘要等。

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

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

> 请为我写一段两段的概述，说明为什么文档对产品团队很重要。

或者，您可以从建议的提示或提示起始语中选择：

* **继续写作** – GitBook Agent 会分析您当前页面的内容，然后基于此生成更多内容。
* **解释…** – 选择此项，然后告诉 GitBook Agent 您想让它解释什么。这不受限于页面上的内容，因此您可以要求它解释任何内容。
* **总结** – 总结您页面上的所有内容。这对于在详细文档底部写 TL;DR，或在顶部添加供快速查看的摘要非常有用。
* **解释这个** – 这会用更简单的语言解释页面上的复杂信息——包括解释缩略语和其他行话。如果您正在阅读的页面包含大量复杂信息，或您想为非技术人员添加说明，这非常适合。
* **翻译** – 将您当前的页面翻译成若干语言中的一种。如果您想翻译成列表中没有的语言，只需在提示框中输入该语言即可。

### 为 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`.
