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

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

先向 agent 发送提示词,然后在同一条线程中继续使用 @mintlify 提及它,以便细化和迭代 agent 创建的拉取请求(PR;亦称“合并请求”或 Merge Request)。 例如:@mintlify Our quickstart page needs a new section on inviting collaborators。接着:@mintlify The new section should be called "Inviting collaborators"。然后再根据需要继续进行其他迭代。

从 agent 开始,由你手动完成

先向 agent 发送指令以启动一个项目,然后检出它创建的 branch,在本地环境或 Web 编辑器中完成任务。agent 可以帮助你起步,之后你可以接手完成整个任务。 例如:@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]。

从拉取请求生成发布说明

向 agent 提供特定的拉取请求,让其根据提交历史生成发布说明或更新日志。 例如:@mintlify Generate release notes for this PR: [PR link]。

处理拉取请求评审反馈

将拉取请求链接分享给 agent,以便处理文档拉取请求中的审阅意见和代码评审反馈。 例如:@mintlify Address the review comments on this PR: [PR link]。

生成代码示例

让 agent 在整份文档或特定页面中为各个功能生成代码示例。 例如:@mintlify Generate a code example to make the authentication method easier to understand。

向文档添加图片或文件

在向 agent 发送指令时,直接在 Slack 消息中附加文件或图片。agent 会处理附件并将其加入到文档中。支持的附件类型包括图片、PDF、SVG 以及其他文档。 例如:@mintlify Add this diagram to the architecture overview page,并在消息中附上该图片。

检查文档中的图片

agent 可以查看文档、已连接仓库和附件中的 JPEG、PNG、GIF 和 WebP 图片。你可以让它描述图片、编写替代文本,或检查截图是否仍与周围内容一致。 例如:@mintlify Add descriptive alt text to every image on the quickstart page。 在需要身份验证的部署中,agent 只会查看它已读取的已发布页面中出现的图片。

审查现有内容

让 agent 审查现有内容的技术准确性、写作风格、语法或其他问题。 例如:@mintlify 请审查 API 限流部分。我们上个月更改了限制。

回应用户反馈

根据用户的反馈向 agent 提问,以便对文档进行有针对性的更新。 例如:@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?。

使用 Automations 实现自动化

创建自动化来处理重复性任务和响应式维护工作,例如在你为产品添加新功能时撰写更新日志或更新内容。 参见自动化概览了解更多信息。

使用 API 实现自动化

将 agent 集成到你现有的自动化工具中。当代码发生变更时,它可以自动更新文档、触发内容审查,或在多个代码仓库之间同步文档更新。 要从你自己的工具中运行 agent,请创建一个使用 webhook 触发器的自定义自动化。使用 agent 的 API 端点来获取任务状态以及发送消息。