@peterxiaoyang/superspec 0.1.44 → 0.1.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -1
- package/dist/cli.js +23 -24
- package/dist/code_review.js +7 -2
- package/dist/format.d.ts +20 -2
- package/dist/format.js +217 -26
- package/dist/git_state.d.ts +12 -1
- package/dist/git_state.js +45 -0
- package/dist/install.d.ts +1 -0
- package/dist/install.js +12 -0
- package/dist/next.d.ts +1 -1
- package/dist/next.js +3 -8
- package/dist/openspec.d.ts +13 -0
- package/dist/openspec.js +28 -0
- package/dist/phase_confirmation.d.ts +6 -0
- package/dist/phase_confirmation.js +22 -6
- package/dist/phase_plan.d.ts +10 -1
- package/dist/phase_plan.js +250 -37
- package/dist/record.d.ts +1 -1
- package/dist/record.js +38 -30
- package/dist/review.js +18 -2
- package/dist/sync.js +13 -4
- package/dist/task.js +15 -2
- package/dist/task_evidence.d.ts +1 -1
- package/dist/task_evidence.js +85 -10
- package/dist/transition.d.ts +4 -3
- package/dist/transition.js +166 -29
- package/dist/types.d.ts +38 -1
- package/dist/types.js +1 -0
- package/dist/workflow_config.d.ts +24 -0
- package/dist/workflow_config.js +127 -0
- package/package.json +1 -1
- package/templates/workflow/AGENTS.md +1 -1
- package/templates/workflow/agents/architect.toml +1 -1
- package/templates/workflow/agents/code-reviewer.toml +1 -1
- package/templates/workflow/agents/critic.toml +1 -1
- package/templates/workflow/agents/executor.toml +1 -1
- package/templates/workflow/agents/explore.toml +1 -1
- package/templates/workflow/agents/test-engineer.toml +1 -1
- package/templates/workflow/agents/test-runner.toml +1 -1
- package/templates/workflow/agents/verifier.toml +1 -1
- package/templates/workflow/prompts/architect.md +25 -33
- package/templates/workflow/prompts/code-reviewer.md +19 -67
- package/templates/workflow/prompts/critic.md +36 -87
- package/templates/workflow/prompts/executor.md +17 -19
- package/templates/workflow/prompts/explore.md +12 -46
- package/templates/workflow/prompts/test-engineer.md +22 -35
- package/templates/workflow/prompts/test-runner.md +11 -21
- package/templates/workflow/prompts/verifier.md +13 -37
- package/templates/workflow/skills/superspec-apply/SKILL.md +17 -85
- package/templates/workflow/skills/superspec-explore/SKILL.md +57 -66
- package/templates/workflow/skills/superspec-propose/SKILL.md +76 -129
- package/templates/workflow/skills/superspec-review/SKILL.md +14 -73
|
@@ -8,105 +8,96 @@ metadata:
|
|
|
8
8
|
|
|
9
9
|
# SuperSpec Explore
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
只读调查当前 change,形成基于证据的 `discovery.md`。目标不是穷举仓库,而是确认本次 change 的目标、现状差异、真实影响范围、关键链路与待决问题。
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## 工作方式
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
运行 `superspec transition next --change "<change>"`,以返回的当前事项为准。优先通过代码、文档、已有测试和需求源消除未知;只有业务语义、验收、范围、数据口径或关键取舍无法由现有证据裁决时才询问用户。
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
2. 执行返回的命令、工作项或用户确认
|
|
19
|
-
3. 用户确认用 `superspec record user-decision --change "<change>" --input -`;工作项审查报告用 `superspec record job-submit --change "<change>" --job <JOB> --report -`
|
|
20
|
-
4. 回到第 1 步
|
|
21
|
-
|
|
22
|
-
进入下一阶段前,必须先处理 next 返回的用户确认、审查或验证事项。默认完整审查路径下,`explore -> propose` 会创建 `critic` 工作项审查 discovery。
|
|
23
|
-
|
|
24
|
-
如果 next 提示 discovery 不完整或有未确认问题,先检查并填写 discovery,不要把草稿占位、格式缺口或路径空白直接转问用户。用户明确说 PRD、文档、原型或其它需求源已更新时,先重新核对来源,不复用旧依据。什么未知该进 `## 待确认问题`,判定标准见「写作规则」。
|
|
25
|
-
|
|
26
|
-
执行推进类命令前,对照 critic 的 Discovery 审查阻塞条件快速自检(非穷尽):锚点可核验、链路表完整且状态为枚举值、完成判定可判定、未知去向明确、已勾选问题有行内结论。自检不替代审查工作项,只为减少驳回往返。
|
|
27
|
-
|
|
28
|
-
Discovery 审查报告是待验证的独立意见,不会自动扩大本次 change。审查未通过时,主流程先根据用户目标、当前 discovery 的直接证据和明确完成判定,独立判断整份报告是否有资格阻塞:只要存在一个属于本次 change、有直接证据且影响范围判断或阶段完成条件的问题,就补充 discovery 并重新审查;不要为了让报告“全部正确”而处理其余越界建议。只有整份报告提出的问题均不具备阻塞条件时,才可将本次审查结论标记为不阻塞,并按工作流提供的方式留痕。该判断只适用于当前材料;discovery 变化后必须重新审查,不做部分问题裁决或永久豁免。问题是否成立取决于业务范围、完成判定或风险接受时,先询问用户;可由现有材料直接判定的越界、无证据或非阻断建议由主流程说明判断理由。
|
|
17
|
+
用户明确说明 PRD、文档、原型或其他需求源已更新时,重新核对来源,不复用旧结论。文档协议、状态和推进由工作流校验;按 `next` 的反馈修正即可。
|
|
29
18
|
|
|
30
19
|
## 探索分工
|
|
31
20
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
给 subagent 的深扫任务书按此骨架下达,缺项会直接拉低深扫质量:
|
|
21
|
+
对于可能影响代码、数据、运行时行为或用户可观察结果的 change,主流程必须委派 `explore` subagent 进行独立只读深扫。
|
|
35
22
|
|
|
36
|
-
|
|
37
|
-
目标:<本次要回答的探查问题,一句话>
|
|
38
|
-
需求原话:<用户原话或 PRD 关键句,不转述>
|
|
39
|
-
已知锚点:<已确认的短锚点(类名/文件名:行号)或文档锚点;没有写“无”>
|
|
40
|
-
参考:<PRD/需求文档/artifact 路径;没有写“无”>
|
|
41
|
-
必查:<正向搜索的具体搜索词(字段名/枚举/路由/文案)> + 反向调用/入口面检查;
|
|
42
|
-
按链路五要素枚举上游来源、规则变形、持久化语义、下游消费者、视图差异;
|
|
43
|
-
运行时数据依赖按 IDC 追到 producer 侧最后一次变形处
|
|
44
|
-
返回:已确认事实 / 基于锚点的推断 / 未知及是否阻塞 / 影响范围候选 / 风险 / 需主流程确认的问题;全部带发现方式和证据锚点
|
|
45
|
-
边界:只读,不写方案;“未发现”只能写按哪些发现方式未发现
|
|
46
|
-
```
|
|
23
|
+
主流程负责定义本次要回答的探查问题、核验决定范围的关键证据并汇总 discovery;subagent 负责补全主会话可能遗漏的调用关系、数据链路、相邻消费者、隐性契约和未知项。
|
|
47
24
|
|
|
48
|
-
subagent
|
|
25
|
+
纯文档、明确 typo、单文件机械修改或已确认无代码影响的任务可以跳过 subagent,并在 discovery 中说明原因。
|
|
49
26
|
|
|
50
|
-
## discovery.md
|
|
27
|
+
## discovery.md 模板
|
|
51
28
|
|
|
52
29
|
```markdown
|
|
53
30
|
# Discovery
|
|
54
31
|
|
|
55
32
|
## 需求理解
|
|
56
|
-
-
|
|
57
|
-
-
|
|
33
|
+
- 用户目标:<用户原话或可核验的归纳>
|
|
34
|
+
- 当前差异:<当前实现与目标的差异,附证据>
|
|
35
|
+
- 完成判定:<用户可见行为的改动前/后口径>
|
|
58
36
|
|
|
59
37
|
## 现状
|
|
60
|
-
-
|
|
38
|
+
- <当前实现、入口、已有约束和关键事实>
|
|
61
39
|
|
|
62
40
|
## 影响范围
|
|
63
|
-
-
|
|
41
|
+
- <受影响的代码面、相邻模块、用户/系统可观察面及排除理由>
|
|
64
42
|
|
|
65
43
|
## 链路五要素
|
|
66
44
|
| ID | 发现方式 | 上游来源 | 规则变形 | 持久化语义 | 下游消费者 | 视图差异 | 未知/排除 | 证据 | 状态 |
|
|
67
45
|
|---|---|---|---|---|---|---|---|---|---|
|
|
68
|
-
| CHAIN-001 |
|
|
46
|
+
| CHAIN-001 | <发现路径> | <输入/配置/历史数据> | <关键变形或无> | <持久化含义或不落库> | <消费者或无> | <可观察差异或无> | <未知或排除理由> | <锚点> | 已确认 |
|
|
69
47
|
|
|
70
48
|
## 风险和边界
|
|
71
|
-
-
|
|
49
|
+
- <有证据的技术、兼容、依赖或发布风险>
|
|
72
50
|
|
|
73
51
|
## 输入数据来源核查
|
|
74
|
-
-
|
|
75
|
-
- 有运行时数据依赖:按表核查。
|
|
52
|
+
- <无运行时数据依赖时,说明不适用原因>
|
|
76
53
|
|
|
77
54
|
| 核查ID | 消费位置 | 必需输入 | 数据来源 | 区分依据 | 状态/理由 |
|
|
78
55
|
|---|---|---|---|---|---|
|
|
79
|
-
| IDC-001 |
|
|
56
|
+
| IDC-001 | <入口/规则/算法> | <字段/集合/状态> | <相关 producer 或组装位置> | <可证伪依据> | 已证明 |
|
|
80
57
|
|
|
81
58
|
## 待确认问题
|
|
82
|
-
- [ ] Q-001 [验收]
|
|
83
|
-
- [ ] Q-002 [数据来源] status 字段的业务口径以哪份文档为准?需要用户指认来源;阻塞 IDC-001 判定
|
|
59
|
+
- [ ] Q-001 [验收] <一个待决问题>。影响:<范围或验收>。选项:A <后果> / B <后果>。建议:<理由>
|
|
84
60
|
```
|
|
85
61
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
62
|
+
模板提供稳定骨架;不要为了填满每个章节或表格而制造事实、链路或风险。
|
|
63
|
+
|
|
64
|
+
## 写作原则
|
|
65
|
+
|
|
66
|
+
### 证据与认知边界
|
|
67
|
+
|
|
68
|
+
Discovery 必须明确区分已确认事实、基于证据的推断和仍未裁决的未知。
|
|
69
|
+
|
|
70
|
+
事实应能追溯到源码、文档、命令输出或用户确认;推断应说明其证据链和不确定性。不要把当前实现、模型偏好或未经确认的业务语义当成用户需求、验收口径或范围结论。
|
|
71
|
+
|
|
72
|
+
使用足以复核的源码或文档锚点。纯文档、配置或新文件没有代码锚点时,说明原因即可。
|
|
73
|
+
|
|
74
|
+
### 影响范围与链路
|
|
75
|
+
|
|
76
|
+
调查的目标是识别本次 change 实际会改变的责任边界,而不是穷举所有相关模块。
|
|
77
|
+
|
|
78
|
+
沿真实调用、数据流和既有契约扩展调查:说明重要范围为什么受影响,也说明相邻范围为什么保持不变。只有名称相似、技术上可能相关或属于某类消费者,不构成进入影响范围的理由。
|
|
79
|
+
|
|
80
|
+
当 change 涉及共享数据、跨边界输入、持久化语义或下游可观察行为时,建立足以判断影响的链路视图:输入来自哪里、关键形态如何变化、由谁持久化或解释、哪些消费者和视图会观察到结果。调查应追到决定本次输入语义的责任点,而不止停在 consumer、DTO 或校验器。
|
|
81
|
+
|
|
82
|
+
不涉及此类链路时,说明不适用的具体原因;不要为了填表虚构链路。
|
|
83
|
+
|
|
84
|
+
### 未知与用户决策
|
|
85
|
+
|
|
86
|
+
先通过继续调查、阅读代码、运行已有测试或核对需求源消除未知。只有无法由现有证据裁决、且会影响需求范围、验收、用户可见行为、数据语义、安全、兼容或关键方案取舍的问题,才交给用户决定。
|
|
87
|
+
|
|
88
|
+
每个待决问题只表达一个决策,并说明影响、可选方向及建议依据。彼此相关的问题一次汇总提出,而不是逐个往返。
|
|
89
|
+
|
|
90
|
+
已经被证据排除的范围、实现细节、内部拆分和不影响验收的未知,不应升级为用户问题。非阻塞未知必须说明为什么不影响本次验收。
|
|
91
|
+
|
|
92
|
+
### 结论闭环
|
|
93
|
+
|
|
94
|
+
用户答复或新的证据不会只解决一个问题行;应同步更新需求理解、影响范围、链路结论、风险与后续计划依据。
|
|
95
|
+
|
|
96
|
+
回答含糊、与问题不对应或引入新的关键未知时,不把它视为确认。按工作流记录有效决策后,再将结论写回 discovery。
|
|
104
97
|
|
|
105
98
|
## Guardrails
|
|
106
99
|
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
- 用户未确认的决策不自行推断。
|
|
112
|
-
- 审查通过后、推进前不做非必要的文档编辑;文档变更会作废已通过的审查并触发重审。
|
|
100
|
+
- 不改业务代码或计划材料。
|
|
101
|
+
- 不自行扩大范围、选择未确认的业务语义或推进状态。
|
|
102
|
+
- 审查意见用于补足证据,不自动创造新范围、新需求或新方案。
|
|
103
|
+
- discovery 发生实质变化后,以 `next` 决定后续审查或推进。
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: superspec-propose
|
|
3
|
-
description: "
|
|
3
|
+
description: "在 SuperSpec Propose 阶段把 discovery 转成可审查、可执行的计划。"
|
|
4
4
|
metadata:
|
|
5
5
|
author: SuperSpec
|
|
6
6
|
source: SuperSpec
|
|
@@ -8,68 +8,73 @@ metadata:
|
|
|
8
8
|
|
|
9
9
|
# SuperSpec Propose
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
你是计划阶段。职责:把已确认的 discovery 转成 `proposal.md`、`specs/`、`design.md`、`tasks.md` 和 `test-contract.md`。Skill 提供作者模板;状态机负责校验结构、字段、引用和推进协议,gate 报错时按错误修正,不把机械问题交给审查角色。
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## 工作方式
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
先运行 `superspec transition next --change "<change>"`,以返回的事项、确认、审查与提交命令为准。只把用户已确认的行为、边界和有证据的风险写成计划,不改业务代码。
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
2. 执行返回的命令、工作项或用户确认
|
|
19
|
-
3. 用户确认用 `superspec record user-decision --change "<change>" --input -`;工作项审查报告用 `superspec record job-submit --change "<change>" --job <JOB> --report -`(文件路径模式仍可作为 fallback)
|
|
20
|
-
4. 回到第 1 步
|
|
17
|
+
需求源、业务口径或验收更新时,先在 `proposal.md` 增加 `## 需求变化`,记录变化来源、变化、受影响能力、已修改材料、保持不变的范围和处理方式;再按实际影响同步规格、设计和测试契约。
|
|
21
18
|
|
|
22
|
-
|
|
19
|
+
人类可读正文使用简体中文。源码锚点采用能唯一定位的最短写法;文档引用使用 `文件#锚点`,让实现者能打开原材料。
|
|
23
20
|
|
|
24
|
-
|
|
21
|
+
## 产物模板
|
|
25
22
|
|
|
26
|
-
|
|
23
|
+
### proposal.md
|
|
27
24
|
|
|
28
|
-
|
|
25
|
+
严格以 `openspec instructions proposal` 的原生结构为准;在该结构中清楚回答为什么需要这个 change、哪些能力变化和影响范围,而不是写实现步骤。
|
|
29
26
|
|
|
30
|
-
|
|
27
|
+
```markdown
|
|
28
|
+
# Proposal
|
|
31
29
|
|
|
32
|
-
##
|
|
30
|
+
## Why
|
|
31
|
+
<当前问题、影响,以及现在为什么要处理>
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
|
|
33
|
+
## What Changes
|
|
34
|
+
- <用户或系统可辨识的能力变化>
|
|
36
35
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
-
|
|
40
|
-
- 能力变化只描述目标结果和范围,不展开 requirement / scenario,也不写类、函数、字段、算法、数据流、调用顺序或复用机制;这些内容分别属于 specs 和 design
|
|
41
|
-
- 可以说明必须保持不变的相邻能力、兼容边界和高层发布影响,但不为完整而编造非目标;具体顺序、回滚步骤和技术方案属于 design
|
|
42
|
-
- `## Impact` 必须能看出受影响范围和原因,写成:
|
|
36
|
+
## Capabilities
|
|
37
|
+
### New Capabilities
|
|
38
|
+
- `<capability>`: <能力简述>
|
|
43
39
|
|
|
44
|
-
|
|
40
|
+
### Modified Capabilities
|
|
41
|
+
- `<capability>`: <变化简述>
|
|
42
|
+
|
|
43
|
+
## Impact
|
|
45
44
|
| Area | Reason |
|
|
46
45
|
|---|---|
|
|
47
|
-
|
|
|
46
|
+
| <模块/API/数据面> | <为什么会受影响、要保持什么语义> |
|
|
48
47
|
```
|
|
49
48
|
|
|
50
|
-
|
|
51
|
-
- `Reason` 只解释该范围为什么受影响、会暴露什么变化或承担什么兼容责任,不展开具体实现方案
|
|
52
|
-
- discovery 含 `## 输入数据来源核查` 的 IDC 项时,相关 `Reason` 须引用对应 `IDC-xxx` 状态(`已证明` / `未知阻塞` / `未知非阻塞`)
|
|
53
|
-
- discovery 含 `## 链路五要素` 时,`## Impact` 须与非 `未知阻塞` 链路行中已确证的下游消费者 / 视图差异对账:受本次改动影响的写入 Area / Reason 并引用对应 `CHAIN-xxx`;不受影响的写明排除理由,可按组书写,排除理由不回写 discovery.md。对账不要求逐行进入 Impact;同一链路已由 `IDC-xxx` 覆盖时,引用其一并注明对应即可
|
|
54
|
-
- 不写设计决策、字段归属、测试场景、RED/GREEN 过程、任务拆分、文件修改顺序或执行日志
|
|
49
|
+
`Why` 不提前指定方案;`What Changes` 与 `Capabilities` 只写可辨识结果。`Impact` 是有原因的影响分析,不是待修改文件白名单或任务清单。discovery 已证实的输入链路、消费者或视图影响应在此对账;已排除的范围说明理由即可。
|
|
55
50
|
|
|
56
51
|
### specs/
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
-
|
|
68
|
-
-
|
|
69
|
-
|
|
52
|
+
|
|
53
|
+
先执行 `openspec instructions specs`,再为 proposal 中每个能力变化建立对应的增量。规格描述完成后长期成立的可观察行为,不描述类、函数、算法、文件或执行过程。
|
|
54
|
+
|
|
55
|
+
```markdown
|
|
56
|
+
## ADDED Requirements
|
|
57
|
+
|
|
58
|
+
### Requirement: <行为规则>
|
|
59
|
+
<可判定的结果>。
|
|
60
|
+
|
|
61
|
+
#### Scenario: <场景>
|
|
62
|
+
- **WHEN** <前置条件和触发动作>
|
|
63
|
+
- **THEN** <可观察结果>
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
使用 OpenSpec 规定的 ADDED / MODIFIED / REMOVED / RENAMED 语义。每个场景要能独立理解和验收;一个行为规则的多个边界情形可以用多个 scenario,不要把多个独立责任混成一句。
|
|
70
67
|
|
|
71
68
|
### design.md
|
|
72
|
-
|
|
69
|
+
|
|
70
|
+
`design.md` 的职责是把已确认的需求、事实和约束,转化为实现者可以据此作出一致决策的技术方案。它不是 discovery、Impact、specs 或 tasks 的复述。
|
|
71
|
+
|
|
72
|
+
- 说明本次方案如何承担责任:关键能力落在哪个边界、主要数据/控制流如何经过、哪些现有机制被接入或改变。按最能表达方案的功能、运行阶段或系统边界组织即可。
|
|
73
|
+
- 只明确会影响验收、兼容性或跨模块一致性的技术决策与契约,例如接口语义、数据形态、状态转换、优先级、事务与恢复行为。未改变的既有语义无需重新设计。
|
|
74
|
+
- 复用现有逻辑时,说明复用什么、接入到哪里、本次差异是什么、哪些语义必须保持。除非需求明确要求,不把本次接入扩展为对通用基础设施的重建或升级。
|
|
75
|
+
- 涉及数据传递时,说明目标输入如何从 producer 到达 consumer,以及 consumer 如何处理它。方案必须与已确认的链路事实一致;发现新的可观察影响时,回写影响分析和测试计划。
|
|
76
|
+
- 明确本次不处理但容易被误解为范围内的相邻能力。对真实存在的取舍、共享契约、风险、回滚或待决问题,按需要说明;没有实际决策价值的章节不要生成。
|
|
77
|
+
- 设计应描述机制与边界,而不是逐行实现、文件修改顺序、任务拆分或测试执行过程。允许使用最有表达力的形式:文字、图、表、伪代码、状态图或数据流。
|
|
73
78
|
|
|
74
79
|
```markdown
|
|
75
80
|
# 设计
|
|
@@ -117,121 +122,63 @@ metadata:
|
|
|
117
122
|
- [ ] DEC-xxx <阻塞决策>
|
|
118
123
|
```
|
|
119
124
|
|
|
120
|
-
规则:
|
|
121
|
-
- 写 design 前对照 discovery / proposal / specs,把影响实现的事实和约束转成具体安排;不记录调查过程,不复制 Impact、specs 行为、discovery 证据或 tasks 拆分。
|
|
122
|
-
- `## 实现方案` 是主体。代码影响型需求必须能映射到可定位的方案,但不要求需求与小节一一对应;紧密相关需求可以共用方案,只有存在独立技术路线时才拆分。
|
|
123
|
-
- 方案按业务功能、运行时阶段或系统边界组织。标题同时写明“针对什么”和“怎么实现”,例如 `班段内最新入/最早出:复用既有 START/END 选择策略`;不要只写“策略复用”“数据处理”“接口调整”等泛称。
|
|
124
|
-
- 每个方案整体说明实现机制、影响范围、设计依据和边界约束;不要求固定字段,只写本次实际涉及的数据、接口、流程和运行边界。共享契约集中定义一次,其他方案引用。
|
|
125
|
-
- 当本次 change 确实新增或改变行为、数据语义、接口兼容、状态、优先级、一致性、并发或恢复结果,且不同选择会影响已声明验收时,才明确对应契约;未改变的既有语义不重新设计。可以使用必要的模块、接口、表 / 字段、关键函数、数据流、状态机、优先级矩阵和简短伪代码。
|
|
126
|
-
- 声明“复用现有逻辑”或“保持行为不变”时,说明复用对象、接入位置、本次差异和需要保持的语义,不能只写抽象结论。
|
|
127
|
-
- 复用现有基础设施或通用机制时,只设计本次接入和差异,不重新证明或升级该机制的一般可靠性。除非用户、proposal 或 specs 明确提升对应质量等级,不新增未经确认的基础设施、可靠性模式或版本协调机制。
|
|
128
|
-
- 可以描述运行时算法、数据 / 控制流、状态转换和事务顺序;不写逐行代码、完整 SQL、文件修改顺序、task、测试命令或 RED/GREEN 步骤。
|
|
129
|
-
- discovery 的 `## 输入数据来源核查` 影响方案时,分别写清 producer→consumer 的输入完整性和 consumer 处理方式;相关 `IDC-xxx` 为 `未知阻塞` 时 design 不得 ready。
|
|
130
|
-
- discovery 含 `## 链路五要素` 时,方案不得违背已确证链路事实。design 可以引用 CHAIN 解释路线;若发现 Impact 未记录的消费者、视图差异或用户 / 系统可观察行为影响,先回写 Impact,再进入 test-contract 映射。
|
|
131
|
-
- `## 非目标` 和 `## 总体方案` 必须生成:非目标写最容易被误认为本次范围的相邻能力或技术路线,不编造无关项;总体方案用 2~5 句概括功能点关系、主要数据流或调用关系,不展开任务步骤。
|
|
132
|
-
- 模板中的可选注释只用于判断是否生成,不写入成品。替代路线、整体方案取舍、关键契约、风险 / 取舍与回滚没有真实内容时连标题一起省略;替代路线优先写在对应方案内,只有横跨多个功能点时才集中说明;只有阻塞确认项才追加 `## 待用户确认`。
|
|
133
|
-
|
|
134
125
|
### tasks.md
|
|
135
|
-
|
|
126
|
+
|
|
127
|
+
使用 OpenSpec 的任务分组;每个顶格 checkbox 是一个可独立完成和验证的 task。按依赖顺序排列,多个独立行为或入口不能共享一个验证边界时拆开。
|
|
136
128
|
|
|
137
129
|
```markdown
|
|
138
130
|
# Tasks
|
|
139
131
|
|
|
140
|
-
##
|
|
132
|
+
## <分组>
|
|
141
133
|
|
|
142
|
-
- [ ] 1.1
|
|
134
|
+
- [ ] 1.1 <可独立验证的行为或明确的非行为改动>
|
|
143
135
|
执行依据:
|
|
144
136
|
- 测试: test-contract.md#TEST-001
|
|
145
|
-
- 设计: design.md
|
|
146
|
-
- 来源: proposal.md#Impact;specs
|
|
147
|
-
-
|
|
148
|
-
- 边界:
|
|
149
|
-
- [ ] 1.2 检查 verifier 绑定执行证据 tdd_required:true
|
|
150
|
-
执行依据:
|
|
151
|
-
- 测试: test-contract.md#TEST-002,TEST-003
|
|
152
|
-
- 设计: design.md#执行证据核对:复用现有证据链
|
|
153
|
-
- 来源: proposal.md#Impact;discovery.md#CHAIN-001
|
|
154
|
-
- 原因: 证据核对与文档绑定是两个独立验收入口
|
|
155
|
-
- 边界: 不改变历史证据的判定语义
|
|
156
|
-
|
|
157
|
-
## Documentation
|
|
137
|
+
- 设计: design.md#<对应实现方案>
|
|
138
|
+
- 来源: proposal.md#Impact;specs/<capability>/spec.md#<对应规则>
|
|
139
|
+
- 验收: <完成后可检查的结果>
|
|
140
|
+
- 边界: <不能改变的具体行为、接口或数据语义>
|
|
158
141
|
|
|
159
|
-
- [ ] 2
|
|
142
|
+
- [ ] 1.2 <纯文档或机械改动>
|
|
143
|
+
执行依据:
|
|
144
|
+
- 测试:
|
|
145
|
+
- 设计: design.md#<对应方案>
|
|
146
|
+
- 来源: proposal.md#Impact
|
|
147
|
+
- 验收: <可检查的非行为结果>
|
|
148
|
+
- 边界: <不改业务行为>
|
|
160
149
|
```
|
|
161
150
|
|
|
162
|
-
|
|
163
|
-
- 每个普通 TDD task(`tdd_required:true`)必须紧跟一个 `执行依据:` 块,包含五个字段:`测试`(该 task 必须兑现的 test-contract 场景,引用 `test-contract.md#TEST-xxx`,多个用逗号合并)、`设计`(执行路线在 `design.md` 的位置或短摘录)、`来源`(task 产生依据,如 `proposal.md#Impact`、spec delta、`discovery.md#CHAIN-xxx,IDC-xxx`,已有明确文件路径的补充材料用 `.superspec/artifacts/...`)、`原因`(为什么单独拆出这个 task)、`边界`(执行时需要保护的边界)
|
|
164
|
-
- `执行依据:` 必须紧跟所属 task 行(中间最多允许一个空行);字段不得重复;块内不得出现 checkbox(`- [ ]` / `- [x]`),否则会变成无人执行的暗任务并被引擎拒绝
|
|
165
|
-
- `设计`、`来源` 的标题或短摘录引用必须使用带文件名前缀的可定位格式,如 `design.md#...`、`proposal.md#...`、`specs/.../spec.md#...`;只有 ID 型引用(TEST/CHAIN/IDC)可以逗号合并。`边界` 默认直接写可对照 diff 的具体保护语义,不需要文件前缀;只有主动引用既有文档原文时才写对应文件和锚点
|
|
166
|
-
- 声明的每个 `TEST-xxx` 必须存在于 `test-contract.md`,否则 `propose-ready` 和 `start-apply` 会被阻断
|
|
167
|
-
- 五个字段的内容必须针对该 task 具体可核验,执行者和审查者要拿它们对照实现:`边界` 写出改动不应触碰的具体行为、模块或语义(能对着 diff 判断有没有越界),不写"不破坏现有功能"这类放在任何 task 上都成立的套话;`原因` 说明这个 task 独立存在的理由,不写"需要单独实现";不同 task 的执行依据不应互相复制
|
|
168
|
-
- 写不出可定位的 `设计` 引用时,说明 `design.md` 缺少该 task 的实现方案或边界约束——先补设计,不编造引用
|
|
169
|
-
- 单个 task 声明的测试超过 3 个时,`原因` 必须说明为什么不再拆分
|
|
170
|
-
- `tdd_required:false` task 可以写执行依据,`测试` 字段按需填写;特征化任务(characterization task,指为固化既有行为而写保护测试、不引入新行为的任务)用 `tdd_required:false no_tdd_reason:characterization` 标记,只有这类任务可以在执行阶段以特征化通过作为测试证据
|
|
171
|
-
- `REVIEW-FIX-*` task 由引擎在审查返工时追加,不需要手写执行依据
|
|
172
|
-
- `<task_id>` 可以是 `1.1` 或 `TASK-001.1`,必须唯一、稳定;标题不要包含 task id token,例如不要写 `## 1.1 Review verifier`
|
|
173
|
-
- task 内部步骤用普通 bullet,不用缩进 checkbox——引擎只解析顶格 checkbox 行,缩进的会变成无人执行的暗任务
|
|
174
|
-
- `tdd_required:true`(默认)——改运行时代码/业务逻辑/权限/外部接口
|
|
175
|
-
- `tdd_required:false` + `no_tdd_reason:xxx`——纯文档/配置/机械改名/生成物
|
|
176
|
-
- task 行只标记是否需要 TDD,不写 RED/GREEN 命令、断言或预期输出;实际 RED/GREEN 由 apply 阶段执行并记录
|
|
177
|
-
- 一个 task 对应一个可独立验证的行为变化,或一个明确的非行为改动
|
|
178
|
-
- 多个行为变化、入口或运行时模块不能形成同一个 RED/GREEN 闭环时拆开;需要“顺便”改多个不相邻模块的 task 在 propose 阶段就拆分或补充任务,不留到 apply 阶段扩大范围
|
|
179
|
-
- 任务按可执行顺序排列:引擎忽略标题、按全文顶格 checkbox 行的先后顺序逐个驱动执行,被依赖的任务必须排在依赖它的任务之前,跨组同样如此(顺序与分组冲突时调整任务归组或拆组);跨组依赖可在任务行内注明依赖的 task id 作为提示,但注明不改变执行顺序
|
|
151
|
+
每个普通 task 紧跟 `执行依据:`,显式写 `测试`、`设计`、`来源`、`验收`、`边界`。行为 task 的测试引用相应场景;纯非行为 task 才可留空并在验收/边界说明原因。`验收` 与 `边界` 必须能针对该 task 对照实现,不写可套用到任何 task 的空话;引用必须能定位到真正支持该 task 的材料。验证策略由 task-start 按所选模式编译,计划中不要推断 RED/GREEN。
|
|
180
152
|
|
|
181
153
|
### test-contract.md
|
|
182
|
-
|
|
154
|
+
|
|
155
|
+
把每个需自动验证的验收行为写成能推导断言的场景,不写测试命令或断言代码。
|
|
183
156
|
|
|
184
157
|
```markdown
|
|
185
158
|
# Test Contract
|
|
186
159
|
|
|
187
160
|
| test_id | scenario |
|
|
188
161
|
|---|---|
|
|
189
|
-
| TEST-001 |
|
|
190
|
-
| TEST-002 | 已登录用户提交金额为 -1 的订单,下单被拒绝并返回校验错误 |
|
|
162
|
+
| TEST-001 | 给定 <条件>,当 <动作> 时,观察到 <可判定结果> |
|
|
191
163
|
```
|
|
192
164
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
如果 discovery 含 `## 输入数据来源核查` 的 IDC 项,在测试表后增加 `## 输入数据覆盖验证`:
|
|
196
|
-
|
|
197
|
-
| 核查ID | 验证方式 | 输入链路声明 | 证据或计划 |
|
|
198
|
-
|---|---|---|---|
|
|
199
|
-
| IDC-001 | 源码锚点 + 聚焦测试 | producer 产生的目标输入会进入 consumer | path.ts:10 + TEST-001 |
|
|
200
|
-
|
|
201
|
-
证明方式可用源码锚点、fixture、targeted test、日志或 trace,须说明证明力;不强制集成测试。只证 consumer 算法、没证 producer→consumer 输入完整性,测试契约不足。
|
|
165
|
+
数据传递、字段形态或 producer-to-consumer 契约变化时,在测试表后说明输入完整性的证明方式(源码锚点、fixture、聚焦测试、日志或 trace)及其证明力;只证明 consumer 算法不足以证明新输入真的到达 consumer。
|
|
202
166
|
|
|
203
|
-
|
|
167
|
+
## 待用户确认与审查
|
|
204
168
|
|
|
205
|
-
|
|
206
|
-
遇到会影响需求范围、验收标准、用户可见行为、方案取舍、测试策略、安全、权限、数据判断的关键不确定问题,先写入相关计划文档的 `## 待用户确认` 段落;没有阻塞确认项的文档不加该段落:
|
|
169
|
+
会影响范围、验收、兼容、数据语义、安全或关键方案取舍的未知,写在相应计划文档的 `## 待用户确认` 下:
|
|
207
170
|
|
|
208
171
|
```markdown
|
|
209
172
|
## 待用户确认
|
|
210
|
-
|
|
211
|
-
- [ ] DEC-001 [方案] 是否需要兼容历史行为?影响:验收口径(CHAIN-003)。选项:A 兼容(加开关、保留旧路径)/ B 不兼容。建议 A:存量数据仍被报表消费
|
|
173
|
+
- [ ] DEC-001 [方案] <一个待决问题>。影响:<范围/验收>。选项:A <后果> / B <后果>。建议:<理由>
|
|
212
174
|
```
|
|
213
175
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
`next` 会在 propose 阶段检查 `proposal.md`、`design.md` 和 `test-contract.md` 的该段落。存在未确认项时,汇总一次向用户提问(按影响排序并说明问题间依赖,不逐个往返);收到回答后用驱动方式中的 `record user-decision` 命令登记,JSON 经 stdin 传入(scope 建议引用 `DEC-xxx`,一条决策可列多个 ID;此为留痕约定,引擎不校验格式)。
|
|
217
|
-
|
|
218
|
-
答案来自用户时,先登记再勾选;答案来自需求文档、代码证据等外部事实核对时,行内写明证据来源,不伪造用户决策。用户回答含糊、与候选项不匹配或引出新问题时,不视为已确认;复述理解并获得明确答复后再登记。把结论反映到 proposal/design/test-contract 相关内容,勾选行内注明结论要点;确认项作废或重复时改为 `[x]` 并注明理由,不要删除确认项。局部实现细节、命名、普通文件组织和不影响需求/验收/风险的技术微调不要升级为用户确认。
|
|
219
|
-
|
|
220
|
-
进入 propose 后出现新的业务规则、产品口径、验收标准、示例规范或需求源更新时,不要静默覆盖原计划;默认先在 `proposal.md` 记录 `## 需求变化`,说明变化来源、变化内容、受影响能力、直接修改的文档章节、确认保持不变的范围和处理方式(更新当前 change / 新建后续 change / 暂不处理)。该段是后续增量审查判断“本轮变化”的权威锚点;不得把未受影响的历史设计重新列为本轮待审范围。只有影响规格、技术路线或测试契约时,才同步更新 `specs/`、`design.md` 或 `test-contract.md`。
|
|
221
|
-
|
|
222
|
-
审查报告是待验证的独立意见,不会自动创造新需求。主流程处理 finding 时先分离 underlying problem 与 recommendation:根据本次 change 的目标、直接证据和明确验收独立判断问题是否成立;问题成立时选择满足既有需求的最小修复。Recommendation 只是非绑定建议,不是验收标准;与用户决定、已确认复用路线或 `## 非目标` 冲突的具体方案不实施,也不得仅为通过审查增加未经确认的基础设施、兼容、额外任务、故障场景或测试义务。若 reviewer 指出的事实证据证明现有方案无法满足用户已确认的强制需求、规格约束或明确验收结果,补足对应结果、契约或证据,而不是默认采用 reviewer 指定的架构;Reviewer 不得自行新增或升级强制要求。
|
|
223
|
-
|
|
224
|
-
普通计划审查未通过后,主流程拥有整份报告的最终阻塞准入判断权,但不得篡改原报告或把审查意见直接升级为需求。只要报告中存在一个有直接证据、属于本次 change 且影响明确验收或落地的问题,就修改对应材料并重新审查;不要为了让报告“全部正确”而处理其余越界建议。只有整份报告提出的问题均不具备上述阻塞条件时,才可将本次审查结论标记为不阻塞,并按工作流提供的方式留痕。该判断只适用于当前材料;材料变化后必须重新审查,不做部分问题裁决或永久豁免。问题是否成立取决于需求范围、验收口径、风险接受或技术路线时,先询问用户;可由当前材料直接判定的越界、无证据或非阻断建议由主流程说明判断理由。
|
|
225
|
-
|
|
226
|
-
## 完成条件
|
|
176
|
+
收到答复后,先按 `next` 返回的方式登记用户决策,再回写材料并勾选该项。局部实现细节不升级为用户决策。
|
|
227
177
|
|
|
228
|
-
|
|
178
|
+
审查意见是独立证据,不会自动创造需求。只修复有直接证据、属于本次 change 且影响已声明验收或可落地性的问题;以满足现有需求的最小改动闭环。建议、技术偏好或未采纳路线不能自行升级为 task、测试义务或基础设施。材料变化后重新运行 `next`,由引擎安排必要复审。
|
|
229
179
|
|
|
230
180
|
## Guardrails
|
|
231
181
|
|
|
232
|
-
-
|
|
233
|
-
-
|
|
234
|
-
-
|
|
235
|
-
- 不跳过 transition
|
|
236
|
-
- 不跳过完整审查路径下的审核工作项
|
|
237
|
-
- 审查通过后、推进前不做非必要的文档编辑;计划材料变更会按当前审查模式和角色职责触发必要的复审。
|
|
182
|
+
- 不绕过未确认的业务决策或返回的独立审查事项。
|
|
183
|
+
- 不把 Impact 当作文件白名单,也不把审查建议当作新需求。
|
|
184
|
+
- 不手写流程推进、审查结论或验证证据。
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: superspec-review
|
|
3
|
-
description: "
|
|
3
|
+
description: "在 SuperSpec Review 阶段运行独立代码审查、最终验证并完成交付闭环。适用于 apply 结束后的审查、修复、验证。"
|
|
4
4
|
metadata:
|
|
5
5
|
author: SuperSpec
|
|
6
6
|
source: SuperSpec
|
|
@@ -8,84 +8,25 @@ metadata:
|
|
|
8
8
|
|
|
9
9
|
# SuperSpec Review
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
完成代码审查、最终验证和交付确认;目标是证明本次 change 已满足既定计划,而不是增加审批或需求。
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## 工作方式
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
运行 `superspec transition next --change "<change>"`,以返回的 job packet、角色、提交命令和下一步为准。代码、计划或证据发生变化后重新运行 `next`,不要手动复用旧结论。
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
2. 执行返回的命令,或处理返回的工作项/用户确认。
|
|
19
|
-
3. 登记结果。
|
|
20
|
-
4. 回到第 1 步。
|
|
17
|
+
处理审查或验证工作项时:
|
|
21
18
|
|
|
22
|
-
|
|
19
|
+
1. 打开 job packet,确认当前范围、引用材料和停止条件。
|
|
20
|
+
2. 启动指定的独立角色做只读判断;主流程不替代该角色重审。
|
|
21
|
+
3. 按 packet 返回的命令登记原始报告,报告必须基于真实文件、事件或测试证据。
|
|
22
|
+
4. 重新运行 `next`,让引擎决定修复、复审、验证或交付。
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
代码审查发现纯实现问题时,按当前动作回到同一 change 的 apply 追加最小修复;修复采用当前 mode 对应的验证要求。方案、需求或混合问题需要主流程按证据区分处理方向,不能擅自选择改代码还是改计划。最终验证通过后,只有 `next` 明确给出交付动作时才交付。
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
| 当前状态 | 动作 |
|
|
29
|
-
|---|---|
|
|
30
|
-
| `apply` | 所有 task 已完成时推进到 `apply_done` |
|
|
31
|
-
| `apply_done` | 执行代码审查 |
|
|
32
|
-
| `review` | 执行最终验证 |
|
|
33
|
-
|
|
34
|
-
在 `apply_done`:
|
|
35
|
-
|
|
36
|
-
- 有代码类改动时,`review-ready` 创建或等待代码审查工作项。
|
|
37
|
-
- 没有代码类改动时,`review-ready` 直接进入 `review`,不启动子代理;内部会记录跳过原因。
|
|
38
|
-
- 代码审查通过后,再次执行 `review-ready` 进入 `review`。
|
|
39
|
-
- 代码审查通过后若代码状态再次变化,旧审查失效;流程内如果需要改代码,必须先回 apply,修完后重新走代码审查。
|
|
40
|
-
|
|
41
|
-
在 `review`:
|
|
42
|
-
|
|
43
|
-
- `review-ready` 创建或等待最终验证工作项。
|
|
44
|
-
- 最终验证工作项会绑定方案文档和当前已登记的执行证据版本。
|
|
45
|
-
- 最终验证通过后,如果绑定文档或已登记执行证据版本变化,下一次 `review-ready` 会创建新的最终验证工作项。
|
|
46
|
-
- 不要根据风险参数自行跳过最终验证;按 next 和 `review-ready` 返回结果执行。
|
|
47
|
-
|
|
48
|
-
## 工作项处理
|
|
49
|
-
|
|
50
|
-
如果 next 返回代码审查或最终验证工作项:
|
|
51
|
-
|
|
52
|
-
1. 读取工作项说明(job packet)。
|
|
53
|
-
2. 启动对应独立角色执行只读审查或验证。
|
|
54
|
-
3. 按工作项说明中的提交命令提交 JSON 报告,优先从 stdin 提交。
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
superspec record job-submit --change "<change>" --job <JOB> --report -
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
文件路径模式仅作为备用。报告登记沿用现有事件和原始报告归档机制;不要新增追溯字段或自定义原始报告文件类型。
|
|
61
|
-
|
|
62
|
-
代码审查结果处理:
|
|
63
|
-
|
|
64
|
-
- 代码审查通过:再次执行 `review-ready`,进入 `review`。
|
|
65
|
-
- 报告格式不符合要求,或没有给出可处理的问题:状态停在 `apply_done`,下一轮代码审查工作项说明会带上拒绝原因;按原因修正报告生成方式或审查口径后再执行。
|
|
66
|
-
- 连续两次报告不符合要求或没有可处理问题时,next 会要求先修正报告生成方式、模板或审查口径,避免无限重试。
|
|
67
|
-
- 发现纯代码实现问题:按 next 提示执行 `reopen --to apply --review-fix <job_id>#<problem_id> --reason "<reason>"`,由引擎追加普通修复 task。
|
|
68
|
-
- 发现方案/需求文档问题或混合问题:next 会先返回用户确认。记录使用者选择和原因后,按 next 返回的命令回到计划阶段或实现阶段。
|
|
69
|
-
|
|
70
|
-
最终验证结果处理:
|
|
71
|
-
|
|
72
|
-
- 最终验证通过:执行 next 下发的 accept 命令。
|
|
73
|
-
- 最终验证未通过:报告会保全原始报告引用和问题列表。按报告中的问题修复或回退;不要直接 accept。
|
|
74
|
-
|
|
75
|
-
## accept 和 accepted 后返工
|
|
76
|
-
|
|
77
|
-
- 只有状态为 `review`,且 `next` / `review-ready` 要求的审查或验证已满足时,才执行 accept。
|
|
78
|
-
- `accepted` 是正常完成终态,next 不再继续推进。
|
|
79
|
-
- 使用者补充、修正或扩展方案、需求、验收或实现约束时,主流程先确定唯一对应的 change 并读取真实状态;只有该 change 当前为 accepted,才按 next 返回的内部 continuation 自动把用户内容概括为 reason 并回到 propose。无法唯一确定 change 时只询问补充属于哪个 change;不要让使用者选择工作流动作,也不要要求使用者执行命令。
|
|
80
|
-
- 如果只是问答、致谢或不改变方案含义的说明,保持 accepted,不触发状态变化。
|
|
81
|
-
- 不从 accepted 直接回 apply;回到 propose 后先修改计划材料,再按 next 重新完成计划审查、实现、代码审查和最终验证。
|
|
26
|
+
用户新增或改变需求、验收、兼容或实现约束时,先回到对应 change 的 propose 更新计划;不把自然语言补充直接作为编码授权。问答、致谢或不改变方案含义的说明不触发返工。
|
|
82
27
|
|
|
83
28
|
## Guardrails
|
|
84
29
|
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
- 涉及代码审查问题回退时,以 next 当前返回为准,不手动套用旧 job 或旧问题编号。
|
|
89
|
-
- 不把 accepted 后的新需求直接当作 apply 授权,必须先 reopen 到 propose。
|
|
90
|
-
- 审查和验证报告必须引用真实文件、事件或测试证据,不编造。
|
|
91
|
-
- 不跳过 transition。
|
|
30
|
+
- 不绕过引擎要求的审查、验证、确认或修复。
|
|
31
|
+
- 不手写状态推进、报告结论或伪造证据。
|
|
32
|
+
- 审查报告必须基于真实文件、事件或测试证据;建议不自动升级为新需求。
|