关于 n8n:spec-driven-development
面向 n8n 开发的规格驱动 Skill,将 `.agents/specs/` 作为架构、API 契约和实现范围的依据,指导实现、核对一致性并同步规格与代码。
主要功能
- 01查找并阅读相关规格
- 02依据已记录的决策实现
- 03代码偏离时更新规格
- 04对照规格验证实现
适用场景
- 01启动复杂功能开发
- 02保持 API 契约与代码一致
- 03检查已完成工作中的规格差距
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ n8n-io/ n8n --skill n8n:spec-driven-development安装后在 Claude Code 中输入/n8n:spec-driven-development确认已加载。
详细介绍
规范驱动开发
规范存放在 .agents/specs/ 中,是架构决策、API 契约和实现范围的唯一事实来源。实现与规范必须保持同步——两者都不能单方面主导。
核心循环
Read spec → Implement → Verify alignment → Update spec or code → Repeat
开始工作前
- 查找规范。 在
.agents/specs/中搜索与该功能匹配的文件:
ls .agents/specs/
-
通读完整规范。 编写代码前,先了解范围、决策、API 契约和待解决的问题。
-
如果不存在规范,且任务并非简单任务(新模块、新 API、架构变更),请询问用户是否要先创建规范。
实现期间
- 参考规范中的决策——不要重新决定规范已经确定的事项。
- 如果偏离规范(找到更好的方案、用户要求变更、发现约束),请在同一会话中立即更新规范。不要让规范与代码不同步。
- 完成事项后,勾选 TODO 复选框(
- [ ]→- [x])。 - 对于有意跳过或替换的事项,添加删除线或注释,并简要说明原因:
- [x] ~~OpenRouter proxy~~ → Direct execution: nodes call OpenRouter directly
完成工作后
执行规范验证:
- 重新阅读规范,并对照实现。
- 检查各个部分:
- 规范中的 API 端点是否与控制器一致?
- 规范中的配置项/环境变量是否与配置类一致?
- 规范中的模块结构是否与实际文件树一致?
- 规范中的类型定义是否与
@n8n/api-types一致? - 所有 TODO 项是否都已正确勾选或未勾选?
- 更新规范,修正发现的偏差。常见偏差包括:
- 新增的文件未列在结构部分
- 实现过程中变更了 API 响应结构
- 调整了配置默认值
- 细化了架构决策
- 向用户指出尚未解决的缺口——即规范承诺但实现尚未交付的事项(对于 MVP 可以接受,但应予以说明)。
规范文件约定
- 每项功能在
.agents/specs/中可有一个或多个 Markdown 文件。 - 保持规范简洁。映射关系使用表格,结构使用代码块。
- 使用
## Implementation TODO和复选框跟踪进度。 - 如有帮助,可拆分为多个文件(例如,将后端和前端分开),但不必遵循严格的命名方案。
用户要求“自我审查”或“根据规范验证”时
- 阅读所有相关规范。
- 阅读所有实现文件。
- 按结构化方式进行对比:
- 一致:规范与代码相符的事项
- 偏差:两者不一致的事项(立即修复)
- 缺口:规范中尚未实现的事项(注明为未来工作)
- 修正偏差、更新规范,并向用户说明缺口。
评论
支持 Markdown