codex-genesis-harness 0.1.4 → 0.1.6
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/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
- package/.codebase/CURRENT_STATE.md +9 -7
- package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
- package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
- package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
- package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
- package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
- package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
- package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
- package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
- package/.codebase/README.md +139 -139
- package/.codebase/RECOVERY_POINTS.md +438 -438
- package/.codebase/state.json +37 -0
- package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
- package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
- package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
- package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
- package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
- package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
- package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
- package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
- package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
- package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
- package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
- package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
- package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
- package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
- package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
- package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
- package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
- package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
- package/.codex/skills/genesis-harness/SKILL.md +1427 -1418
- package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
- package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
- package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
- package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
- package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
- package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
- package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
- package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
- package/.codex/skills/genesis-harness/references/workflows.md +33 -33
- package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
- package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
- package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
- package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
- package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
- package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
- package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
- package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
- package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
- package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
- package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
- package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
- package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
- package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
- package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
- package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
- package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
- package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
- package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
- package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
- package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
- package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
- package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
- package/.codex/skills/genesis-mvp-planning/SKILL.md +114 -0
- package/.codex/skills/genesis-mvp-planning/agents/openai.yaml +6 -0
- package/.codex/skills/genesis-mvp-planning/checklists/mvp-readiness.md +18 -0
- package/.codex/skills/genesis-mvp-planning/examples/5-phase-roadmap-example.md +43 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-1-core.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-2-auth.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-3-features.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-4-integrations.md +17 -0
- package/.codex/skills/genesis-mvp-planning/templates/phase-5-readiness.md +17 -0
- package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
- package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
- package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-release-orchestration/SKILL.md +653 -653
- package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -274
- package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -220
- package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -253
- package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -472
- package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -494
- package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -303
- package/.codex/skills/genesis-release-orchestration/templates/release-runbook-template.md +420 -420
- package/.codex/skills/genesis-research-first/SKILL.md +237 -237
- package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
- package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
- package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
- package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
- package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
- package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
- package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
- package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
- package/.codex/skills/genesis-state-machine/SKILL.md +34 -0
- package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
- package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
- package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
- package/.codex-plugin/plugin.json +24 -24
- package/CHANGELOG.md +42 -0
- package/LICENSE +22 -22
- package/README.EN.md +784 -719
- package/README.VI.md +776 -712
- package/README.md +113 -253
- package/VERSION +2 -2
- package/bin/genesis-harness.js +90 -87
- package/package.json +68 -43
- package/scripts/README.md +342 -342
- package/scripts/compact-context.sh +0 -0
- package/scripts/contract_integrity_gate.js +83 -0
- package/scripts/detect-changes.sh +0 -0
- package/scripts/healing_telemetry.js +118 -0
- package/scripts/install.sh +4 -1
- package/scripts/offload-log.sh +0 -0
- package/scripts/prompt_sentinel.js +84 -0
- package/scripts/run-evals.sh +1 -0
- package/scripts/run-verify-loop.sh +11 -0
- package/scripts/spec_visual_sync.js +157 -0
- package/scripts/test_generator.js +142 -0
- package/scripts/transition_state.sh +67 -0
- package/scripts/uninstall.sh +1 -0
- package/scripts/validation_gates.sh +85 -0
- package/scripts/verify.sh +5 -0
- package/tests/unit/contract_integrity_gate.test.js +74 -0
- package/tests/unit/healing_telemetry.test.js +58 -0
- package/tests/unit/prompt_sentinel.test.js +50 -0
- package/tests/unit/spec_visual_sync.test.js +77 -0
- package/tests/unit/test_generator.test.js +62 -0
|
@@ -1,211 +1,211 @@
|
|
|
1
|
-
# Requirements Validation Checklist
|
|
2
|
-
|
|
3
|
-
**Purpose**: Validate that all requirements are clear, complete, and aligned before implementation starts.
|
|
4
|
-
|
|
5
|
-
**Status**: MANDATORY - Use after Q&A, before creating contracts and tests.
|
|
6
|
-
|
|
7
|
-
## Completeness Check
|
|
8
|
-
|
|
9
|
-
- [ ] **All Q&A items answered**:
|
|
10
|
-
- No "TBD" fields remaining?
|
|
11
|
-
- No "Unknown" fields that can be resolved?
|
|
12
|
-
- All dependencies documented?
|
|
13
|
-
|
|
14
|
-
- [ ] **Requirements are Specific**:
|
|
15
|
-
- "User can upload file" → ✅ "User can upload JPEG/PNG < 5MB to profile"
|
|
16
|
-
- Vague requirements identified and clarified?
|
|
17
|
-
- Units and formats specified (MB, seconds, JSON)?
|
|
18
|
-
|
|
19
|
-
- [ ] **Requirements are Measurable**:
|
|
20
|
-
- Success can be verified objectively?
|
|
21
|
-
- Metrics and thresholds defined?
|
|
22
|
-
- Acceptance criteria quantified where possible?
|
|
23
|
-
|
|
24
|
-
- [ ] **Requirements are Achievable**:
|
|
25
|
-
- Technical team believes it's feasible?
|
|
26
|
-
- Skills and knowledge present?
|
|
27
|
-
- Resource constraints acknowledged?
|
|
28
|
-
- Timeline realistic?
|
|
29
|
-
|
|
30
|
-
- [ ] **Requirements are Relevant**:
|
|
31
|
-
- Aligned with product roadmap?
|
|
32
|
-
- Business value clear?
|
|
33
|
-
- Won't be made obsolete by other work?
|
|
34
|
-
|
|
35
|
-
## Scope Validation
|
|
36
|
-
|
|
37
|
-
- [ ] **Scope is bounded**:
|
|
38
|
-
- Clear IN/OUT distinction?
|
|
39
|
-
- Related features NOT in scope documented?
|
|
40
|
-
- Phase 2/future work identified?
|
|
41
|
-
|
|
42
|
-
- [ ] **No scope creep identified**:
|
|
43
|
-
- Requirements are focused?
|
|
44
|
-
- "Nice to have" separated from "must have"?
|
|
45
|
-
- Dependencies on other features noted?
|
|
46
|
-
|
|
47
|
-
- [ ] **Edge cases included in scope**:
|
|
48
|
-
- Error cases considered?
|
|
49
|
-
- Boundary conditions documented?
|
|
50
|
-
- Performance edge cases noted?
|
|
51
|
-
|
|
52
|
-
## Technical Feasibility
|
|
53
|
-
|
|
54
|
-
- [ ] **Technical approach approved**:
|
|
55
|
-
- Architect reviewed proposed solution?
|
|
56
|
-
- Major technical decisions documented?
|
|
57
|
-
- No unknowns that are blockers?
|
|
58
|
-
|
|
59
|
-
- [ ] **API/Contract defined**:
|
|
60
|
-
- Input schema clear?
|
|
61
|
-
- Output schema clear?
|
|
62
|
-
- Error responses defined?
|
|
63
|
-
- Breaking changes identified?
|
|
64
|
-
|
|
65
|
-
- [ ] **Data Model defined**:
|
|
66
|
-
- Database schema changes clear?
|
|
67
|
-
- Backward compatibility strategy defined?
|
|
68
|
-
- Data migration plan if needed?
|
|
69
|
-
|
|
70
|
-
- [ ] **Dependencies external/internal identified**:
|
|
71
|
-
- External APIs or services needed?
|
|
72
|
-
- Libraries or tools required?
|
|
73
|
-
- Existing modules to integrate with?
|
|
74
|
-
- Build/deployment requirements?
|
|
75
|
-
|
|
76
|
-
## Acceptance Criteria Validation
|
|
77
|
-
|
|
78
|
-
- [ ] **Acceptance Criteria are testable**:
|
|
79
|
-
- Each criterion can be verified?
|
|
80
|
-
- Test cases can be written?
|
|
81
|
-
- No subjective criteria ("looks good")?
|
|
82
|
-
|
|
83
|
-
- [ ] **Acceptance Criteria are complete**:
|
|
84
|
-
- Happy path covered?
|
|
85
|
-
- Error paths included?
|
|
86
|
-
- Edge cases represented?
|
|
87
|
-
- Performance criteria included?
|
|
88
|
-
|
|
89
|
-
- [ ] **Acceptance Criteria are prioritized**:
|
|
90
|
-
- Must-have criteria clear?
|
|
91
|
-
- Nice-to-have criteria separate?
|
|
92
|
-
- Dependencies between criteria noted?
|
|
93
|
-
|
|
94
|
-
## Stakeholder Alignment
|
|
95
|
-
|
|
96
|
-
- [ ] **Product owner approved**:
|
|
97
|
-
- Requirements match product vision?
|
|
98
|
-
- Business value documented?
|
|
99
|
-
- Conflicts with other priorities resolved?
|
|
100
|
-
|
|
101
|
-
- [ ] **Tech lead/architect approved**:
|
|
102
|
-
- Technical feasibility confirmed?
|
|
103
|
-
- Approach aligns with architecture?
|
|
104
|
-
- Technical risks identified?
|
|
105
|
-
|
|
106
|
-
- [ ] **No conflicting requirements**:
|
|
107
|
-
- Performance vs. complexity tradeoffs addressed?
|
|
108
|
-
- Security vs. usability resolved?
|
|
109
|
-
- Team capacity confirmed?
|
|
110
|
-
|
|
111
|
-
## Documentation & Communication
|
|
112
|
-
|
|
113
|
-
- [ ] **Requirements documented clearly**:
|
|
114
|
-
- User stories well-formed?
|
|
115
|
-
- Acceptance criteria listed?
|
|
116
|
-
- Related documents linked?
|
|
117
|
-
|
|
118
|
-
- [ ] **Ambiguities resolved**:
|
|
119
|
-
- Team discussed unclear points?
|
|
120
|
-
- Assumptions documented?
|
|
121
|
-
- Glossary for domain terms created?
|
|
122
|
-
|
|
123
|
-
- [ ] **Team has common understanding**:
|
|
124
|
-
- Walkthrough with key people done?
|
|
125
|
-
- Q&A items captured in writing?
|
|
126
|
-
- No silent disagreements about scope?
|
|
127
|
-
|
|
128
|
-
## Risk Assessment
|
|
129
|
-
|
|
130
|
-
- [ ] **Technical risks identified**:
|
|
131
|
-
- Unknown technologies or patterns?
|
|
132
|
-
- Performance risks documented?
|
|
133
|
-
- Integration risks noted?
|
|
134
|
-
|
|
135
|
-
- [ ] **Business risks identified**:
|
|
136
|
-
- Dependencies on external parties?
|
|
137
|
-
- Market timing risks?
|
|
138
|
-
- Competitive concerns?
|
|
139
|
-
|
|
140
|
-
- [ ] **Mitigation strategies defined**:
|
|
141
|
-
- Risk reduction tactics identified?
|
|
142
|
-
- Contingency plans for critical risks?
|
|
143
|
-
- Escalation criteria defined?
|
|
144
|
-
|
|
145
|
-
## Testing & Quality
|
|
146
|
-
|
|
147
|
-
- [ ] **Test Strategy defined**:
|
|
148
|
-
- Unit test scope?
|
|
149
|
-
- Integration test scenarios?
|
|
150
|
-
- E2E test critical paths?
|
|
151
|
-
- Performance test requirements?
|
|
152
|
-
|
|
153
|
-
- [ ] **Test Data & Fixtures planned**:
|
|
154
|
-
- What data needed for testing?
|
|
155
|
-
- Edge case datasets created?
|
|
156
|
-
- Load test scenarios defined?
|
|
157
|
-
|
|
158
|
-
- [ ] **Quality Standards aligned**:
|
|
159
|
-
- Code review criteria?
|
|
160
|
-
- Test coverage target (80%+)?
|
|
161
|
-
- Performance benchmarks?
|
|
162
|
-
- Security standards?
|
|
163
|
-
|
|
164
|
-
## Sign-Off
|
|
165
|
-
|
|
166
|
-
- [ ] **Product Owner**: _Name_ ☐ Approved
|
|
167
|
-
- [ ] **Tech Lead**: _Name_ ☐ Approved
|
|
168
|
-
- [ ] **Team Lead**: _Name_ ☐ Approved
|
|
169
|
-
- [ ] **Any additional stakeholders**: ☐ Approved
|
|
170
|
-
|
|
171
|
-
## Implementation Readiness
|
|
172
|
-
|
|
173
|
-
### Ready to Proceed:
|
|
174
|
-
- [ ] All Q&A complete
|
|
175
|
-
- [ ] All validations passed
|
|
176
|
-
- [ ] All stakeholders approved
|
|
177
|
-
- [ ] No blockers identified
|
|
178
|
-
- [ ] Team ready to start
|
|
179
|
-
|
|
180
|
-
### If NOT ready:
|
|
181
|
-
- [ ] List items preventing readiness
|
|
182
|
-
- [ ] Owner assigned for each blocker
|
|
183
|
-
- [ ] Timeline to resolve each blocker
|
|
184
|
-
|
|
185
|
-
---
|
|
186
|
-
|
|
187
|
-
## Usage
|
|
188
|
-
|
|
189
|
-
```
|
|
190
|
-
After completing feature/bug/refactor Q&A:
|
|
191
|
-
|
|
192
|
-
1. Run through this validation checklist
|
|
193
|
-
2. Address any gaps or concerns
|
|
194
|
-
3. Get sign-offs from stakeholders
|
|
195
|
-
4. Only then proceed to:
|
|
196
|
-
- Contract definition
|
|
197
|
-
- Test creation
|
|
198
|
-
- Implementation planning
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
## Validation Result
|
|
202
|
-
|
|
203
|
-
**Status**: ☐ Ready / ☐ Needs Work
|
|
204
|
-
|
|
205
|
-
**Blockers** (if any):
|
|
206
|
-
- _item_
|
|
207
|
-
- _item_
|
|
208
|
-
|
|
209
|
-
**Owner**: _Name_
|
|
210
|
-
**Date**: _YYYY-MM-DD_
|
|
211
|
-
**Next Steps**: _Action items_
|
|
1
|
+
# Requirements Validation Checklist
|
|
2
|
+
|
|
3
|
+
**Purpose**: Validate that all requirements are clear, complete, and aligned before implementation starts.
|
|
4
|
+
|
|
5
|
+
**Status**: MANDATORY - Use after Q&A, before creating contracts and tests.
|
|
6
|
+
|
|
7
|
+
## Completeness Check
|
|
8
|
+
|
|
9
|
+
- [ ] **All Q&A items answered**:
|
|
10
|
+
- No "TBD" fields remaining?
|
|
11
|
+
- No "Unknown" fields that can be resolved?
|
|
12
|
+
- All dependencies documented?
|
|
13
|
+
|
|
14
|
+
- [ ] **Requirements are Specific**:
|
|
15
|
+
- "User can upload file" → ✅ "User can upload JPEG/PNG < 5MB to profile"
|
|
16
|
+
- Vague requirements identified and clarified?
|
|
17
|
+
- Units and formats specified (MB, seconds, JSON)?
|
|
18
|
+
|
|
19
|
+
- [ ] **Requirements are Measurable**:
|
|
20
|
+
- Success can be verified objectively?
|
|
21
|
+
- Metrics and thresholds defined?
|
|
22
|
+
- Acceptance criteria quantified where possible?
|
|
23
|
+
|
|
24
|
+
- [ ] **Requirements are Achievable**:
|
|
25
|
+
- Technical team believes it's feasible?
|
|
26
|
+
- Skills and knowledge present?
|
|
27
|
+
- Resource constraints acknowledged?
|
|
28
|
+
- Timeline realistic?
|
|
29
|
+
|
|
30
|
+
- [ ] **Requirements are Relevant**:
|
|
31
|
+
- Aligned with product roadmap?
|
|
32
|
+
- Business value clear?
|
|
33
|
+
- Won't be made obsolete by other work?
|
|
34
|
+
|
|
35
|
+
## Scope Validation
|
|
36
|
+
|
|
37
|
+
- [ ] **Scope is bounded**:
|
|
38
|
+
- Clear IN/OUT distinction?
|
|
39
|
+
- Related features NOT in scope documented?
|
|
40
|
+
- Phase 2/future work identified?
|
|
41
|
+
|
|
42
|
+
- [ ] **No scope creep identified**:
|
|
43
|
+
- Requirements are focused?
|
|
44
|
+
- "Nice to have" separated from "must have"?
|
|
45
|
+
- Dependencies on other features noted?
|
|
46
|
+
|
|
47
|
+
- [ ] **Edge cases included in scope**:
|
|
48
|
+
- Error cases considered?
|
|
49
|
+
- Boundary conditions documented?
|
|
50
|
+
- Performance edge cases noted?
|
|
51
|
+
|
|
52
|
+
## Technical Feasibility
|
|
53
|
+
|
|
54
|
+
- [ ] **Technical approach approved**:
|
|
55
|
+
- Architect reviewed proposed solution?
|
|
56
|
+
- Major technical decisions documented?
|
|
57
|
+
- No unknowns that are blockers?
|
|
58
|
+
|
|
59
|
+
- [ ] **API/Contract defined**:
|
|
60
|
+
- Input schema clear?
|
|
61
|
+
- Output schema clear?
|
|
62
|
+
- Error responses defined?
|
|
63
|
+
- Breaking changes identified?
|
|
64
|
+
|
|
65
|
+
- [ ] **Data Model defined**:
|
|
66
|
+
- Database schema changes clear?
|
|
67
|
+
- Backward compatibility strategy defined?
|
|
68
|
+
- Data migration plan if needed?
|
|
69
|
+
|
|
70
|
+
- [ ] **Dependencies external/internal identified**:
|
|
71
|
+
- External APIs or services needed?
|
|
72
|
+
- Libraries or tools required?
|
|
73
|
+
- Existing modules to integrate with?
|
|
74
|
+
- Build/deployment requirements?
|
|
75
|
+
|
|
76
|
+
## Acceptance Criteria Validation
|
|
77
|
+
|
|
78
|
+
- [ ] **Acceptance Criteria are testable**:
|
|
79
|
+
- Each criterion can be verified?
|
|
80
|
+
- Test cases can be written?
|
|
81
|
+
- No subjective criteria ("looks good")?
|
|
82
|
+
|
|
83
|
+
- [ ] **Acceptance Criteria are complete**:
|
|
84
|
+
- Happy path covered?
|
|
85
|
+
- Error paths included?
|
|
86
|
+
- Edge cases represented?
|
|
87
|
+
- Performance criteria included?
|
|
88
|
+
|
|
89
|
+
- [ ] **Acceptance Criteria are prioritized**:
|
|
90
|
+
- Must-have criteria clear?
|
|
91
|
+
- Nice-to-have criteria separate?
|
|
92
|
+
- Dependencies between criteria noted?
|
|
93
|
+
|
|
94
|
+
## Stakeholder Alignment
|
|
95
|
+
|
|
96
|
+
- [ ] **Product owner approved**:
|
|
97
|
+
- Requirements match product vision?
|
|
98
|
+
- Business value documented?
|
|
99
|
+
- Conflicts with other priorities resolved?
|
|
100
|
+
|
|
101
|
+
- [ ] **Tech lead/architect approved**:
|
|
102
|
+
- Technical feasibility confirmed?
|
|
103
|
+
- Approach aligns with architecture?
|
|
104
|
+
- Technical risks identified?
|
|
105
|
+
|
|
106
|
+
- [ ] **No conflicting requirements**:
|
|
107
|
+
- Performance vs. complexity tradeoffs addressed?
|
|
108
|
+
- Security vs. usability resolved?
|
|
109
|
+
- Team capacity confirmed?
|
|
110
|
+
|
|
111
|
+
## Documentation & Communication
|
|
112
|
+
|
|
113
|
+
- [ ] **Requirements documented clearly**:
|
|
114
|
+
- User stories well-formed?
|
|
115
|
+
- Acceptance criteria listed?
|
|
116
|
+
- Related documents linked?
|
|
117
|
+
|
|
118
|
+
- [ ] **Ambiguities resolved**:
|
|
119
|
+
- Team discussed unclear points?
|
|
120
|
+
- Assumptions documented?
|
|
121
|
+
- Glossary for domain terms created?
|
|
122
|
+
|
|
123
|
+
- [ ] **Team has common understanding**:
|
|
124
|
+
- Walkthrough with key people done?
|
|
125
|
+
- Q&A items captured in writing?
|
|
126
|
+
- No silent disagreements about scope?
|
|
127
|
+
|
|
128
|
+
## Risk Assessment
|
|
129
|
+
|
|
130
|
+
- [ ] **Technical risks identified**:
|
|
131
|
+
- Unknown technologies or patterns?
|
|
132
|
+
- Performance risks documented?
|
|
133
|
+
- Integration risks noted?
|
|
134
|
+
|
|
135
|
+
- [ ] **Business risks identified**:
|
|
136
|
+
- Dependencies on external parties?
|
|
137
|
+
- Market timing risks?
|
|
138
|
+
- Competitive concerns?
|
|
139
|
+
|
|
140
|
+
- [ ] **Mitigation strategies defined**:
|
|
141
|
+
- Risk reduction tactics identified?
|
|
142
|
+
- Contingency plans for critical risks?
|
|
143
|
+
- Escalation criteria defined?
|
|
144
|
+
|
|
145
|
+
## Testing & Quality
|
|
146
|
+
|
|
147
|
+
- [ ] **Test Strategy defined**:
|
|
148
|
+
- Unit test scope?
|
|
149
|
+
- Integration test scenarios?
|
|
150
|
+
- E2E test critical paths?
|
|
151
|
+
- Performance test requirements?
|
|
152
|
+
|
|
153
|
+
- [ ] **Test Data & Fixtures planned**:
|
|
154
|
+
- What data needed for testing?
|
|
155
|
+
- Edge case datasets created?
|
|
156
|
+
- Load test scenarios defined?
|
|
157
|
+
|
|
158
|
+
- [ ] **Quality Standards aligned**:
|
|
159
|
+
- Code review criteria?
|
|
160
|
+
- Test coverage target (80%+)?
|
|
161
|
+
- Performance benchmarks?
|
|
162
|
+
- Security standards?
|
|
163
|
+
|
|
164
|
+
## Sign-Off
|
|
165
|
+
|
|
166
|
+
- [ ] **Product Owner**: _Name_ ☐ Approved
|
|
167
|
+
- [ ] **Tech Lead**: _Name_ ☐ Approved
|
|
168
|
+
- [ ] **Team Lead**: _Name_ ☐ Approved
|
|
169
|
+
- [ ] **Any additional stakeholders**: ☐ Approved
|
|
170
|
+
|
|
171
|
+
## Implementation Readiness
|
|
172
|
+
|
|
173
|
+
### Ready to Proceed:
|
|
174
|
+
- [ ] All Q&A complete
|
|
175
|
+
- [ ] All validations passed
|
|
176
|
+
- [ ] All stakeholders approved
|
|
177
|
+
- [ ] No blockers identified
|
|
178
|
+
- [ ] Team ready to start
|
|
179
|
+
|
|
180
|
+
### If NOT ready:
|
|
181
|
+
- [ ] List items preventing readiness
|
|
182
|
+
- [ ] Owner assigned for each blocker
|
|
183
|
+
- [ ] Timeline to resolve each blocker
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Usage
|
|
188
|
+
|
|
189
|
+
```
|
|
190
|
+
After completing feature/bug/refactor Q&A:
|
|
191
|
+
|
|
192
|
+
1. Run through this validation checklist
|
|
193
|
+
2. Address any gaps or concerns
|
|
194
|
+
3. Get sign-offs from stakeholders
|
|
195
|
+
4. Only then proceed to:
|
|
196
|
+
- Contract definition
|
|
197
|
+
- Test creation
|
|
198
|
+
- Implementation planning
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Validation Result
|
|
202
|
+
|
|
203
|
+
**Status**: ☐ Ready / ☐ Needs Work
|
|
204
|
+
|
|
205
|
+
**Blockers** (if any):
|
|
206
|
+
- _item_
|
|
207
|
+
- _item_
|
|
208
|
+
|
|
209
|
+
**Owner**: _Name_
|
|
210
|
+
**Date**: _YYYY-MM-DD_
|
|
211
|
+
**Next Steps**: _Action items_
|
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
# Planning Schema Reference
|
|
2
|
-
|
|
3
|
-
Use this file when creating or auditing `.planning/`.
|
|
4
|
-
|
|
5
|
-
## Core Files
|
|
6
|
-
|
|
7
|
-
- `PROJECT.md`: product identity, users, value, scope, out of scope, constraints, assumptions, milestone, success criteria.
|
|
8
|
-
- `REQUIREMENTS.md`: functional requirements, non-functional requirements, user stories, acceptance criteria, edge cases, unknowns.
|
|
9
|
-
- `ROADMAP.md`: milestones, phases, dependencies, status, phase acceptance criteria.
|
|
10
|
-
- `STATE.md`: current phase, active feature or bug, last task, next task, blockers, latest verification.
|
|
11
|
-
- `STACK.md`: language, framework, runtime, database, package manager, tests, lint/typecheck, deployment, local commands.
|
|
12
|
-
- `ARCHITECTURE.md`: architecture, boundaries, data flow, dependency direction, service boundaries, principles, forbidden patterns.
|
|
13
|
-
- `DESIGN.md`: UX principles, screens, components, state management, accessibility, constraints.
|
|
14
|
-
- `API_DOCS.md`: endpoints, examples, errors, auth, versioning.
|
|
15
|
-
- `INTEGRATIONS.md`: services, SDKs, environment variables, secrets, failure handling, fallback behavior, limits.
|
|
16
|
-
- `CONVENTIONS.md`: naming, folders, style, errors, logging, testing, API, security, patterns to follow and avoid.
|
|
17
|
-
- `PITFALLS.md`: common mistakes, risky areas, fragile dependencies, warnings.
|
|
18
|
-
- `LESSONS_LEARNED.md`: bug lessons with root cause, failed assumption, correct pattern, prevention, changed files, verification.
|
|
19
|
-
- `SPEC_CHANGELOG.md`: every spec-affecting change.
|
|
20
|
-
- `QUALITY_SCORE.md`: quality rubric scores and next actions.
|
|
21
|
-
|
|
22
|
-
## Required Subtrees
|
|
23
|
-
|
|
24
|
-
- `diagrams/`
|
|
25
|
-
- `research/`
|
|
26
|
-
- `decisions/`
|
|
27
|
-
- `phases/`
|
|
28
|
-
- `features/`
|
|
29
|
-
- `bugs/`
|
|
30
|
-
- `audits/`
|
|
31
|
-
- `checks/`
|
|
32
|
-
- `quick/`
|
|
33
|
-
- `codebase/`
|
|
34
|
-
- `templates/`
|
|
35
|
-
|
|
1
|
+
# Planning Schema Reference
|
|
2
|
+
|
|
3
|
+
Use this file when creating or auditing `.planning/`.
|
|
4
|
+
|
|
5
|
+
## Core Files
|
|
6
|
+
|
|
7
|
+
- `PROJECT.md`: product identity, users, value, scope, out of scope, constraints, assumptions, milestone, success criteria.
|
|
8
|
+
- `REQUIREMENTS.md`: functional requirements, non-functional requirements, user stories, acceptance criteria, edge cases, unknowns.
|
|
9
|
+
- `ROADMAP.md`: milestones, phases, dependencies, status, phase acceptance criteria.
|
|
10
|
+
- `STATE.md`: current phase, active feature or bug, last task, next task, blockers, latest verification.
|
|
11
|
+
- `STACK.md`: language, framework, runtime, database, package manager, tests, lint/typecheck, deployment, local commands.
|
|
12
|
+
- `ARCHITECTURE.md`: architecture, boundaries, data flow, dependency direction, service boundaries, principles, forbidden patterns.
|
|
13
|
+
- `DESIGN.md`: UX principles, screens, components, state management, accessibility, constraints.
|
|
14
|
+
- `API_DOCS.md`: endpoints, examples, errors, auth, versioning.
|
|
15
|
+
- `INTEGRATIONS.md`: services, SDKs, environment variables, secrets, failure handling, fallback behavior, limits.
|
|
16
|
+
- `CONVENTIONS.md`: naming, folders, style, errors, logging, testing, API, security, patterns to follow and avoid.
|
|
17
|
+
- `PITFALLS.md`: common mistakes, risky areas, fragile dependencies, warnings.
|
|
18
|
+
- `LESSONS_LEARNED.md`: bug lessons with root cause, failed assumption, correct pattern, prevention, changed files, verification.
|
|
19
|
+
- `SPEC_CHANGELOG.md`: every spec-affecting change.
|
|
20
|
+
- `QUALITY_SCORE.md`: quality rubric scores and next actions.
|
|
21
|
+
|
|
22
|
+
## Required Subtrees
|
|
23
|
+
|
|
24
|
+
- `diagrams/`
|
|
25
|
+
- `research/`
|
|
26
|
+
- `decisions/`
|
|
27
|
+
- `phases/`
|
|
28
|
+
- `features/`
|
|
29
|
+
- `bugs/`
|
|
30
|
+
- `audits/`
|
|
31
|
+
- `checks/`
|
|
32
|
+
- `quick/`
|
|
33
|
+
- `codebase/`
|
|
34
|
+
- `templates/`
|
|
35
|
+
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
# Quality Rubric
|
|
2
|
-
|
|
3
|
-
Use this file when updating `.planning/QUALITY_SCORE.md`.
|
|
4
|
-
|
|
5
|
-
| Score | Meaning |
|
|
6
|
-
|---:|---|
|
|
7
|
-
| 0 | Unknown, absent, or not evaluated |
|
|
8
|
-
| 2 | Known major gaps with no mitigation |
|
|
9
|
-
| 4 | Basic structure exists but is inconsistent or mostly manual |
|
|
10
|
-
| 6 | Working baseline with known gaps and follow-up tasks |
|
|
11
|
-
| 8 | Strong, verified, documented, and mostly automated |
|
|
12
|
-
| 10 | Mature, automated, documented, reviewed, and low-risk |
|
|
13
|
-
|
|
14
|
-
## Areas
|
|
15
|
-
|
|
16
|
-
- Architecture: module boundaries, dependency direction, diagrams, ADRs, forbidden patterns.
|
|
17
|
-
- Tests: regression coverage, smoke tests, edge cases, failing-first evidence, repeatability.
|
|
18
|
-
- Docs Sync: behavior docs, changelog entries, impact matrix compliance.
|
|
19
|
-
- Security: auth, secrets, data protection, dependency risk, destructive-operation safeguards.
|
|
20
|
-
- Maintainability: naming, duplication, dead code, conventions, module size, refactor risk.
|
|
21
|
-
- Observability: logs, metrics, traces, errors, health checks, debug commands, inspection workflow.
|
|
1
|
+
# Quality Rubric
|
|
2
|
+
|
|
3
|
+
Use this file when updating `.planning/QUALITY_SCORE.md`.
|
|
4
|
+
|
|
5
|
+
| Score | Meaning |
|
|
6
|
+
|---:|---|
|
|
7
|
+
| 0 | Unknown, absent, or not evaluated |
|
|
8
|
+
| 2 | Known major gaps with no mitigation |
|
|
9
|
+
| 4 | Basic structure exists but is inconsistent or mostly manual |
|
|
10
|
+
| 6 | Working baseline with known gaps and follow-up tasks |
|
|
11
|
+
| 8 | Strong, verified, documented, and mostly automated |
|
|
12
|
+
| 10 | Mature, automated, documented, reviewed, and low-risk |
|
|
13
|
+
|
|
14
|
+
## Areas
|
|
15
|
+
|
|
16
|
+
- Architecture: module boundaries, dependency direction, diagrams, ADRs, forbidden patterns.
|
|
17
|
+
- Tests: regression coverage, smoke tests, edge cases, failing-first evidence, repeatability.
|
|
18
|
+
- Docs Sync: behavior docs, changelog entries, impact matrix compliance.
|
|
19
|
+
- Security: auth, secrets, data protection, dependency risk, destructive-operation safeguards.
|
|
20
|
+
- Maintainability: naming, duplication, dead code, conventions, module size, refactor risk.
|
|
21
|
+
- Observability: logs, metrics, traces, errors, health checks, debug commands, inspection workflow.
|
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
# Research Rubric
|
|
2
|
-
|
|
3
|
-
Use this file before planning or implementing non-trivial work.
|
|
4
|
-
|
|
5
|
-
## Required Evidence
|
|
6
|
-
|
|
7
|
-
| Evidence | Required? | Notes |
|
|
8
|
-
|---|---:|---|
|
|
9
|
-
| Local code paths | Yes | Include file paths or commands. |
|
|
10
|
-
| Similar existing patterns | Yes | Prefer repo conventions over new abstractions. |
|
|
11
|
-
| Official docs | When available | Cite URL or doc name and date checked. |
|
|
12
|
-
| Reputable external examples | When useful | Do not copy architecture blindly. |
|
|
13
|
-
| Unknowns | Yes | Record gaps instead of inventing facts. |
|
|
14
|
-
|
|
15
|
-
## Output Format
|
|
16
|
-
|
|
17
|
-
```md
|
|
18
|
-
## Research: <topic>
|
|
19
|
-
|
|
20
|
-
Date:
|
|
21
|
-
Question:
|
|
22
|
-
|
|
23
|
-
## Local Evidence
|
|
24
|
-
|
|
25
|
-
| File / Command | Finding | Impact |
|
|
26
|
-
|---|---|---|
|
|
27
|
-
|
|
28
|
-
## External Evidence
|
|
29
|
-
|
|
30
|
-
| Source | Date Checked | Finding | Impact |
|
|
31
|
-
|---|---|---|---|
|
|
32
|
-
|
|
33
|
-
## Decision Impact
|
|
34
|
-
|
|
35
|
-
- [ ] TBD
|
|
36
|
-
|
|
37
|
-
## Confidence / Gaps
|
|
38
|
-
|
|
39
|
-
- [ ] TBD
|
|
40
|
-
```
|
|
41
|
-
|
|
1
|
+
# Research Rubric
|
|
2
|
+
|
|
3
|
+
Use this file before planning or implementing non-trivial work.
|
|
4
|
+
|
|
5
|
+
## Required Evidence
|
|
6
|
+
|
|
7
|
+
| Evidence | Required? | Notes |
|
|
8
|
+
|---|---:|---|
|
|
9
|
+
| Local code paths | Yes | Include file paths or commands. |
|
|
10
|
+
| Similar existing patterns | Yes | Prefer repo conventions over new abstractions. |
|
|
11
|
+
| Official docs | When available | Cite URL or doc name and date checked. |
|
|
12
|
+
| Reputable external examples | When useful | Do not copy architecture blindly. |
|
|
13
|
+
| Unknowns | Yes | Record gaps instead of inventing facts. |
|
|
14
|
+
|
|
15
|
+
## Output Format
|
|
16
|
+
|
|
17
|
+
```md
|
|
18
|
+
## Research: <topic>
|
|
19
|
+
|
|
20
|
+
Date:
|
|
21
|
+
Question:
|
|
22
|
+
|
|
23
|
+
## Local Evidence
|
|
24
|
+
|
|
25
|
+
| File / Command | Finding | Impact |
|
|
26
|
+
|---|---|---|
|
|
27
|
+
|
|
28
|
+
## External Evidence
|
|
29
|
+
|
|
30
|
+
| Source | Date Checked | Finding | Impact |
|
|
31
|
+
|---|---|---|---|
|
|
32
|
+
|
|
33
|
+
## Decision Impact
|
|
34
|
+
|
|
35
|
+
- [ ] TBD
|
|
36
|
+
|
|
37
|
+
## Confidence / Gaps
|
|
38
|
+
|
|
39
|
+
- [ ] TBD
|
|
40
|
+
```
|
|
41
|
+
|