AGENTS.md 小节实战:把图表即代码变成团队共享流程
「图表即代码」是开发者与技术写作者的高频任务。它的输入通常是流程描述,期望得到的是图表代码。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。
本文介绍如何在 AGENTS.md 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 图表即代码(diagram-as-code) |
| 作用 | 把流程描述转为 Mermaid 或 PlantUML 图 |
| 输入 | 流程描述 |
| 输出 | 图表代码 |
| 形态 | 纯提示词 |
| 风险 | 低 |
| 适用人群 | 开发者与技术写作者 |
处理流程分四步:
- 识别参与者与步骤
- 选择图类型
- 生成代码
- 检查渲染
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。
在 AGENTS.md 中是什么形态
AGENTS.md 是放在仓库根目录、写给编码智能体看的说明文件,多个编码智能体工具都会读取它。把常用流程写成其中的一个小节,就相当于给所有智能体装上同一个技能。
根目录的 AGENTS.md 对整个仓库生效;子目录也可以放自己的 AGENTS.md,就近补充或覆盖说明。
示例配置
AGENTS.md 中的小节示例(示意):
## 图表即代码(diagram-as-code)
- 何时使用:用户需要把流程描述转为 Mermaid 或 PlantUML 图
- 输入:流程描述
- 输出:图表代码
- 步骤:
1. 识别参与者与步骤
2. 选择图类型
3. 生成代码
4. 检查渲染
- 约束:
- 文中的命令和接口要与当前代码逐一核对。
- 信息不足时先提问,不要自行编造数据或事实。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在仓库根目录打开(或新建)AGENTS.md
- 新增一个以技能名命名的小节,写清何时使用、输入、步骤与约束
- 引用项目里已有的命令和脚本,不要写不存在的命令
- 让智能体执行一次相关任务,检查是否遵循
- 随代码评审一起维护这个小节
实操:一次完整的运行
假设你在文档仓库与文档站中发出这样的请求(虚构示例):
帮我做一下图表即代码,材料是附上的流程描述。
智能体识别到任务与「图表即代码」相关后,会依次识别参与者与步骤、选择图类型、生成代码、检查渲染。最终交付图表代码,并在末尾列出需要人工确认的内容。你的工作是对照原始流程描述抽查两三处关键信息,确认无误后再使用。
测试与验收
让两个不同的编码智能体分别执行同一任务,对比是否都按小节中的步骤进行。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准流程描述,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- AGENTS.md 越写越长,变成没人维护的百科;每个小节保持一屏以内。
- 写了与实际不符的构建或测试命令,智能体会照做并失败。
- 只写了步骤,没写交付格式,导致每次输出的图表代码结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 图表即代码 · 极简与进阶
- 图表即代码 · 定制指南
- 图表即代码 · Gemini CLI 版
- 注释翻译 · AGENTS.md 版
- 升级迁移指南 · AGENTS.md 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。