使用 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 改进这个页面 会应用通用最佳实践，但如果没有更具体的指导，Agent 可能无法达到你设想的目标。

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

• 给出直接指令 – 如果你希望 Agent 用步骤块来制作分步指南，或者添加一个包含许多可展开区块的 FAQ 部分，请准确告诉它该怎么做，以便第一次就得到正确结果。

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