> 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/write-and-edit-with-ai.md).
# 使用 GitBook Agent 写作
GitBook Agent 是一款强大的工具，可为你在 GitBook 中的文档生成内容。
Agent 能做的事情很多，从在页面上撰写简短文字，到编辑现有块、创建新页面等等，都可以在一次变更请求中完成。
{% hint style="info" %}
#### GitBook Agent 会遵循你的风格指南
在一个中定义你团队的写作规则 [风格指南](/docs/documentation/zh/chuang-jian-nei-rong/styleguide.md)，当你请求它帮忙时，Agent 会将其视为唯一事实来源。它会在每个任务中将你的风格指南的 **首页** 加载到上下文中，所以请把主要规则放在那里。
你也可以 [添加简短的自定义说明](/docs/documentation/zh/gitbook-agent/overview.md#add-a-style-guide-and-custom-instructions) ，在站点级别。
{% endhint %}
### GitBook Agent 能做什么？
GitBook Agent 与 GitBook 应用深度集成，因此它能理解你在编辑器中可以创建的块，以及你所在章节更广泛的内容。
这意味着你可以用 Agent 来：
* 根据你的提示词撰写新内容
* 搜索现有页面并更新特定内容
* 重新格式化内容，以充分利用 GitBook 的不同块
* 更新代码示例
* 在页面之间移动内容
* 在特定位置添加新页面
### 如何与 GitBook Agent 交互
与 GitBook Agent 协作有几种方式：
* 在现有变更请求中打开 Agent，并告诉它你的需求
* 使用 GitBook Agent 规划并实施新的变更请求
* 在块的评论中标记 Agent
* 在页面的空白行中创建新内容
让我们逐一了解这些方式，看看它们是如何工作的。
#### 在任何变更请求中打开 GitBook Agent 聊天窗口
你可以随时通过点击 **GitBook 代理** 按钮，在章节标题栏中打开变更请求里的 Agent 聊天窗口。这会在应用右侧打开 Agent 的聊天窗口。
在变更请求中打开 GitBook Agent
你可以在这里输入提示词，让 Agent 按照它执行——它会在遵循你的指示时解释自己正在做什么，修改内容会随着它的工作实时出现在你的章节中。
你可以随时给出后续指示或澄清步骤，或者直接编辑你章节中的内容，从而与你和 GitBook Agent 协同工作。
#### 使用 GitBook Agent 实施变更请求
点击 **GitBook 代理** 的一部分 **编辑** 按钮，打开一个弹窗。
你可以在这里写一个提示词，告诉 Agent 你的变更请求应包含什么内容，然后添加可能对理解变更有帮助的参考页面作为上下文。
一旦你点击 **开始变更请求** Agent 就会为你打开一个变更请求，并开始执行你的指示。在每个阶段，Agent 都会在应用右侧的聊天窗口中告诉你它正在做什么。
完成后，你可以直接在页面上自行编辑内容，或者给 Agent 更多指示，继续优化你的更改。
#### 在评论中标记 GitBook Agent
如果你希望 Agent 审阅页面上的某个特定块，可以在评论中标记它并告诉它你的需求。只需点击 **对块发表评论** 并标记 @gitbook 来标记 Agent，然后告诉它你希望它做什么。
GitBook Agent 会根据你的提示更新内容，然后回复你的评论，告诉你它做了什么。
#### 使用 GitBook Agent 改进页面内容
该 **改进** 菜单为你提供了一组预设选项，可指示 GitBook Agent 执行常见操作来改进页面内容。
你可以访问 **改进** 菜单，方法是将鼠标悬停在页面标题上，或者打开页面的 **操作菜单** .
在“改进”菜单中，你可以告诉 Agent：
* 为页面添加图标
* 根据页面内容生成页面描述
* 修正拼写和语法
* 重写以与其他页面保持一致
* 针对 SEO 进行优化
* 添加摘要和下一步部分
* 链接到相关主题和页面
* 将单个页面拆分为多个页面
前两个选项是条件性的——它们会根据你的页面内容而变化。因此，如果你的页面已经有图标和描述，你就不会在菜单中看到这些选项。
点击任意选项，Agent 就会立即开始执行你的任务。
#### 在空白块中创建新内容
你可以使用 GitBook Agent 在页面上的任何空白行中创建内容。它可以创建各种内容——以 Markdown 格式编写——包括代码示例、模板、页面摘要等。
按 `空格键` 在任何空白行上，或者输入 `/` 并选择 **使用 AI 写作** 来启动 GitBook Agent。
你可以立即开始输入任何你想要的提示词。GitBook Agent 会分析提示词并据此生成内容。例如：
> 为我写一段两段式概述，解释为什么文档对产品团队很重要。
或者，你也可以从建议的提示词或提示词起始语中选择一个：
* **继续写作** – GitBook Agent 会分析你当前页面上的内容，然后据此生成更多内容。
* **解释……** – 选择这个，然后告诉 GitBook Agent 你希望它解释什么。它不受你页面内容的限制，所以你可以让它解释任何东西。
* **总结** – 总结你页面上的所有内容。这非常适合在详细文档底部撰写 TL;DR，或在顶部添加一个快速摘要，方便刚浏览的人查看。
* **解释这个** – 这会用更简单的语言解释你页面上的复杂信息——包括解释首字母缩略词和其他行话。如果你正在阅读的页面包含大量复杂信息，或者你想为不那么技术化的人添加说明，这个选项非常合适。
* **翻译** – 将你当前页面翻译成若干预设语言中的一种。如果你想翻译成列表中没有的语言，只需将其输入提示框即可。
### 为 GitBook Agent 编写有效的提示词
GitBook Agent 就像一个很擅长听从指示的队友。你需要给它清晰的指令和上下文，才能获得最佳结果。
以下是编写优秀提示词的几个快速建议：
* **分解任务** – Agent 最擅长完成聚焦明确的任务。将复杂项目拆分为更小的步骤，并要求 Agent 一次完成一个。
* **要具体** – 像 `@gitbook 改进此页面` 这样的通用提示词会应用通用最佳实践，但如果没有更具体的指导，Agent 可能无法达到你设想的目标。
* **聚焦结果** – 如果你听说客户在遇到某个具体问题，就把这些问题告诉 Agent——或者告诉它你希望实现的结果。它会根据这些结果提出改进建议。
* **给出直接指令** – 如果你希望 Agent 在分步指南中使用 stepper 块，或者添加一个带有多个可展开块的 FAQ 部分，请准确告诉它要做什么，这样才能第一次就得到正确结果。
* **将更宽泛的提示用于更大范围的改进** – 对于修复拼写错误、跨页面更新功能名称，或从文档中移除特定块类型等维护任务，你可以使用类似 `@gitbook 将所有 v2.3.9 的实例替换为 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 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/write-and-edit-with-ai.md?ask=&goal=
```
`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.