使用 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 一起规划并实施新的变更请求

• 在区块的评论中提及（Tag）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 在页面的任何空行上创建内容。它可以创建各种内容——以 Markdown 格式——包括代码示例、模板、页面摘要等。

使用 GitBook AI 撰写。

按下 空间 在任何空行上，或输入 / 并选择 使用 AI 撰写 以启动 GitBook Agent。

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

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

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

• 继续写作 — GitBook Agent 将分析您当前页面上的内容，然后基于该内容生成更多内容。

• 解释… — 选择此项，然后告诉 GitBook Agent 您希望它解释的内容。这不受限于页面上的内容，因此您可以让它解释任何内容。

• 摘要 — 对您页面上的所有内容进行摘要。这非常适合在详细文档底部编写 TL;DR，或在顶部为只是查看的人添加快速摘要。

• 解释此内容 — 这将用更简单的语言解释您页面上的复杂信息——包括解释首字母缩略词和其他行话。如果您正在阅读的页面涉及大量复杂信息，或您想为非技术人员添加说明，这非常合适。

• 翻译 — 将您当前的页面翻译成若干指定语言之一。如果您想翻译为列表中没有的语言，只需在提示框中输入该语言即可。

为 GitBook Agent 编写有效提示

GitBook Agent 就像一个擅长接受指令的队友。您需要为它提供清晰的指示和上下文，以获得最佳结果。

以下是编写良好提示的一些快速提示：

• 将其拆分 — Agent 最擅长完成有针对性的任务。将复杂项目拆分为更小的步骤，并要求 Agent 一次完成一个步骤。

• 具体说明 — 像这样的一般性提示 @gitbook 改进此页面 将应用通用最佳实践，但如果没有更具体的指导，Agent 可能无法实现您心中的目标。

• 关注结果 — 如果您听到客户遇到的具体问题，告诉 Agent 这些问题——或您想要达成的结果。它将根据这些结果建议改进。

• 给出直接指示 — 如果您希望 Agent 在一步步指南中使用步进区块，或添加包含多个可展开区块的常见问题（FAQ）部分，请准确告诉它应该做什么，以便首次获得正确的结果。

• 对于更广泛的改进使用宽泛提示 — 对于维护任务，例如修正拼写错误、在各页面更新功能名称或从文档中删除特定区块类型，您可以使用诸如 @gitbook 将所有 v2.3.9 的实例替换为 v2.4.0 的命令.