codex-genesis-harness 0.1.5 → 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.
Files changed (151) hide show
  1. package/.codebase/ARCHITECTURE_REVIEW_COMPLETE.md +216 -216
  2. package/.codebase/CURRENT_STATE.md +7 -2
  3. package/.codebase/FILE_NAMING_CLARIFICATION.md +161 -161
  4. package/.codebase/HARNESS_COMPLETENESS_AUDIT.md +613 -613
  5. package/.codebase/IMPLEMENTATION_COMPLETE.md +429 -429
  6. package/.codebase/IMPLEMENTATION_HANDOFF.md +351 -351
  7. package/.codebase/IMPROVEMENTS_SUMMARY.md +419 -419
  8. package/.codebase/PHASE3_SKILLS_NAMING_COMPLETE.md +292 -292
  9. package/.codebase/PHASE_DEPENDENCY_MAP.md +486 -486
  10. package/.codebase/QUICK_START_SPEC_IMPACT.md +456 -456
  11. package/.codebase/README.md +139 -139
  12. package/.codebase/RECOVERY_POINTS.md +438 -438
  13. package/.codex/skills/genesis-api-sync/SKILL.md +354 -354
  14. package/.codex/skills/genesis-api-sync/checklists/api-sync-checklist.md +101 -101
  15. package/.codex/skills/genesis-api-sync/templates/api-change-template.md +257 -257
  16. package/.codex/skills/genesis-debug-guide/SKILL.md +479 -479
  17. package/.codex/skills/genesis-debug-guide/checklists/flaky-test-investigation.md +339 -339
  18. package/.codex/skills/genesis-debug-guide/checklists/production-bug-debug.md +210 -210
  19. package/.codex/skills/genesis-debug-guide/checklists/test-failure-debug.md +158 -158
  20. package/.codex/skills/genesis-debug-guide/observability/debug-commands.md +365 -365
  21. package/.codex/skills/genesis-debug-guide/playbooks/unit-test-failures.md +289 -289
  22. package/.codex/skills/genesis-debug-guide/templates/debug-investigation-log.md +288 -288
  23. package/.codex/skills/genesis-docs-automation/SKILL.md +1003 -1003
  24. package/.codex/skills/genesis-docs-automation/checklists/docs-validation.md +359 -359
  25. package/.codex/skills/genesis-docs-automation/checklists/spec-alignment.md +312 -312
  26. package/.codex/skills/genesis-docs-automation/observability/docs-tracking.md +382 -382
  27. package/.codex/skills/genesis-docs-automation/playbooks/auto-update-flow.md +851 -851
  28. package/.codex/skills/genesis-docs-automation/playbooks/changelog-generation.md +491 -491
  29. package/.codex/skills/genesis-docs-automation/templates/changelog-entry-template.md +187 -187
  30. package/.codex/skills/genesis-docs-automation/templates/handoff-template.md +297 -297
  31. package/.codex/skills/genesis-harness/SKILL.md +1427 -1427
  32. package/.codex/skills/genesis-harness/agents/openai.yaml +7 -7
  33. package/.codex/skills/genesis-harness/checklists/bug-fix-qa.md +169 -169
  34. package/.codex/skills/genesis-harness/checklists/new-feature-qa.md +157 -157
  35. package/.codex/skills/genesis-harness/checklists/refactor-qa.md +216 -216
  36. package/.codex/skills/genesis-harness/checklists/requirements-validation.md +211 -211
  37. package/.codex/skills/genesis-harness/references/planning-schema.md +35 -35
  38. package/.codex/skills/genesis-harness/references/quality-rubric.md +21 -21
  39. package/.codex/skills/genesis-harness/references/research-rubric.md +41 -41
  40. package/.codex/skills/genesis-harness/references/workflows.md +33 -33
  41. package/.codex/skills/genesis-harness/resources/agents-template.md +27 -27
  42. package/.codex/skills/genesis-harness/resources/api-docs-template.md +32 -32
  43. package/.codex/skills/genesis-harness/resources/architecture-template.md +30 -30
  44. package/.codex/skills/genesis-harness/resources/audit-template.md +26 -26
  45. package/.codex/skills/genesis-harness/resources/bug-template.md +34 -34
  46. package/.codex/skills/genesis-harness/resources/change-impact-matrix-template.md +204 -204
  47. package/.codex/skills/genesis-harness/resources/check-template.md +21 -21
  48. package/.codex/skills/genesis-harness/resources/conventions-template.md +42 -42
  49. package/.codex/skills/genesis-harness/resources/decision-template.md +33 -33
  50. package/.codex/skills/genesis-harness/resources/design-template.md +26 -26
  51. package/.codex/skills/genesis-harness/resources/escalation-template.md +21 -21
  52. package/.codex/skills/genesis-harness/resources/feature-template.md +49 -49
  53. package/.codex/skills/genesis-harness/resources/foundation-phase-template.md +131 -131
  54. package/.codex/skills/genesis-harness/resources/integrations-template.md +32 -32
  55. package/.codex/skills/genesis-harness/resources/journeys-template.md +13 -13
  56. package/.codex/skills/genesis-harness/resources/lessons-learned-template.md +12 -12
  57. package/.codex/skills/genesis-harness/resources/observability-template.md +34 -34
  58. package/.codex/skills/genesis-harness/resources/phase-00-foundation-template.md +76 -76
  59. package/.codex/skills/genesis-harness/resources/phase-template.md +34 -34
  60. package/.codex/skills/genesis-harness/resources/pitfalls-template.md +22 -22
  61. package/.codex/skills/genesis-harness/resources/planning-tree-template.md +39 -39
  62. package/.codex/skills/genesis-harness/resources/post-implementation-guide.md +347 -347
  63. package/.codex/skills/genesis-harness/resources/project-template.md +38 -38
  64. package/.codex/skills/genesis-harness/resources/quality-score-template.md +11 -11
  65. package/.codex/skills/genesis-harness/resources/requirements-template.md +26 -26
  66. package/.codex/skills/genesis-harness/resources/research-template.md +26 -26
  67. package/.codex/skills/genesis-harness/resources/review-template.md +22 -22
  68. package/.codex/skills/genesis-harness/resources/spec-changelog-template.md +6 -6
  69. package/.codex/skills/genesis-harness/resources/stack-template.md +33 -33
  70. package/.codex/skills/genesis-harness/resources/verification-template.md +26 -26
  71. package/.codex/skills/genesis-harness/scripts/check-architecture-boundaries.sh +0 -0
  72. package/.codex/skills/genesis-harness/scripts/check-docs-sync.sh +0 -0
  73. package/.codex/skills/genesis-harness/scripts/check-no-debug-logs.sh +0 -0
  74. package/.codex/skills/genesis-harness/scripts/check-required-planning-files.sh +0 -0
  75. package/.codex/skills/genesis-harness/scripts/check-spec-changelog.sh +0 -0
  76. package/.codex/skills/genesis-harness/scripts/check-task-tracking.sh +0 -0
  77. package/.codex/skills/genesis-harness/scripts/compact-context.sh +0 -0
  78. package/.codex/skills/genesis-harness/scripts/create-adr.sh +0 -0
  79. package/.codex/skills/genesis-harness/scripts/create-bug.sh +0 -0
  80. package/.codex/skills/genesis-harness/scripts/create-feature.sh +0 -0
  81. package/.codex/skills/genesis-harness/scripts/detect-stack.sh +0 -0
  82. package/.codex/skills/genesis-harness/scripts/init-planning.sh +0 -0
  83. package/.codex/skills/genesis-harness/scripts/list-changed-files.sh +0 -0
  84. package/.codex/skills/genesis-harness/scripts/offload-log.sh +0 -0
  85. package/.codex/skills/genesis-harness/scripts/run-verification.sh +0 -0
  86. package/.codex/skills/genesis-harness/scripts/run-verify-loop.sh +0 -0
  87. package/.codex/skills/genesis-harness/scripts/update-state.sh +0 -0
  88. package/.codex/skills/genesis-mvp-planning/SKILL.md +114 -0
  89. package/.codex/skills/genesis-mvp-planning/agents/openai.yaml +6 -0
  90. package/.codex/skills/genesis-mvp-planning/checklists/mvp-readiness.md +18 -0
  91. package/.codex/skills/genesis-mvp-planning/examples/5-phase-roadmap-example.md +43 -0
  92. package/.codex/skills/genesis-mvp-planning/templates/phase-1-core.md +17 -0
  93. package/.codex/skills/genesis-mvp-planning/templates/phase-2-auth.md +17 -0
  94. package/.codex/skills/genesis-mvp-planning/templates/phase-3-features.md +17 -0
  95. package/.codex/skills/genesis-mvp-planning/templates/phase-4-integrations.md +17 -0
  96. package/.codex/skills/genesis-mvp-planning/templates/phase-5-readiness.md +17 -0
  97. package/.codex/skills/genesis-new-design/agents/openai.yaml +3 -3
  98. package/.codex/skills/genesis-observability-automation/checklists/.gitkeep +0 -0
  99. package/.codex/skills/genesis-observability-automation/observability/.gitkeep +0 -0
  100. package/.codex/skills/genesis-observability-automation/playbooks/.gitkeep +0 -0
  101. package/.codex/skills/genesis-observability-automation/templates/.gitkeep +0 -0
  102. package/.codex/skills/genesis-release-orchestration/SKILL.md +653 -653
  103. package/.codex/skills/genesis-release-orchestration/checklists/post-deployment-verification.md +274 -274
  104. package/.codex/skills/genesis-release-orchestration/checklists/pre-release-validation.md +220 -220
  105. package/.codex/skills/genesis-release-orchestration/observability/release-tracking.md +253 -253
  106. package/.codex/skills/genesis-release-orchestration/playbooks/canary-deployment-orchestration.md +472 -472
  107. package/.codex/skills/genesis-release-orchestration/playbooks/semantic-versioning-automation.md +494 -494
  108. package/.codex/skills/genesis-release-orchestration/templates/deployment-strategy-template.md +303 -303
  109. package/.codex/skills/genesis-release-orchestration/templates/release-runbook-template.md +420 -420
  110. package/.codex/skills/genesis-research-first/SKILL.md +237 -237
  111. package/.codex/skills/genesis-research-first/templates/.gitkeep +0 -0
  112. package/.codex/skills/genesis-spec-propagation/SKILL.md +534 -534
  113. package/.codex/skills/genesis-spec-propagation/checklists/phase-update-verification.md +384 -384
  114. package/.codex/skills/genesis-spec-propagation/checklists/spec-change-detection.md +257 -257
  115. package/.codex/skills/genesis-spec-propagation/observability/propagation-tracking.md +373 -373
  116. package/.codex/skills/genesis-spec-propagation/playbooks/breaking-change-propagation.md +692 -692
  117. package/.codex/skills/genesis-spec-propagation/playbooks/feature-change-propagation.md +434 -434
  118. package/.codex/skills/genesis-spec-propagation/templates/migration-guide-template.md +407 -407
  119. package/.codex/skills/genesis-upgrade-design/agents/openai.yaml +3 -3
  120. package/.codex/skills/spec-impact-engine/SKILL.md +504 -504
  121. package/.codex/skills/spec-impact-engine/detect-spec-changes.sh +0 -0
  122. package/.codex-plugin/plugin.json +19 -19
  123. package/CHANGELOG.md +42 -0
  124. package/LICENSE +22 -22
  125. package/README.EN.md +784 -730
  126. package/README.VI.md +776 -723
  127. package/README.md +102 -247
  128. package/VERSION +2 -2
  129. package/bin/genesis-harness.js +90 -87
  130. package/package.json +9 -3
  131. package/scripts/README.md +342 -342
  132. package/scripts/compact-context.sh +0 -0
  133. package/scripts/contract_integrity_gate.js +83 -0
  134. package/scripts/detect-changes.sh +0 -0
  135. package/scripts/healing_telemetry.js +118 -0
  136. package/scripts/install.sh +4 -1
  137. package/scripts/offload-log.sh +0 -0
  138. package/scripts/prompt_sentinel.js +84 -0
  139. package/scripts/run-evals.sh +1 -0
  140. package/scripts/run-verify-loop.sh +11 -0
  141. package/scripts/spec_visual_sync.js +157 -0
  142. package/scripts/test_generator.js +142 -0
  143. package/scripts/transition_state.sh +0 -0
  144. package/scripts/uninstall.sh +1 -0
  145. package/scripts/validation_gates.sh +40 -1
  146. package/scripts/verify.sh +5 -0
  147. package/tests/unit/contract_integrity_gate.test.js +74 -0
  148. package/tests/unit/healing_telemetry.test.js +58 -0
  149. package/tests/unit/prompt_sentinel.test.js +50 -0
  150. package/tests/unit/spec_visual_sync.test.js +77 -0
  151. package/tests/unit/test_generator.test.js +62 -0
