codex-genesis-harness 0.1.1 → 0.1.4

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.
Files changed (180) hide show
  1. package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -0
  2. package/.codebase/CURRENT_STATE.md +2 -0
  3. package/.codebase/DOMAIN_MODELS.md +5 -3
  4. package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -0
  5. package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -0
  6. package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -0
  7. package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -0
  8. package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -0
  9. package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -0
  10. package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -0
  11. package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -0
  12. package/.codebase/README.md +139 -0
  13. package/.codebase/RECOVERY_POINTS.md +438 -0
  14. package/.codex/skills/genesis-api-sync/SKILL.md +354 -0
  15. package/.codex/skills/genesis-api-sync/agents/openai.yaml +7 -0
  16. package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -0
  17. package/.codex/skills/genesis-api-sync/examples/example.md +68 -0
  18. package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -0
  19. package/.codex/skills/genesis-debug-guide/SKILL.md +479 -0
  20. package/.codex/skills/genesis-debug-guide/agents/openai.yaml +7 -0
  21. package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -0
  22. package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -0
  23. package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -0
  24. package/.codex/skills/genesis-debug-guide/examples/example.md +48 -0
  25. package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -0
  26. package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -0
  27. package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -0
  28. package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -0
  29. package/.codex/skills/genesis-docs-automation/agents/openai.yaml +7 -0
  30. package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -0
  31. package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -0
  32. package/.codex/skills/genesis-docs-automation/examples/example.md +59 -0
  33. package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -0
  34. package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -0
  35. package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -0
  36. package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -0
  37. package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -0
  38. package/.codex/skills/genesis-harness/SKILL.md +734 -82
  39. package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -0
  40. package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -0
  41. package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -0
  42. package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -0
  43. package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -0
  44. package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -0
  45. package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -0
  46. package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -0
  47. package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +23 -23
  48. package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +24 -24
  49. package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +21 -21
  50. package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +46 -46
  51. package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +24 -24
  52. package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +25 -25
  53. package/.codex/skills/genesis-harness/scripts/compact-context.sh +54 -0
  54. package/.codex/skills/genesis-harness/scripts/create-adr.sh +74 -74
  55. package/.codex/skills/genesis-harness/scripts/create-bug.sh +160 -160
  56. package/.codex/skills/genesis-harness/scripts/create-feature.sh +217 -217
  57. package/.codex/skills/genesis-harness/scripts/detect-stack.sh +26 -26
  58. package/.codex/skills/genesis-harness/scripts/init-planning.sh +750 -719
  59. package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +12 -12
  60. package/.codex/skills/genesis-harness/scripts/offload-log.sh +72 -0
  61. package/.codex/skills/genesis-harness/scripts/run-verification.sh +47 -47
  62. package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +75 -0
  63. package/.codex/skills/genesis-harness/scripts/update-state.sh +33 -33
  64. package/.codex/skills/genesis-harness-engineering/SKILL.md +159 -0
  65. package/.codex/skills/genesis-harness-engineering/checklists/checklist.md +48 -0
  66. package/.codex/skills/genesis-harness-engineering/examples/example.md +57 -0
  67. package/.codex/skills/genesis-harness-engineering/playbooks/harness-evolution.md +99 -0
  68. package/.codex/skills/genesis-harness-engineering/templates/harness-change-template.md +37 -0
  69. package/.codex/skills/genesis-observability-automation/SKILL.md +382 -0
  70. package/.codex/skills/genesis-observability-automation/agents/openai.yaml +7 -0
  71. package/.codex/skills/genesis-observability-automation/examples/example.md +86 -0
  72. package/.codex/skills/genesis-performance-profiling/SKILL.md +510 -0
  73. package/.codex/skills/genesis-performance-profiling/agents/openai.yaml +6 -0
  74. package/.codex/skills/genesis-performance-profiling/checklists/optimization-verification.md +199 -0
  75. package/.codex/skills/genesis-performance-profiling/checklists/performance-baseline.md +183 -0
  76. package/.codex/skills/genesis-performance-profiling/examples/example.md +234 -0
  77. package/.codex/skills/genesis-performance-profiling/observability/performance-tracking.md +202 -0
  78. package/.codex/skills/genesis-performance-profiling/playbooks/load-testing-orchestration.md +593 -0
  79. package/.codex/skills/genesis-performance-profiling/playbooks/profiling-playbook.md +601 -0
  80. package/.codex/skills/genesis-performance-profiling/templates/load-test-config-template.md +428 -0
  81. package/.codex/skills/genesis-performance-profiling/templates/performance-report-template.md +238 -0
  82. package/.codex/skills/genesis-release-orchestration/SKILL.md +653 -0
  83. package/.codex/skills/genesis-release-orchestration/agents/openai.yaml +7 -0
  84. package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -0
  85. package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -0
  86. package/.codex/skills/genesis-release-orchestration/examples/example.md +78 -0
  87. package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -0
  88. package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -0
  89. package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -0
  90. package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -0
  91. package/.codex/skills/genesis-release-orchestration/templates/release-runbook-template.md +420 -0
  92. package/.codex/skills/genesis-research-first/SKILL.md +237 -0
  93. package/.codex/skills/genesis-research-first/agents/openai.yaml +7 -0
  94. package/.codex/skills/genesis-research-first/examples/example.md +85 -0
  95. package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -0
  96. package/.codex/skills/genesis-spec-propagation/agents/openai.yaml +7 -0
  97. package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -0
  98. package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -0
  99. package/.codex/skills/genesis-spec-propagation/examples/example.md +63 -0
  100. package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -0
  101. package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -0
  102. package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -0
  103. package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -0
  104. package/.codex/skills/spec-impact-engine/SKILL.md +504 -0
  105. package/.codex/skills/spec-impact-engine/agents/openai.yaml +7 -0
  106. package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +262 -0
  107. package/.codex/skills/spec-impact-engine/examples/example.md +98 -0
  108. package/.codex/skills/spec-impact-engine/templates/impact-report.md +248 -0
  109. package/.codex/skills/spec-impact-engine/templates/migration-guide.md +223 -0
  110. package/.codex-plugin/plugin.json +1 -1
  111. package/README.EN.md +719 -0
  112. package/README.VI.md +712 -0
  113. package/README.md +261 -107
  114. package/VERSION +1 -1
  115. package/bin/genesis-harness.js +20 -11
  116. package/package.json +1 -1
  117. package/scripts/README.md +342 -0
  118. package/scripts/compact-context.sh +54 -0
  119. package/scripts/detect-changes.sh +152 -0
  120. package/scripts/install.sh +50 -41
  121. package/scripts/offload-log.sh +72 -0
  122. package/scripts/run-evals.sh +70 -43
  123. package/scripts/run-verify-loop.sh +75 -0
  124. package/scripts/uninstall.sh +52 -43
  125. package/scripts/verify.sh +165 -73
  126. package/.codex/skills/harness-engineering-skill/SKILL.md +0 -45
  127. package/.codex/skills/harness-engineering-skill/checklists/checklist.md +0 -8
  128. package/.codex/skills/harness-engineering-skill/examples/example.md +0 -4
  129. package/.codex/skills/harness-engineering-skill/templates/harness-change-template.md +0 -8
  130. /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/SKILL.md +0 -0
  131. /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/agents/openai.yaml +0 -0
  132. /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/checklists/checklist.md +0 -0
  133. /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/examples/example.md +0 -0
  134. /package/.codex/skills/{ai-provider-skill → genesis-ai-provider}/templates/provider-contract-template.md +0 -0
  135. /package/.codex/skills/{api-contract-skill → genesis-api-contract}/SKILL.md +0 -0
  136. /package/.codex/skills/{api-contract-skill → genesis-api-contract}/agents/openai.yaml +0 -0
  137. /package/.codex/skills/{api-contract-skill → genesis-api-contract}/checklists/checklist.md +0 -0
  138. /package/.codex/skills/{api-contract-skill → genesis-api-contract}/examples/example.md +0 -0
  139. /package/.codex/skills/{api-contract-skill → genesis-api-contract}/templates/api-contract-template.md +0 -0
  140. /package/.codex/skills/{architecture-skill → genesis-architecture}/SKILL.md +0 -0
  141. /package/.codex/skills/{architecture-skill → genesis-architecture}/agents/openai.yaml +0 -0
  142. /package/.codex/skills/{architecture-skill → genesis-architecture}/checklists/checklist.md +0 -0
  143. /package/.codex/skills/{architecture-skill → genesis-architecture}/examples/example.md +0 -0
  144. /package/.codex/skills/{architecture-skill → genesis-architecture}/templates/architecture-decision-template.md +0 -0
  145. /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/SKILL.md +0 -0
  146. /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/agents/openai.yaml +0 -0
  147. /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/checklists/checklist.md +0 -0
  148. /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/examples/example.md +0 -0
  149. /package/.codex/skills/{codebase-map-skill → genesis-codebase-map}/templates/map-update-template.md +0 -0
  150. /package/.codex/skills/{design-spec-skill → genesis-design-spec}/SKILL.md +0 -0
  151. /package/.codex/skills/{design-spec-skill → genesis-design-spec}/agents/openai.yaml +0 -0
  152. /package/.codex/skills/{design-spec-skill → genesis-design-spec}/checklists/checklist.md +0 -0
  153. /package/.codex/skills/{design-spec-skill → genesis-design-spec}/examples/example.md +0 -0
  154. /package/.codex/skills/{design-spec-skill → genesis-design-spec}/templates/design-spec-template.md +0 -0
  155. /package/.codex/skills/{docs-skill → genesis-docs}/SKILL.md +0 -0
  156. /package/.codex/skills/{docs-skill → genesis-docs}/agents/openai.yaml +0 -0
  157. /package/.codex/skills/{docs-skill → genesis-docs}/checklists/checklist.md +0 -0
  158. /package/.codex/skills/{docs-skill → genesis-docs}/examples/example.md +0 -0
  159. /package/.codex/skills/{docs-skill → genesis-docs}/templates/docs-update-template.md +0 -0
  160. /package/.codex/skills/{harness-engineering-skill → genesis-harness-engineering}/agents/openai.yaml +0 -0
  161. /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/SKILL.md +0 -0
  162. /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/agents/openai.yaml +0 -0
  163. /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/checklists/checklist.md +0 -0
  164. /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/examples/example.md +0 -0
  165. /package/.codex/skills/{pipeline-orchestration-skill → genesis-pipeline-orchestration}/templates/orchestration-template.md +0 -0
  166. /package/.codex/skills/{planning-skill → genesis-planning}/SKILL.md +0 -0
  167. /package/.codex/skills/{planning-skill → genesis-planning}/agents/openai.yaml +0 -0
  168. /package/.codex/skills/{planning-skill → genesis-planning}/checklists/checklist.md +0 -0
  169. /package/.codex/skills/{planning-skill → genesis-planning}/examples/example.md +0 -0
  170. /package/.codex/skills/{planning-skill → genesis-planning}/templates/plan-template.md +0 -0
  171. /package/.codex/skills/{release-skill → genesis-release}/SKILL.md +0 -0
  172. /package/.codex/skills/{release-skill → genesis-release}/agents/openai.yaml +0 -0
  173. /package/.codex/skills/{release-skill → genesis-release}/checklists/checklist.md +0 -0
  174. /package/.codex/skills/{release-skill → genesis-release}/examples/example.md +0 -0
  175. /package/.codex/skills/{release-skill → genesis-release}/templates/release-checklist-template.md +0 -0
  176. /package/.codex/skills/{research-skill → genesis-research}/SKILL.md +0 -0
  177. /package/.codex/skills/{research-skill → genesis-research}/agents/openai.yaml +0 -0
  178. /package/.codex/skills/{research-skill → genesis-research}/checklists/checklist.md +0 -0
  179. /package/.codex/skills/{research-skill → genesis-research}/examples/example.md +0 -0
  180. /package/.codex/skills/{research-skill → genesis-research}/templates/research-note-template.md +0 -0
