Appearance
工作流概览
以下
/spec:*命令在 Claude Code 和 OpenAI Codex 中通用。确保已运行spec-first init --claude或spec-first init --codex初始化项目。
完整工作流
Spec-First 提供从创意发现到知识沉淀的完整工作流:
Ideate → Brainstorm → Plan → Work → Review → Compound
(发现) (定义) (规划) (实现) (审查) (沉淀)可选前置阶段:Ideate
当你不确定要做什么时,可以从 Ideate 开始:
| 属性 | 值 |
|---|---|
| 输入 | 聚焦提示(可选) |
| 输出 | 排名改进列表 |
| 产出路径 | docs/ideation/YYYY-MM-DD-<topic>-ideation.md |
- 通过代码扫描生成基于实际的改进建议
- 先发散后收敛的对抗性过滤机制
- 选定方向后衔接 Brainstorm
五阶段闭环详情
1. Brainstorm(需求探索)
目标: 明确要做什么
| 属性 | 值 |
|---|---|
| 输入 | 用户的初始想法 |
| 输出 | 结构化的需求文档 |
| 产出路径 | docs/brainstorms/YYYY-MM-DD-<topic>-requirements.md |
关键活动:
- 探索需求背景和目标
- 讨论可行方案
- 确定功能范围和边界
- 明确验收标准
价值: 避免方向性错误,减少返工
2. Plan(方案规划)
目标: 明确怎么做
| 属性 | 值 |
|---|---|
| 输入 | 需求文档 |
| 输出 | 详细的实施计划 |
| 产出路径 | docs/plans/YYYY-MM-DD-NNN-<type>-<name>-plan.md |
内容包括:
- 技术选型和架构设计
- 任务拆解和优先级
- 风险识别和应对策略
- 时间和资源估算
价值: 确保方案可行,降低实施风险
3. Work(执行实施)
目标: 完成开发
| 属性 | 值 |
|---|---|
| 输入 | 实施计划 |
| 输出 | 可运行的代码 + 测试 |
| 产出路径 | 项目源代码 |
执行方式:
- 按照计划的步骤逐步实现
- 保持与计划的一致性
- 记录遇到的问题和调整
- 更新相关文档
价值: 有序推进,避免遗漏
4. Review(质量评审)
目标: 确保质量
| 属性 | 值 |
|---|---|
| 输入 | 实施产物 |
| 输出 | 评审报告 |
| 产出路径 | 内嵌在会话中 |
评审维度:
- Correctness(正确性) - 功能是否符合需求
- Completeness(完整性) - 是否有遗漏
- Maintainability(可维护性) - 代码质量和可读性
- Risk(风险) - 潜在问题和改进建议
价值: 及早发现问题,保证交付质量
5. Compound(知识沉淀)
目标: 提取可复用知识
| 属性 | 值 |
|---|---|
| 输入 | 评审通过的产物 |
| 输出 | 知识文档 |
| 产出路径 | docs/solutions/<category>/<filename>.md |
沉淀内容:
- 问题根因和解决方案
- 最佳实践和经验教训
- 可复用的代码模式
- 项目规范和约定
价值: 避免重复踩坑,加速后续开发
工作流产出路径汇总
| 阶段 | 产出路径 | 命名规范 |
|---|---|---|
| Brainstorm | docs/brainstorms/ | YYYY-MM-DD-<topic>-requirements.md |
| Plan | docs/plans/ | YYYY-MM-DD-NNN-<type>-<name>-plan.md |
| Work | 项目源代码 | - |
| Review | 内嵌在会话中 | - |
| Compound | docs/solutions/ | <category>/<filename>.md |
阶段转换条件
| 转换 | 触发条件 |
|---|---|
| Ideate → Brainstorm | 选定一个改进方向 |
| Brainstorm → Plan | 需求文档完成,验收标准明确 |
| Plan → Work | 计划通过评审,任务拆解完成 |
| Work → Review | 代码实现完成,自测通过 |
| Review → Compound | 审查通过,无阻断性问题 |
| Review → Work | 发现问题,需要修复 |
| Compound → Brainstorm | 知识反哺,启动下一轮迭代 |
工作流特点
- 闭环迭代 - 每个阶段都有明确的输入输出,形成完整闭环
- 质量内建 - 在流程中嵌入质量检查,而非事后补救
- 知识复利 - 持续沉淀经验,让团队越来越高效
- 灵活适配 - 可根据实际情况调整流程深度
何时使用
| 场景 | 建议起点 |
|---|---|
| 想改进项目但不知从何入手 | 从 ideate 开始 |
| 需求模糊,不确定要做什么 | 从 brainstorm 开始 |
| 需求清晰,但不知道怎么做 | 从 plan 开始 |
| 计划就绪,直接开发 | 从 work 开始 |
| 代码已完成,需要评审 | 从 review 开始 |
| 解决了问题,想要沉淀 | 从 compound 开始 |
| 需求明确,想全自动交付 | 使用 LFG |
快速示例
新功能开发
bash
# 1. 探索需求
/spec:brainstorm "用户登录功能"
# 2. 制定计划
/spec:plan docs/brainstorms/2026-03-30-user-login-requirements.md
# 3. 执行开发
/spec:work docs/plans/2026-03-30-001-feat-user-login-plan.md
# 4. 代码评审
/spec:review
# 5. 知识沉淀
/spec:compoundBug 修复
bash
# 1. 复现问题
/spec:brainstorm "修复登录超时问题"
# 2. 制定修复计划
/spec:plan docs/brainstorms/2026-03-30-login-timeout-requirements.md
# 3. 执行修复
/spec:work docs/plans/2026-03-30-002-fix-login-timeout-plan.md
# 4. 代码评审
/spec:review
# 5. 沉淀解决方案
/spec:compound下一步
| 你现在的状态 | 推荐阅读 |
|---|---|
| 刚接触 Spec-First | 快速开始 — 10 分钟端到端体验 |
| 想深入了解某个阶段 | Ideate / Brainstorm / Plan / Work / Review / Compound |
| 想全自动交付 | LFG 自主工作流 |
| 想了解底层机制 | 什么是 Spec-First / 记忆系统 |