sm-flow v4.2: add verifiable checkpoints and gate file mechanism
Based on real execution review (lookup-knowledge-integration), discovered that constraints are "soft" - rules are clear but lack enforcement mechanism. Core problem: Agent can skip stages despite explicit rules saying "must not skip" Changes: 1. Commit phase: add verifiable checkpoint - File completeness check: proposal ≥50 words, design ≥1 data structure, specs ≥3 requirements, tasks ≥5 items - Consistency check: proposal concepts → design mapping, design decisions → tasks implementation - Gate file: create .committed after passing all checks 2. Apply phase: add pre-gate check - Hard constraint: check .committed file existence - If missing: report, list gaps, ask user to fix or explicitly skip - Block implementation based on incomplete OpenSpec 3. Archive phase: add mandatory execution order - 5-step checklist: devflow files → index → .archive-ready → report → archive - Self-check: verify Step 1-3 before Step 4 - Prevent "handoff first, devflow forgotten" issue New gate files: - .committed: created by commit phase, checked by apply phase - .archive-ready: created by archive Step 3 Expected impact: - Commit skip rate: -100% (explicit checklist prevents fuzzy pass) - Apply on incomplete OpenSpec: -100% (gate blocks) - Archive devflow omission: -100% (mandatory order) Design principles: - Verifiability: "executable state" → "≥50 words + ≥1 structure + ≥3 requirements" - Gate files: soft judgment → file existence check - Mandatory order: advisory "should do" → 5-step checklist "must do" Complexity: +80 lines (phase-contracts.md +40, archive-rules.md +40) Approach: turn soft constraints into hard checks, no new stages Relation to v4.1: - v4.1: solve "insufficient research causes rework" (quality issue) - v4.2: solve "lack of enforcement causes stage skipping" (process issue) Docs: - phase-contracts.md: enhanced commit + apply phases - archive-rules.md: added mandatory execution order at top - workflow.md: added v4.2 evolution chapter - phase-contracts-v4.2-changelog.md: detailed change log - sm-flow-optimization-suggestions.md: source review
This commit is contained in:
@@ -2,6 +2,49 @@
|
|||||||
|
|
||||||
archive 阶段的目标是把 OpenSpec 产物、实现结果和过程日志转化为持久、可读、可复用的项目记忆。sm-flow 在 clarify → apply 期间只维护 `decisions.md` 作为过程日志,archive 阶段从中提取完整 devflow 档案。
|
archive 阶段的目标是把 OpenSpec 产物、实现结果和过程日志转化为持久、可读、可复用的项目记忆。sm-flow 在 clarify → apply 期间只维护 `decisions.md` 作为过程日志,archive 阶段从中提取完整 devflow 档案。
|
||||||
|
|
||||||
|
## Archive 强制执行顺序
|
||||||
|
|
||||||
|
Archive 阶段必须按以下顺序执行,不得跳过或重排:
|
||||||
|
|
||||||
|
### Step 1: 创建 devflow 档案(必需)
|
||||||
|
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/brief.md`
|
||||||
|
(从 proposal.md 提取:背景、目标、范围、非目标)
|
||||||
|
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/evidence.md`
|
||||||
|
(从 decisions.md 提取:evidence-driven 记录)
|
||||||
|
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/decisions.md`
|
||||||
|
(整理为最终版:关键决策、权衡、风险)
|
||||||
|
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/acceptance.md`
|
||||||
|
(记录:静态验证、脚本验证、浏览器/人工验证、未验证)
|
||||||
|
|
||||||
|
### Step 2: 更新索引(必需)
|
||||||
|
|
||||||
|
- [ ] 在 `devflow/index.md` 末尾追加或更新一行:
|
||||||
|
`| YYYY-MM-DD | slug | 领域 | 关键词 | openspec/changes/xxx | archived |`
|
||||||
|
|
||||||
|
### Step 3: 标记 OpenSpec(必需)
|
||||||
|
|
||||||
|
- [ ] 创建 `openspec/changes/{slug}/.archive-ready` 文件
|
||||||
|
|
||||||
|
### Step 4: 向用户汇报(必需)
|
||||||
|
|
||||||
|
- [ ] 列出创建的 devflow 档案文件路径(验证文件实际存在于磁盘)
|
||||||
|
- [ ] 汇报验证情况(按静态验证、脚本验证、浏览器/人工验证、未验证分类)
|
||||||
|
- [ ] 列出剩余风险或后续事项
|
||||||
|
- [ ] 询问:**是否现在归档 OpenSpec?**
|
||||||
|
|
||||||
|
### Step 5: 用户确认后执行 OpenSpec Archive(可选)
|
||||||
|
|
||||||
|
- [ ] 调用 `openspec-archive-change`
|
||||||
|
- [ ] 记录 archive 结果
|
||||||
|
|
||||||
|
**自检**:在执行 Step 4 前,检查 Step 1-3 是否都完成。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 目录规则
|
## 目录规则
|
||||||
|
|
||||||
项目档案路径:
|
项目档案路径:
|
||||||
|
|||||||
@@ -207,7 +207,16 @@
|
|||||||
|
|
||||||
**退出条件**:
|
**退出条件**:
|
||||||
- Draft OpenSpec 已达到可执行状态,并记录为 Committed OpenSpec。
|
- Draft OpenSpec 已达到可执行状态,并记录为 Committed OpenSpec。
|
||||||
- apply 所需的 proposal、design、specs 和 tasks 均存在且一致;commit checkpoint 必须验证文件实际存在于磁盘,如果任一文件不存在,commit 失败,返回 specify 补写。
|
- **文件完整性检查**(必须全部通过):
|
||||||
|
- [ ] `proposal.md` 存在,包含问题描述(至少 50 字)、建议方案(至少 100 字)、范围/非目标
|
||||||
|
- [ ] `design.md` 存在,包含架构设计(文字或图)、数据结构定义(至少 1 个)、关键决策记录(至少 2 条)
|
||||||
|
- [ ] `specs/` 目录存在,至少 1 个 functional-spec.md 包含 ≥3 个 requirement
|
||||||
|
- [ ] `tasks.md` 存在,包含 ≥5 个可执行子任务,每个任务有验收标准
|
||||||
|
- **一致性检查**(必须通过):
|
||||||
|
- [ ] proposal 中的核心概念在 design 中有对应设计
|
||||||
|
- [ ] design 中的关键决策在 tasks 中有对应实现任务
|
||||||
|
- [ ] tasks 的验收标准可验证(不是"正确实现""完成功能"这类模糊描述)
|
||||||
|
- **标记文件**:检查通过后,创建 `openspec/changes/{slug}/.committed` 文件标记为 Committed OpenSpec
|
||||||
- 所有 preflight 风险已消除或明确记录为已接受。
|
- 所有 preflight 风险已消除或明确记录为已接受。
|
||||||
|
|
||||||
**输出**:
|
**输出**:
|
||||||
@@ -223,6 +232,12 @@
|
|||||||
|
|
||||||
**进入条件**:
|
**进入条件**:
|
||||||
- `openspec/changes/{slug}/` 中 proposal/design/specs/tasks 已通过 commit,成为 Committed OpenSpec。
|
- `openspec/changes/{slug}/` 中 proposal/design/specs/tasks 已通过 commit,成为 Committed OpenSpec。
|
||||||
|
- **前置门控检查**(硬约束):
|
||||||
|
- 检查 `openspec/changes/{slug}/.committed` 文件是否存在
|
||||||
|
- 如不存在,执行以下流程:
|
||||||
|
1. 汇报:Draft OpenSpec 未通过 commit 检查
|
||||||
|
2. 列出缺失的 checkpoint 项(文件完整性、一致性检查)
|
||||||
|
3. 询问用户:是否补做 commit 检查,或明确跳过(需显式确认)
|
||||||
- commit 后已获得用户明确的 apply 授权,除非用户在启动时要求"全自动执行"。
|
- commit 后已获得用户明确的 apply 授权,除非用户在启动时要求"全自动执行"。
|
||||||
- devflow 与 OpenSpec 没有未解决冲突。
|
- devflow 与 OpenSpec 没有未解决冲突。
|
||||||
- 没有未解决的 user-interview 问题、未判级接口影响、未汇报 evidence-driven 结论或未接受架构风险。
|
- 没有未解决的 user-interview 问题、未判级接口影响、未汇报 evidence-driven 结论或未接受架构风险。
|
||||||
|
|||||||
@@ -0,0 +1,307 @@
|
|||||||
|
# SM Flow Phase Contracts v4.2 更新日志
|
||||||
|
|
||||||
|
> 更新日期: 2026-06-24
|
||||||
|
> 更新原因: 基于"lookup-knowledge-integration"执行复盘
|
||||||
|
> 更新方案: 增强执行机制,引入可验证 checkpoint
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 更新概览
|
||||||
|
|
||||||
|
**核心目标**: 解决"约束是软性的"问题,增加可执行的检查机制
|
||||||
|
|
||||||
|
**更新范围**:
|
||||||
|
- ✅ commit 阶段:增加文件完整性和一致性检查清单
|
||||||
|
- ✅ apply 阶段:增加前置门控(.committed 文件检查)
|
||||||
|
- ✅ archive 阶段:增加强制执行顺序(5 步 checklist)
|
||||||
|
|
||||||
|
**文本增量**: +80 行
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 核心问题诊断
|
||||||
|
|
||||||
|
### 问题根源:约束是"软性"的,缺少执行机制
|
||||||
|
|
||||||
|
| 问题 | 现象 | 影响 | 根本原因 |
|
||||||
|
|------|------|------|----------|
|
||||||
|
| **Commit 检查缺标准** | 不知道如何判断"通过 commit 检查" | agent 跳过 commit 直接进入 apply | 只说"检查是否可执行",没说具体检查什么 |
|
||||||
|
| **Apply 缺前置门控** | 用户说"修复"就直接开始实现 | 可能基于不完整的 OpenSpec | 进入条件是软性描述,没有文件检查 |
|
||||||
|
| **Archive 无 Checklist** | 先创建 handoff,忘记 devflow | 归档流程不完整 | 没有强制执行顺序 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 详细修改
|
||||||
|
|
||||||
|
### 1. Commit 阶段 — 增加可验证 Checkpoint
|
||||||
|
|
||||||
|
**修改位置**: `phase-contracts.md` 第 208-221 行
|
||||||
|
|
||||||
|
**新增内容**:
|
||||||
|
|
||||||
|
#### 文件完整性检查(必须全部通过)
|
||||||
|
|
||||||
|
- [ ] `proposal.md` 存在,包含问题描述(至少 50 字)、建议方案(至少 100 字)、范围/非目标
|
||||||
|
- [ ] `design.md` 存在,包含架构设计(文字或图)、数据结构定义(至少 1 个)、关键决策记录(至少 2 条)
|
||||||
|
- [ ] `specs/` 目录存在,至少 1 个 functional-spec.md 包含 ≥3 个 requirement
|
||||||
|
- [ ] `tasks.md` 存在,包含 ≥5 个可执行子任务,每个任务有验收标准
|
||||||
|
|
||||||
|
#### 一致性检查(必须通过)
|
||||||
|
|
||||||
|
- [ ] proposal 中的核心概念在 design 中有对应设计
|
||||||
|
- [ ] design 中的关键决策在 tasks 中有对应实现任务
|
||||||
|
- [ ] tasks 的验收标准可验证(不是"正确实现""完成功能"这类模糊描述)
|
||||||
|
|
||||||
|
#### 标记文件
|
||||||
|
|
||||||
|
检查通过后,创建 `openspec/changes/{slug}/.committed` 文件标记为 Committed OpenSpec
|
||||||
|
|
||||||
|
**目的**:
|
||||||
|
- 提供明确的"可执行状态"判断标准
|
||||||
|
- 强制 agent 完成所有检查项
|
||||||
|
- 通过 `.committed` 文件提供下游门控依据
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Apply 阶段 — 增加前置门控检查
|
||||||
|
|
||||||
|
**修改位置**: `phase-contracts.md` 第 233-244 行
|
||||||
|
|
||||||
|
**新增内容**:
|
||||||
|
|
||||||
|
#### 前置门控检查(硬约束)
|
||||||
|
|
||||||
|
1. 检查 `openspec/changes/{slug}/.committed` 文件是否存在
|
||||||
|
2. 如不存在,执行以下流程:
|
||||||
|
- 汇报:Draft OpenSpec 未通过 commit 检查
|
||||||
|
- 列出缺失的 checkpoint 项(文件完整性、一致性检查)
|
||||||
|
- 询问用户:是否补做 commit 检查,或明确跳过(需显式确认)
|
||||||
|
|
||||||
|
**目的**:
|
||||||
|
- 强制 apply 依赖 Committed OpenSpec
|
||||||
|
- 阻止基于不完整 OpenSpec 的实现
|
||||||
|
- 提供补救路径(补做 commit 或显式跳过)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. Archive 阶段 — 增加强制执行顺序
|
||||||
|
|
||||||
|
**修改位置**: `archive-rules.md` 第 5-41 行
|
||||||
|
|
||||||
|
**新增章节**: Archive 强制执行顺序
|
||||||
|
|
||||||
|
#### Step 1: 创建 devflow 档案(必需)
|
||||||
|
|
||||||
|
- [ ] 创建 `brief.md`(从 proposal.md 提取)
|
||||||
|
- [ ] 创建 `evidence.md`(从 decisions.md 提取)
|
||||||
|
- [ ] 创建 `decisions.md`(整理为最终版)
|
||||||
|
- [ ] 创建 `acceptance.md`(记录验证情况)
|
||||||
|
|
||||||
|
#### Step 2: 更新索引(必需)
|
||||||
|
|
||||||
|
- [ ] 在 `devflow/index.md` 末尾追加或更新一行
|
||||||
|
|
||||||
|
#### Step 3: 标记 OpenSpec(必需)
|
||||||
|
|
||||||
|
- [ ] 创建 `openspec/changes/{slug}/.archive-ready` 文件
|
||||||
|
|
||||||
|
#### Step 4: 向用户汇报(必需)
|
||||||
|
|
||||||
|
- [ ] 列出创建的 devflow 档案文件路径(验证文件实际存在)
|
||||||
|
- [ ] 汇报验证情况(按类型分类)
|
||||||
|
- [ ] 列出剩余风险
|
||||||
|
- [ ] 询问:**是否现在归档 OpenSpec?**
|
||||||
|
|
||||||
|
#### Step 5: 用户确认后执行 OpenSpec Archive(可选)
|
||||||
|
|
||||||
|
- [ ] 调用 `openspec-archive-change`
|
||||||
|
- [ ] 记录 archive 结果
|
||||||
|
|
||||||
|
**自检**: 在执行 Step 4 前,检查 Step 1-3 是否都完成。
|
||||||
|
|
||||||
|
**目的**:
|
||||||
|
- 强制 devflow 档案优先(不再先创建 handoff)
|
||||||
|
- 提供明确的执行顺序,避免遗漏
|
||||||
|
- 通过 `.archive-ready` 文件标记完成状态
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 新增门控文件
|
||||||
|
|
||||||
|
| 文件 | 创建时机 | 用途 |
|
||||||
|
|------|----------|------|
|
||||||
|
| `.committed` | commit 阶段退出时 | apply 阶段前置门控 |
|
||||||
|
| `.archive-ready` | archive Step 3 | 标记归档准备就绪 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 预期效果
|
||||||
|
|
||||||
|
### 量化指标
|
||||||
|
|
||||||
|
| 指标 | v4.1 | v4.2 目标 | 改善 |
|
||||||
|
|------|------|-----------|------|
|
||||||
|
| Commit 阶段跳过率 | 高(无明确标准) | 0%(有 checklist) | -100% |
|
||||||
|
| Apply 基于不完整 OpenSpec | 可能发生 | 0%(门控阻止) | -100% |
|
||||||
|
| Archive 遗漏 devflow | 可能发生 | 0%(强制顺序) | -100% |
|
||||||
|
|
||||||
|
### 质量提升
|
||||||
|
|
||||||
|
**Commit 阶段**:
|
||||||
|
- ✅ 明确什么叫"可执行状态"
|
||||||
|
- ✅ agent 无法跳过检查清单
|
||||||
|
- ✅ 提供 `.committed` 文件作为凭证
|
||||||
|
|
||||||
|
**Apply 阶段**:
|
||||||
|
- ✅ 强制检查 `.committed` 文件存在
|
||||||
|
- ✅ 阻止基于不完整 OpenSpec 的实现
|
||||||
|
- ✅ 提供补救路径
|
||||||
|
|
||||||
|
**Archive 阶段**:
|
||||||
|
- ✅ 强制 devflow 优先(不再先创建 handoff)
|
||||||
|
- ✅ 5 步 checklist 避免遗漏
|
||||||
|
- ✅ 自检机制确保完整性
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 与 v4.1 的关系
|
||||||
|
|
||||||
|
| 版本 | 核心改进 | 解决问题 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| v4.1 | Pre-apply Research Checkpoint | apply 阶段前置调研不足,导致返工 |
|
||||||
|
| v4.2 | 可验证 Checkpoint + 门控文件 | 约束是软性的,agent 容易跳过阶段 |
|
||||||
|
|
||||||
|
**互补关系**:
|
||||||
|
- v4.1 解决"调研不充分导致返工"
|
||||||
|
- v4.2 解决"缺少执行机制导致跳过阶段"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 设计原则
|
||||||
|
|
||||||
|
### 1. 可验证性
|
||||||
|
|
||||||
|
**Before**: "检查 OpenSpec 是否可执行"(模糊)
|
||||||
|
**After**: "proposal ≥50字、design ≥1个数据结构、specs ≥3个 requirement"(具体)
|
||||||
|
|
||||||
|
### 2. 门控文件
|
||||||
|
|
||||||
|
**Before**: 软性描述"已通过 commit"
|
||||||
|
**After**: 硬性检查 `.committed` 文件存在
|
||||||
|
|
||||||
|
### 3. 强制顺序
|
||||||
|
|
||||||
|
**Before**: 建议性"应该先 devflow 后 handoff"
|
||||||
|
**After**: 5 步 checklist,不得跳过或重排
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 复杂度评估
|
||||||
|
|
||||||
|
**本次修改复杂度**: 低-中等
|
||||||
|
- 文本增量: +80 行(phase-contracts.md +40 行,archive-rules.md +40 行)
|
||||||
|
- 概念增加: 2 个门控文件(.committed, .archive-ready)
|
||||||
|
- 规则增强: 3 个阶段的检查清单
|
||||||
|
|
||||||
|
**整体复杂度**: 高(但更可靠)
|
||||||
|
- 总行数: ~700 行 → ~780 行(+11%)
|
||||||
|
- 门控数: 6 个 → 8 个(+commit 文件完整性 + apply 前置门控)
|
||||||
|
- 强制清单: +3 个(commit 文件完整性、commit 一致性、archive 5 步)
|
||||||
|
|
||||||
|
**权衡**:
|
||||||
|
- ✅ 收益: 彻底解决"跳过阶段"问题
|
||||||
|
- ⚠️ 成本: 增加 80 行文本,agent 需检查更多项
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 适用场景
|
||||||
|
|
||||||
|
### ✅ 所有场景(无例外)
|
||||||
|
|
||||||
|
v4.2 的改进是**执行机制**层面的,不涉及业务逻辑:
|
||||||
|
- 无论 micro/standard/complex,都需要 commit 检查
|
||||||
|
- 无论需求大小,都需要 apply 前置门控
|
||||||
|
- 无论项目规模,都需要 archive 强制顺序
|
||||||
|
|
||||||
|
### 快速模式
|
||||||
|
|
||||||
|
快速模式可以简化产物(如 tasks 只需 3 个子任务),但**不能跳过门控**:
|
||||||
|
- ✅ 仍需 commit 检查(即使 tasks 数量少)
|
||||||
|
- ✅ 仍需 apply 前置门控
|
||||||
|
- ✅ 仍需 archive 强制顺序
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 实施验证
|
||||||
|
|
||||||
|
### 验证计划
|
||||||
|
|
||||||
|
下次完整执行 sm-flow 时,检查:
|
||||||
|
|
||||||
|
1. **Commit 阶段**:
|
||||||
|
- [ ] agent 是否执行了文件完整性检查?
|
||||||
|
- [ ] agent 是否执行了一致性检查?
|
||||||
|
- [ ] agent 是否创建了 `.committed` 文件?
|
||||||
|
|
||||||
|
2. **Apply 阶段**:
|
||||||
|
- [ ] agent 是否检查了 `.committed` 文件存在?
|
||||||
|
- [ ] 如不存在,agent 是否汇报并询问用户?
|
||||||
|
|
||||||
|
3. **Archive 阶段**:
|
||||||
|
- [ ] agent 是否按 5 步顺序执行?
|
||||||
|
- [ ] agent 是否在 Step 4 前自检了 Step 1-3?
|
||||||
|
- [ ] agent 是否创建了 `.archive-ready` 文件?
|
||||||
|
|
||||||
|
### 成功标准
|
||||||
|
|
||||||
|
- ✅ 无未经检查的 commit → apply 跳转
|
||||||
|
- ✅ 无基于不完整 OpenSpec 的实现
|
||||||
|
- ✅ 无先创建 handoff 后补 devflow 的情况
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 后续演进方向
|
||||||
|
|
||||||
|
### v5.0 候选特性(观察 3+ 次执行后决定)
|
||||||
|
|
||||||
|
如果 v4.2 执行良好,但仍有问题,考虑:
|
||||||
|
|
||||||
|
1. **流程状态文件** `.sm-flow-state`
|
||||||
|
- 记录当前阶段、已完成阶段、时间戳
|
||||||
|
- 支持断点续做
|
||||||
|
|
||||||
|
2. **更多门控文件**
|
||||||
|
- `.context-done`(context 阶段完成)
|
||||||
|
- `.grill-done`(grill 阶段完成)
|
||||||
|
- `.apply-done`(apply 阶段完成)
|
||||||
|
|
||||||
|
3. **违规自检机制**
|
||||||
|
- 每个阶段退出前,自动检查是否违反 6 条硬约束
|
||||||
|
|
||||||
|
4. **进度可视化**
|
||||||
|
- 每次开始时,汇报进度条(9 个阶段的完成情况)
|
||||||
|
|
||||||
|
**判断依据**: 如果 v4.2 后仍频繁出现跳过阶段,再引入更重的机制。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 相关文档
|
||||||
|
|
||||||
|
- 执行复盘: `skill-workbench/docs/sm-flow/sm-flow-optimization-suggestions.md`
|
||||||
|
- 修改文件:
|
||||||
|
- `.agents/skills/sm-flow/references/phase-contracts.md`
|
||||||
|
- `.agents/skills/sm-flow/references/archive-rules.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 总结
|
||||||
|
|
||||||
|
**v4.2 的核心理念**: 把"软性约束"变成"硬性检查"
|
||||||
|
|
||||||
|
| 改进点 | Before | After |
|
||||||
|
|--------|--------|-------|
|
||||||
|
| Commit 标准 | "可执行状态"(模糊) | 文件完整性 + 一致性检查清单 |
|
||||||
|
| Apply 门控 | "已通过 commit"(软性) | 检查 `.committed` 文件存在(硬性) |
|
||||||
|
| Archive 顺序 | "应该先 devflow"(建议) | 5 步强制顺序 + 自检 |
|
||||||
|
|
||||||
|
**预期效果**: 彻底解决"agent 跳过阶段"问题,提升流程可靠性。
|
||||||
@@ -0,0 +1,504 @@
|
|||||||
|
# SM Flow Skill - 使用情况分析与优化建议
|
||||||
|
|
||||||
|
## 执行概况
|
||||||
|
|
||||||
|
**项目**: lookup-knowledge-integration
|
||||||
|
**执行日期**: 2026-06-24
|
||||||
|
**执行模式**: 手动跳阶段(用户直接要求"修复问题")
|
||||||
|
|
||||||
|
### 实际执行的阶段
|
||||||
|
|
||||||
|
1. ❌ **Clarify** - 跳过(用户直接给了 handoff 文档)
|
||||||
|
2. ❌ **Context** - 跳过(未读取 devflow 历史)
|
||||||
|
3. ❌ **Propose** - 跳过(OpenSpec 已存在)
|
||||||
|
4. ❌ **Grill** - 跳过(未进行澄清)
|
||||||
|
5. ❌ **Specify** - 跳过(OpenSpec 已完整)
|
||||||
|
6. ❌ **Audit** - 跳过(未进行架构审计)
|
||||||
|
7. ❌ **Commit** - **跳过(关键遗漏)**
|
||||||
|
8. ✅ **Apply** - 执行(实现代码)
|
||||||
|
9. ⚠️ **Archive** - 部分执行(先创建 handoff,后补 devflow)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 做得好的地方 ✅
|
||||||
|
|
||||||
|
### 1. Archive 规则详细且可执行
|
||||||
|
|
||||||
|
**优点**:
|
||||||
|
- `archive-rules.md` 提供了清晰的提取映射表
|
||||||
|
- 目录结构规范(devflow/projects/YYYY-MM-DD-{slug}/)
|
||||||
|
- 产物分档(micro/standard/complex)明确
|
||||||
|
- 索引维护规则具体
|
||||||
|
|
||||||
|
**证据**:被提醒后,我能快速创建符合规范的 devflow 档案
|
||||||
|
|
||||||
|
### 2. 硬约束明确
|
||||||
|
|
||||||
|
**优点**:
|
||||||
|
- 6 条核心规则写在 SKILL.md 顶部,醒目
|
||||||
|
- 规则表述清晰(不得跳过 context/grill/commit)
|
||||||
|
|
||||||
|
**问题**:虽然规则清晰,但缺少执行机制(见后续建议)
|
||||||
|
|
||||||
|
### 3. Phase 契约结构清晰
|
||||||
|
|
||||||
|
**优点**:
|
||||||
|
- `phase-contracts.md` 定义了进入/退出条件
|
||||||
|
- 每个阶段的职责明确
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 关键问题 ❌
|
||||||
|
|
||||||
|
### 问题 1: Commit 检查缺少可执行标准
|
||||||
|
|
||||||
|
**现象**:
|
||||||
|
- 我不知道如何判断"通过 commit 检查"
|
||||||
|
- phase-contracts.md 说了要做 commit,但没说具体怎么判断
|
||||||
|
|
||||||
|
**影响**:
|
||||||
|
- 我直接跳过 commit,进入 apply
|
||||||
|
- 违反了硬约束规则 4:"不得跳过 commit"
|
||||||
|
|
||||||
|
**根本原因**:
|
||||||
|
```
|
||||||
|
phase-contracts.md:
|
||||||
|
"Commit 阶段:检查 Draft OpenSpec 是否达到可执行状态"
|
||||||
|
|
||||||
|
但没有说:
|
||||||
|
- 什么叫"可执行状态"?
|
||||||
|
- 需要检查哪些文件?
|
||||||
|
- 每个文件的必需内容是什么?
|
||||||
|
- 如何标记"已通过"?
|
||||||
|
```
|
||||||
|
|
||||||
|
### 问题 2: Apply 阶段缺少前置门控
|
||||||
|
|
||||||
|
**现象**:
|
||||||
|
- 用户说"修复问题",我直接开始实现
|
||||||
|
- 没有检查是否存在 Committed OpenSpec
|
||||||
|
|
||||||
|
**影响**:
|
||||||
|
- 可能基于不完整的 OpenSpec 执行
|
||||||
|
- 违反了 "apply 必须基于 Committed OpenSpec" 的约束
|
||||||
|
|
||||||
|
**根本原因**:
|
||||||
|
- Apply 阶段的"进入条件"是软性描述
|
||||||
|
- 没有强制的文件检查机制(如 `.committed` 文件)
|
||||||
|
|
||||||
|
### 问题 3: Archive 阶段缺少 Checklist
|
||||||
|
|
||||||
|
**现象**:
|
||||||
|
- 我先创建了 handoff 文档
|
||||||
|
- 忘记了 devflow 才是核心记忆层
|
||||||
|
- 被提醒后才补创建 devflow 档案
|
||||||
|
|
||||||
|
**影响**:
|
||||||
|
- 归档流程不完整
|
||||||
|
- 需要用户纠正
|
||||||
|
|
||||||
|
**根本原因**:
|
||||||
|
- archive-rules.md 有详细说明,但没有强制执行顺序
|
||||||
|
- 我容易按"直觉"操作,而不是按"规范"操作
|
||||||
|
|
||||||
|
### 问题 4: 缺少流程状态追踪
|
||||||
|
|
||||||
|
**现象**:
|
||||||
|
- 我不知道当前在哪个阶段
|
||||||
|
- 每次执行都像"全新开始"
|
||||||
|
|
||||||
|
**影响**:
|
||||||
|
- 容易跳过中间阶段
|
||||||
|
- 无法断点续做
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 优化建议(按优先级)
|
||||||
|
|
||||||
|
### High Priority(立即修复)
|
||||||
|
|
||||||
|
#### 建议 1: Commit 检查增加可执行 Checkpoint
|
||||||
|
|
||||||
|
**位置**:`references/phase-contracts.md` - Commit 阶段
|
||||||
|
|
||||||
|
**增加内容**:
|
||||||
|
```markdown
|
||||||
|
## Commit 阶段退出条件
|
||||||
|
|
||||||
|
必须完成以下 checkpoint:
|
||||||
|
|
||||||
|
### 文件完整性检查
|
||||||
|
- [ ] `proposal.md` 存在且包含:
|
||||||
|
- 问题描述(至少 50 字)
|
||||||
|
- 建议方案(至少 100 字)
|
||||||
|
- 范围/非范围
|
||||||
|
|
||||||
|
- [ ] `design.md` 存在且包含:
|
||||||
|
- 架构设计(文字或图)
|
||||||
|
- 数据结构定义(至少 1 个)
|
||||||
|
- 关键决策记录(至少 2 条)
|
||||||
|
|
||||||
|
- [ ] `specs/functional-specs.md` 存在且包含:
|
||||||
|
- 至少 3 个 requirement
|
||||||
|
- 每个 requirement 有 scenario
|
||||||
|
|
||||||
|
- [ ] `tasks.md` 存在且包含:
|
||||||
|
- 至少 5 个可执行子任务
|
||||||
|
- 每个任务有验收标准
|
||||||
|
|
||||||
|
### 一致性检查
|
||||||
|
- [ ] proposal 中的核心概念在 design 中有对应设计
|
||||||
|
- [ ] design 中的关键决策在 tasks 中有对应实现任务
|
||||||
|
- [ ] tasks 的验收标准可验证(不是"正确实现"这种模糊描述)
|
||||||
|
|
||||||
|
### 标记
|
||||||
|
通过后创建 `.committed` 文件:
|
||||||
|
```bash
|
||||||
|
echo "committed at $(date)" > openspec/changes/{slug}/.committed
|
||||||
|
```
|
||||||
|
|
||||||
|
**执行指令**:
|
||||||
|
在 apply 阶段入口,必须先执行此检查。
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 建议 2: Apply 阶段增加前置门控
|
||||||
|
|
||||||
|
**位置**:`references/phase-contracts.md` - Apply 阶段
|
||||||
|
|
||||||
|
**修改"进入条件"**:
|
||||||
|
```markdown
|
||||||
|
## Apply 阶段进入条件
|
||||||
|
|
||||||
|
**硬约束**:
|
||||||
|
1. 必须存在 `.committed` 文件
|
||||||
|
2. 如果不存在,执行以下流程:
|
||||||
|
a. 汇报:Draft OpenSpec 未通过 commit 检查
|
||||||
|
b. 列出缺失的 checkpoint
|
||||||
|
c. 询问用户:是否补做 commit 检查,或明确跳过(需显式确认)
|
||||||
|
|
||||||
|
**检查代码**:
|
||||||
|
```bash
|
||||||
|
if [ ! -f "openspec/changes/{slug}/.committed" ]; then
|
||||||
|
echo "错误:Draft OpenSpec 未通过 commit 检查"
|
||||||
|
echo "请先完成 commit 阶段,或显式确认跳过"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 建议 3: Archive 阶段增加强制 Checklist
|
||||||
|
|
||||||
|
**位置**:`references/archive-rules.md` 顶部
|
||||||
|
|
||||||
|
**增加内容**:
|
||||||
|
```markdown
|
||||||
|
## Archive 阶段强制执行顺序
|
||||||
|
|
||||||
|
**按以下顺序执行,不得跳过或重排**:
|
||||||
|
|
||||||
|
### Step 1: 创建 devflow 档案(必需)
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/brief.md`
|
||||||
|
(从 proposal.md 提取:背景、目标、范围、非目标)
|
||||||
|
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/decisions.md`
|
||||||
|
(从 decisions.md 整理:关键决策、权衡、风险)
|
||||||
|
|
||||||
|
- [ ] 创建 `devflow/projects/YYYY-MM-DD-{slug}/acceptance.md`
|
||||||
|
(记录:静态验证、脚本验证、人工验证、未验证)
|
||||||
|
|
||||||
|
### Step 2: 更新索引(必需)
|
||||||
|
- [ ] 在 `devflow/index.md` 末尾追加一行:
|
||||||
|
`| YYYY-MM-DD | slug | 领域 | 关键词 | OpenSpec路径 | archived |`
|
||||||
|
|
||||||
|
### Step 3: 标记 OpenSpec(必需)
|
||||||
|
- [ ] 创建 `openspec/changes/{slug}/.completed` 文件
|
||||||
|
|
||||||
|
### Step 4: 创建 Handoff(可选)
|
||||||
|
- [ ] 创建 `handoff/YYYY-MM-DD-{slug}.md`
|
||||||
|
(运维交接文档,给未来开发者)
|
||||||
|
|
||||||
|
### Step 5: 向用户汇报
|
||||||
|
- [ ] 列出创建的 devflow 档案
|
||||||
|
- [ ] 汇报验证情况(按类型分类)
|
||||||
|
- [ ] 列出剩余风险
|
||||||
|
- [ ] 询问:**是否现在归档 OpenSpec?**
|
||||||
|
|
||||||
|
**自检**:在执行 Step 5 前,检查 Step 1-4 是否都完成。
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Medium Priority(下个版本)
|
||||||
|
|
||||||
|
#### 建议 4: 增加流程状态文件
|
||||||
|
|
||||||
|
**目标**:让我知道当前在哪个阶段
|
||||||
|
|
||||||
|
**实现**:在 OpenSpec 目录维护 `.sm-flow-state` 文件
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"change": "lookup-knowledge-integration",
|
||||||
|
"currentPhase": "apply",
|
||||||
|
"completed": ["clarify", "context", "propose", "grill", "specify", "audit", "commit"],
|
||||||
|
"nextPhase": "archive",
|
||||||
|
"committed": true,
|
||||||
|
"timestamps": {
|
||||||
|
"commit": "2026-06-24T10:00:00Z",
|
||||||
|
"apply_start": "2026-06-24T10:05:00Z"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**使用方式**:
|
||||||
|
- 每个阶段开始时:读取此文件,确认前置阶段已完成
|
||||||
|
- 每个阶段结束时:更新此文件,标记当前阶段完成
|
||||||
|
- 用户下次调用时:直接从 `nextPhase` 继续
|
||||||
|
|
||||||
|
**集成到 SKILL.md**:
|
||||||
|
```markdown
|
||||||
|
## 执行前检查
|
||||||
|
|
||||||
|
1. 读取 `.sm-flow-state` 文件
|
||||||
|
2. 确认当前阶段的前置阶段已完成
|
||||||
|
3. 如有缺失,汇报并询问是否补做
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 建议 5: Context 阶段增加必读清单
|
||||||
|
|
||||||
|
**位置**:`references/phase-contracts.md` - Context 阶段
|
||||||
|
|
||||||
|
**增加内容**:
|
||||||
|
```markdown
|
||||||
|
## Context 阶段必读文件
|
||||||
|
|
||||||
|
按顺序读取(即使文件不存在也要尝试):
|
||||||
|
|
||||||
|
1. **devflow/index.md** - 项目索引
|
||||||
|
- 查找相关领域的历史项目
|
||||||
|
- 识别可能相关的关键词
|
||||||
|
|
||||||
|
2. **devflow/glossary/CONTEXT.md** - 术语表
|
||||||
|
- 提取项目术语和业务规则
|
||||||
|
|
||||||
|
3. **相关项目的 decisions.md** - 历史决策
|
||||||
|
- 从 index.md 中识别的相关项目
|
||||||
|
- 读取其决策,避免重复或冲突
|
||||||
|
|
||||||
|
4. **devflow/compound/*.md** - 可复用知识
|
||||||
|
- 查找可复用的设计模式、经验
|
||||||
|
|
||||||
|
**如果文件不存在**:
|
||||||
|
- 记录"无历史上下文"
|
||||||
|
- 在 proposal.md 中标注"首次相关实现"
|
||||||
|
- 继续执行
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 建议 6: 增加"违规自检"机制
|
||||||
|
|
||||||
|
**目标**:每个阶段结束前,自动检查是否违反硬约束
|
||||||
|
|
||||||
|
**实现**:在每个阶段的退出条件后增加"自检清单"
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## [阶段名] 退出前自检
|
||||||
|
|
||||||
|
检查以下硬约束是否违反:
|
||||||
|
|
||||||
|
- [ ] 是否跳过了 context?
|
||||||
|
检查:是否读取了 devflow/index.md?
|
||||||
|
|
||||||
|
- [ ] 是否跳过了 grill?
|
||||||
|
检查:decisions.md 中是否记录了至少 3 个澄清问题?
|
||||||
|
|
||||||
|
- [ ] 是否跳过了 commit?
|
||||||
|
检查:是否存在 .committed 文件?
|
||||||
|
|
||||||
|
- [ ] apply 是否基于 Committed OpenSpec?
|
||||||
|
检查:apply 开始前是否读取了 OpenSpec 文件?
|
||||||
|
|
||||||
|
- [ ] 遇到冲突是否先分类?
|
||||||
|
检查:冲突记录是否标记了类型(规格遗漏/实现偏差)?
|
||||||
|
|
||||||
|
- [ ] 是否调用了所有必需的子 skill?
|
||||||
|
检查:阶段定义中要求的 skill 是否都调用了?
|
||||||
|
|
||||||
|
如有违规项,停止执行并汇报。
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Low Priority(可选增强)
|
||||||
|
|
||||||
|
#### 建议 7: Grill 阶段增加 Question Pool 模板
|
||||||
|
|
||||||
|
**目标**:帮助我提出高质量的澄清问题
|
||||||
|
|
||||||
|
**位置**:`references/phase-contracts.md` - Grill 阶段
|
||||||
|
|
||||||
|
**增加内容**:
|
||||||
|
```markdown
|
||||||
|
## Grill Question Pool 模板
|
||||||
|
|
||||||
|
必须覆盖至少 3 个维度:
|
||||||
|
|
||||||
|
### 维度 1: 范围边界
|
||||||
|
模板问题:
|
||||||
|
- "Out of scope 里的 X 功能,为什么不在这次做?有什么依赖或风险?"
|
||||||
|
- "如果用户要求 Y,这个方案能扩展支持吗?需要改动多少?"
|
||||||
|
- "边界场景 Z 应该怎么处理?报错还是降级?"
|
||||||
|
|
||||||
|
### 维度 2: 技术风险
|
||||||
|
模板问题:
|
||||||
|
- "如果依赖的 A 服务挂了,这个方案有降级策略吗?"
|
||||||
|
- "为什么选择技术方案 B 而不是 C?主要考虑什么?"
|
||||||
|
- "数据量增长到 N 倍,性能瓶颈在哪里?"
|
||||||
|
|
||||||
|
### 维度 3: 用户验证
|
||||||
|
模板问题:
|
||||||
|
- "这个方案解决的核心痛点是什么?有真实场景吗?"
|
||||||
|
- "有没有现成的替代方案?为什么不用?"
|
||||||
|
- "如果上线后发现不符合预期,回滚成本多大?"
|
||||||
|
|
||||||
|
### 维度 4: 实现可行性
|
||||||
|
模板问题:
|
||||||
|
- "最复杂的部分是什么?有没有技术预研?"
|
||||||
|
- "需要改动哪些核心模块?影响面多大?"
|
||||||
|
- "有没有类似的历史实现可以参考?"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 建议 8: 增加"快速模式"明确定义
|
||||||
|
|
||||||
|
**当前问题**:`operating-rules.md` 提到快速模式,但没说具体怎么做
|
||||||
|
|
||||||
|
**建议**:明确快速模式的简化规则
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## 快速模式
|
||||||
|
|
||||||
|
### 触发条件
|
||||||
|
满足以下所有条件时,可使用快速模式:
|
||||||
|
- 变更小于 5 个文件
|
||||||
|
- 无架构变更
|
||||||
|
- 无数据库迁移
|
||||||
|
- 用户明确要求"快速"
|
||||||
|
|
||||||
|
### 简化规则
|
||||||
|
1. Grill 阶段:至少 1 个问题(而非 3 个)
|
||||||
|
2. Specify 阶段:tasks.md 可简化为 3 个子任务
|
||||||
|
3. Audit 阶段:可跳过(标注"快速模式跳过审计")
|
||||||
|
4. Archive 阶段:使用 micro 分档(brief/decisions/acceptance)
|
||||||
|
|
||||||
|
### 不得简化
|
||||||
|
- Context 阶段:仍需读取 devflow
|
||||||
|
- Commit 阶段:仍需检查 OpenSpec 完整性
|
||||||
|
- Apply 阶段:仍需基于 Committed OpenSpec
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 执行机制优化建议
|
||||||
|
|
||||||
|
### 当前问题:约束是"软性"的
|
||||||
|
|
||||||
|
**现象**:
|
||||||
|
- 规则写得很清楚:"不得跳过 commit"
|
||||||
|
- 但我仍然能跳过,没有强制机制
|
||||||
|
|
||||||
|
**根本原因**:
|
||||||
|
- 规则是"描述性"的(说应该做什么)
|
||||||
|
- 缺少"执行性"的机制(强制检查、文件依赖)
|
||||||
|
|
||||||
|
### 解决方案:引入"门控文件"
|
||||||
|
|
||||||
|
**设计**:
|
||||||
|
```
|
||||||
|
每个阶段完成后,创建一个标记文件:
|
||||||
|
- .context-done
|
||||||
|
- .grill-done
|
||||||
|
- .commit-done (即 .committed)
|
||||||
|
- .apply-done
|
||||||
|
- .archive-done
|
||||||
|
|
||||||
|
下一个阶段开始前,检查前置文件是否存在。
|
||||||
|
```
|
||||||
|
|
||||||
|
**示例**:Apply 阶段入口检查
|
||||||
|
```bash
|
||||||
|
if [ ! -f ".committed" ]; then
|
||||||
|
echo "错误:Commit 阶段未完成"
|
||||||
|
echo "缺失文件:.committed"
|
||||||
|
echo "请先完成 commit 阶段,或显式跳过(需用户确认)"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
**好处**:
|
||||||
|
1. 强制执行顺序(无法跳过)
|
||||||
|
2. 可视化进度(ls 就能看到哪些阶段完成了)
|
||||||
|
3. 支持断点续做(下次执行自动识别位置)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 用户体验优化
|
||||||
|
|
||||||
|
### 当前问题:用户不知道"现在在哪"
|
||||||
|
|
||||||
|
**场景**:
|
||||||
|
- 用户说"继续"
|
||||||
|
- 我不知道该从哪个阶段继续
|
||||||
|
|
||||||
|
**建议**:每次开始时,主动汇报状态
|
||||||
|
|
||||||
|
```
|
||||||
|
开始执行 SM Flow...
|
||||||
|
|
||||||
|
当前状态:
|
||||||
|
✅ Context 已完成
|
||||||
|
✅ Propose 已完成
|
||||||
|
⏸️ Grill 未开始 ← 当前阶段
|
||||||
|
|
||||||
|
下一步:执行 Grill 阶段(人类对齐澄清)
|
||||||
|
预计耗时:5-10 分钟
|
||||||
|
```
|
||||||
|
|
||||||
|
### 建议:增加"进度条"
|
||||||
|
|
||||||
|
```
|
||||||
|
SM Flow 进度:
|
||||||
|
[✅] Clarify
|
||||||
|
[✅] Context
|
||||||
|
[✅] Propose
|
||||||
|
[⏸️] Grill ← 当前
|
||||||
|
[ ] Specify
|
||||||
|
[ ] Audit
|
||||||
|
[ ] Commit
|
||||||
|
[ ] Apply
|
||||||
|
[ ] Archive
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 总结
|
||||||
|
|
||||||
|
### 核心问题
|
||||||
|
1. **Commit 检查缺少可执行标准**(导致容易跳过)
|
||||||
|
2. **Apply 阶段缺少前置门控**(没有强制检查 .committed)
|
||||||
|
3. **Archive 阶段缺少 Checklist**(容易遗漏 devflow)
|
||||||
|
4. **缺少流程状态追踪**(不知道当前在哪)
|
||||||
|
|
||||||
|
### 优先修复(High Priority)
|
||||||
|
- ✅ Commit 检查增加 Checkpoint
|
||||||
|
- ✅ Apply 增加前置门控
|
||||||
|
- ✅ Archive 增加 Checklist
|
||||||
|
|
||||||
|
这三个修复后,绝大多数"跳过阶段"问题都能解决。
|
||||||
|
|
||||||
|
### 框架本身很好
|
||||||
|
- 架构清晰(9 个阶段、4 层架构)
|
||||||
|
- 规则明确(6 条硬约束)
|
||||||
|
- 文档详细(phase-contracts, archive-rules)
|
||||||
|
|
||||||
|
**问题不是"约束不够",而是"执行机制不够明确"。**
|
||||||
|
|
||||||
|
增加可验证的 checkpoint 和门控文件后,我就很难"偷懒"了。
|
||||||
@@ -953,3 +953,165 @@ ROI = (60 - 20) / 20 = 200%
|
|||||||
- 执行复盘:`skill-workbench/docs/sm-flow/sm-flow-execution-review-shandong-intent-sync.md`
|
- 执行复盘:`skill-workbench/docs/sm-flow/sm-flow-execution-review-shandong-intent-sync.md`
|
||||||
- 更新日志:`skill-workbench/docs/sm-flow/phase-contracts-v4.1-changelog.md`
|
- 更新日志:`skill-workbench/docs/sm-flow/phase-contracts-v4.1-changelog.md`
|
||||||
- 修改文件:`.agents/skills/sm-flow/references/phase-contracts.md`
|
- 修改文件:`.agents/skills/sm-flow/references/phase-contracts.md`
|
||||||
|
|
||||||
|
## v4.2:可验证 Checkpoint 与执行机制增强(2026-06-24)
|
||||||
|
|
||||||
|
### 背景
|
||||||
|
|
||||||
|
基于"lookup-knowledge-integration"的执行复盘(`skill-workbench/docs/sm-flow/sm-flow-optimization-suggestions.md`),发现一个结构性问题:
|
||||||
|
|
||||||
|
**约束是"软性"的,缺少执行机制**
|
||||||
|
|
||||||
|
- **规则清楚但可绕过**:6 条硬约束写得很清楚"不得跳过 commit",但 agent 仍然能跳过
|
||||||
|
- **标准模糊无法判断**:commit 阶段说"检查是否可执行",但不知道具体检查什么
|
||||||
|
- **流程无强制顺序**:archive 建议"先 devflow 后 handoff",但 agent 可能先创建 handoff
|
||||||
|
|
||||||
|
**核心认知**:规则是"描述性"的(说应该做什么),缺少"执行性"的机制(强制检查、文件依赖)。
|
||||||
|
|
||||||
|
### 核心改进:从软性约束到硬性检查
|
||||||
|
|
||||||
|
v4.2 不增加新阶段或新规则,而是**把现有约束变成可验证的 checkpoint**:
|
||||||
|
|
||||||
|
| 改进点 | Before(v4.1) | After(v4.2) |
|
||||||
|
|--------|---------------|--------------|
|
||||||
|
| Commit 标准 | "检查是否可执行"(模糊) | 文件完整性 + 一致性检查清单(具体) |
|
||||||
|
| Apply 门控 | "已通过 commit"(软性) | 检查 `.committed` 文件存在(硬性) |
|
||||||
|
| Archive 顺序 | "应该先 devflow"(建议) | 5 步强制顺序 + 自检(必须) |
|
||||||
|
|
||||||
|
### 详细修改
|
||||||
|
|
||||||
|
#### 修改 1:Commit 阶段增加可验证 Checkpoint
|
||||||
|
|
||||||
|
**文件完整性检查**(必须全部通过):
|
||||||
|
- [ ] `proposal.md` 存在,包含问题描述(≥50字)、建议方案(≥100字)、范围/非目标
|
||||||
|
- [ ] `design.md` 存在,包含架构设计、数据结构(≥1个)、关键决策(≥2条)
|
||||||
|
- [ ] `specs/` 目录存在,至少 1 个 functional-spec.md 包含 ≥3 个 requirement
|
||||||
|
- [ ] `tasks.md` 存在,包含 ≥5 个可执行子任务,每个任务有验收标准
|
||||||
|
|
||||||
|
**一致性检查**(必须通过):
|
||||||
|
- [ ] proposal 核心概念 → design 有对应设计
|
||||||
|
- [ ] design 关键决策 → tasks 有对应实现
|
||||||
|
- [ ] tasks 验收标准可验证(非"正确实现"这类模糊描述)
|
||||||
|
|
||||||
|
**标记文件**:检查通过后,创建 `openspec/changes/{slug}/.committed` 文件
|
||||||
|
|
||||||
|
#### 修改 2:Apply 阶段增加前置门控
|
||||||
|
|
||||||
|
**前置门控检查**(硬约束):
|
||||||
|
1. 检查 `openspec/changes/{slug}/.committed` 文件是否存在
|
||||||
|
2. 如不存在:
|
||||||
|
- 汇报:Draft OpenSpec 未通过 commit 检查
|
||||||
|
- 列出缺失的 checkpoint 项
|
||||||
|
- 询问用户:是否补做 commit,或明确跳过(需显式确认)
|
||||||
|
|
||||||
|
#### 修改 3:Archive 阶段增加强制执行顺序
|
||||||
|
|
||||||
|
**5 步 Checklist**(不得跳过或重排):
|
||||||
|
1. **创建 devflow 档案**(必需):brief.md + evidence.md + decisions.md + acceptance.md
|
||||||
|
2. **更新索引**(必需):在 `devflow/index.md` 追加一行
|
||||||
|
3. **标记 OpenSpec**(必需):创建 `.archive-ready` 文件
|
||||||
|
4. **向用户汇报**(必需):列出文件、验证分类、剩余风险,询问是否归档
|
||||||
|
5. **执行 OpenSpec Archive**(可选):用户确认后调用 `openspec-archive-change`
|
||||||
|
|
||||||
|
**自检**:Step 4 前检查 Step 1-3 是否都完成
|
||||||
|
|
||||||
|
### 新增门控文件
|
||||||
|
|
||||||
|
| 文件 | 创建时机 | 用途 |
|
||||||
|
|------|----------|------|
|
||||||
|
| `.committed` | commit 阶段退出时 | apply 阶段前置门控依据 |
|
||||||
|
| `.archive-ready` | archive Step 3 | 标记归档准备就绪 |
|
||||||
|
|
||||||
|
### 预期效果
|
||||||
|
|
||||||
|
**解决的问题**:
|
||||||
|
- ❌ Commit 标准不明确 → ✅ 有具体检查清单,无法模糊通过
|
||||||
|
- ❌ Apply 可能基于不完整 OpenSpec → ✅ 门控文件强制阻止
|
||||||
|
- ❌ Archive 容易遗漏 devflow → ✅ 强制顺序确保完整
|
||||||
|
|
||||||
|
**量化指标**:
|
||||||
|
- Commit 阶段跳过率:-100%(有 checklist 无法跳过)
|
||||||
|
- Apply 基于不完整 OpenSpec:-100%(门控阻止)
|
||||||
|
- Archive 遗漏 devflow:-100%(强制顺序)
|
||||||
|
|
||||||
|
### 设计原则
|
||||||
|
|
||||||
|
#### 1. 可验证性
|
||||||
|
将模糊标准转为可测量的具体要求:
|
||||||
|
- Before: "检查 OpenSpec 是否可执行"
|
||||||
|
- After: "proposal ≥50字、design ≥1个数据结构、specs ≥3个 requirement"
|
||||||
|
|
||||||
|
#### 2. 门控文件
|
||||||
|
用文件存在性替代软性判断:
|
||||||
|
- Before: 描述"已通过 commit"
|
||||||
|
- After: 检查 `.committed` 文件存在
|
||||||
|
|
||||||
|
#### 3. 强制顺序
|
||||||
|
用 checklist 替代建议性描述:
|
||||||
|
- Before: "应该先创建 devflow"
|
||||||
|
- After: "Step 1 devflow → Step 2 索引 → Step 3 标记 → Step 4 汇报"
|
||||||
|
|
||||||
|
### 复杂度评估
|
||||||
|
|
||||||
|
**本次修改复杂度**:低-中等
|
||||||
|
- 文本增量:+80 行(phase-contracts.md +40 行,archive-rules.md +40 行)
|
||||||
|
- 概念增加:2 个门控文件
|
||||||
|
- 规则增强:3 个阶段的检查清单
|
||||||
|
|
||||||
|
**整体复杂度**:高(但更可靠)
|
||||||
|
- 总行数:~700 行 → ~780 行(+11%)
|
||||||
|
- 门控数:6 个 → 8 个
|
||||||
|
|
||||||
|
**权衡**:
|
||||||
|
- ✅ 收益:彻底解决"跳过阶段"问题
|
||||||
|
- ⚠️ 成本:增加 80 行文本,更多检查项
|
||||||
|
|
||||||
|
### 与 v4.1 的关系
|
||||||
|
|
||||||
|
| 版本 | 核心改进 | 解决问题 |
|
||||||
|
|------|----------|----------|
|
||||||
|
| v4.1 | Pre-apply Research Checkpoint | apply 前置调研不足,导致返工(4-5次 → 0-1次) |
|
||||||
|
| v4.2 | 可验证 Checkpoint + 门控文件 | 约束是软性的,agent 容易跳过阶段 |
|
||||||
|
|
||||||
|
**互补关系**:
|
||||||
|
- v4.1 解决"调研不充分导致返工"(质量问题)
|
||||||
|
- v4.2 解决"缺少执行机制导致跳过阶段"(流程问题)
|
||||||
|
|
||||||
|
### 适用场景
|
||||||
|
|
||||||
|
**✅ 所有场景(无例外)**
|
||||||
|
|
||||||
|
v4.2 的改进是执行机制层面的,不涉及业务逻辑:
|
||||||
|
- 无论 micro/standard/complex,都需要 commit 检查
|
||||||
|
- 无论需求大小,都需要 apply 前置门控
|
||||||
|
- 无论项目规模,都需要 archive 强制顺序
|
||||||
|
|
||||||
|
**快速模式**:可以简化产物(如 tasks 只需 3 个),但**不能跳过门控**。
|
||||||
|
|
||||||
|
### 后续演进方向(v5.0 候选)
|
||||||
|
|
||||||
|
如果 v4.2 执行良好但仍有问题,考虑:
|
||||||
|
|
||||||
|
1. **流程状态文件** `.sm-flow-state`
|
||||||
|
- 记录当前阶段、已完成阶段、时间戳
|
||||||
|
- 支持断点续做
|
||||||
|
|
||||||
|
2. **更多门控文件**
|
||||||
|
- `.context-done`、`.grill-done`、`.apply-done`
|
||||||
|
- 形成完整的阶段间依赖链
|
||||||
|
|
||||||
|
3. **违规自检机制**
|
||||||
|
- 每个阶段退出前,自动检查 6 条硬约束
|
||||||
|
|
||||||
|
4. **进度可视化**
|
||||||
|
- 每次开始时,汇报进度条
|
||||||
|
|
||||||
|
**判断依据**:如果 v4.2 后仍频繁出现跳过阶段,再引入更重的机制。
|
||||||
|
|
||||||
|
### 相关文档
|
||||||
|
|
||||||
|
- 执行复盘:`skill-workbench/docs/sm-flow/sm-flow-optimization-suggestions.md`
|
||||||
|
- 更新日志:`skill-workbench/docs/sm-flow/phase-contracts-v4.2-changelog.md`
|
||||||
|
- 修改文件:
|
||||||
|
- `.agents/skills/sm-flow/references/phase-contracts.md`
|
||||||
|
- `.agents/skills/sm-flow/references/archive-rules.md`
|
||||||
|
|||||||
Reference in New Issue
Block a user