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,74 @@
1
+ # Sitemap
2
+
3
+ > Complete inventory of all pages in your application
4
+
5
+ ## Application Sitemap
6
+
7
+ | Page ID | Page Name | Route | Auth | Priority | Features | User Flow | Requirements |
8
+ |---------|-----------|-------|------|----------|----------|-----------|--------------|
9
+ | P001 | | | | | | | |
10
+ | P002 | | | | | | | |
11
+ | P003 | | | | | | | |
12
+ | P004 | | | | | | | |
13
+ | P005 | | | | | | | |
14
+ | P006 | | | | | | | |
15
+ | P007 | | | | | | | |
16
+ | P008 | | | | | | | |
17
+
18
+ ## Sitemap Statistics
19
+
20
+ - **Total Pages**: X
21
+ - **P0 (MVP Critical)**: X pages
22
+ - **P1 (Important)**: X pages
23
+ - **P2 (Future)**: X pages
24
+ - **Auth Required**: X pages
25
+ - **Public**: X pages
26
+
27
+ ## Navigation Hierarchy
28
+
29
+ ```
30
+ Home (/)
31
+ ├── Sign Up (/signup)
32
+ ├── Login (/login)
33
+ └── Authenticated App
34
+ ├── Dashboard (/dashboard)
35
+ ├── [Feature 1]
36
+ │ ├── List (/feature-1)
37
+ │ ├── Create (/feature-1/create)
38
+ │ ├── Detail (/feature-1/:id)
39
+ │ └── Edit (/feature-1/:id/edit)
40
+ ├── [Feature 2]
41
+ │ └── ...
42
+ ├── Settings
43
+ │ ├── Profile (/settings/profile)
44
+ │ └── Account (/settings/account)
45
+ └── Admin (/admin) [if admin]
46
+ ```
47
+
48
+ ## Requirement Coverage Matrix
49
+
50
+ | Requirement ID | Description | Covered in Pages | Status |
51
+ |----------------|-------------|------------------|--------|
52
+ | FR-001 | | | |
53
+ | FR-002 | | | |
54
+ | FR-003 | | | |
55
+
56
+ ### Coverage Summary
57
+
58
+ - **Total Requirements**: X
59
+ - **Covered**: X (100%)
60
+ - **Uncovered**: X
61
+
62
+ ---
63
+
64
+ ## Validation Checklist
65
+
66
+ - [ ] All requirements mapped to at least one page
67
+ - [ ] All pages have wireframe prompts
68
+ - [ ] User flows documented
69
+ - [ ] Navigation hierarchy complete
70
+ - [ ] Priority levels assigned
71
+
72
+ **Validated By**: [Name]
73
+ **Date**: [Date]
74
+ **Status**: Ready for Epic Generation
@@ -0,0 +1,121 @@
1
+ # Story-XXX: [Story Name]
2
+
3
+ ## Metadata
4
+
5
+ | Field | Value |
6
+ |-------|-------|
7
+ | Story ID | story-XXX |
8
+ | Epic | epic-XXX: [Epic Name] |
9
+ | Priority | P0 / P1 / P2 |
10
+ | Status | Draft / Ready / In Progress / Review / Done |
11
+ | Complexity | Simple / Medium / Complex |
12
+
13
+ ## References
14
+
15
+ | Reference | Link |
16
+ |-----------|------|
17
+ | Page | P00X: [Page Name] |
18
+ | Route | `/route/path` |
19
+ | Wireframe | `3-ux/vX.X.X/wireframes/P00X-name.md` |
20
+ | Requirements | FR-001, FR-002 |
21
+
22
+ ## User Story
23
+
24
+ **As a** [user type]
25
+ **I want** [action/capability]
26
+ **So that** [benefit/value]
27
+
28
+ ## Acceptance Criteria
29
+
30
+ ### AC-1: [Criterion Name]
31
+
32
+ **Given** [precondition/context]
33
+ **When** [action taken]
34
+ **Then** [expected result]
35
+ **And** [additional expectation]
36
+
37
+ ### AC-2: [Criterion Name]
38
+
39
+ **Given** [precondition/context]
40
+ **When** [action taken]
41
+ **Then** [expected result]
42
+
43
+ ### AC-3: [Criterion Name]
44
+
45
+ **Given** [precondition/context]
46
+ **When** [action taken]
47
+ **Then** [expected result]
48
+
49
+ ## Edge Cases
50
+
51
+ | Scenario | Expected Behavior |
52
+ |----------|-------------------|
53
+ | [Edge case 1] | [What should happen] |
54
+ | [Edge case 2] | [What should happen] |
55
+ | [Error condition] | [How to handle] |
56
+
57
+ ## Technical Notes
58
+
59
+ ### API Endpoints
60
+
61
+ | Method | Endpoint | Description |
62
+ |--------|----------|-------------|
63
+ | GET | `/api/resource` | [What it does] |
64
+ | POST | `/api/resource` | [What it does] |
65
+
66
+ ### Data Models
67
+
68
+ - [Model 1]: [Fields affected]
69
+ - [Model 2]: [Fields affected]
70
+
71
+ ### Components
72
+
73
+ - [Component 1]: [New/Modified]
74
+ - [Component 2]: [New/Modified]
75
+
76
+ ## UI/UX Notes
77
+
78
+ See wireframe: `3-ux/vX.X.X/wireframes/P00X-name.md`
79
+
80
+ **Key interactions:**
81
+ - [Interaction 1]
82
+ - [Interaction 2]
83
+
84
+ **States to implement:**
85
+ - [ ] Loading state
86
+ - [ ] Empty state
87
+ - [ ] Error state
88
+ - [ ] Success state
89
+
90
+ ## Dependencies
91
+
92
+ **Requires (must be done first):**
93
+ - [ ] story-XXX: [Name] - [Why]
94
+
95
+ **Blocks (waiting on this):**
96
+ - [ ] story-XXX: [Name] - [Why]
97
+
98
+ ## Testing Requirements
99
+
100
+ - [ ] Unit tests for [component/function]
101
+ - [ ] Integration test for [flow]
102
+ - [ ] E2E test for [user journey]
103
+ - [ ] Accessibility audit (WCAG 2.1 AA)
104
+
105
+ ## Definition of Done
106
+
107
+ - [ ] All acceptance criteria pass
108
+ - [ ] Code reviewed and approved
109
+ - [ ] Tests written and passing
110
+ - [ ] No console errors/warnings
111
+ - [ ] Accessibility verified
112
+ - [ ] Documentation updated (if needed)
113
+ - [ ] Deployed to staging
114
+ - [ ] Product owner approved
115
+
116
+ ---
117
+
118
+ **Created**: [Date]
119
+ **Started**: [Date]
120
+ **Completed**: [Date]
121
+ **Implemented By**: [Name/Agent]
@@ -0,0 +1,153 @@
1
+ ---
2
+ pageId: P00X
3
+ pageName: [Page Name]
4
+ route: [/route]
5
+ authRequired: [Yes/No]
6
+ priority: [P0/P1/P2]
7
+ status: Draft
8
+ requirements: [FR-001, FR-002]
9
+ ---
10
+
11
+ # Wireframe Prompt: [Page Name]
12
+
13
+ ## Page Context
14
+
15
+ **Purpose**: [What this page is for]
16
+
17
+ **User arrives from**: [Previous page/entry point]
18
+
19
+ **User leaves to**: [Next page(s)]
20
+
21
+ **User goals**:
22
+ - [Goal 1]
23
+ - [Goal 2]
24
+ - [Goal 3]
25
+
26
+ ---
27
+
28
+ ## AI Wireframe Prompt
29
+
30
+ **Copy this prompt to Google Stitch, Excalidraw AI, or v0.dev:**
31
+
32
+ ```
33
+ Create a wireframe for a [type] page with the following specifications:
34
+
35
+ **Page Purpose**: [Description]
36
+
37
+ **Target User**: [User type and context]
38
+
39
+ **Layout - Desktop (1440px):**
40
+ - [Section 1]: [Description]
41
+ - [Section 2]: [Description]
42
+ - [Section 3]: [Description]
43
+
44
+ **Layout - Mobile (375px):**
45
+ - [How sections stack/reorganize]
46
+
47
+ **Components Needed:**
48
+ - [Component 1]: [Description]
49
+ - [Component 2]: [Description]
50
+ - [Component 3]: [Description]
51
+
52
+ **Key Interactions:**
53
+ - [Interaction 1]
54
+ - [Interaction 2]
55
+
56
+ **Style Notes:**
57
+ - [Style preference 1]
58
+ - [Style preference 2]
59
+ - Inspired by: [App 1], [App 2]
60
+
61
+ **Accessibility:**
62
+ - [Requirement 1]
63
+ - [Requirement 2]
64
+ ```
65
+
66
+ ---
67
+
68
+ ## Detailed Specifications
69
+
70
+ ### Header
71
+
72
+ - [ ] Logo
73
+ - [ ] Navigation
74
+ - [ ] User avatar/menu
75
+ - [ ] Search (if applicable)
76
+
77
+ ### Main Content
78
+
79
+ **Section 1: [Name]**
80
+ - Purpose:
81
+ - Components:
82
+ - Data displayed:
83
+
84
+ **Section 2: [Name]**
85
+ - Purpose:
86
+ - Components:
87
+ - Data displayed:
88
+
89
+ ### Sidebar (if applicable)
90
+
91
+ - Purpose:
92
+ - Components:
93
+ - Data displayed:
94
+
95
+ ### Footer (if applicable)
96
+
97
+ - Links:
98
+ - Information:
99
+
100
+ ---
101
+
102
+ ## Interaction States
103
+
104
+ **Buttons:**
105
+ - Default:
106
+ - Hover:
107
+ - Loading:
108
+ - Disabled:
109
+
110
+ **Forms:**
111
+ - Empty:
112
+ - Filled:
113
+ - Error:
114
+ - Success:
115
+
116
+ **Lists/Tables:**
117
+ - Empty state:
118
+ - Loading state:
119
+ - Populated:
120
+
121
+ ---
122
+
123
+ ## User Flow
124
+
125
+ ```
126
+ [Previous Page]
127
+
128
+ [This Page] → User sees [X]
129
+
130
+ User takes action [Y]
131
+
132
+ [Next Page / Result]
133
+ ```
134
+
135
+ ---
136
+
137
+ ## Requirements Covered
138
+
139
+ | Requirement | How It's Addressed |
140
+ |-------------|-------------------|
141
+ | FR-XXX | [Implementation on this page] |
142
+ | FR-XXX | [Implementation on this page] |
143
+
144
+ ---
145
+
146
+ ## Validation Checklist
147
+
148
+ - [ ] All requirements addressed
149
+ - [ ] Desktop layout specified
150
+ - [ ] Mobile layout specified
151
+ - [ ] Interaction states defined
152
+ - [ ] User flow documented
153
+ - [ ] AI prompt ready for use
@@ -0,0 +1,191 @@
1
+ ---
2
+ name: 'step-01-brainstorm'
3
+ description: 'Explore and expand the core idea through collaborative discovery'
4
+ nextStepFile: './step-02-requirements.md'
5
+ outputFile: '1-context/{version}/1-brainstorm/idea.md'
6
+ ---
7
+
8
+ # Step 1: Brainstorm
9
+
10
+ ## MANDATORY EXECUTION RULES (READ FIRST)
11
+
12
+ - 🛑 **NEVER** generate content without user input
13
+ - 📖 **CRITICAL**: Read this complete step before taking action
14
+ - 🎯 You are a **FACILITATOR**, not a content generator
15
+ - 💬 Ask questions, listen, reflect back, then help organize
16
+ - ⏹️ **HALT** at menu and wait for user selection
17
+ - 🚫 **FORBIDDEN** to proceed to next step until user selects [C]
18
+
19
+ ## YOUR IDENTITY
20
+
21
+ You are **IRIS** (Insight & Requirements Intelligence Specialist). You have an uncanny ability to ask the right questions at the right time. You're curious, thorough, but never tedious.
22
+
23
+ **Communication Style:**
24
+ - Ask probing questions that make users think deeper
25
+ - Reflect back what you hear to confirm understanding
26
+ - Use "What if..." and "Tell me more about..." frequently
27
+ - Celebrate clarity: "Now we're getting somewhere!"
28
+ - Patient with non-technical explanations
29
+
30
+ ## SEQUENCE OF INSTRUCTIONS
31
+
32
+ ### 1. Check for Existing Content
33
+
34
+ First, check if `1-context/{version}/1-brainstorm/idea.md` exists:
35
+
36
+ **If document exists with content:**
37
+ ```
38
+ I see you've already started your brainstorm. Let me read what you have...
39
+
40
+ [Read and summarize the existing content]
41
+
42
+ Would you like to:
43
+ - [E] Expand on this further
44
+ - [R] Start fresh with a new brainstorm
45
+ - [C] Continue to Requirements (if complete)
46
+ ```
47
+
48
+ **If document is empty or template:**
49
+ Continue with fresh brainstorm below.
50
+
51
+ ### 2. Opening Question
52
+
53
+ Begin with a warm, open question:
54
+
55
+ ```
56
+ Welcome! I'm IRIS, and I'm here to help you uncover the story behind your idea.
57
+
58
+ Let's start simple: **What do you want to build?**
59
+
60
+ Don't worry about being perfect - just tell me in your own words.
61
+ Even a single sentence is enough to get started.
62
+ ```
63
+
64
+ ### 3. Active Listening and Deep Dive
65
+
66
+ After the user responds, use these techniques:
67
+
68
+ **Reflection:**
69
+ ```
70
+ So what I'm hearing is [paraphrase their idea]. Is that right?
71
+ ```
72
+
73
+ **Probing Questions (use 2-3, not all):**
74
+ - "What problem does this solve for people?"
75
+ - "Who specifically would use this? Can you describe them?"
76
+ - "Why does this matter to you personally?"
77
+ - "What happens if this doesn't get built?"
78
+ - "What would wild success look like?"
79
+ - "What makes your approach different from what exists?"
80
+
81
+ **Clarification:**
82
+ ```
83
+ When you say [term], what do you mean exactly?
84
+ ```
85
+
86
+ **Expansion:**
87
+ ```
88
+ Tell me more about [specific aspect they mentioned]...
89
+ ```
90
+
91
+ ### 4. Synthesize and Confirm
92
+
93
+ After 3-5 exchanges, synthesize what you've learned:
94
+
95
+ ```
96
+ Let me summarize what I've understood:
97
+
98
+ **Core Idea:** [One sentence summary]
99
+
100
+ **The Problem:** [What pain point this addresses]
101
+
102
+ **Target Users:** [Who will use this]
103
+
104
+ **Why It Matters:** [Why this should exist]
105
+
106
+ **Success Looks Like:** [What winning means]
107
+
108
+ **Unique Angle:** [What makes this different]
109
+
110
+ Does this capture your vision? What would you add or change?
111
+ ```
112
+
113
+ ### 5. Save to Document
114
+
115
+ Once the user confirms, save to the brainstorm file:
116
+
117
+ ```markdown
118
+ # Brainstorm
119
+
120
+ ## Core Idea
121
+ [One sentence description of what they're building]
122
+
123
+ ## The Problem
124
+ [What pain point or need this addresses]
125
+
126
+ ## Target Users
127
+ [Who will use this - be specific]
128
+
129
+ ## Why It Matters
130
+ [Why this should exist, what happens if it doesn't]
131
+
132
+ ## Vision for Success
133
+ [What wild success looks like]
134
+
135
+ ## Unique Value
136
+ [What makes this approach different]
137
+
138
+ ---
139
+ *Last updated: {date}*
140
+ *Status: Complete*
141
+ ```
142
+
143
+ ### 6. Present Menu
144
+
145
+ After saving, present the menu:
146
+
147
+ ```
148
+ Your brainstorm is saved to 1-context/{version}/1-brainstorm/idea.md
149
+
150
+ What would you like to do?
151
+
152
+ [A] Advanced Elicitation - Dive deeper with structured questioning
153
+ [P] Party Mode - Get perspectives from multiple agents
154
+ [C] Continue - Move to Requirements (Step 2 of 6)
155
+ [R] Revise - Make changes to the brainstorm
156
+ ```
157
+
158
+ ## MENU HANDLING
159
+
160
+ **If user selects [A] - Advanced Elicitation:**
161
+ Load and execute: `_code/workflows/core/advanced-elicitation.md`
162
+ Use structured questioning techniques to explore the idea more deeply.
163
+ Return to this step's menu when complete.
164
+
165
+ **If user selects [P] - Party Mode:**
166
+ Load and execute: `_code/workflows/party/workflow.md`
167
+ Bring multiple agent perspectives to discuss the idea.
168
+ Return to this step's menu when complete.
169
+
170
+ **If user selects [C] - Continue:**
171
+ Save any final changes, then load: `./step-02-requirements.md`
172
+ **CRITICAL:** Read the entire next step file before taking action.
173
+
174
+ **If user selects [R] - Revise:**
175
+ Ask what they'd like to change, update the document, present menu again.
176
+
177
+ ## QUALITY CHECKLIST (Before Proceeding)
178
+
179
+ Before allowing [C], verify:
180
+ - [ ] Core idea is stated in one clear sentence
181
+ - [ ] Problem being solved is defined
182
+ - [ ] Target users are specific (not "everyone")
183
+ - [ ] Why it matters is articulated
184
+ - [ ] Success vision exists
185
+ - [ ] User has confirmed the summary
186
+
187
+ If any are missing, gently guide the user to complete them.
188
+
189
+ ---
190
+
191
+ **REMEMBER:** You are a curious detective uncovering the story behind the idea. Every great product starts with a clear understanding of the problem.