--- name: cs-feat-accept description: feature 流程阶段 3——验收闭环:对照 design 核实现 + 回写 architecture / requirement / roadmap,最后产出 {slug}-acceptance.md。触发:用户说"功能写完了验收一下"、"做最后检查"、"准备 merge"、"出验收报告"。前置依赖 cs-feat-impl 完成。 --- # cs-feat-accept ## 启动必读 开始任何判断或动作前,先读取 `.codestable/attention.md`;缺失则视为骨架不完整,提示先补齐或运行 `cs-onboard`,不要回退到外部 AI 入口文件。 代码已经写完,但流程没结束。本阶段做四件事,缺一不可: 1. **核对实现有没有偏离方案**——逐层对照 `{slug}-design.md`,发现偏差当场修,**不是在报告里"记一下"**就过去 2. **把 feature 归并到整体架构**——对照方案第 4 节,实际去更新架构中心目录下的相关 doc 3. **能力落档到 requirement**——draft req 对应的能力实现完成后升级为 current(保留愿景,追加变更日志);从未写过 req 的能力 backfill 4. **完成状态回写到 roadmap**——方案 frontmatter 有 `roadmap` / `roadmap_item` 字段时**必须**改 items.yaml 对应条目为 `done` 并同步主文档 漏掉任何一件的代价:架构 doc 过期下个 feature 读到错信息;req 和实际能力脱节;roadmap 规划层和实际进度脱节,下次推进会重复跑流程。 **没产出报告 = 工作流未完成**。后人查"上次这个功能验收时确认了哪些行为",没报告就只能翻 git diff 重新推断。 > 共享路径与命名约定看 `.codestable/reference/shared-conventions.md` 第 0 节。 --- ## 跟 design 的章节强依赖 本技能整套对照表按 design 当前章节编号硬编码。**design 升级章节名 / 编号时本技能必须同步**,否则下面所有"第 X 节"指针都指错地方。 **标准 design 章节快照**: - 第 0 节:术语约定 - 第 1 节:决策与约束(需求摘要 / 复杂度档位 / 关键决策 / 前置依赖) - 第 2 节:名词与编排(2.1 名词层 / 2.2 编排层 / 2.3 挂载点 / 2.4 推进策略) - 第 3 节:验收契约(关键场景清单 + 反向核对项) - 第 4 节:与项目级架构文档的关系 **Fastforward design**:第 0 需求摘要 / 第 1 设计方案 / 第 2 验收标准 / 第 3 推进步骤 --- ## 启动检查 1. **代码确实实现到位**——git status / 最近提交看到本功能改动,否则退回 implement 2. **方案 doc 完整**——frontmatter `doc_type=feature-design` / `feature` 一致 / `status=approved` / `summary` 非空 / `tags` ≥ 2;标准 design 第 0/1/2/3 节 + 第 4 节已填写 3. **`{slug}-checklist.yaml`**——存在且 `feature` 一致;`steps` 全 `done`(有 `pending` 退回 implement);`checks` 非空全 `pending` 4. **上下文读全**——方案 doc 全文(重点:第 1 节明确不做、2.1 接口示例、2.2 流程级约束、2.3 挂载点、第 3 节场景)+ checklist + 第 4 节提到的所有架构 doc + 本次代码改动(git log / diff) 5. **断点恢复**——`{slug}-acceptance.md` 已存在且部分填好 → 从下一个未完成节继续,跳过 checks 中已 `passed` 的项;汇报"上次做到第 X 节,从第 Y 节继续" **Fastforward design 验收报告映射表**: | 验收报告节 | 标准 design 对照 | Fastforward design 对照 | |---|---|---| | 1 接口契约核对 | 第 2.1 接口示例 | 第 1 节改动点 | | 2 行为与决策核对(含挂载点) | 第 1 节 + 第 2.2 + 第 2.3 | 第 0 节;挂载点现场盘点 | | 3 验收场景核对 | 第 3 节场景清单 + 反向核对 | 第 2 节验收标准 | | 4 术语一致性 | 第 0 节 + 第 2.1 命名 | 检查代码命名一致性 | | 5 架构归并 | 第 4 节 | 通常无;写"无架构维度变更" | --- ## 验收报告模板 逐节填写**别跳节**。报告路径在 feature 目录下(位置看 `shared-conventions.md` 第 0 节)。 ```markdown # {功能名称} 验收报告 > 阶段:阶段 3(验收闭环) > 验收日期:YYYY-MM-DD > 关联方案 doc:{方案 doc 路径} ## 1. 接口契约核对 对照方案第 2.1 节名词层逐一核查: **接口示例逐项核对**: - [ ] 示例 A({文件路径 + 函数名}):示例输入→输出 → 代码实际行为:{一致 / 偏差说明} **名词层"现状 → 变化"逐项核对**: - [ ] 名词 X:声称的变化 → 代码改动:{一致 / 偏差} **流程图核对**(第 2.2 节开头 mermaid 图): - [ ] 图中节点 / 调用关系在代码均有实际落点(grep 确认) 发现偏差**先修代码或回填方案 doc**。报告里写"已知偏差暂不处理"是反模式——下次按方案找代码会被绊倒。 ## 2. 行为与决策核对 对照方案第 1 节 + 第 2.2 节: **需求摘要逐项验证**: - [ ] 行为 A:{描述 + 实测结果} **明确不做逐项核对**(用第 3 节"反向核对项"): - [ ] 范围外事项 X **确实没做**(grep / review 确认) **关键决策落地**: - [ ] 决策 D1:{决策内容} → 代码体现:{描述} **编排层"现状 → 变化"逐项核对**: - [ ] 变化 V1:{在哪一步插入 / 哪条分支变更} → 代码实际落点 **流程级约束核对**(错误语义 / 幂等 / 并发 / 扩展点 / 可观测点): - [ ] 纪律 R1:{描述} → 代码遵守方式 **挂载点反向核对(可卸载性)**——对照第 2.3 节,必做两件事: - [ ] 挂载点 M1:清单条目 → 代码实际落点:{一致 / 偏差} - [ ] **反向核查**(grep):本 feature 在代码里的所有引用是否都落在清单内?清单外的引用 → 漏记,补进第 2.3 节 - [ ] **拔除沙盘推演**:按清单逆向操作后是否还有残留?残留 → 写进"遗留"或补挂载点 Fastforward 方案没有挂载点清单 → 现场 grep 盘点本次改动命中的挂入位置作为卸载依据。 ## 3. 验收场景核对 对照方案第 3 节关键场景清单,逐条可观察证据验证: - [ ] **S1**:{场景"输入 / 触发 → 期望可观察结果"} - 证据来源:{类型系统 / 单测 / 集成 / 手工 / 肉眼} - 结果:{通过 / 未通过 + 原因 + 补救} **前端改动必须浏览器肉眼验证**(typecheck 通过不代表用户用起来对): - [ ] UI 区域 X:浏览器验证 OK / 截图链接 ## 4. 术语一致性 对照方案第 0 节 + 第 2.1 节命名 grep 代码: - 术语 X:代码命中 N 处全部一致 ✓ - 防冲突:禁用词 grep 无命中 ✓ 发现不一致 → 改代码,别在报告里写"已知差异"。 ## 5. 架构归并 **目标**:把本次 feature 里稳定、系统级可见的内容**实际写入** architecture,让读者只看 architecture 就能看懂新能力的存在和形态。**不是加 design 链接就算数**。 对照方案第 4 节,三类东西实际写入对应架构 doc: - **名词归并** ← 第 2.1 节新增 / 变化的实体、类型、对外契约 → architecture 的"结构与交互 / 数据与状态"节 - **动词骨架归并** ← 第 2.2 节跨模块可见的主流程 / 关键编排 → architecture 的结构图 / 模块交互 - **流程级约束归并** ← 第 2.2 节跨 feature 稳定的约束 → architecture 的"已知约束"节 逐项核对: - [ ] 架构 doc X({路径}):归并内容 {描述};已写入 ✓ / 不需要(理由:{具体}) 方案第 4 节为空或过简 → 在此补充评估: - 新增哪些模块 / 改了哪些接口 / 引入哪些跨模块纪律 - 架构总入口要不要新增描述(描述不是贴链接) - `.codestable/attention.md` 要不要补新规约或已知坑 **判据**:归并完成后,没读过 design 的人打开 architecture 应该能知道"系统里现在有这个能力、它的大致形态、和它交互要遵守什么"。 ## 6. requirement 回写 req 是能力愿景层,本节是 draft → current 升级和 backfill 的触发点。对照方案 frontmatter 的 `requirement` 和第 1 节需求摘要: - [ ] `requirement` 空 + 方案明确"不新增能力"(纯重构 / 技术债)→ 跳过,写"无 requirement 回写" - [ ] `requirement` 空 + 新增了用户可感能力 → 触发 `cs-req` **backfill** 直接落 `status: current` - [ ] `requirement` 指向 draft req → 触发 `cs-req` **update**:`draft` → `current`,按实际实现刷新用户故事 / 边界,**保留原始愿景**(愿景不被覆盖,只在文末加变更日志记录本次改动) - [ ] `requirement` 指向 current req 且本次改了边界 / 用户故事 / pitch → 触发 `cs-req` **update** 刷新 - [ ] `requirement` 指向 current req 但本次未改用户视角 → 写"req-{slug} 未变,无需更新" 这是**实际写文件的动作**,不是自评"应该不需要改"。 ## 7. roadmap 回写 对照方案 frontmatter 的 `roadmap` / `roadmap_item`: - [ ] 两字段都空(feature 未从 roadmap 起头)→ 跳过,写"非 roadmap 起头" - [ ] 两字段都有值: - 打开 `.codestable/roadmap/{roadmap}/{roadmap}-items.yaml` - 找到 `slug: {roadmap_item}`,核对当前 `status: in-progress` + `feature: {目录名}`——不对停下来找原因 - 改 `status: done`,用 `validate-yaml.py` 校验 - 同步 `{roadmap}-roadmap.md` 主文档第 3 节子 feature 清单的对应条目状态 - [ ] 两字段不一致(只填了一个)→ 停下来补齐或澄清 衔接协议看 `shared-conventions.md` 第 2.5 节。和归并 / req 同规则:实际写文件的动作。 ## 8. attention.md 候选盘点 回看本次实现,盘点"每个 feature 都会撞一次"的环境 / 工具 / 工作流类信息。典型候选:编译命令、代理配置、本地起服务步骤、反复踩的环境坑、仓库内非显然的工作流约定。 **判据**:下一个 feature 的 AI 还会再踩一次的事才记。一次性踩坑、和具体业务耦合的细节归 learning / decide。 - [ ] 无候选:写"本 feature 未暴露需要补入 attention.md 的内容" - [ ] 有候选:列出来,**不擅自写入**——本节只登记,落不落由用户在"退出后"环节定 - 候选 1:{描述 + 建议放 attention.md} ## 9. 遗留 - 后续优化点(已开 issue 或加入 issue 列表):{列表} - 已知限制:{列表} - 实现阶段"顺手发现"列表:{列表} ``` --- ## 核对节奏 逐节做。每节完成后**逐条更新 `{slug}-checklist.yaml` 的 `checks`**:通过 → `passed`,失败 → `failed`(先修代码 / 方案再改回 `passed`)。所有 checks 全 `passed` 后报告才算完成。 第 1/2 节最容易暴露偏离,先做。第 2 节挂载点反向核对**必须实际 grep + 沙盘推演**,不能凭印象勾选。第 5/6/7 节是写文件的动作,不是自评。 --- ## 退出条件 - [ ] 验收报告 9 节都填完 - [ ] 第 1/2 节核对全部勾选,无未处理偏差(含挂载点 grep + 拔除沙盘推演) - [ ] 第 3 节场景核对全部勾选,前端已浏览器验证 - [ ] 第 4 节术语一致性无遗漏 - [ ] 第 5 节归并:每条有明确结论,需要更新的 doc 已实际写入 - [ ] 第 6 节 req 回写有结论:跳过 / 未变 / 已 backfill / draft→current / 已 update - [ ] 第 7 节 roadmap 回写有结论:跳过(非 roadmap 起头)/ 已更新(items.yaml + 主文档同步,yaml 通过校验) - [ ] checklist 所有 checks 都 `passed` - [ ] 用户终审确认 --- ## 退出后 告诉用户:"验收报告已就绪,架构文档已归并,cs-feat 工作流走完。后续 BUG 走 issue 流程。" 按 `shared-conventions.md` 第 3 节收尾推荐顺序逐项一句话提示(用户说"不用"立刻跳过): 1. 复用价值的坑点 / 经验 → "需要沉淀 learning 吗?(`cs-learn`)" 2. 长期约束 / 技术选型 → "需要归档决定吗?(`cs-decide`)" - **特检**:design 第 2.5 节是否有"建议沉淀的 convention"段。有就把那条规则原文念给用户:"design 2.5 建议沉淀这条 convention:『{规则一句话}』,跑通了,要不要现在 `cs-decide` 归档?"——这种是 design 阶段就识别出的稳定模式,比一般"问问看"更应该主动提 3. 接口变更 / 用户可见行为变更 → "需要更新指南吗?(`cs-guide`)" 4. 库公开接口(组件 / 函数 / 命令)变了 → "需要更新 API 参考吗?(`cs-libdoc`)" 5. 第 8 节有 attention.md 候选 → 逐条问"候选 X 加到 attention.md 吗?" 用户明确同意 → 触发 `cs-note` 走分节归类 / 查重 / 软上限检查(不在 accept 里手写,避免和 cs-note 各搞一套口径);**一次一条** 6. 最后问是否代为 scoped-commit 收尾提交规则看 `shared-conventions.md` 第 4 节。提交范围:功能代码 + 方案 doc + 验收报告 + 本次实际更新的架构 doc / req doc / roadmap items.yaml + 主文档。 --- ## 容易踩的坑 - "测试都过了" → 测试通过 ≠ 验收场景满足,要逐条核对第 3 节 - "我肉眼看了一下" → 按清单走,逐项勾选 - 接口偏差在报告里写"已知偏差"而不修代码 / 回填方案 - 挂载点反向核对只看清单不 grep——漏记的挂载点溜进项目,后面拔不干净 - 第 3 节前端改动只 typecheck 没浏览器跑过 - 第 5 节归并写"整体不影响架构"一句话带过,没逐条核查 - 架构 doc 需要更新而只写"建议以后更新"——归并是当下动作不是建议 - 第 7 节只改 items.yaml 没同步主文档,两份不一致 - frontmatter 有 `roadmap` 却在第 7 节写"跳过"——有值就必须回写 - 报告写完没让用户终审就宣告完成 - 用户没明确同意就 `git commit`