使用场景

在文档流程中使用 agent 的示例。

agent 可以协助完成多种文档相关任务。以下示例展示了几种将 agent 集成到文档流程中的方式。选择一种适合你团队当前工作方式的方案，并根据你的具体需求进行调整。

​

在 Slack 线程中迭代优化提示词

先向 agent 发送提示词，然后在同一条线程中继续使用 @mintlify 提及它，以便对其创建的拉取请求（PR；亦称“合并请求”/Merge Request）进行细化和迭代。

例如：@mintlify Our quickstart page needs a new section on inviting collaborators。接着：@mintlify The new section should be called "Inviting collaborators"。然后再根据需要继续进行其他迭代。

​

从助手开始，由你手动完成

先向助手发送指令以启动一个项目，然后检出它创建的 branch，在本地环境或 Web 编辑器中完成任务。助手可以帮助你起步，之后你可以接手完成整个任务。

例如：@mintlify Update the quickstart page to include information about inviting collaborators，然后检出该 branch，使用你喜欢的方式进行进一步修改。

​

在合并功能变更时更新文档

当你合并功能拉取请求（PR）时，将该 PR 的链接分享给 agent，让其更新相关文档。

例如：@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link].

​

从拉取请求生成发布说明

向智能助手提供特定的拉取请求，让其根据提交历史生成发布说明或更新日志。

例如：@mintlify Generate release notes for this PR: [PR link]。

​

处理拉取请求评审反馈

将拉取请求链接分享给助手，以便处理文档拉取请求中的审阅意见和代码评审反馈。

例如：@mintlify Address the review comments on this PR: [PR link]。

​

生成代码示例

让智能体在整份文档或特定页面中为各个功能生成代码示例。

例如：@mintlify Generate a code example to make the authentication method easier to understand.

​

向文档添加图片或文件

在向智能体发送指令时，直接在 Slack 消息中附加文件或图片。智能体会处理附件并将其加入到文档中。

例如：@mintlify Add this diagram to the architecture overview page，并在消息中附上该图片。

​

审查现有内容

让助手审查现有内容的技术准确性、写作风格、语法或其他问题。

例如：@mintlify 请审查 API 限流部分。我们上个月更改了限制。

​

回应用户反馈

根据用户的反馈向助手提问，以便对文档进行有针对性的更新。

例如：@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?.

​

使用工作流实现自动化

创建工作流，以自动化处理重复性任务和响应式维护任务，例如在你的产品添加新功能时撰写更新日志或更新内容。

参见 Workflows 了解更多信息。

​

使用 API 实现自动化

将 agent 集成到你现有的自动化工具中，当代码发生变更时自动更新文档、触发内容审查，或在多个代码仓库之间同步文档更新。

使用 agent 的 API 端点来创建任务、获取特定任务以及获取所有任务。

通过 API 创建任务时，你可以使用 asDraft 参数（默认为 false）控制拉取请求是否以草稿模式打开。将 asDraft 设置为 true 以创建草稿拉取请求，或保留默认值以创建非草稿拉取请求，从而在自动化工作流中立即进行审查和合并。

在代码合并后自动更新文档教程中了解如何设置 API 自动化。