Skip to main content

从 Linear 自动生成 API 文档

创建一个文档 Playbook,将其同步为 Linear 标签,让团队中任何人只需给工单打上该标签就能触发文档生成。
AuthorCognition
Category项目管理
Features集成、Playbook
1

编写文档指南

首先为你想标准化的任务创建一个运行手册。在本例中,我们将构建一个运行手册,当团队成员为工单添加特定标签时自动生成 API 文档。前往 Settings > Playbooks 并点击 Create playbook。为其命名并设置一个宏命令(例如 !add-docs)。编写明确的、分步骤的指令。引用真实的文件路径和约定,以便 Devin 遵循你团队的标准:你的运行手册越具体,输出效果就越好。引用你团队实际使用的文档模板、风格指南和工具。参见运行手册文档了解更多编写高效运行手册的说明。
2

将 Playbook 同步到 Linear

如果你尚未连接 Linear 集成:前往 Settings > Integrations > Linear 并点击 Connect。选择 Devin 需要访问的团队。连接完成后,向下滚动到 Synced playbook labels 并点击 Add playbook。从下拉菜单中选择 !add-docs。这会在 Linear 中的 Devin Playbooks 标签组下自动创建一个名为 !add-docs 的标签。现在,当有人将该标签添加到工单时,Devin 会基于你的 playbook 启动会话。
要让 playbook 标签自动同步到 Linear,你的 Linear 工作区必须将 Manage workspace labels 设置为 All members(位于 Linear 的 Settings > Security 下)。如果未启用该设置,你需要在 Linear 中手动创建这些标签。
3

给工单打标签并生成文档

当团队成员在这样的工单上添加 !add-docs 标签时:
ENG-215: Add POST /api/v2/webhooks endpoint — accepts a URL and event types, validates the URL is reachable, stores the subscription, and returns the webhook ID.
Devin 会自动启动一次会话,并按照你的文档 playbook 执行:
  • 阅读工单 — 提取端点描述、参数以及任何关联的 PR
  • 查找源代码 — 定位路由处理函数、请求校验 schema 和响应类型
  • 生成文档 — 在 docs/api/ 中创建一个遵循你现有格式的新页面
  • 打开一个 PR — 包含新的文档页面和更新后的侧边栏
这在批量操作场景中同样适用——使用 Cmd+A 多选工单,右键单击,然后添加 !add-docs 标签,就可以并行为多个端点生成文档。
安装 Linear 集成后,Devin 可以原生访问 Linear 的工具——因此你的 playbook 可以指示 Devin 根据结果更新工单标签或状态。由于标签可以触发其他自动化,你可以串联工作流——例如,在文档生成之后,一个 Docs Ready 标签可以通知技术文档作者进行审阅。
4

为你的团队制定更多操作手册

同样的模式适用于任何重复性任务。创建一个 playbook,将其同步为一个标签,你的团队就可以在任意工单上触发它。以下是一些示例:
  • !write-tests — 为工单中描述的功能添加测试覆盖
  • !refactor — 按照你团队的约定重构代码
  • !security-audit — 审查代码中的安全漏洞,并提交一个包含修复的 PR(pull request)
  • !migrate — 运行标准化迁移(依赖升级、API 版本提升)
你也可以设置自动化触发器,让 Devin 在无人手动添加标签的情况下自动开始工作。前往 Settings > Integrations > Linear,滚动到 Automation triggers,并配置一个触发器,使其在工单流转到特定状态或被打上特定标签时触发。