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