使用 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 的聊天窗口。

在变更请求中打开 GitBook Agent

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

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

使用 GitBook Agent 实施变更请求

点击 GitBook 代理 部分的 编辑 按钮位于空间右上角以打开模态窗口。

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

一旦你点击 开始变更请求 Agent 会为你打开一个变更请求并开始执行你的指示。在每个阶段,Agent 都会在应用右侧的聊天窗口中告诉你它正在做什么。

完成后,你可以在页面上直接自己编辑内容,或给 Agent 更多指示继续完善你的更改。

在评论中@提及 GitBook Agent

如果你希望 Agent 审查页面上的特定块,你可以在评论中@提及它并告诉它你的需求。只需点击 块上评论 并@gitbook 来标记 Agent,然后告诉它你希望它做什么。

GitBook Agent 会根据你的提示更新内容,然后回复你的评论,告诉你它所做的更改。

在空块中创建新内容

此功能可在以下方案中使用 专业版与企业版计划.

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

A GitBook screenshot showing the AI writing options
使用 GitBook AI 撰写内容。

按下 空间 在任何空行,或输入 / 并选择 与 AI 一起撰写 以启动 GitBook Agent。

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

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

或者,你可以从建议的提示或提示启动器中选择:

  • 继续写作 – GitBook Agent 会分析你当前页面的内容,然后基于该内容生成更多内容。

  • 解释… – 选择此项,然后告诉 GitBook Agent 你希望它解释的内容。这不受你页面上内容的限制,所以你可以让它解释任何事情。

  • 总结 – 总结页面上的所有内容。这非常适合在详细文档底部写 TL;DR,或在顶部为仅查看的人添加快速摘要。

  • 解释这个 – 这会用更简单的语言解释页面上的复杂信息 — 包括解释首字母缩略词和其他术语。如果你正在阅读的页面涉及大量复杂信息,或你想为非技术人员添加解释,这非常适合。

  • 翻译 – 将你当前的页面翻译为若干语言中的一种。如果你想翻译成列表中没有的语言,只需在提示框中输入该语言即可。

为 GitBook Agent 撰写有效提示

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

以下是撰写良好提示的一些快速提示:

  • 将其分解 – Agent 最适合完成聚焦的任务。将复杂项目分解为较小步骤,并一次要求 Agent 完成其中之一。

  • 具体说明 – 通用提示如 @gitbook 改进此页面 将应用通用最佳实践,但如果没有更具体的指导,Agent 可能无法达到你心目中的目标。

  • 关注结果 – 如果你听到客户遇到的某个具体问题,告诉 Agent 这些问题或你想要实现的结果。它会基于这些结果建议改进措施。

  • 给出直接指示 – 如果你希望 Agent 为逐步指南使用步进块,或添加带有多个可展开块的常见问题部分,请准确告诉它该怎么做,以便首次就获得正确的结果。

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

最后更新于

这有帮助吗?