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,40 @@
1
+ # Brainstorm
2
+
3
+ > What's your idea? Write a few sentences about what you want to build.
4
+
5
+ <!--
6
+ INSTRUCTIONS:
7
+ Just write naturally. Don't worry about being perfect.
8
+ IRIS will help you expand and clarify this later.
9
+
10
+ Example:
11
+ "I want to build a website that helps kids learn coding through fun games
12
+ and projects. Parents can track progress and teachers can create custom courses."
13
+ -->
14
+
15
+ ## My Idea
16
+
17
+ [Write your idea here - even just one sentence is fine to start]
18
+
19
+
20
+ ## The Problem I'm Solving
21
+
22
+ [What pain point or need does this address?]
23
+
24
+
25
+ ## Who It's For
26
+
27
+ [Who will use this? Be specific if you can]
28
+
29
+
30
+ ## Why This Matters
31
+
32
+ [Why should this exist? What happens if it doesn't get built?]
33
+
34
+
35
+ ---
36
+
37
+ <!--
38
+ NEXT STEP: After filling this out, run /brief to have IRIS
39
+ help you expand and improve your brainstorm.
40
+ -->
@@ -0,0 +1,62 @@
1
+ # Requirements
2
+
3
+ > What must your product DO? List the features and capabilities.
4
+
5
+ <!--
6
+ INSTRUCTIONS:
7
+ List what your product needs to do. Start with "Users must be able to..."
8
+ Don't worry about HOW - just WHAT.
9
+
10
+ Example:
11
+ 1. Users must be able to create an account
12
+ 2. Users must be able to log in with email or Google
13
+ 3. Kids can watch video lessons and code at the same time
14
+ 4. Parents can see their child's progress
15
+ -->
16
+
17
+ ## Must Have (MVP)
18
+
19
+ These are required for launch. Without these, the product doesn't work.
20
+
21
+ 1.
22
+ 2.
23
+ 3.
24
+ 4.
25
+ 5.
26
+
27
+ ## Should Have (V1.1)
28
+
29
+ These make it significantly better. Important for growth.
30
+
31
+ 1.
32
+ 2.
33
+ 3.
34
+
35
+ ## Could Have (Future)
36
+
37
+ Nice to have someday. Post-launch wishlist.
38
+
39
+ 1.
40
+ 2.
41
+ 3.
42
+
43
+ ## Constraints
44
+
45
+ Things the product must NOT do, or rules it must follow.
46
+
47
+ 1.
48
+ 2.
49
+
50
+ ## Success Metrics
51
+
52
+ How will you know it's working?
53
+
54
+ 1.
55
+ 2.
56
+
57
+ ---
58
+
59
+ <!--
60
+ NEXT STEP: Run /requirements to have IRIS help you
61
+ refine and prioritize these requirements.
62
+ -->
@@ -0,0 +1,64 @@
1
+ # Inspiration
2
+
3
+ > What apps, designs, or products inspire you?
4
+
5
+ <!--
6
+ INSTRUCTIONS:
7
+ List apps you admire and what you like about them.
8
+ Be specific - "Duolingo's streak system" is better than just "Duolingo"
9
+
10
+ Example:
11
+ 1. Duolingo - gamification, streaks, fun learning
12
+ 2. Notion - clean interface, flexible blocks
13
+ 3. Khan Academy Kids - kid-friendly UI, progress tracking
14
+ -->
15
+
16
+ ## Products I Admire
17
+
18
+ | Product | What I Like About It |
19
+ |---------|---------------------|
20
+ | | |
21
+ | | |
22
+ | | |
23
+ | | |
24
+ | | |
25
+
26
+ ## Design Inspiration
27
+
28
+ Links to designs, screenshots, or styles you like:
29
+
30
+ 1.
31
+ 2.
32
+ 3.
33
+
34
+ ## UX Patterns to Borrow
35
+
36
+ Specific interactions or features to emulate:
37
+
38
+ 1.
39
+ 2.
40
+ 3.
41
+
42
+ ## What to AVOID
43
+
44
+ Design patterns or experiences you dislike:
45
+
46
+ 1.
47
+ 2.
48
+ 3.
49
+
50
+ ---
51
+
52
+ ## Moodboard
53
+
54
+ Add screenshots and images to the `moodboard/` folder.
55
+
56
+ Files in `3-inspiration/moodboard/`:
57
+ - (Add your images here)
58
+
59
+ ---
60
+
61
+ <!--
62
+ NEXT STEP: Run /inspiration to have IRIS help you
63
+ analyze and organize your inspirations.
64
+ -->
@@ -0,0 +1,5 @@
1
+ # Moodboard Folder
2
+
3
+ Add screenshots, images, and visual inspiration here.
4
+
5
+ Supported formats: .png, .jpg, .gif, .svg, .webp
@@ -0,0 +1,119 @@
1
+ # Entities
2
+
3
+ > Who uses your product and what data does it track?
4
+
5
+ <!--
6
+ INSTRUCTIONS:
7
+ 1. List the types of users (e.g., Admin, Customer, Guest)
8
+ 2. List the main "things" your app tracks (e.g., Products, Orders, Posts)
9
+ 3. Don't worry about being technical - just describe naturally
10
+
11
+ Example:
12
+ Users: Admin, Teacher, Student, Parent
13
+ Things: Courses, Lessons, Progress, Badges
14
+ -->
15
+
16
+ ## User Types
17
+
18
+ ### 1. [User Type Name]
19
+
20
+ **Can do:**
21
+ -
22
+ -
23
+ -
24
+
25
+ **Cannot do:**
26
+ -
27
+ -
28
+
29
+ **Sees:**
30
+ -
31
+ -
32
+
33
+ ---
34
+
35
+ ### 2. [User Type Name]
36
+
37
+ **Can do:**
38
+ -
39
+ -
40
+ -
41
+
42
+ **Cannot do:**
43
+ -
44
+ -
45
+
46
+ **Sees:**
47
+ -
48
+ -
49
+
50
+ ---
51
+
52
+ ### 3. [User Type Name] (if applicable)
53
+
54
+ **Can do:**
55
+ -
56
+
57
+ **Cannot do:**
58
+ -
59
+
60
+ **Sees:**
61
+ -
62
+
63
+ ---
64
+
65
+ ## Data Types (Things Your App Tracks)
66
+
67
+ ### 1. [Data Type Name]
68
+
69
+ **What it is:**
70
+
71
+ **Information it stores:**
72
+ -
73
+ -
74
+ -
75
+
76
+ **Who can create it:**
77
+
78
+ **Belongs to:**
79
+
80
+ **Contains:**
81
+
82
+ ---
83
+
84
+ ### 2. [Data Type Name]
85
+
86
+ **What it is:**
87
+
88
+ **Information it stores:**
89
+ -
90
+ -
91
+ -
92
+
93
+ **Who can create it:**
94
+
95
+ **Belongs to:**
96
+
97
+ **Contains:**
98
+
99
+ ---
100
+
101
+ ### 3. [Data Type Name]
102
+
103
+ **What it is:**
104
+
105
+ **Information it stores:**
106
+ -
107
+
108
+ **Who can create it:**
109
+
110
+ **Belongs to:**
111
+
112
+ **Contains:**
113
+
114
+ ---
115
+
116
+ <!--
117
+ NEXT STEP: Run /entities to have IRIS help you
118
+ define relationships and permissions.
119
+ -->
@@ -0,0 +1,89 @@
1
+ # Framework
2
+
3
+ > Technical preferences and constraints (optional for non-coders)
4
+
5
+ <!--
6
+ INSTRUCTIONS:
7
+ If you're not technical, just fill in what you know.
8
+ It's fine to leave things blank - ATLAS will recommend defaults.
9
+
10
+ Example:
11
+ - Platform: Web and mobile (tablets mostly)
12
+ - Must work offline sometimes
13
+ - No budget for expensive hosting
14
+ -->
15
+
16
+ ## Platform
17
+
18
+ Where does this need to work?
19
+
20
+ - [ ] Web (desktop browser)
21
+ - [ ] Web (mobile browser)
22
+ - [ ] iOS app
23
+ - [ ] Android app
24
+ - [ ] Tablet-optimized
25
+ - [ ] Desktop app (Windows/Mac)
26
+ - [ ] Other:
27
+
28
+ **Primary device:**
29
+
30
+ ---
31
+
32
+ ## Technology Preferences
33
+
34
+ (Leave blank if you don't have preferences)
35
+
36
+ **Frontend:**
37
+ <!-- Options: React, Vue, Next.js, plain HTML, no preference -->
38
+
39
+ **Backend:**
40
+ <!-- Options: Node.js, Python, Ruby, no preference -->
41
+
42
+ **Database:**
43
+ <!-- Options: PostgreSQL, MongoDB, Supabase, Firebase, no preference -->
44
+
45
+ ---
46
+
47
+ ## Hosting Preferences
48
+
49
+ (Leave blank if you don't have preferences)
50
+
51
+ **Where should it run:**
52
+ <!-- Options: Vercel, Railway, AWS, no preference -->
53
+
54
+ **Budget constraints:**
55
+ <!-- e.g., "Free tier only", "$50/month max", "No constraints" -->
56
+
57
+ ---
58
+
59
+ ## Integrations
60
+
61
+ Does it need to connect to external services?
62
+
63
+ - [ ] Payments (Stripe, PayPal, etc.)
64
+ - [ ] Email (SendGrid, Mailchimp, etc.)
65
+ - [ ] Authentication (Google, Apple, etc.)
66
+ - [ ] Analytics (Google Analytics, Plausible, etc.)
67
+ - [ ] Other:
68
+
69
+ ---
70
+
71
+ ## Non-Functional Requirements
72
+
73
+ **Performance:**
74
+ <!-- e.g., "Must load in under 3 seconds", "Handle 1000 users at once" -->
75
+
76
+ **Security:**
77
+ <!-- e.g., "User data must be encrypted", "GDPR compliant" -->
78
+
79
+ **Accessibility:**
80
+ <!-- e.g., "Must work with screen readers", "Color blind friendly" -->
81
+
82
+ **Other:**
83
+
84
+ ---
85
+
86
+ <!--
87
+ NEXT STEP: Run /framework to have IRIS help you
88
+ make technology decisions with ATLAS.
89
+ -->
@@ -0,0 +1,9 @@
1
+ # Outline v1.0.0
2
+
3
+ This folder will contain:
4
+ - technical-outline.md
5
+ - data-schema.md
6
+ - api-outline.md
7
+ - tech-stack.md
8
+
9
+ Run /outline to generate these files from your BRIEF.
@@ -0,0 +1,9 @@
1
+ # UX v1.0.0
2
+
3
+ This folder will contain:
4
+ - sitemap.md
5
+ - user-flows.md
6
+ - coverage-matrix.md
7
+ - wireframes/ (folder with AI prompts per page)
8
+
9
+ Run /ux to generate these files from your BRIEF and Outline.
@@ -0,0 +1,7 @@
1
+ # Wireframes
2
+
3
+ This folder will contain AI prompts for each page in your sitemap.
4
+
5
+ Files will be named: P001-landing.md, P002-login.md, etc.
6
+
7
+ Run /ux to generate these from your sitemap.
@@ -0,0 +1,10 @@
1
+ # Epics
2
+
3
+ This folder contains your epic files.
4
+
5
+ Epics are numbered sequentially and NEVER restart:
6
+ - epic-001-user-auth.md
7
+ - epic-002-core-features.md
8
+ - epic-003-new-feature.md (added later)
9
+
10
+ Run /docs to generate epics from your context.
@@ -0,0 +1,15 @@
1
+ # Stories
2
+
3
+ This folder contains story files organized by epic.
4
+
5
+ Structure:
6
+ stories/
7
+ ├── epic-001/
8
+ │ ├── story-001-signup.md
9
+ │ └── story-002-login.md
10
+ ├── epic-002/
11
+ │ └── story-003-create-item.md
12
+ └── epic-003/
13
+ └── story-015-new-feature.md
14
+
15
+ Run /docs to generate stories from your epics.
@@ -0,0 +1,58 @@
1
+ # Changelog
2
+
3
+ > Track every change to your project. All ideas deserve a story.
4
+
5
+ <!--
6
+ This file is automatically updated when you run /evolve.
7
+ You can also update it manually.
8
+ -->
9
+
10
+ ## [Unreleased]
11
+
12
+ ### Added
13
+ -
14
+
15
+ ### Changed
16
+ -
17
+
18
+ ### Fixed
19
+ -
20
+
21
+ ---
22
+
23
+ ## [v1.0.0] - YYYY-MM-DD
24
+
25
+ ### Added
26
+ - Initial MVP release
27
+ - [List initial features]
28
+
29
+ ### Notes
30
+ - First version of the project
31
+ - Context: `1-context/v1.0.0/`
32
+
33
+ ---
34
+
35
+ <!--
36
+ TEMPLATE FOR NEW VERSIONS:
37
+
38
+ ## [vX.X.X] - YYYY-MM-DD
39
+
40
+ ### Added
41
+ - New features
42
+
43
+ ### Changed
44
+ - Changes to existing features
45
+
46
+ ### Fixed
47
+ - Bug fixes
48
+
49
+ ### Deprecated
50
+ - Features that will be removed
51
+
52
+ ### Removed
53
+ - Features that were removed
54
+
55
+ ### Notes
56
+ - Context: `1-context/vX.X.X/`
57
+ - Epics added: epic-XXX
58
+ -->
@@ -0,0 +1,16 @@
1
+ # Research
2
+
3
+ This folder is for deep research, references, and background information.
4
+
5
+ Examples:
6
+ - Market research
7
+ - Competitor analysis
8
+ - Technical research
9
+ - Domain knowledge
10
+ - Legal/compliance research
11
+
12
+ Organize by topic using subfolders:
13
+ research/
14
+ ├── market-analysis/
15
+ ├── competitor-review/
16
+ └── technical-research/