使用 GitBook Agent 编写

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

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

Agent 可以完成各种任务，从为页面撰写小段文本，到编辑现有区块，以及在一个变更请求中创建新页面、新章节等。

GitBook Agent 会遵循你的风格指南

你可以 添加你自己的风格指南和自定义说明 在站点级别进行设置——这样无论你何时请求帮助，Agent 都会始终匹配你的语气和风格。

GitBook Agent 能做什么？

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

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

• 根据你的提示编写新内容

• 搜索现有页面并更新特定内容

• 重新格式化内容，以充分利用 GitBook 的不同区块

• 更新代码示例

• 在页面之间移动内容

• 在特定位置添加新页面

如何与 GitBook Agent 交互

有几种方式可以使用 GitBook Agent：

• 在现有变更请求中打开 Agent，并告诉它你的需求

• 使用 GitBook Agent 规划并实施一个新的变更请求

• 在区块评论中标记 Agent

• 在页面中的空白行创建新内容

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

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

你可以随时在变更请求中点击 GitBook Agent 按钮来打开 Agent 聊天窗口。这样会在应用右侧打开 Agent 的聊天窗口。

在变更请求中打开 GitBook Agent

在这里，你可以编写一个供 Agent 执行的提示——它会在遵循你的指令时解释自己正在做什么，并且在其工作过程中，变更会显示在你的空间中。

你可以提供后续指示或澄清步骤，也可以随时直接编辑你的空间内容，从而与 GitBook Agent 协同工作。

使用 GitBook Agent 实施变更请求

点击 GitBook Agent 部分，位于 编辑 按钮中，该按钮位于空间右上角，以打开一个模态窗口。

在这里，你可以编写提示，告诉 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 improve this page 这样的通用提示会应用一些通用最佳实践，但如果没有更具体的指导，Agent 可能无法实现你心中预期的目标。

• 关注结果 ——如果你听说客户遇到了某个具体问题，请把这些问题——或你希望实现的结果——告诉 Agent。它会根据这些结果提出改进建议。

• 给出直接指令 ——如果你希望 Agent 使用 stepper 区块来制作分步指南，或者添加一个包含多个可展开区块的 FAQ 部分，请准确告诉它该怎么做，这样才能第一次就获得正确结果。

• 在需要更广泛改进时使用宽泛提示 ——对于修复错字、跨页面更新功能名称，或从文档中删除特定区块类型等维护任务，你可以使用如下命令： @gitbook replace all instances of v2.3.9 with v2.4.0.