@@ -0,0 +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_
@@ -0,0 +1,204 @@
1
+ # Change Impact Matrix
2
+
3
+ **What docs must be updated when different types of changes are made.**
4
+
5
+ Use this matrix to identify all docs that need updating for your feature/bug fix.
6
+
7
+ ## Feature: Behavior Changed
8
+
9
+ **You changed**:
10
+ - User-facing behavior
11
+ - Acceptance criteria
12
+ - Requirement fulfilled
13
+
14
+ **Update these docs**:
15
+ - [ ] `.planning/REQUIREMENTS.md` - Document new requirement
16
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record the change
17
+ - [ ] `.planning/STATE.md` - Update current status
18
+ - [ ] `.planning/SUMMARY.md` - Recent changes
19
+ - [ ] `.planning/FEATURE_INDEX.md` - Feature status
20
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate coverage
21
+
22
+ ---
23
+
24
+ ## Feature: API Changed
25
+
26
+ **You changed**:
27
+ - New endpoints
28
+ - Request/response schemas
29
+ - Auth mechanism
30
+ - Error responses
31
+ - Breaking changes
32
+
33
+ **Update these docs**:
34
+ - [ ] `.planning/API_DOCS.md` - Document new/changed endpoints
35
+ - [ ] `.planning/REQUIREMENTS.md` - Behavior changes
36
+ - [ ] `.planning/INTEGRATIONS.md` - If auth/secrets changed
37
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record API changes with migration notes
38
+ - [ ] `.planning/STATE.md` - Current phase
39
+ - [ ] `.planning/SUMMARY.md` - Recent changes
40
+ - [ ] `.planning/FEATURE_INDEX.md` - Feature status
41
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate API coverage
42
+
43
+ ---
44
+
45
+ ## Feature: Database Changed
46
+
47
+ **You changed**:
48
+ - New tables/collections
49
+ - Schema modifications
50
+ - Data migrations
51
+ - Queries/indexes
52
+
53
+ **Update these docs**:
54
+ - [ ] `.planning/ARCHITECTURE.md` - New data models/schema
55
+ - [ ] `.planning/diagrams/database-erd.mmd` - Update ERD
56
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record schema changes with migration steps
57
+ - [ ] `.planning/STATE.md` - Current phase
58
+ - [ ] `.planning/SUMMARY.md` - Recent changes
59
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate architecture coverage
60
+
61
+ ---
62
+
63
+ ## Feature: UI/UX Changed
64
+
65
+ **You changed**:
66
+ - New screens/pages
67
+ - Component structure
68
+ - User flows
69
+ - Navigation
70
+ - Accessibility
71
+
72
+ **Update these docs**:
73
+ - [ ] `.planning/DESIGN.md` - New screens/components/flow
74
+ - [ ] `.planning/JOURNEYS.md` - Updated user journeys
75
+ - [ ] `.planning/SMOKE_TESTS.md` - New verification paths
76
+ - [ ] `.planning/diagrams/system-context.mmd` - If flows changed
77
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record UI changes
78
+ - [ ] `.planning/STATE.md` - Current phase
79
+ - [ ] `.planning/SUMMARY.md` - Recent changes
80
+ - [ ] `.planning/FEATURE_INDEX.md` - Feature status
81
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate design coverage
82
+
83
+ ---
84
+
85
+ ## Feature: Architecture Changed
86
+
87
+ **You changed**:
88
+ - Module boundaries
89
+ - Service structure
90
+ - Dependency direction
91
+ - Data flow
92
+ - Design patterns
93
+
94
+ **Update these docs**:
95
+ - [ ] `.planning/ARCHITECTURE.md` - New module boundaries, patterns, principles
96
+ - [ ] `.planning/diagrams/container-architecture.mmd` - Update architecture diagram
97
+ - [ ] `.planning/diagrams/deployment-flow.mmd` - If deployment changed
98
+ - [ ] `.planning/CONVENTIONS.md` - New patterns to follow
99
+ - [ ] `.planning/decisions/ADR-XXX-*.md` - Create ADR for major decision
100
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record architecture changes
101
+ - [ ] `.planning/STATE.md` - Current phase
102
+ - [ ] `.planning/SUMMARY.md` - Recent changes
103
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate architecture score
104
+
105
+ ---
106
+
107
+ ## Feature: Integration Changed
108
+
109
+ **You changed**:
110
+ - New external services
111
+ - API keys/secrets
112
+ - Webhooks
113
+ - Rate limits
114
+ - Fallback strategies
115
+
116
+ **Update these docs**:
117
+ - [ ] `.planning/INTEGRATIONS.md` - New services, env vars, failure handling
118
+ - [ ] `.planning/STACK.md` - New dependencies
119
+ - [ ] `.planning/OBSERVABILITY.md` - New error handling/logs
120
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record integration changes
121
+ - [ ] `.planning/STATE.md` - Current phase
122
+ - [ ] `.planning/SUMMARY.md` - Recent changes
123
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate integration coverage
124
+
125
+ ---
126
+
127
+ ## Feature: Configuration/Environment Changed
128
+
129
+ **You changed**:
130
+ - New env variables
131
+ - Config files
132
+ - Build process
133
+ - Runtime environment
134
+ - Deployment parameters
135
+
136
+ **Update these docs**:
137
+ - [ ] `.planning/STACK.md` - New commands, env vars, versions
138
+ - [ ] `.planning/INTEGRATIONS.md` - New secrets/config
139
+ - [ ] `.planning/CONVENTIONS.md` - New rules
140
+ - [ ] `.planning/diagrams/deployment-flow.mmd` - If deployment changed
141
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record config changes
142
+ - [ ] `.planning/STATE.md` - Current phase
143
+ - [ ] `.planning/SUMMARY.md` - Recent changes
144
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate coverage
145
+
146
+ ---
147
+
148
+ ## Bug Fix: Behavior Corrected
149
+
150
+ **You fixed**:
151
+ - Incorrect behavior
152
+ - Edge case handling
153
+ - Error recovery
154
+
155
+ **Update these docs**:
156
+ - [ ] `.planning/LESSONS_LEARNED.md` - Document root cause, prevention
157
+ - [ ] `.planning/SPEC_CHANGELOG.md` - Record fix
158
+ - [ ] `.planning/PITFALLS.md` - Add prevention rule if applicable
159
+ - [ ] `.planning/STATE.md` - Current phase
160
+ - [ ] `.planning/SUMMARY.md` - Recent changes
161
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate
162
+
163
+ ---
164
+
165
+ ## Refactor: No Behavior Change
166
+
167
+ **You changed**:
168
+ - Internal code organization
169
+ - Performance optimization
170
+ - Dependency updates
171
+ - Code cleanup
172
+
173
+ **Update these docs**:
174
+ - [ ] `.planning/ARCHITECTURE.md` - If structure clarified
175
+ - [ ] `.planning/CONVENTIONS.md` - If patterns improved
176
+ - [ ] `.planning/LESSONS_LEARNED.md` - Document why refactor needed
177
+ - [ ] `.planning/STATE.md` - Current phase
178
+ - [ ] `.planning/SUMMARY.md` - Recent changes
179
+ - [ ] `.planning/QUALITY_SCORE.md` - Recalculate maintainability
180
+
181
+ ---
182
+
183
+ ## Always Update
184
+
185
+ **Regardless of change type, ALWAYS update:**
186
+
187
+ - [ ] `.planning/STATE.md` - current phase, active feature, next task
188
+ - [ ] `.planning/SUMMARY.md` - recent changes, next recommended task
189
+ - [ ] `.planning/SPEC_CHANGELOG.md` - date, reason, impacted docs, migration notes
190
+ - [ ] `.planning/FEATURE_INDEX.md` or `.planning/bugs/` - status update
191
+
192
+ **Exception**: Internal refactor with zero behavior change can skip SPEC_CHANGELOG if justified.
193
+
194
+ ---
195
+
196
+ ## How to Use This Matrix
197
+
198
+ 1. **Identify change type** above (Feature: API Changed? Bug Fix? etc.)
199
+ 2. **Check all boxes** that apply
200
+ 3. **Update each doc** listed
201
+ 4. **Verify** with checklist in Definition of Done
202
+ 5. **Add to SPEC_CHANGELOG.md** as final proof
203
+
204
+ **If you forget to update a doc**: Spec drift → future bugs → technical debt → expensive rewrites.
@@ -0,0 +1,131 @@
1
+ # Foundation Phase (Phase 0)
2
+
3
+ ## Overview
4
+
5
+ Phase 0 is a setup phase only. Its purpose is to complete project documentation and establish the planning framework.
6
+
7
+ **This phase contains NO feature implementation tasks.**
8
+
9
+ Feature phases (Phase 1, 2, 3...) are created later only after:
10
+ - Requirements are finalized
11
+ - Product roadmap is confirmed
12
+ - Prioritization is decided
13
+
14
+ ## Goal
15
+
16
+ Establish complete project documentation, confirm product intent, and prepare for feature development.
17
+
18
+ ## Scope
19
+
20
+ - [x] Detect and extract project information
21
+ - [ ] Complete PROJECT.md with confirmed details
22
+ - [ ] Document all REQUIREMENTS.md
23
+ - [ ] Define ARCHITECTURE.md based on codebase inspection
24
+ - [ ] Document STACK.md (languages, frameworks, tools)
25
+ - [ ] Define CONVENTIONS.md (coding patterns, style)
26
+ - [ ] Document INTEGRATIONS.md (if any)
27
+ - [ ] Create API_DOCS.md structure
28
+ - [ ] Establish PITFALLS.md warnings
29
+ - [ ] Create base Mermaid diagrams
30
+ - [ ] Create initial QUALITY_SCORE.md
31
+ - [ ] Verify harness is functional
32
+
33
+ ## Tasks
34
+
35
+ ### Read & Confirm
36
+
37
+ - [ ] Read `.planning/PROJECT.md`
38
+ - [ ] Confirm product intent is clear
39
+ - [ ] Identify any missing requirements
40
+
41
+ ### Document & Refine
42
+
43
+ - [ ] Complete `.planning/REQUIREMENTS.md` with functional & non-functional reqs
44
+ - [ ] Document `.planning/ARCHITECTURE.md` from codebase inspection
45
+ - [ ] Complete `.planning/STACK.md` with full tech details
46
+ - [ ] Document `.planning/CONVENTIONS.md` from existing code patterns
47
+ - [ ] Identify pitfalls and document in `.planning/PITFALLS.md`
48
+
49
+ ### Diagrams & References
50
+
51
+ - [ ] Create `.planning/diagrams/system-context.mmd`
52
+ - [ ] Create `.planning/diagrams/container-architecture.mmd`
53
+ - [ ] Create `.planning/diagrams/database-erd.mmd` (if applicable)
54
+ - [ ] Create `.planning/diagrams/deployment-flow.mmd`
55
+
56
+ ### Quality & Verification
57
+
58
+ - [ ] Initial QUALITY_SCORE.md (document current state)
59
+ - [ ] Verify `.planning/` structure is complete
60
+ - [ ] Verify all core docs have content (not just TBD)
61
+ - [ ] Run any existing tests/builds to verify health
62
+
63
+ ## Dependencies
64
+
65
+ None. Phase 0 is the foundation.
66
+
67
+ ## Acceptance Criteria
68
+
69
+ - [x] `.planning/` structure created
70
+ - [ ] PROJECT.md completed with confirmed product brief
71
+ - [ ] REQUIREMENTS.md lists all known requirements
72
+ - [ ] STACK.md documents all tech details
73
+ - [ ] ARCHITECTURE.md describes system design
74
+ - [ ] Diagrams are created and reasonably accurate
75
+ - [ ] CONVENTIONS.md documents local patterns
76
+ - [ ] No "TBD" remains in critical docs (PROJECT, REQUIREMENTS, STACK, ARCHITECTURE)
77
+ - [ ] Team/user confirms they understand the roadmap and agree with scope
78
+ - [ ] All verification checks pass
79
+
80
+ ## Verification
81
+
82
+ ```sh
83
+ # Check structure exists
84
+ ls -la .planning/phases/00-foundation/
85
+ ls -la .planning/*.md
86
+ ls -la .planning/diagrams/*.mmd
87
+
88
+ # Verify no critical TBDs remain
89
+ grep -l "TBD" .planning/PROJECT.md .planning/REQUIREMENTS.md .planning/STACK.md .planning/ARCHITECTURE.md || echo "✓ No TBDs in critical docs"
90
+
91
+ # Run any project-specific verification
92
+ # npm test
93
+ # yarn lint
94
+ # python -m pytest
95
+ ```
96
+
97
+ ## Next Phase
98
+
99
+ After Foundation phase completes:
100
+
101
+ 1. Create Phase 1 for first priority feature/milestone
102
+ 2. Each phase gets its own numbered folder (01-feature-name, 02-feature-name, etc.)
103
+ 3. Create feature-specific plans in `.planning/features/` as work begins
104
+
105
+ ---
106
+
107
+ ## Phase 0 vs Feature Phases
108
+
109
+ **Phase 0 (Foundation):**
110
+ - Documentation & setup
111
+ - No feature work
112
+ - Establishes framework
113
+ - All docs defined but empty
114
+
115
+ **Phase 1+ (Features):**
116
+ - Implement specific features
117
+ - Contain implementation tasks
118
+ - Follow Foundation as blueprint
119
+ - Created when requirements are clear
120
+
121
+ ---
122
+
123
+ ## Why No Feature Phases Initially?
124
+
125
+ We don't know what users need until we:
126
+ 1. Complete requirements
127
+ 2. Research existing patterns
128
+ 3. Validate assumptions
129
+ 4. Prioritize work
130
+
131
+ Phase 0 ensures we document existing state before planning future features.
@@ -0,0 +1,76 @@
1
+ # Phase 0: Foundation
2
+
3
+ ## Goal
4
+
5
+ Complete project documentation, validate product intent, and establish the planning framework. **No feature implementation in this phase.**
6
+
7
+ ## Scope
8
+
9
+ Documentation only:
10
+ - [ ] Confirm PROJECT.md details
11
+ - [ ] Complete REQUIREMENTS.md
12
+ - [ ] Document ARCHITECTURE.md
13
+ - [ ] Document STACK.md
14
+ - [ ] Define CONVENTIONS.md
15
+ - [ ] Create base diagrams
16
+ - [ ] Establish baseline quality score
17
+
18
+ ## Dependencies
19
+
20
+ None. This is the foundation.
21
+
22
+ ## Tasks
23
+
24
+ - [ ] Read `.planning/PROJECT.md` - confirm product intent
25
+ - [ ] Read `.planning/REQUIREMENTS.md` - validate requirements
26
+ - [ ] Complete STACK.md with all tech details and versions
27
+ - [ ] Document ARCHITECTURE.md from codebase analysis
28
+ - [ ] Extract CONVENTIONS.md from existing code patterns
29
+ - [ ] Identify and document PITFALLS.md
30
+ - [ ] Create system-context.mmd diagram
31
+ - [ ] Create container-architecture.mmd diagram
32
+ - [ ] Create database-erd.mmd (if applicable)
33
+ - [ ] Create deployment-flow.mmd diagram
34
+ - [ ] Create initial QUALITY_SCORE.md
35
+ - [ ] Verify all `.planning/` structure exists
36
+ - [ ] Run project verification (tests, builds, etc.)
37
+ - [ ] Document decision: "Phase 0 complete, ready for Phase 1 planning"
38
+
39
+ ## Acceptance Criteria
40
+
41
+ - [x] `.planning/` directory structure created
42
+ - [ ] PROJECT.md completed with product details
43
+ - [ ] REQUIREMENTS.md documented
44
+ - [ ] STACK.md has all tech versions
45
+ - [ ] ARCHITECTURE.md describes system boundaries
46
+ - [ ] Diagrams are created
47
+ - [ ] No critical TBDs remain in core docs
48
+ - [ ] Team confirms understanding of project scope
49
+ - [ ] All verification checks pass
50
+
51
+ ## Verification
52
+
53
+ ```sh
54
+ # Verify structure
55
+ test -d .planning/phases/00-foundation && echo "✓ Phase folder exists"
56
+
57
+ # Check core docs are not just TBD
58
+ for file in PROJECT REQUIREMENTS STACK ARCHITECTURE CONVENTIONS; do
59
+ if grep -q "^## " .planning/$file.md && ! grep -q "TBD$" .planning/$file.md; then
60
+ echo "✓ .planning/$file.md has content"
61
+ fi
62
+ done
63
+
64
+ # List all diagrams
65
+ ls -la .planning/diagrams/*.mmd | wc -l
66
+ ```
67
+
68
+ ## Risk & Rollback
69
+
70
+ **Risk**: Documentation may be incomplete or inaccurate.
71
+
72
+ **Rollback**: This is a documentation phase. If docs need revision, simply edit the `.planning/*.md` files directly. No code changes to rollback.
73
+
74
+ ## Notes
75
+
76
+ This phase is setup only. Feature phases start in Phase 1 after Foundation is complete and requirements are confirmed.