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