code-framework 1.0.0

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 (69) hide show
  1. package/README.md +110 -0
  2. package/_code/agents/atlas.agent.yaml +58 -0
  3. package/_code/agents/builder.agent.yaml +58 -0
  4. package/_code/agents/echo.agent.yaml +58 -0
  5. package/_code/agents/iris.agent.yaml +70 -0
  6. package/_code/agents/luna.agent.yaml +62 -0
  7. package/_code/agents/phoenix.agent.yaml +58 -0
  8. package/_code/agents/sage.agent.yaml +58 -0
  9. package/_code/agents/scout.agent.yaml +54 -0
  10. package/_code/templates/epic-template.md +81 -0
  11. package/_code/templates/sitemap-template.md +74 -0
  12. package/_code/templates/story-template.md +121 -0
  13. package/_code/templates/wireframe-prompt-template.md +153 -0
  14. package/_code/workflows/brief/steps/step-01-brainstorm.md +191 -0
  15. package/_code/workflows/brief/steps/step-02-requirements.md +230 -0
  16. package/_code/workflows/brief/steps/step-03-inspiration.md +285 -0
  17. package/_code/workflows/brief/steps/step-04-entities.md +359 -0
  18. package/_code/workflows/brief/steps/step-05-framework.md +455 -0
  19. package/_code/workflows/brief/steps/step-06-review.md +370 -0
  20. package/_code/workflows/brief/workflow.md +52 -0
  21. package/_code/workflows/docs/steps/step-01-validate.md +256 -0
  22. package/_code/workflows/docs/steps/step-02-epic.md +310 -0
  23. package/_code/workflows/docs/steps/step-03-story.md +338 -0
  24. package/_code/workflows/docs/steps/step-04-plan.md +348 -0
  25. package/_code/workflows/docs/workflow.md +127 -0
  26. package/_code/workflows/evolve/steps/step-01-version.md +297 -0
  27. package/_code/workflows/evolve/steps/step-02-scope.md +279 -0
  28. package/_code/workflows/evolve/steps/step-03-context.md +365 -0
  29. package/_code/workflows/evolve/steps/step-04-changelog.md +297 -0
  30. package/_code/workflows/evolve/workflow.md +103 -0
  31. package/_code/workflows/help.md +387 -0
  32. package/_code/workflows/implement/steps/step-01-select.md +214 -0
  33. package/_code/workflows/implement/steps/step-02-code.md +275 -0
  34. package/_code/workflows/implement/steps/step-03-test.md +327 -0
  35. package/_code/workflows/implement/steps/step-04-done.md +317 -0
  36. package/_code/workflows/implement/workflow.md +77 -0
  37. package/_code/workflows/outline/steps/step-01-analyze.md +344 -0
  38. package/_code/workflows/outline/steps/step-02-schema.md +369 -0
  39. package/_code/workflows/outline/steps/step-03-api.md +316 -0
  40. package/_code/workflows/outline/steps/step-04-stack.md +300 -0
  41. package/_code/workflows/outline/workflow.md +103 -0
  42. package/_code/workflows/party/workflow.md +69 -0
  43. package/_code/workflows/review/steps/step-01-checklist.md +354 -0
  44. package/_code/workflows/review/steps/step-02-qa.md +363 -0
  45. package/_code/workflows/review/workflow.md +138 -0
  46. package/_code/workflows/status.md +177 -0
  47. package/_code/workflows/ux/steps/step-01-sitemap.md +251 -0
  48. package/_code/workflows/ux/steps/step-02-wireframes.md +394 -0
  49. package/_code/workflows/ux/steps/step-03-flows.md +384 -0
  50. package/_code/workflows/ux/steps/step-04-validate.md +344 -0
  51. package/_code/workflows/ux/workflow.md +70 -0
  52. package/install.js +194 -0
  53. package/package.json +37 -0
  54. package/project-template/.claude/commands.yaml +356 -0
  55. package/project-template/.claude/settings.json +11 -0
  56. package/project-template/1-context/_active.yaml +15 -0
  57. package/project-template/1-context/v1.0.0/1-brainstorm/idea.md +40 -0
  58. package/project-template/1-context/v1.0.0/2-requirements/requirements.md +62 -0
  59. package/project-template/1-context/v1.0.0/3-inspiration/inspiration.md +64 -0
  60. package/project-template/1-context/v1.0.0/3-inspiration/moodboard/.gitkeep +5 -0
  61. package/project-template/1-context/v1.0.0/4-entities/entities.md +119 -0
  62. package/project-template/1-context/v1.0.0/5-framework/framework.md +89 -0
  63. package/project-template/2-outline/v1.0.0/.gitkeep +9 -0
  64. package/project-template/3-ux/v1.0.0/.gitkeep +9 -0
  65. package/project-template/3-ux/v1.0.0/wireframes/.gitkeep +7 -0
  66. package/project-template/4-documentation/epics/.gitkeep +10 -0
  67. package/project-template/4-documentation/stories/.gitkeep +15 -0
  68. package/project-template/5-evolution/changelog.md +58 -0
  69. package/project-template/research/.gitkeep +16 -0
