跳转至

工作流程

CodexSpec 将开发过程结构化为可审查的检查点,每个阶段都有人工验证。

工作流程概览

┌──────────────────────────────────────────────────────────────────────────┐
│                    CodexSpec 人机协作工作流程                             │
├──────────────────────────────────────────────────────────────────────────┤
│                                                                          │
│  1. Constitution  ──►  定义项目原则                                      │
│         │                                                                │
│         ▼                                                                │
│  2. Specify  ───────►  交互式问答澄清需求                                │
│         │                                                                │
│         ▼                                                                │
│  3. Generate Spec  ─►  创建 spec.md 文档                                 │
│         │               ✓ 自动审查:生成 review-spec.md                 │
│         ▼                                                                │
│  4. Spec to Plan  ──►  创建技术方案                                      │
│         │               ✓ 自动审查:生成 review-plan.md                 │
│         ▼                                                                │
│  5. Plan to Tasks  ─►  生成原子任务                                      │
│         │               ✓ 自动审查:生成 review-tasks.md                │
│         ▼                                                                │
│  6. Implement  ─────►  使用条件 TDD 工作流执行实现                       │
│                                                                          │
└──────────────────────────────────────────────────────────────────────────┘

为什么审查很重要

不审查 有审查
AI 做出错误的假设 人工及早发现误解
不完整的需求继续传播 在实现之前识别缺口
架构偏离原始意图 在每个阶段验证一致性
结果:返工 结果:一次做对

自动审查

每个生成命令现在会自动运行审查

  • /codexspec:generate-spec → 自动调用 review-spec
  • /codexspec:spec-to-plan → 自动调用 review-plan
  • /codexspec:plan-to-tasks → 自动调用 review-tasks

审查报告会与工件一起生成,让你可以立即查看问题。

迭代质量循环

当审查报告中发现问题时,用自然语言描述修复方案,系统会同时更新工件和报告:

┌──────────────────────────────────────────────────────────────────────┐
│                    迭代质量循环                                        │
├──────────────────────────────────────────────────────────────────────┤
│                                                                       │
│  工件 (spec/plan/tasks.md)                                            │
│         │                                                             │
│         ▼                                                             │
│  自动审查 ──────► 审查报告 (review-*.md)                               │
│         │                    │                                        │
│         │                    ▼                                        │
│         │             发现问题?                                       │
│         │                    │                                        │
│         │              ┌─────┴─────┐                                  │
│         │              │           │                                  │
│         │             是          否                                   │
│         │              │           │                                  │
│         │              ▼           ▼                                  │
│         │     在对话中描述修复   继续下一步                             │
│         │              │                                              │
│         │              ▼                                              │
│         │     同时更新:                                               │
│         │       • 工件 (spec/plan/tasks.md)                           │
│         │       • 审查报告 (review-*.md)                               │
│         │              │                                              │
│         └──────────────┘                                              │
│                (重复直到满意)                                          │
│                                                                       │
│  手动重新审查:随时运行 /codexspec:review-* 获取全新分析                │
│                                                                       │
└──────────────────────────────────────────────────────────────────────┘

工作方式

  1. 自动审查:每个生成命令自动运行对应的审查
  2. 审查报告:生成 review-*.md 文件,包含发现的问题
  3. 迭代修复:在对话中描述需要修复的内容,工件和报告同时更新
  4. 手动重新审查:随时运行 /codexspec:review-spec|plan|tasks 获取全新分析

核心命令

阶段 命令 用途
1 /codexspec:constitution 定义项目原则
2 /codexspec:specify 需求的交互式问答
3 /codexspec:generate-spec 创建规格说明文档 (★ 自动审查)
- /codexspec:review-spec 自动调用,也可手动重新验证
4 /codexspec:spec-to-plan 创建技术方案 (★ 自动审查)
- /codexspec:review-plan 自动调用,也可手动重新验证
5 /codexspec:plan-to-tasks 分解为任务 (★ 自动审查)
- /codexspec:review-tasks 自动调用,也可手动重新验证
6 /codexspec:implement-tasks 执行实现

两阶段规格说明

specify 与 clarify 的区别

方面 /codexspec:specify /codexspec:clarify
目的 初始探索 迭代细化
何时使用 不存在 spec.md spec.md 存在,需要填补缺口
输入 你的初始想法 现有的 spec.md
输出 无(仅对话) 更新 spec.md

条件 TDD

实现遵循条件 TDD:

  • 代码任务:测试优先(红 → 绿 → 验证 → 重构)
  • 不可测试任务(文档、配置):直接实现