@@ -1,9 +1,9 @@
1
- interface:
1
+ interface:
2
2
  display_name: "Genesis Harness"
3
- short_description: "Plan, track, verify, and review projects"
4
- brand_color: "#2563EB"
3
+ short_description: " Lập kế hoạch, giám sát và kiểm thử dự án"
4
+ brand_color: "#2563EB"
5
5
  default_prompt: "Use $genesis-harness to initialize planning and operate this repository with test-first workflows."
6
-
7
- policy:
8
- allow_implicit_invocation: true
9
-
6
+
7
+ policy:
8
+ allow_implicit_invocation: true
9
+
@@ -1,169 +1,169 @@
1
- # Bug Fix Q&A Checklist
2
-
3
- **Purpose**: Structured questionnaire to understand and document bug fixes before planning /fix-bug.
4
-
5
- **Status**: MANDATORY - Complete before creating implementation plan.
6
-
7
- ## Bug Identification & Reproduction
8
-
9
- - [ ] **Bug clearly described**:
10
- - What is the incorrect behavior?
11
- - What should happen instead?
12
- - Step-by-step repro steps documented
13
-
14
- - [ ] **Reproducibility confirmed**:
15
- - Consistently reproducible?
16
- - Specific conditions/environment needed?
17
- - Affects all users or specific scenarios?
18
-
19
- - [ ] **Severity & Priority assessed**:
20
- - Critical (blocks core functionality)?
21
- - High (significant impact, workaround exists)?
22
- - Medium (inconvenience, non-blocking)?
23
- - Low (cosmetic, nice-to-fix)?
24
-
25
- - [ ] **Affected Versions identified**:
26
- - When was this introduced?
27
- - Which versions affected?
28
- - Latest stable version affected?
29
-
30
- ## Root Cause Analysis
31
-
32
- - [ ] **Root cause identified** (or hypothesis if unknown):
33
- - Specific code location/module?
34
- - Logic error or incorrect assumption?
35
- - Missing validation or error handling?
36
- - Race condition or state issue?
37
- - Integration bug with external service?
38
-
39
- - [ ] **Why was it missed**:
40
- - Was there a test that should have caught this?
41
- - Missing test coverage?
42
- - Environment-specific (dev vs. production)?
43
-
44
- - [ ] **Affected systems mapped**:
45
- - Single module or cross-module issue?
46
- - API side or client side?
47
- - Database or state management?
48
- - Performance or correctness?
49
-
50
- ## Impact Assessment
51
-
52
- - [ ] **Data Integrity concerns**:
53
- - Has data been corrupted or lost?
54
- - Rollback/recovery strategy needed?
55
- - Data migration required after fix?
56
-
57
- - [ ] **User Impact**:
58
- - How many users affected?
59
- - What functionality is broken?
60
- - Workaround available in the meantime?
61
-
62
- - [ ] **Breaking Change Risk**:
63
- - Does the fix change public API behavior?
64
- - Will this break existing clients?
65
- - Backward compatibility needed?
66
-
67
- ## Fix Strategy
68
-
69
- - [ ] **Fix approach decided**:
70
- - Minimal change to fix only the bug?
71
- - Or refactor to prevent similar bugs?
72
- - Tradeoffs understood?
73
-
74
- - [ ] **Side Effects considered**:
75
- - What other code paths use this?
76
- - Could this fix introduce new bugs?
77
- - Dependencies to check?
78
-
79
- - [ ] **Regression Prevention**:
80
- - What test catches this bug?
81
- - Test added before or after fix?
82
- - Similar patterns to look for?
83
-
84
- ## Testing & Verification
85
-
86
- - [ ] **Test Case for Bug**:
87
- - Failing test created before fix?
88
- - Test reproduces the exact bug?
89
- - Test passes after fix?
90
-
91
- - [ ] **Regression Tests**:
92
- - Existing tests still pass?
93
- - Edge cases covered?
94
- - Similar bugs tested in other areas?
95
-
96
- - [ ] **Verification Plan**:
97
- - How will we verify fix in production?
98
- - Monitoring/alerts to confirm success?
99
- - Rollback plan if fix causes issues?
100
-
101
- ## Deployment & Release
102
-
103
- - [ ] **Hotfix or Regular Release**:
104
- - Needs immediate hotfix deployment?
105
- - Can wait for next regular release?
106
- - Affects which release branches?
107
-
108
- - [ ] **Release Notes**:
109
- - What message for end users?
110
- - Migration steps if needed?
111
- - Workaround guidance during transition?
112
-
113
- - [ ] **Rollout Strategy**:
114
- - Staged rollout or immediate?
115
- - Feature flags needed?
116
- - Canary deployment approach?
117
-
118
- ## Documentation Updates
119
-
120
- - [ ] **Docs need updating**:
121
- - Behavior changed in docs?
122
- - Workaround documented?
123
- - Migration guide needed?
124
-
125
- - [ ] **Release Notes written**:
126
- - User-friendly description
127
- - Workaround mentioned if applicable
128
- - Any breaking changes noted
129
-
130
- ## Lesson Learned
131
-
132
- - [ ] **How to prevent this in future**:
133
- - Better test coverage?
134
- - Code review checklist item?
135
- - Documentation gap?
136
- - Process improvement?
137
-
138
- - [ ] **Similar bugs searched**:
139
- - Pattern scan for similar issues in codebase?
140
- - Found and fixed other instances?
141
-
142
- ---
143
-
144
- ## Usage
145
-
146
- Use this checklist **before** calling `/fix-bug`:
147
-
148
- ```
149
- 1. Read and reproduce the bug
150
- 2. Complete this checklist thoroughly
151
- 3. Add bug details to implementation plan
152
- 4. Create failing test first
153
- 5. Fix with minimal change
154
- 6. Verify all tests pass
155
- 7. Document lesson learned
156
- ```
157
-
158
- ## Known Information About Bug
159
-
160
- - **Bug ID/Ticket**: _reference_
161
- - **Reported By**: _name_
162
- - **Date Reported**: _YYYY-MM-DD_
163
- - **Current Status**: _New / Assigned / In Progress_
164
-
165
- ---
166
-
167
- **Checklist Completed**: ☐
168
- **Date**: _YYYY-MM-DD_
169
- **Assigned To**: _Name_
1
+ # Bug Fix Q&A Checklist
2
+
3
+ **Purpose**: Structured questionnaire to understand and document bug fixes before planning /fix-bug.
4
+
5
+ **Status**: MANDATORY - Complete before creating implementation plan.
6
+
7
+ ## Bug Identification & Reproduction
8
+
9
+ - [ ] **Bug clearly described**:
10
+ - What is the incorrect behavior?
11
+ - What should happen instead?
12
+ - Step-by-step repro steps documented
13
+
14
+ - [ ] **Reproducibility confirmed**:
15
+ - Consistently reproducible?
16
+ - Specific conditions/environment needed?
17
+ - Affects all users or specific scenarios?
18
+
19
+ - [ ] **Severity & Priority assessed**:
20
+ - Critical (blocks core functionality)?
21
+ - High (significant impact, workaround exists)?
22
+ - Medium (inconvenience, non-blocking)?
23
+ - Low (cosmetic, nice-to-fix)?
24
+
25
+ - [ ] **Affected Versions identified**:
26
+ - When was this introduced?
27
+ - Which versions affected?
28
+ - Latest stable version affected?
29
+
30
+ ## Root Cause Analysis
31
+
32
+ - [ ] **Root cause identified** (or hypothesis if unknown):
33
+ - Specific code location/module?
34
+ - Logic error or incorrect assumption?
35
+ - Missing validation or error handling?
36
+ - Race condition or state issue?
37
+ - Integration bug with external service?
38
+
39
+ - [ ] **Why was it missed**:
40
+ - Was there a test that should have caught this?
41
+ - Missing test coverage?
42
+ - Environment-specific (dev vs. production)?
43
+
44
+ - [ ] **Affected systems mapped**:
45
+ - Single module or cross-module issue?
46
+ - API side or client side?
47
+ - Database or state management?
48
+ - Performance or correctness?
49
+
50
+ ## Impact Assessment
51
+
52
+ - [ ] **Data Integrity concerns**:
53
+ - Has data been corrupted or lost?
54
+ - Rollback/recovery strategy needed?
55
+ - Data migration required after fix?
56
+
57
+ - [ ] **User Impact**:
58
+ - How many users affected?
59
+ - What functionality is broken?
60
+ - Workaround available in the meantime?
61
+
62
+ - [ ] **Breaking Change Risk**:
63
+ - Does the fix change public API behavior?
64
+ - Will this break existing clients?
65
+ - Backward compatibility needed?
66
+
67
+ ## Fix Strategy
68
+
69
+ - [ ] **Fix approach decided**:
70
+ - Minimal change to fix only the bug?
71
+ - Or refactor to prevent similar bugs?
72
+ - Tradeoffs understood?
73
+
74
+ - [ ] **Side Effects considered**:
75
+ - What other code paths use this?
76
+ - Could this fix introduce new bugs?
77
+ - Dependencies to check?
78
+
79
+ - [ ] **Regression Prevention**:
80
+ - What test catches this bug?
81
+ - Test added before or after fix?
82
+ - Similar patterns to look for?
83
+
84
+ ## Testing & Verification
85
+
86
+ - [ ] **Test Case for Bug**:
87
+ - Failing test created before fix?
88
+ - Test reproduces the exact bug?
89
+ - Test passes after fix?
90
+
91
+ - [ ] **Regression Tests**:
92
+ - Existing tests still pass?
93
+ - Edge cases covered?
94
+ - Similar bugs tested in other areas?
95
+
96
+ - [ ] **Verification Plan**:
97
+ - How will we verify fix in production?
98
+ - Monitoring/alerts to confirm success?
99
+ - Rollback plan if fix causes issues?
100
+
101
+ ## Deployment & Release
102
+
103
+ - [ ] **Hotfix or Regular Release**:
104
+ - Needs immediate hotfix deployment?
105
+ - Can wait for next regular release?
106
+ - Affects which release branches?
107
+
108
+ - [ ] **Release Notes**:
109
+ - What message for end users?
110
+ - Migration steps if needed?
111
+ - Workaround guidance during transition?
112
+
113
+ - [ ] **Rollout Strategy**:
114
+ - Staged rollout or immediate?
115
+ - Feature flags needed?
116
+ - Canary deployment approach?
117
+
118
+ ## Documentation Updates
119
+
120
+ - [ ] **Docs need updating**:
121
+ - Behavior changed in docs?
122
+ - Workaround documented?
123
+ - Migration guide needed?
124
+
125
+ - [ ] **Release Notes written**:
126
+ - User-friendly description
127
+ - Workaround mentioned if applicable
128
+ - Any breaking changes noted
129
+
130
+ ## Lesson Learned
131
+
132
+ - [ ] **How to prevent this in future**:
133
+ - Better test coverage?
134
+ - Code review checklist item?
135
+ - Documentation gap?
136
+ - Process improvement?
137
+
138
+ - [ ] **Similar bugs searched**:
139
+ - Pattern scan for similar issues in codebase?
140
+ - Found and fixed other instances?
141
+
142
+ ---
143
+
144
+ ## Usage
145
+
146
+ Use this checklist **before** calling `/fix-bug`:
147
+
148
+ ```
149
+ 1. Read and reproduce the bug
150
+ 2. Complete this checklist thoroughly
151
+ 3. Add bug details to implementation plan
152
+ 4. Create failing test first
153
+ 5. Fix with minimal change
154
+ 6. Verify all tests pass
155
+ 7. Document lesson learned
156
+ ```
157
+
158
+ ## Known Information About Bug
159
+
160
+ - **Bug ID/Ticket**: _reference_
161
+ - **Reported By**: _name_
162
+ - **Date Reported**: _YYYY-MM-DD_
163
+ - **Current Status**: _New / Assigned / In Progress_
164
+
165
+ ---
166
+
167
+ **Checklist Completed**: ☐
168
+ **Date**: _YYYY-MM-DD_
169
+ **Assigned To**: _Name_
@@ -1,157 +1,157 @@
1
- # New Feature Q&A Checklist
2
-
3
- **Purpose**: Structured questionnaire to capture all requirements before planning /new-feature.
4
-
5
- **Status**: MANDATORY - Complete all fields before /plan is created.
6
-
7
- ## User Story & Intent
8
-
9
- - [ ] **User Story defined**: "As a [who], I want [what] so that [why]"
10
- - Who is the primary user/actor?
11
- - What specific action or capability do they need?
12
- - What outcome or value does this deliver?
13
-
14
- - [ ] **Success Criteria clear**: How do we know this feature is working?
15
- - At least 3 measurable criteria
16
- - Business metrics or user satisfaction indicators
17
-
18
- - [ ] **Out of Scope documented**: What is explicitly NOT included?
19
- - Related features we're NOT doing now
20
- - Future enhancements or phases
21
-
22
- ## Requirements & Constraints
23
-
24
- - [ ] **Functional Requirements clear**:
25
- - Primary use cases (happy path)
26
- - Secondary use cases
27
- - Data inputs and outputs
28
-
29
- - [ ] **Non-Functional Requirements identified**:
30
- - Performance expectations (speed, throughput, latency)
31
- - Scalability requirements
32
- - Availability/uptime requirements
33
- - Browser/device support
34
-
35
- - [ ] **Dependencies & Integrations mapped**:
36
- - Does this touch APIs? Which ones?
37
- - Database schema changes needed?
38
- - External services involved?
39
- - Existing modules that will be modified?
40
-
41
- - [ ] **Constraints & Limitations noted**:
42
- - Technical constraints (memory, compute)
43
- - Business constraints (timeline, budget)
44
- - Regulatory/compliance constraints
45
- - Breaking changes or migration requirements?
46
-
47
- ## Impact & Scope
48
-
49
- - [ ] **Affected Systems identified**:
50
- - Which modules will change? (list by name)
51
- - Which APIs will change or be added?
52
- - Which database tables/schemas affected?
53
- - Frontend routes or pages added/modified?
54
-
55
- - [ ] **API Surface Changes**:
56
- - New endpoints needed?
57
- - Modified endpoint behavior?
58
- - Deprecated endpoints?
59
- - Data contract changes?
60
-
61
- - [ ] **Database Changes**:
62
- - New tables/collections?
63
- - Schema migrations?
64
- - Backward compatibility concerns?
65
-
66
- - [ ] **UI/UX Changes**:
67
- - New pages/screens?
68
- - Modified navigation flows?
69
- - New user interactions?
70
-
71
- ## Edge Cases & Error Handling
72
-
73
- - [ ] **Edge Cases enumerated**:
74
- - Boundary conditions (empty, null, max values)
75
- - Concurrent operations conflicts
76
- - Network failures or timeouts
77
- - Permission/authorization scenarios
78
- - Race conditions or state inconsistencies
79
-
80
- - [ ] **Error Scenarios documented**:
81
- - Invalid input handling
82
- - Failure recovery strategy
83
- - User-facing error messages
84
- - Logging/observability for debugging
85
-
86
- ## Architecture & Design
87
-
88
- - [ ] **Architectural Pattern chosen**:
89
- - Synchronous vs. asynchronous?
90
- - Client-side vs. server-side?
91
- - Real-time vs. eventual consistency?
92
- - Distributed or monolithic?
93
-
94
- - [ ] **Design Decisions recorded** (Why this approach?):
95
- - What alternatives were considered?
96
- - Why this one was chosen?
97
- - Any known tradeoffs?
98
-
99
- - [ ] **Performance Considerations**:
100
- - Caching strategy if needed?
101
- - Query optimization?
102
- - Batch processing opportunities?
103
-
104
- ## Testing Strategy
105
-
106
- - [ ] **Test Coverage planned**:
107
- - Unit tests (which modules?)
108
- - Integration tests (which interactions?)
109
- - E2E tests (which user flows?)
110
- - Target coverage: 80%+ or higher?
111
-
112
- - [ ] **Test Data & Fixtures**:
113
- - What test data do we need?
114
- - Realistic edge case fixtures?
115
- - Performance test datasets?
116
-
117
- ## Rollout & Monitoring
118
-
119
- - [ ] **Deployment Strategy**:
120
- - Staged rollout or all-at-once?
121
- - Feature flags needed?
122
- - Rollback plan if issues arise?
123
-
124
- - [ ] **Monitoring & Observability**:
125
- - What metrics should we track?
126
- - Key logs to monitor?
127
- - Alert thresholds?
128
-
129
- ## Sign-Off
130
-
131
- - [ ] **Stakeholder confirmation**: Product owner/PM approved?
132
- - [ ] **Tech lead review**: Architecture and scope approved?
133
- - [ ] **No unknowns remaining**: All "TBD" fields resolved?
134
-
135
- ---
136
-
137
- ## Usage
138
-
139
- Use this checklist **before** calling `/plan` for a new feature:
140
-
141
- ```
142
- 1. Read this checklist
143
- 2. Answer every question (or explicitly mark "not applicable")
144
- 3. If any field is "TBD" or uncertain, add to "Known Unknowns"
145
- 4. Share answers with /plan command
146
- 5. /plan creates implementation strategy
147
- ```
148
-
149
- ## Known Unknowns (for this feature)
150
-
151
- - [ ] _Add any uncertain items here_
152
-
153
- ---
154
-
155
- **Date**: _YYYY-MM-DD_
156
- **Author**: _Name_
157
- **Feature**: _[Feature Name]_
1
+ # New Feature Q&A Checklist
2
+
3
+ **Purpose**: Structured questionnaire to capture all requirements before planning /new-feature.
4
+
5
+ **Status**: MANDATORY - Complete all fields before /plan is created.
6
+
7
+ ## User Story & Intent
8
+
9
+ - [ ] **User Story defined**: "As a [who], I want [what] so that [why]"
10
+ - Who is the primary user/actor?
11
+ - What specific action or capability do they need?
12
+ - What outcome or value does this deliver?
13
+
14
+ - [ ] **Success Criteria clear**: How do we know this feature is working?
15
+ - At least 3 measurable criteria
16
+ - Business metrics or user satisfaction indicators
17
+
18
+ - [ ] **Out of Scope documented**: What is explicitly NOT included?
19
+ - Related features we're NOT doing now
20
+ - Future enhancements or phases
21
+
22
+ ## Requirements & Constraints
23
+
24
+ - [ ] **Functional Requirements clear**:
25
+ - Primary use cases (happy path)
26
+ - Secondary use cases
27
+ - Data inputs and outputs
28
+
29
+ - [ ] **Non-Functional Requirements identified**:
30
+ - Performance expectations (speed, throughput, latency)
31
+ - Scalability requirements
32
+ - Availability/uptime requirements
33
+ - Browser/device support
34
+
35
+ - [ ] **Dependencies & Integrations mapped**:
36
+ - Does this touch APIs? Which ones?
37
+ - Database schema changes needed?
38
+ - External services involved?
39
+ - Existing modules that will be modified?
40
+
41
+ - [ ] **Constraints & Limitations noted**:
42
+ - Technical constraints (memory, compute)
43
+ - Business constraints (timeline, budget)
44
+ - Regulatory/compliance constraints
45
+ - Breaking changes or migration requirements?
46
+
47
+ ## Impact & Scope
48
+
49
+ - [ ] **Affected Systems identified**:
50
+ - Which modules will change? (list by name)
51
+ - Which APIs will change or be added?
52
+ - Which database tables/schemas affected?
53
+ - Frontend routes or pages added/modified?
54
+
55
+ - [ ] **API Surface Changes**:
56
+ - New endpoints needed?
57
+ - Modified endpoint behavior?
58
+ - Deprecated endpoints?
59
+ - Data contract changes?
60
+
61
+ - [ ] **Database Changes**:
62
+ - New tables/collections?
63
+ - Schema migrations?
64
+ - Backward compatibility concerns?
65
+
66
+ - [ ] **UI/UX Changes**:
67
+ - New pages/screens?
68
+ - Modified navigation flows?
69
+ - New user interactions?
70
+
71
+ ## Edge Cases & Error Handling
72
+
73
+ - [ ] **Edge Cases enumerated**:
74
+ - Boundary conditions (empty, null, max values)
75
+ - Concurrent operations conflicts
76
+ - Network failures or timeouts
77
+ - Permission/authorization scenarios
78
+ - Race conditions or state inconsistencies
79
+
80
+ - [ ] **Error Scenarios documented**:
81
+ - Invalid input handling
82
+ - Failure recovery strategy
83
+ - User-facing error messages
84
+ - Logging/observability for debugging
85
+
86
+ ## Architecture & Design
87
+
88
+ - [ ] **Architectural Pattern chosen**:
89
+ - Synchronous vs. asynchronous?
90
+ - Client-side vs. server-side?
91
+ - Real-time vs. eventual consistency?
92
+ - Distributed or monolithic?
93
+
94
+ - [ ] **Design Decisions recorded** (Why this approach?):
95
+ - What alternatives were considered?
96
+ - Why this one was chosen?
97
+ - Any known tradeoffs?
98
+
99
+ - [ ] **Performance Considerations**:
100
+ - Caching strategy if needed?
101
+ - Query optimization?
102
+ - Batch processing opportunities?
103
+
104
+ ## Testing Strategy
105
+
106
+ - [ ] **Test Coverage planned**:
107
+ - Unit tests (which modules?)
108
+ - Integration tests (which interactions?)
109
+ - E2E tests (which user flows?)
110
+ - Target coverage: 80%+ or higher?
111
+
112
+ - [ ] **Test Data & Fixtures**:
113
+ - What test data do we need?
114
+ - Realistic edge case fixtures?
115
+ - Performance test datasets?
116
+
117
+ ## Rollout & Monitoring
118
+
119
+ - [ ] **Deployment Strategy**:
120
+ - Staged rollout or all-at-once?
121
+ - Feature flags needed?
122
+ - Rollback plan if issues arise?
123
+
124
+ - [ ] **Monitoring & Observability**:
125
+ - What metrics should we track?
126
+ - Key logs to monitor?
127
+ - Alert thresholds?
128
+
129
+ ## Sign-Off
130
+
131
+ - [ ] **Stakeholder confirmation**: Product owner/PM approved?
132
+ - [ ] **Tech lead review**: Architecture and scope approved?
133
+ - [ ] **No unknowns remaining**: All "TBD" fields resolved?
134
+
135
+ ---
136
+
137
+ ## Usage
138
+
139
+ Use this checklist **before** calling `/plan` for a new feature:
140
+
141
+ ```
142
+ 1. Read this checklist
143
+ 2. Answer every question (or explicitly mark "not applicable")
144
+ 3. If any field is "TBD" or uncertain, add to "Known Unknowns"
145
+ 4. Share answers with /plan command
146
+ 5. /plan creates implementation strategy
147
+ ```
148
+
149
+ ## Known Unknowns (for this feature)
150
+
151
+ - [ ] _Add any uncertain items here_
152
+
153
+ ---
154
+
155
+ **Date**: _YYYY-MM-DD_
156
+ **Author**: _Name_
157
+ **Feature**: _[Feature Name]_