@@ -0,0 +1,348 @@
1
+ ---
2
+ name: 'step-04-plan'
3
+ description: 'Generate the complete living plan document'
4
+ previousStepFile: './step-03-story.md'
5
+ outputFile: '4-documentation/PLAN.md'
6
+ ---
7
+
8
+ # Step 4: The Living Plan
9
+
10
+ ## MANDATORY EXECUTION RULES (READ FIRST)
11
+
12
+ - 🛑 **NEVER** finalize plan without user review of epics and stories
13
+ - 📖 **CRITICAL**: The plan is a living document that grows forever
14
+ - đŸŽ¯ All ideas deserve a story - nothing is forgotten
15
+ - đŸ’Ŧ Celebrate completion but emphasize this is a beginning
16
+ - âšī¸ **HALT** at menu and wait for user selection
17
+ - đŸšĢ **FORBIDDEN** to mark plan as "final" - it's always growing
18
+
19
+ ## YOUR IDENTITY
20
+
21
+ You are **ECHO**. In this final documentation step, you're creating the overview document that ties everything together. This plan will grow with every new feature.
22
+
23
+ **Key Principle:** "All ideas deserve a story." The plan is never complete - it's always growing.
24
+
25
+ ## SEQUENCE OF INSTRUCTIONS
26
+
27
+ ### 1. Gather All Documentation
28
+
29
+ Read all generated documentation:
30
+
31
+ ```
32
+ 4-documentation/epics/*.md
33
+ 4-documentation/stories/*/*.md
34
+ ```
35
+
36
+ Count and categorize:
37
+ - Total epics
38
+ - Total stories
39
+ - Stories by priority (P0/P1/P2)
40
+ - Stories by epic
41
+
42
+ ### 2. Calculate Statistics
43
+
44
+ ```
45
+ ## Documentation Statistics
46
+
47
+ | Metric | Count |
48
+ |--------|-------|
49
+ | Total Epics | [X] |
50
+ | Total Stories | [X] |
51
+ | P0 (MVP Critical) | [X] stories |
52
+ | P1 (Important) | [X] stories |
53
+ | P2 (Nice to Have) | [X] stories |
54
+
55
+ ### By Epic
56
+ | Epic | Name | Stories | P0 | P1 | P2 |
57
+ |------|------|---------|----|----|----|
58
+ | epic-001 | [Name] | [X] | [X] | [X] | [X] |
59
+ | epic-002 | [Name] | [X] | [X] | [X] | [X] |
60
+ | ... | ... | ... | ... | ... | ... |
61
+ ```
62
+
63
+ ### 3. Generate Recommended Implementation Order
64
+
65
+ Based on dependencies and priorities:
66
+
67
+ ```
68
+ ## Recommended Implementation Order
69
+
70
+ ### Phase 1: Foundation (MVP Core)
71
+ Focus: Get to a working product ASAP
72
+
73
+ **Epic-001: [User Authentication]**
74
+ - story-001: [Sign Up Form Display]
75
+ - story-002: [Sign Up Form Validation]
76
+ - story-003: [Email Verification]
77
+ - story-004: [Login Flow]
78
+
79
+ **Epic-002: [Core Feature 1]** (partial)
80
+ - story-005: [Basic feature setup]
81
+ - story-006: [List view]
82
+
83
+ **Phase 1 Total:** [X] stories
84
+
85
+ ### Phase 2: MVP Complete
86
+ Focus: All P0 functionality working
87
+
88
+ **Epic-002: [Core Feature 1]** (continued)
89
+ - story-007: [Create flow]
90
+ - story-008: [Edit flow]
91
+ - story-009: [Delete flow]
92
+
93
+ **Epic-003: [Core Feature 2]**
94
+ - story-010: [Feature setup]
95
+ - story-011: [Main flow]
96
+
97
+ **Phase 2 Total:** [X] stories
98
+
99
+ ### Phase 3: Polish & Enhancement
100
+ Focus: P1 features and quality improvements
101
+
102
+ **Epic-004: [Supporting Feature]**
103
+ - story-012: ...
104
+ - story-013: ...
105
+
106
+ **Phase 3 Total:** [X] stories
107
+
108
+ ### Phase 4: Future
109
+ Focus: P2 features when time permits
110
+
111
+ **Remaining stories from all epics**
112
+ ```
113
+
114
+ ### 4. Create The Living Plan Document
115
+
116
+ ```markdown
117
+ # The Living Plan
118
+
119
+ > "All ideas deserve a story."
120
+
121
+ ## Project Overview
122
+
123
+ **Project:** [Name from BRIEF]
124
+ **Version:** [Current version]
125
+ **Generated:** [Date]
126
+ **Last Updated:** [Date]
127
+
128
+ ## Plan Philosophy
129
+
130
+ This is a **living plan** - it grows with your project.
131
+
132
+ - **Epics** represent user value, not technical layers
133
+ - **Stories** are atomic, implementable units of work
134
+ - **Numbers never restart** - story-100 comes after story-99, forever
135
+ - **New features** add new epics and stories, preserving history
136
+
137
+ ## Current Status
138
+
139
+ ### Statistics
140
+
141
+ | Metric | Count |
142
+ |--------|-------|
143
+ | Total Epics | [X] |
144
+ | Total Stories | [X] |
145
+ | MVP (P0) Stories | [X] |
146
+ | Enhancement (P1) Stories | [X] |
147
+ | Future (P2) Stories | [X] |
148
+
149
+ ### Epic Overview
150
+
151
+ | Epic | Name | Stories | Priority | Status |
152
+ |------|------|---------|----------|--------|
153
+ | epic-001 | [Name] | [X] | P0 | Draft |
154
+ | epic-002 | [Name] | [X] | P0 | Draft |
155
+ | epic-003 | [Name] | [X] | P1 | Draft |
156
+ | ... | ... | ... | ... | ... |
157
+
158
+ ## Implementation Roadmap
159
+
160
+ ### Phase 1: Foundation
161
+ [Phase 1 details from step 3]
162
+
163
+ ### Phase 2: MVP Complete
164
+ [Phase 2 details from step 3]
165
+
166
+ ### Phase 3: Polish
167
+ [Phase 3 details from step 3]
168
+
169
+ ### Phase 4: Future
170
+ [Phase 4 details from step 3]
171
+
172
+ ## Story Index
173
+
174
+ ### All Stories by Number
175
+
176
+ | Story | Name | Epic | Priority | Status |
177
+ |-------|------|------|----------|--------|
178
+ | story-001 | [Name] | epic-001 | P0 | Draft |
179
+ | story-002 | [Name] | epic-001 | P0 | Draft |
180
+ | story-003 | [Name] | epic-001 | P0 | Draft |
181
+ | ... | ... | ... | ... | ... |
182
+
183
+ ## How This Plan Grows
184
+
185
+ When you add new features (using `/evolve`):
186
+
187
+ ```
188
+ Current: v1.0.0
189
+ ├── epic-001 to epic-005
190
+ └── story-001 to story-025
191
+
192
+ After adding Payment feature (v1.1.0):
193
+ ├── epic-001 to epic-005 (unchanged)
194
+ ├── epic-006: Payment Integration (NEW)
195
+ └── story-001 to story-025 (unchanged)
196
+ └── story-026 to story-030 (NEW)
197
+
198
+ After major redesign (v2.0.0):
199
+ ├── epic-001 to epic-006 (unchanged)
200
+ ├── epic-007 to epic-010 (NEW)
201
+ └── story-001 to story-030 (unchanged)
202
+ └── story-031 to story-050 (NEW)
203
+ ```
204
+
205
+ ## Quick Reference
206
+
207
+ ### Key Files
208
+
209
+ | Purpose | Location |
210
+ |---------|----------|
211
+ | This Plan | `4-documentation/PLAN.md` |
212
+ | All Epics | `4-documentation/epics/` |
213
+ | All Stories | `4-documentation/stories/` |
214
+ | Context | `1-context/{version}/` |
215
+ | Architecture | `2-outline/{version}/` |
216
+ | UX/Wireframes | `3-ux/{version}/` |
217
+
218
+ ### Key Commands
219
+
220
+ | Command | Purpose |
221
+ |---------|---------|
222
+ | `/implement` | Start implementing a story |
223
+ | `/evolve` | Add a new feature (grows the plan) |
224
+ | `/review` | Review implementation quality |
225
+ | `/party` | Multi-agent discussion |
226
+
227
+ ## What's Next?
228
+
229
+ Your documentation is complete. You can now:
230
+
231
+ 1. **Start implementing** - Run `/implement` to begin coding
232
+ 2. **Review the plan** - Make sure priorities are correct
233
+ 3. **Add details** - Expand any story that needs more context
234
+ 4. **Evolve** - When ready for new features, run `/evolve`
235
+
236
+ ---
237
+
238
+ *Generated by ECHO*
239
+ *"All ideas deserve a story."*
240
+ *Version: {version}*
241
+ ```
242
+
243
+ ### 5. Save The Plan
244
+
245
+ Save to `4-documentation/PLAN.md`
246
+
247
+ ### 6. Present Completion Summary
248
+
249
+ ```
250
+ ## Documentation Complete!
251
+
252
+ 🎉 Your living plan is ready.
253
+
254
+ **Created:**
255
+ - [X] epics organized by user value
256
+ - [X] stories with Given/When/Then criteria
257
+ - 1 living plan document
258
+
259
+ **Files Generated:**
260
+ - 4-documentation/PLAN.md
261
+ - 4-documentation/epics/epic-001 through epic-[XXX].md
262
+ - 4-documentation/stories/epic-*/story-001 through story-[XXX].md
263
+
264
+ **Story Numbers:**
265
+ - Started at: story-001 (or continued from story-[XXX])
266
+ - Ended at: story-[XXX]
267
+ - Next story will be: story-[XXX+1]
268
+
269
+ ## Key Principles Followed
270
+
271
+ ✅ Epics organized by USER VALUE (not technical layers)
272
+ ✅ Stories use Given/When/Then acceptance criteria
273
+ ✅ Story numbers NEVER restart
274
+ ✅ Database tables created only when stories need them
275
+ ✅ No story depends on a future story
276
+ ✅ All requirements covered by stories
277
+ ```
278
+
279
+ ### 7. Present Menu
280
+
281
+ ```
282
+ The Living Plan is complete!
283
+
284
+ What would you like to do?
285
+
286
+ [I] Implement - Start coding with BUILDER
287
+ [E] Edit Epic - Modify an epic
288
+ [S] Edit Story - Modify a story
289
+ [V] View Plan - Open PLAN.md
290
+ [P] Party Mode - Review plan with all agents
291
+ [?] Ask a question about the plan
292
+ ```
293
+
294
+ ## MENU HANDLING
295
+
296
+ **If user selects [I] - Implement:**
297
+ Load and execute: `_code/workflows/implement/workflow.md`
298
+
299
+ **If user selects [E] - Edit Epic:**
300
+ Ask which epic, load and present for editing.
301
+
302
+ **If user selects [S] - Edit Story:**
303
+ Ask which story, load and present for editing.
304
+
305
+ **If user selects [V] - View Plan:**
306
+ Display contents of PLAN.md.
307
+
308
+ **If user selects [P] - Party Mode:**
309
+ Load and execute: `_code/workflows/party/workflow.md`
310
+ Include all agents for comprehensive review.
311
+
312
+ **If user selects [?] - Question:**
313
+ Answer their question about the plan.
314
+ Return to menu.
315
+
316
+ ## QUALITY CHECKLIST (Before Completing)
317
+
318
+ Before marking documentation complete, verify:
319
+ - [ ] All epics approved by user
320
+ - [ ] All stories approved by user
321
+ - [ ] Story numbers are sequential and continuous
322
+ - [ ] No gaps in requirement coverage
323
+ - [ ] PLAN.md accurately reflects all documentation
324
+ - [ ] User knows about `/implement` and `/evolve`
325
+
326
+ ## THE LIVING PLAN PHILOSOPHY
327
+
328
+ **Why "Living"?**
329
+ - Traditional plans become outdated immediately
330
+ - This plan grows with every feature
331
+ - Nothing is ever deleted, only added
332
+ - History is preserved forever
333
+
334
+ **Why "All Ideas Deserve a Story"?**
335
+ - No idea is too small to track
336
+ - Every feature request becomes a story
337
+ - Backlogs are just stories with lower priority
338
+ - The plan never says "no" - only "later"
339
+
340
+ **Why Numbers Never Restart?**
341
+ - Prevents confusion and conflicts
342
+ - story-1 in v1.0.0 is different from story-1 in v2.0.0
343
+ - Global numbering = global history
344
+ - Easy to reference across versions
345
+
346
+ ---
347
+
348
+ **REMEMBER:** This is a beginning, not an end. The plan will grow with every `/evolve`. Celebrate the milestone, but know there's always more to build.
@@ -0,0 +1,127 @@
1
+ ---
2
+ name: docs
3
+ description: Generate epics and stories from your context
4
+ agent: echo
5
+ version: 1.0.0
6
+ requires:
7
+ - 1-context/{version}/
8
+ - 2-outline/{version}/
9
+ - 3-ux/{version}/sitemap.md
10
+ nextStep: ./steps/step-01-validate.md
11
+ ---
12
+
13
+ # Documentation Workflow
14
+
15
+ > "All ideas deserve a story. Let's create your living plan."
16
+
17
+ ## What We're Creating
18
+
19
+ **Epics** - Large features broken into stories
20
+ **Stories** - Individual implementable units with acceptance criteria
21
+
22
+ ## The Living Plan Philosophy
23
+
24
+ Your documentation grows forever:
25
+
26
+ ```
27
+ 4-documentation/
28
+ ├── epics/
29
+ │ ├── epic-001-user-auth.md # Original MVP
30
+ │ ├── epic-002-course-management.md # Original MVP
31
+ │ ├── epic-003-progress-tracking.md # Original MVP
32
+ │ ├── epic-004-payments.md # Added in v1.1.0
33
+ │ └── epic-005-certificates.md # Added in v1.2.0
34
+ │
35
+ └── stories/
36
+ ├── epic-001/
37
+ │ ├── story-001-signup.md
38
+ │ ├── story-002-login.md
39
+ │ └── story-003-password-reset.md
40
+ ├── epic-002/
41
+ │ └── ...
42
+ └── epic-004/ # New feature stories
43
+ ├── story-015-add-payment-method.md
44
+ └── story-016-checkout-flow.md
45
+ ```
46
+
47
+ ## Epic Structure
48
+
49
+ ```markdown
50
+ # Epic-XXX: [Epic Name]
51
+
52
+ ## Context
53
+ - Version introduced: vX.X.X
54
+ - Related BRIEF: [path]
55
+ - Related pages: P001, P002, P003
56
+
57
+ ## Description
58
+ What this epic accomplishes and why it matters.
59
+
60
+ ## Acceptance Criteria (Epic Level)
61
+ High-level criteria for the entire epic.
62
+
63
+ ## Stories
64
+ - [ ] Story-XXX: [Name]
65
+ - [ ] Story-XXX: [Name]
66
+ - [ ] Story-XXX: [Name]
67
+
68
+ ## Dependencies
69
+ - Depends on: Epic-XXX (if any)
70
+ - Blocks: Epic-XXX (if any)
71
+ ```
72
+
73
+ ## Story Structure
74
+
75
+ ```markdown
76
+ # Story-XXX: [Story Name]
77
+
78
+ ## Epic
79
+ Epic-XXX: [Epic Name]
80
+
81
+ ## Page Reference
82
+ Page ID: P00X
83
+ Route: /path
84
+ Wireframe: [link to wireframe prompt]
85
+
86
+ ## User Story
87
+ As a [user type],
88
+ I want [action],
89
+ So that [benefit].
90
+
91
+ ## Acceptance Criteria
92
+
93
+ **Given** [precondition]
94
+ **When** [action]
95
+ **Then** [result]
96
+
97
+ **Given** [precondition]
98
+ **When** [action]
99
+ **Then** [result]
100
+
101
+ ## Technical Notes
102
+ - Implementation hints
103
+ - API endpoints needed
104
+ - Data models affected
105
+
106
+ ## Dependencies
107
+ - Requires: Story-XXX
108
+ - Blocks: Story-XXX
109
+ ```
110
+
111
+ ---
112
+
113
+ ## How It Works
114
+
115
+ 1. **Validate Prerequisites** - Check BRIEF, Outline, UX are complete
116
+ 2. **Generate Epics** - Group requirements into logical epics
117
+ 3. **Generate Stories** - Break epics into implementable stories
118
+ 4. **Link Everything** - Connect stories to pages, requirements, outline
119
+
120
+ ---
121
+
122
+ ## Ready?
123
+
124
+ **[V]** Validate prerequisites
125
+ **[G]** Generate epics from context
126
+ **[S]** View current stories
127
+ **[?]** Ask a question