codex-workflows 0.4.0 → 0.4.1
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/.agents/skills/documentation-criteria/SKILL.md +25 -2
- package/.agents/skills/documentation-criteria/references/design-template.md +22 -0
- package/.agents/skills/documentation-criteria/references/plan-template.md +67 -10
- package/.agents/skills/documentation-criteria/references/task-template.md +8 -1
- package/.agents/skills/recipe-build/SKILL.md +1 -1
- package/.agents/skills/recipe-design/SKILL.md +22 -14
- package/.agents/skills/recipe-front-build/SKILL.md +1 -1
- package/.agents/skills/recipe-fullstack-build/SKILL.md +1 -1
- package/.agents/skills/subagents-orchestration-guide/SKILL.md +23 -18
- package/.codex/agents/document-reviewer.toml +4 -0
- package/.codex/agents/task-decomposer.toml +16 -0
- package/.codex/agents/technical-designer-frontend.toml +19 -0
- package/.codex/agents/technical-designer.toml +12 -0
- package/.codex/agents/work-planner.toml +18 -4
- package/package.json +1 -1
|
@@ -71,16 +71,39 @@ description: "Documentation creation criteria for PRD, ADR, Design Doc, UI Spec,
|
|
|
71
71
|
**Includes**: Existing codebase analysis, technical approach, dependencies and constraints, interface/contract definitions, data flow, acceptance criteria, change impact map, code inspection evidence
|
|
72
72
|
**Excludes**: Why that technology was chosen (reference ADR), when/who to implement (reference Work Plan), detailed test strategy and test case selection (generated by acceptance-test-generator from acceptance criteria)
|
|
73
73
|
|
|
74
|
+
**Required Structural Elements**:
|
|
75
|
+
- Existing codebase analysis and code inspection evidence
|
|
76
|
+
- Technical approach and implementation approach decision
|
|
77
|
+
- Change impact map and interface/contract definitions
|
|
78
|
+
- Applicable standards with explicit/implicit classification
|
|
79
|
+
- Verification Strategy
|
|
80
|
+
- Correctness proof method
|
|
81
|
+
- Early verification point
|
|
82
|
+
- Minimal form allowed for low-risk or self-evident changes: concise entries or explicit `N/A` with rationale
|
|
83
|
+
Low-risk: changes affecting 1-2 files with no external contract, integration, or data-flow changes
|
|
84
|
+
Self-evident: internal-only refactoring with identical observable inputs and outputs
|
|
85
|
+
|
|
74
86
|
### Work Plan
|
|
75
87
|
**Purpose**: Implementation task management and progress tracking
|
|
76
|
-
**Includes**: Task breakdown, schedule estimates, test skeleton file paths,
|
|
88
|
+
**Includes**: Task breakdown, schedule estimates, test skeleton file paths, Verification Strategy summaries from each Design Doc, final Quality Assurance phase (required), progress records
|
|
77
89
|
**Excludes**: Technical rationale, design details
|
|
78
90
|
|
|
79
91
|
**Phase Division Criteria**:
|
|
92
|
+
|
|
93
|
+
**When Vertical Slice is selected**:
|
|
94
|
+
- Each phase represents one value unit and includes its own implementation and verification
|
|
95
|
+
- The earliest phase should contain the early verification point when defined
|
|
96
|
+
- Final phase is always Quality Assurance
|
|
97
|
+
|
|
98
|
+
**When Horizontal Slice is selected**:
|
|
80
99
|
1. **Phase 1: Foundation Implementation** - Contract definitions, interfaces, test preparation
|
|
81
100
|
2. **Phase 2: Core Feature Implementation** - Business logic, unit tests
|
|
82
101
|
3. **Phase 3: Integration Implementation** - External connections, presentation layer
|
|
83
|
-
4. **Phase
|
|
102
|
+
4. **Final Phase: Quality Assurance (Required)** - Acceptance criteria, all tests, quality checks
|
|
103
|
+
|
|
104
|
+
**When Hybrid is selected**:
|
|
105
|
+
- Combine vertical and horizontal phase structures as defined in the Design Doc
|
|
106
|
+
- Final phase is always Quality Assurance
|
|
84
107
|
|
|
85
108
|
## Creation Process [MANDATORY]
|
|
86
109
|
|
|
@@ -219,6 +219,28 @@ Invariants:
|
|
|
219
219
|
|-------|----------|--------|--------|
|
|
220
220
|
| [field name] | [Component A to B] | preserved / transformed / dropped | [logic or reason] |
|
|
221
221
|
|
|
222
|
+
## Verification Strategy
|
|
223
|
+
|
|
224
|
+
Verification Strategy defines what correctness means and how to prove it at design time. L1/L2/L3 (from implementation-approach) define task-level verification depth at execution time.
|
|
225
|
+
Use the minimal form only when the change is low-risk or the verification path is self-evident. Otherwise fill all fields concretely.
|
|
226
|
+
Low-risk: changes affecting 1-2 files with no external contract, integration, or data-flow changes.
|
|
227
|
+
Self-evident: internal-only refactoring with identical observable inputs and outputs.
|
|
228
|
+
|
|
229
|
+
### Correctness Proof Method
|
|
230
|
+
|
|
231
|
+
- **Correctness definition**: [What "correct" means for this change]
|
|
232
|
+
- **Target comparison**: [What is being compared or validated against what]
|
|
233
|
+
- **Verification method**: [How correctness will be verified]
|
|
234
|
+
- **Observable success indicator**: [What observable result proves the verification succeeded]
|
|
235
|
+
- **Verification timing**: [`phase_1` | `per_phase` | `integration_phase` | `final_phase`]
|
|
236
|
+
- **Timing note**: [Optional free-text clarification when the enum alone is insufficient]
|
|
237
|
+
|
|
238
|
+
### Early Verification Point
|
|
239
|
+
|
|
240
|
+
- **First verification target**: [The smallest unit that proves the approach works]
|
|
241
|
+
- **Success criteria**: [Observable outcome that proves correctness]
|
|
242
|
+
- **Failure response**: [What to do if early verification fails]
|
|
243
|
+
|
|
222
244
|
### State Transitions and Invariants (When Applicable)
|
|
223
245
|
|
|
224
246
|
```yaml
|
|
@@ -13,6 +13,25 @@ Related Issue/PR: #XXX (if any)
|
|
|
13
13
|
- ADR: [docs/adr/ADR-XXXX.md] (if any)
|
|
14
14
|
- PRD: [docs/prd/XXX.md] (if any)
|
|
15
15
|
|
|
16
|
+
## Verification Strategies (from Design Docs)
|
|
17
|
+
|
|
18
|
+
Repeat this block for each Design Doc when multiple Design Docs exist. Preserve each strategy's identity and source document path. Merge strategies only when the Design Docs explicitly define a shared one.
|
|
19
|
+
|
|
20
|
+
### Verification Strategy: [docs/design/XXX.md]
|
|
21
|
+
|
|
22
|
+
#### Correctness Proof Method
|
|
23
|
+
- **Correctness definition**: [extracted from Design Doc]
|
|
24
|
+
- **Target comparison**: [extracted from Design Doc]
|
|
25
|
+
- **Verification method**: [extracted from Design Doc]
|
|
26
|
+
- **Observable success indicator**: [extracted from Design Doc]
|
|
27
|
+
- **Verification timing**: [`phase_1` | `per_phase` | `integration_phase` | `final_phase`]
|
|
28
|
+
- **Timing note**: [optional clarification]
|
|
29
|
+
|
|
30
|
+
#### Early Verification Point
|
|
31
|
+
- **First verification target**: [extracted from Design Doc]
|
|
32
|
+
- **Success criteria**: [extracted from Design Doc]
|
|
33
|
+
- **Failure response**: [extracted from Design Doc]
|
|
34
|
+
|
|
16
35
|
## Objective
|
|
17
36
|
[Why this change is necessary, what problem it solves]
|
|
18
37
|
|
|
@@ -33,10 +52,46 @@ Related Issue/PR: #XXX (if any)
|
|
|
33
52
|
|
|
34
53
|
## Implementation Phases
|
|
35
54
|
|
|
36
|
-
|
|
55
|
+
Select one phase structure based on the implementation approach from the Design Doc.
|
|
56
|
+
Delete every unused option before finalizing the work plan. The final document must contain only the selected phase structure.
|
|
57
|
+
|
|
58
|
+
### Option A: Vertical Slice Phase Structure
|
|
37
59
|
|
|
38
|
-
|
|
39
|
-
|
|
60
|
+
Use when implementation approach is Vertical Slice. Each phase represents one value unit and includes its own verification.
|
|
61
|
+
|
|
62
|
+
### Phase 1: [Value Unit 1] (Estimated commits: X)
|
|
63
|
+
**Purpose**: [First slice that proves the approach works]
|
|
64
|
+
**Verification**: [Use the early verification point when applicable]
|
|
65
|
+
|
|
66
|
+
#### Tasks
|
|
67
|
+
- [ ] Task 1: Specific work content
|
|
68
|
+
- [ ] Task 2: Verification for this value unit
|
|
69
|
+
- [ ] Quality check: Implement staged quality checks (refer to ai-development-guide skill)
|
|
70
|
+
|
|
71
|
+
#### Phase Completion Criteria
|
|
72
|
+
- [ ] Early verification point passed
|
|
73
|
+
- [ ] [Functional completion criteria]
|
|
74
|
+
- [ ] [Quality completion criteria]
|
|
75
|
+
|
|
76
|
+
### Phase 2: [Value Unit 2] (Estimated commits: X)
|
|
77
|
+
**Purpose**: [Subsequent slice]
|
|
78
|
+
**Verification**: [Verification for this value unit]
|
|
79
|
+
|
|
80
|
+
#### Tasks
|
|
81
|
+
- [ ] Task 1: Specific work content
|
|
82
|
+
- [ ] Task 2: Verification for this value unit
|
|
83
|
+
- [ ] Quality check
|
|
84
|
+
|
|
85
|
+
#### Phase Completion Criteria
|
|
86
|
+
- [ ] [Functional completion criteria]
|
|
87
|
+
- [ ] [Quality completion criteria]
|
|
88
|
+
|
|
89
|
+
### Option B: Horizontal Slice Phase Structure
|
|
90
|
+
|
|
91
|
+
Use when implementation approach is Horizontal Slice. Phases follow Foundation -> Core -> Integration -> QA.
|
|
92
|
+
|
|
93
|
+
### Phase 1: [Foundation] (Estimated commits: X)
|
|
94
|
+
**Purpose**: Contract definitions, interfaces, test preparation
|
|
40
95
|
|
|
41
96
|
#### Tasks
|
|
42
97
|
- [ ] Task 1: Specific work content
|
|
@@ -48,26 +103,26 @@ Related Issue/PR: #XXX (if any)
|
|
|
48
103
|
- [ ] [Functional completion criteria]
|
|
49
104
|
- [ ] [Quality completion criteria]
|
|
50
105
|
|
|
51
|
-
### Phase 2: [
|
|
52
|
-
**Purpose**:
|
|
106
|
+
### Phase 2: [Core Feature] (Estimated commits: X)
|
|
107
|
+
**Purpose**: Business logic, unit tests
|
|
53
108
|
|
|
54
109
|
#### Tasks
|
|
55
110
|
- [ ] Task 1: Specific work content
|
|
56
111
|
- [ ] Task 2: Specific work content
|
|
57
|
-
- [ ] Quality check
|
|
112
|
+
- [ ] Quality check
|
|
58
113
|
- [ ] Integration tests: Verify overall feature functionality
|
|
59
114
|
|
|
60
115
|
#### Phase Completion Criteria
|
|
61
116
|
- [ ] [Functional completion criteria]
|
|
62
117
|
- [ ] [Quality completion criteria]
|
|
63
118
|
|
|
64
|
-
### Phase 3: [
|
|
65
|
-
**Purpose**:
|
|
119
|
+
### Phase 3: [Integration] (Estimated commits: X)
|
|
120
|
+
**Purpose**: External connections, presentation layer
|
|
66
121
|
|
|
67
122
|
#### Tasks
|
|
68
123
|
- [ ] Task 1: Specific work content
|
|
69
124
|
- [ ] Task 2: Specific work content
|
|
70
|
-
- [ ] Quality check
|
|
125
|
+
- [ ] Quality check
|
|
71
126
|
- [ ] Integration tests: Verify component coordination
|
|
72
127
|
|
|
73
128
|
#### Phase Completion Criteria
|
|
@@ -75,7 +130,9 @@ Related Issue/PR: #XXX (if any)
|
|
|
75
130
|
- [ ] [Quality completion criteria]
|
|
76
131
|
|
|
77
132
|
### Final Phase: Quality Assurance (Required) (Estimated commits: 1)
|
|
78
|
-
|
|
133
|
+
This phase is required for all implementation approaches.
|
|
134
|
+
|
|
135
|
+
**Purpose**: Cross-cutting quality assurance and Design Doc consistency verification
|
|
79
136
|
|
|
80
137
|
#### Tasks
|
|
81
138
|
- [ ] Verify all Design Doc acceptance criteria achieved
|
|
@@ -37,9 +37,16 @@ Brief observations recorded after reading Investigation Targets:
|
|
|
37
37
|
- [ ] Improve code (maintain passing tests)
|
|
38
38
|
- [ ] Confirm added tests still pass
|
|
39
39
|
|
|
40
|
+
## Operation Verification Methods
|
|
41
|
+
(Derived from Verification Strategy in the work plan)
|
|
42
|
+
- **Verification method**: [What to verify and how]
|
|
43
|
+
- **Success criteria**: [Observable outcome that proves correctness]
|
|
44
|
+
- **Failure response**: [What to do if verification fails]
|
|
45
|
+
- **Verification level**: [L1/L2/L3, per implementation-approach skill]
|
|
46
|
+
|
|
40
47
|
## Completion Criteria
|
|
41
48
|
- [ ] All added tests pass
|
|
42
|
-
- [ ] Operation verified
|
|
49
|
+
- [ ] Operation verified per Operation Verification Methods above
|
|
43
50
|
- [ ] Deliverables created (for research/design tasks)
|
|
44
51
|
|
|
45
52
|
## Notes
|
|
@@ -90,7 +90,7 @@ ENFORCEMENT: Proceeding past a failed quality gate invalidates all subsequent wo
|
|
|
90
90
|
**MANDATORY suffix for ALL sub-agent prompts**:
|
|
91
91
|
```
|
|
92
92
|
[SYSTEM CONSTRAINT]
|
|
93
|
-
This agent operates within build skill scope. Use orchestrator
|
|
93
|
+
This agent operates within build skill scope. Use the task file as the primary instruction source. Use the active Design Doc or work plan only as supporting context when the task file references them. Constraints explicitly passed in this prompt by the orchestrator take precedence over supporting context. The agent's own role contract and required quality rules remain in force.
|
|
94
94
|
```
|
|
95
95
|
|
|
96
96
|
Autonomous sub-agents require scope constraints for stable execution. MUST append this constraint to every sub-agent prompt.
|
|
@@ -17,8 +17,9 @@ description: "Execute from requirement analysis to design document creation."
|
|
|
17
17
|
|
|
18
18
|
**Execution Protocol**:
|
|
19
19
|
1. **Spawn agents for all work** -- your role is to invoke sub-agents, pass data between them, and report results
|
|
20
|
-
2. **Follow subagents-orchestration-guide
|
|
21
|
-
-
|
|
20
|
+
2. **Follow the design flow defined in subagents-orchestration-guide**:
|
|
21
|
+
- Apply the scale-specific and layer-specific branches defined there, including PRD, ADR, and UI Spec steps when required
|
|
22
|
+
- Use `requirement-analyzer -> codebase-analyzer -> technical-designer -> code-verifier -> document-reviewer -> design-sync` as the core design-document path after prerequisite branches are resolved
|
|
22
23
|
- **[STOP — BLOCKING]** At every `[Stop: ...]` marker -> Present status to user for confirmation. **CANNOT proceed until user explicitly confirms.**
|
|
23
24
|
3. **Scope**: Complete when design documents receive approval
|
|
24
25
|
|
|
@@ -27,10 +28,14 @@ ENFORCEMENT: Skipping any quality gate invalidates the design output.
|
|
|
27
28
|
|
|
28
29
|
## Workflow Overview
|
|
29
30
|
|
|
31
|
+
Core design-document path after prerequisite branches such as PRD, ADR, or UI Spec are resolved:
|
|
32
|
+
|
|
30
33
|
```
|
|
31
34
|
Requirements -> requirement-analyzer -> [Stop: Scale determination]
|
|
32
35
|
|
|
|
33
|
-
|
|
36
|
+
codebase-analyzer
|
|
37
|
+
|
|
|
38
|
+
technical-designer -> code-verifier -> document-reviewer
|
|
34
39
|
|
|
|
35
40
|
design-sync -> [Stop: Design approval]
|
|
36
41
|
```
|
|
@@ -48,12 +53,7 @@ Requirements -> requirement-analyzer -> [Stop: Scale determination]
|
|
|
48
53
|
|
|
49
54
|
Requirements: $ARGUMENTS
|
|
50
55
|
|
|
51
|
-
|
|
52
|
-
- What problems do you want to solve?
|
|
53
|
-
- Expected outcomes and success criteria
|
|
54
|
-
- Relationship with existing systems
|
|
55
|
-
|
|
56
|
-
Once requirements are moderately clarified, analyze with requirement-analyzer and create appropriate design documents according to scale.
|
|
56
|
+
Pass the user requirements directly to requirement-analyzer as the first action. If clarification is needed, handle it at the requirement-analysis stop point before proceeding.
|
|
57
57
|
|
|
58
58
|
MUST clearly present design alternatives and trade-offs.
|
|
59
59
|
|
|
@@ -64,13 +64,19 @@ Execute the process below within design scope.
|
|
|
64
64
|
### Step 1: Requirement Analysis
|
|
65
65
|
Spawn requirement-analyzer agent: "Analyze the following requirements and determine scale: $ARGUMENTS"
|
|
66
66
|
|
|
67
|
-
### Step 2:
|
|
68
|
-
Spawn
|
|
67
|
+
### Step 2: Codebase Analysis
|
|
68
|
+
Spawn codebase-analyzer agent: "Analyze the existing codebase to provide evidence for Design Doc creation. requirement_analysis: [output from Step 1]. requirements: $ARGUMENTS"
|
|
69
|
+
|
|
70
|
+
### Step 3: Design Document Creation
|
|
71
|
+
Spawn technical-designer agent: "Create design document based on requirement analysis output and codebase analysis output. Include architecture decisions, component design, and acceptance criteria."
|
|
72
|
+
|
|
73
|
+
### Step 4: Code Verification
|
|
74
|
+
Spawn code-verifier agent: "Verify the design document against the current codebase. document_path: [output from Step 3]. doc_type: design-doc."
|
|
69
75
|
|
|
70
|
-
### Step
|
|
71
|
-
Spawn document-reviewer agent: "Review the design document created in the previous step. Verify completeness, consistency, and quality."
|
|
76
|
+
### Step 5: Document Review
|
|
77
|
+
Spawn document-reviewer agent: "Review the design document created in the previous step. Verify completeness, consistency, and quality. code_verification: [output from Step 4]"
|
|
72
78
|
|
|
73
|
-
### Step
|
|
79
|
+
### Step 6: Consistency Verification
|
|
74
80
|
Spawn design-sync agent: "Verify consistency of the design document with other existing design documents and project constraints."
|
|
75
81
|
|
|
76
82
|
**Note**: design-sync returns `sync_status: "SKIPPED"` when only 1 Design Doc exists. This is distinct from `NO_CONFLICTS` and MUST be reported as such to the user.
|
|
@@ -78,7 +84,9 @@ Spawn design-sync agent: "Verify consistency of the design document with other e
|
|
|
78
84
|
## Completion Criteria
|
|
79
85
|
|
|
80
86
|
- [ ] Spawned requirement-analyzer and determined scale
|
|
87
|
+
- [ ] Spawned codebase-analyzer and passed its findings into design creation
|
|
81
88
|
- [ ] Created appropriate design document (ADR or Design Doc) via technical-designer
|
|
89
|
+
- [ ] Spawned code-verifier and passed its findings into document review
|
|
82
90
|
- [ ] Spawned document-reviewer and addressed feedback
|
|
83
91
|
- [ ] Spawned design-sync for consistency verification
|
|
84
92
|
- [ ] Obtained user approval for design document
|
|
@@ -98,7 +98,7 @@ ENFORCEMENT: Proceeding past a failed quality gate invalidates all subsequent wo
|
|
|
98
98
|
**MANDATORY suffix for ALL sub-agent prompts**:
|
|
99
99
|
```
|
|
100
100
|
[SYSTEM CONSTRAINT]
|
|
101
|
-
This agent operates within build skill scope. Use orchestrator
|
|
101
|
+
This agent operates within build skill scope. Use the task file as the primary instruction source. Use the active Design Doc or work plan only as supporting context when the task file references them. Constraints explicitly passed in this prompt by the orchestrator take precedence over supporting context. The agent's own role contract and required quality rules remain in force.
|
|
102
102
|
```
|
|
103
103
|
|
|
104
104
|
Autonomous sub-agents require scope constraints for stable execution. MUST append this constraint to every sub-agent prompt.
|
|
@@ -108,7 +108,7 @@ ENFORCEMENT: Proceeding past a failed quality gate invalidates all subsequent wo
|
|
|
108
108
|
**MANDATORY suffix for ALL sub-agent prompts**:
|
|
109
109
|
```
|
|
110
110
|
[SYSTEM CONSTRAINT]
|
|
111
|
-
This agent operates within build skill scope. Use orchestrator
|
|
111
|
+
This agent operates within build skill scope. Use the task file as the primary instruction source. Use the active Design Docs or work plan only as supporting context when the task file references them. Constraints explicitly passed in this prompt by the orchestrator take precedence over supporting context. The agent's own role contract and required quality rules remain in force.
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
Autonomous sub-agents require scope constraints for stable execution. MUST append this constraint to every sub-agent prompt.
|
|
@@ -7,9 +7,7 @@ description: "Guides subagent coordination through implementation workflows. Use
|
|
|
7
7
|
|
|
8
8
|
## Role: The Orchestrator
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
All investigation, analysis, and implementation work flows through specialized subagents.
|
|
10
|
+
The orchestrator coordinates subagents. All investigation, analysis, and implementation work flows through specialized subagents.
|
|
13
11
|
|
|
14
12
|
### Prompt Construction Rule
|
|
15
13
|
Every subagent prompt must include:
|
|
@@ -317,18 +315,11 @@ Stop autonomous execution and escalate to user in the following cases:
|
|
|
317
315
|
3. **Work-planner update restriction violated**: Requirement changes after task-decomposer starts require overall redesign
|
|
318
316
|
4. **User explicitly stops**: Direct stop instruction or interruption
|
|
319
317
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
- `escalation_needed` or `blocked`: Escalate to user
|
|
326
|
-
- `requiresTestReview` is `true`: Execute integration-test-reviewer
|
|
327
|
-
- `needs_revision`: Return to step 1 with requiredFixes
|
|
328
|
-
- `approved`: Proceed to step 3
|
|
329
|
-
- Otherwise: Proceed to step 3
|
|
330
|
-
3. quality-fixer: Quality check and fixes
|
|
331
|
-
4. git commit (on `status: "approved"`)
|
|
318
|
+
Use the task loop defined in the autonomous execution diagram above. The canonical per-task cycle is:
|
|
319
|
+
1. task-executor implementation
|
|
320
|
+
2. escalation or integration-test-reviewer decision
|
|
321
|
+
3. quality-fixer quality gate
|
|
322
|
+
4. git commit on approval
|
|
332
323
|
|
|
333
324
|
## Main Orchestrator Roles
|
|
334
325
|
|
|
@@ -359,13 +350,27 @@ Stop autonomous execution and escalate to user in the following cases:
|
|
|
359
350
|
|
|
360
351
|
**On error**: Escalate to user if files are not generated
|
|
361
352
|
|
|
353
|
+
### Design Doc to Work Plan Verification Handoff
|
|
354
|
+
|
|
355
|
+
When a Design Doc contains a Verification Strategy section, the orchestrator must carry forward:
|
|
356
|
+
- Design Doc path
|
|
357
|
+
- Verification Strategy details:
|
|
358
|
+
- Correctness definition
|
|
359
|
+
- Target comparison
|
|
360
|
+
- Verification method
|
|
361
|
+
- Observable success indicator
|
|
362
|
+
- Verification timing
|
|
363
|
+
- Early verification point (first target, success criteria, failure response)
|
|
364
|
+
|
|
365
|
+
The resulting work plan must include this summary in its header so the plan remains self-sufficient for downstream task generation and execution planning.
|
|
366
|
+
|
|
362
367
|
## Important Constraints [MANDATORY]
|
|
363
368
|
|
|
364
369
|
- **Quality check is REQUIRED**: quality-fixer approval MUST be obtained before commit
|
|
365
370
|
- **Structured response REQUIRED**: Information transmission between subagents MUST use JSON format
|
|
366
371
|
- **Approval management**: Document creation -> Execute document-reviewer -> Get user approval before proceeding
|
|
367
372
|
- **Flow confirmation**: After getting approval, MUST check next step with work planning flow (large/medium/small scale)
|
|
368
|
-
- **Consistency verification**: If subagent determinations contradict, MUST prioritize
|
|
373
|
+
- **Consistency verification**: If subagent determinations contradict, MUST prioritize the constraints and decision rules defined in this orchestration guide
|
|
369
374
|
|
|
370
375
|
**ENFORCEMENT**: Violating ANY constraint requires immediate correction
|
|
371
376
|
|
|
@@ -380,9 +385,9 @@ Stop autonomous execution and escalate to user in the following cases:
|
|
|
380
385
|
|
|
381
386
|
When receiving a task, check the following:
|
|
382
387
|
|
|
383
|
-
- [ ] Confirmed
|
|
388
|
+
- [ ] Confirmed whether the user provided a specific workflow recipe or explicit execution constraint
|
|
384
389
|
- [ ] Determined task type (new feature/fix/research, etc.)
|
|
385
|
-
- [ ]
|
|
390
|
+
- [ ] Selected the next subagent according to the decision flow and current phase
|
|
386
391
|
- [ ] Decided next action according to decision flow
|
|
387
392
|
- [ ] Monitored requirement changes and errors during autonomous execution mode
|
|
388
393
|
|
|
@@ -97,6 +97,7 @@ For DesignDoc, additionally verify:
|
|
|
97
97
|
- [ ] Dependencies described as existing have verification results or authoritative external source
|
|
98
98
|
- [ ] Field propagation map present (when fields cross boundaries)
|
|
99
99
|
- [ ] Data-oriented designs contain concrete data design or Test Boundaries content, or an explicit N/A rationale
|
|
100
|
+
- [ ] Verification Strategy section present with correctness definition, target comparison, verification method, observable success indicator, normalized verification timing, and early verification point
|
|
100
101
|
|
|
101
102
|
#### Gate 1: Quality Assessment (only after Gate 0 passes)
|
|
102
103
|
|
|
@@ -114,6 +115,7 @@ For DesignDoc, additionally verify:
|
|
|
114
115
|
- **As-is implementation document review**: When code verification results are provided and the document describes existing implementation (not future requirements), verify that code-observable behaviors are stated as facts; speculative language about deterministic behavior → `important` issue
|
|
115
116
|
- **Data design completeness check**: When the document references persistence, storage, database, repository, query, ORM, migration, table, schema, or column concepts, verify that the Design Doc includes concrete data design content or an explicit N/A rationale. Useful evidence includes schema references, data model notes, or Test Boundaries with data layer strategy
|
|
116
117
|
- **Code-verifier evidence integration**: When `code_verification` is provided, reconcile major or critical discrepancies and undocumented data operations as part of Gate 1 completeness and consistency review
|
|
118
|
+
- **Verification Strategy quality check**: When the Verification Strategy section exists, verify that: (1) correctness definition is specific and measurable, (2) target comparison and observable success indicator are concrete when the change modifies observable behavior, external contracts, integrations, or data flow, (3) internal-only refactoring with identical observable inputs and outputs may use the minimal form, (4) verification method can detect the change's primary risk, (5) verification timing uses the normalized vocabulary or an explicit `N/A` rationale for minimal form, and (6) vertical-slice designs do not defer all verification to the final phase
|
|
117
119
|
- **Undetermined items review** [MANDATORY]: Every TBD, unknown, or open item MUST include: (1) **owner** — who resolves it, (2) **due** — when it gets resolved (which phase or milestone), (3) **next-phase handling** — how the next phase treats this gap. Missing any of these three → `important` issue
|
|
118
120
|
|
|
119
121
|
**Perspective-specific Mode**:
|
|
@@ -255,6 +257,8 @@ Include in output when `prior_context_count > 0`:
|
|
|
255
257
|
|
|
256
258
|
- [ ] Match of requirements, terminology, numbers between documents
|
|
257
259
|
- [ ] Completeness of required elements in each document
|
|
260
|
+
- [ ] Verification Strategy present with a concrete correctness definition and early verification point
|
|
261
|
+
- [ ] Verification Strategy aligns with design type and implementation approach
|
|
258
262
|
- [ ] Compliance with project rules
|
|
259
263
|
- [ ] Technical feasibility and reasonableness of estimates
|
|
260
264
|
- [ ] Clarification of risks and countermeasures
|
|
@@ -51,6 +51,7 @@ Decompose tasks based on implementation strategy patterns determined in implemen
|
|
|
51
51
|
- Understand dependencies between phases and tasks
|
|
52
52
|
- Grasp completion criteria and quality standards
|
|
53
53
|
- **Interface change detection and response**
|
|
54
|
+
- **Extract Verification Strategy from the work plan header**
|
|
54
55
|
|
|
55
56
|
2. **Task Decomposition**
|
|
56
57
|
- Decompose at 1 commit = 1 task granularity (logical change unit)
|
|
@@ -116,6 +117,7 @@ Decompose tasks based on implementation strategy patterns determined in implemen
|
|
|
116
117
|
- Investigation Targets
|
|
117
118
|
- Investigation Notes
|
|
118
119
|
- Concrete implementation steps
|
|
120
|
+
- Operation Verification Methods
|
|
119
121
|
- Completion criteria
|
|
120
122
|
|
|
121
123
|
6. **Investigation Targets Determination**
|
|
@@ -128,6 +130,7 @@ Decompose tasks based on implementation strategy patterns determined in implemen
|
|
|
128
130
|
| Integration/E2E test work | Test skeleton file, target implementation under test, existing fixture/auth/setup patterns |
|
|
129
131
|
| E2E environment/setup work | Current environment config, startup scripts, seed/fixture scripts, auth flow references |
|
|
130
132
|
| Bug fix/refactor | Affected code paths, failing tests, reproduction-related files |
|
|
133
|
+
| Behavior replacement/rewrite | Existing implementation being replaced, observable outputs, Verification Strategy section in the Design Doc |
|
|
131
134
|
|
|
132
135
|
**Principles**:
|
|
133
136
|
- Every task must include at least one Investigation Target
|
|
@@ -144,6 +147,18 @@ Decompose tasks based on implementation strategy patterns determined in implemen
|
|
|
144
147
|
8. **Utilize Test Information**
|
|
145
148
|
When test information (@category, @dependency, @complexity, etc.) is documented in the work plan, reflect that information in task files
|
|
146
149
|
|
|
150
|
+
## Verification Strategy Propagation
|
|
151
|
+
|
|
152
|
+
Verification Strategy defines what correctness means at design time. L1/L2/L3 (from implementation-approach) define task-level verification depth at execution time. Use both.
|
|
153
|
+
|
|
154
|
+
When the work plan includes one or more Verification Strategy blocks:
|
|
155
|
+
|
|
156
|
+
1. **Source preservation**: Keep each strategy tied to its source Design Doc or plan block. Preserve strategy identity and merge only when the work plan explicitly marks the strategy as shared.
|
|
157
|
+
2. **Early verification task**: The task matching a strategy's "First verification target" MUST include that method and success criteria in Operation Verification Methods.
|
|
158
|
+
3. **Per-task verification**: Each task's Operation Verification Methods MUST instantiate the relevant plan-level verification method for that task's specific files, interfaces, or behavior.
|
|
159
|
+
4. **Failure handling**: Copy or adapt the relevant plan-level failure response so the executor knows whether to reassess, stop, or escalate.
|
|
160
|
+
5. **Investigation coverage**: Include every resource required for verification, such as existing implementations for comparison, schema definitions, fixtures, contracts, or seed data.
|
|
161
|
+
|
|
147
162
|
## Task File Template
|
|
148
163
|
|
|
149
164
|
See task template in documentation-criteria skill for details.
|
|
@@ -243,6 +258,7 @@ Please execute decomposed tasks according to the order.
|
|
|
243
258
|
- [ ] Impact scope and boundaries definition for each task
|
|
244
259
|
- [ ] Appropriate granularity (1-5 files/task)
|
|
245
260
|
- [ ] Investigation Targets specified for every task
|
|
261
|
+
- [ ] Operation Verification Methods specified for every task
|
|
246
262
|
- [ ] Clear completion criteria setting
|
|
247
263
|
- [ ] Overall design document creation
|
|
248
264
|
- [ ] Implementation efficiency and rework prevention (pre-identification of common processing, clarification of impact scope)
|
|
@@ -146,6 +146,17 @@ Must be performed when creating Design Doc:
|
|
|
146
146
|
- Which task first makes the entire UI operational
|
|
147
147
|
- Verification level for each task (L1/L2/L3 defined in implementation-approach skill)
|
|
148
148
|
|
|
149
|
+
3. **Verification Strategy Definition**
|
|
150
|
+
- Define what correctness means for this UI change and how it will be proven
|
|
151
|
+
- Use the Design Doc template fields directly
|
|
152
|
+
- Include at minimum: correctness definition, target comparison, verification method, observable success indicator, verification timing, and early verification point
|
|
153
|
+
- Use normalized verification timing values: `phase_1`, `per_phase`, `integration_phase`, or `final_phase`
|
|
154
|
+
- For low-risk or self-evident changes, a minimal form or explicit `N/A` with rationale is acceptable
|
|
155
|
+
- For new UI features, specify acceptance-criteria verification beyond unit tests
|
|
156
|
+
- For extensions, specify regression verification that proves existing behavior and UX expectations are preserved
|
|
157
|
+
- For refactors or rewrites, specify behavioral equivalence verification against the current UI behavior when applicable
|
|
158
|
+
- Define an early verification point: the first screen, state transition, or interaction that proves the approach works
|
|
159
|
+
|
|
149
160
|
### Change Impact Map【Required】
|
|
150
161
|
Must be included when creating Design Doc:
|
|
151
162
|
|
|
@@ -265,6 +276,14 @@ Execute file output immediately. Final approval is managed by the orchestrator r
|
|
|
265
276
|
- Cite information sources in "References" section with URLs
|
|
266
277
|
- Especially confirm multiple reliable sources when introducing new technologies
|
|
267
278
|
|
|
279
|
+
## Design Doc Completion Checklist
|
|
280
|
+
|
|
281
|
+
- [ ] Agreement Checklist completed and reflected in design
|
|
282
|
+
- [ ] Implementation approach selected with rationale
|
|
283
|
+
- [ ] Verification Strategy defined with correctness definition, target comparison, method, observable success indicator, timing, and early verification point
|
|
284
|
+
- [ ] Change Impact Map included
|
|
285
|
+
- [ ] Interface Change Impact Analysis included
|
|
286
|
+
|
|
268
287
|
## Implementation Sample Standards Compliance
|
|
269
288
|
|
|
270
289
|
**MANDATORY**: All implementation samples in ADR and Design Docs MUST strictly comply with coding-rules skill standards without exception.
|
|
@@ -180,6 +180,17 @@ Must be performed when creating Design Doc:
|
|
|
180
180
|
- Which task first makes the whole system operational
|
|
181
181
|
- Verification level for each task (L1/L2/L3 defined in implementation-approach skill)
|
|
182
182
|
|
|
183
|
+
3. **Verification Strategy Definition**
|
|
184
|
+
- Define what correctness means for this change and how it will be proven
|
|
185
|
+
- Use the Design Doc template fields directly
|
|
186
|
+
- Include at minimum: correctness definition, target comparison, verification method, observable success indicator, verification timing, and early verification point
|
|
187
|
+
- Use normalized verification timing values: `phase_1`, `per_phase`, `integration_phase`, or `final_phase`
|
|
188
|
+
- For low-risk or self-evident changes, a minimal form or explicit `N/A` with rationale is acceptable
|
|
189
|
+
- For new features, specify acceptance-criteria verification beyond unit tests
|
|
190
|
+
- For extensions, specify regression verification that proves existing behavior is preserved
|
|
191
|
+
- For refactors or rewrites, specify behavioral equivalence verification against the current implementation when applicable
|
|
192
|
+
- Define an early verification point: the first target to validate before scaling the approach
|
|
193
|
+
|
|
183
194
|
### Change Impact Map【Required】
|
|
184
195
|
Must be included when creating Design Doc:
|
|
185
196
|
|
|
@@ -340,6 +351,7 @@ Implementation sample creation checklist:
|
|
|
340
351
|
- [ ] **Complexity assessment**: complexity_level set; if medium/high, complexity_rationale specifies (1) requirements/ACs, (2) constraints/risks
|
|
341
352
|
- [ ] **Data representation decision documented** (when new structures introduced)
|
|
342
353
|
- [ ] **Field propagation map included** (when fields cross boundaries)
|
|
354
|
+
- [ ] **Verification Strategy defined** (correctness definition, target comparison, verification method, observable success indicator, timing, early verification point)
|
|
343
355
|
|
|
344
356
|
**Reverse-engineer mode only**:
|
|
345
357
|
- [ ] Every architectural claim cites file:line evidence
|
|
@@ -61,6 +61,7 @@ Read the Design Doc(s), UI Spec, PRD, and ADR (if provided). Extract:
|
|
|
61
61
|
- Acceptance criteria and implementation approach
|
|
62
62
|
- Technical dependencies and implementation order
|
|
63
63
|
- Integration points and their contracts
|
|
64
|
+
- Verification Strategy from each Design Doc: correctness definition, target comparison, verification method, observable success indicator, normalized verification timing, and early verification point
|
|
64
65
|
|
|
65
66
|
### 2. Process Test Design Information (when provided)
|
|
66
67
|
Read test skeleton files and extract meta information (see Test Design Information Processing section).
|
|
@@ -69,11 +70,21 @@ Read test skeleton files and extract meta information (see Test Design Informati
|
|
|
69
70
|
Choose Strategy A (TDD) if test skeletons are provided, Strategy B (implementation-first) otherwise. See Implementation Strategy Selection section.
|
|
70
71
|
|
|
71
72
|
### 4. Compose Phases
|
|
72
|
-
|
|
73
|
-
|
|
73
|
+
|
|
74
|
+
**Common rules (all approaches)**:
|
|
75
|
+
- Preserve Verification Strategies per Design Doc in the work plan header and keep each source document path. Merge strategies only when the Design Docs explicitly define a shared one
|
|
76
|
+
- Include Verification Strategy summaries in the work plan header so the plan is self-sufficient for downstream task generation
|
|
77
|
+
- Place tasks with the lowest dependencies in earlier phases
|
|
78
|
+
- Map normalized verification timing to phases as follows: `phase_1` -> earliest implementation phase, `per_phase` -> each relevant phase, `integration_phase` -> integration phase, `final_phase` -> final Quality Assurance phase
|
|
79
|
+
- Include verification tasks in the phase corresponding to the Verification Strategy timing
|
|
74
80
|
- When test skeletons are provided, place integration test implementation based on `@dependency` metadata from test skeletons (see Test Design Information Processing > Step 2) and place E2E test execution in the final phase
|
|
75
81
|
- When test skeletons are not provided, include test implementation tasks based on Design Doc acceptance criteria
|
|
76
|
-
-
|
|
82
|
+
- Final phase is always Quality Assurance
|
|
83
|
+
|
|
84
|
+
**Phase structure**:
|
|
85
|
+
- Select the phase structure that matches the implementation approach from the Design Doc
|
|
86
|
+
- Use the plan template's vertical or horizontal option accordingly
|
|
87
|
+
- Remove every unused phase-structure option from the final work plan output
|
|
77
88
|
|
|
78
89
|
### 5. Define Tasks with Completion Criteria
|
|
79
90
|
For each task, derive completion criteria from Design Doc acceptance criteria. Apply the 3-element completion definition (Implementation Complete, Quality Complete, Integration Complete).
|
|
@@ -236,7 +247,10 @@ When creating work plans, **Phase Structure Diagrams** and **Task Dependency Dia
|
|
|
236
247
|
## Quality Checklist
|
|
237
248
|
|
|
238
249
|
- [ ] Design Doc(s) consistency verification
|
|
239
|
-
- [ ]
|
|
250
|
+
- [ ] Verification Strategies extracted from each Design Doc and included in the plan header without unintended merging
|
|
251
|
+
- [ ] Phase structure matches the implementation approach
|
|
252
|
+
- [ ] Early verification point placed in the earliest applicable phase
|
|
253
|
+
- [ ] Normalized verification timing mapped consistently to phases
|
|
240
254
|
- [ ] All requirements converted to tasks
|
|
241
255
|
- [ ] Quality assurance exists in final phase
|
|
242
256
|
- [ ] Test skeleton file paths listed in corresponding phases (when provided)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codex-workflows",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "Task-oriented agentic coding framework for OpenAI Codex CLI — skills, recipes, and subagents for structured development workflows",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Shinsuke Kagawa",
|