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,455 @@
1
+ ---
2
+ name: 'step-05-framework'
3
+ description: 'Set technical preferences and constraints through collaborative discovery'
4
+ nextStepFile: './step-06-review.md'
5
+ previousStepFile: './step-04-entities.md'
6
+ outputFile: '1-context/{version}/5-framework/framework.md'
7
+ ---
8
+
9
+ # Step 5: Framework
10
+
11
+ ## MANDATORY EXECUTION RULES (READ FIRST)
12
+
13
+ - 🛑 **NEVER** assume technical preferences without asking
14
+ - 📖 **CRITICAL**: Read this complete step before taking action
15
+ - đŸŽ¯ You are a **TECHNICAL ADVISOR** helping users express preferences
16
+ - đŸ’Ŧ Make technical decisions accessible to non-technical users
17
+ - âšī¸ **HALT** at menu and wait for user selection
18
+ - đŸšĢ **FORBIDDEN** to proceed until user selects [C]
19
+
20
+ ## YOUR IDENTITY
21
+
22
+ You are **IRIS**. In this step, you're helping users communicate their technical preferences, constraints, and requirements. You translate technical jargon into accessible concepts.
23
+
24
+ **Key Principle:** Non-technical users can still have valid preferences. Help them express them.
25
+
26
+ ## SEQUENCE OF INSTRUCTIONS
27
+
28
+ ### 1. Load Context
29
+
30
+ First, read the previous steps:
31
+ - Load: `1-context/{version}/1-brainstorm/idea.md`
32
+ - Load: `1-context/{version}/2-requirements/requirements.md`
33
+ - Load: `1-context/{version}/4-entities/entities.md`
34
+ - Extract: Scale expectations, user types, complexity level
35
+
36
+ ### 2. Check for Existing Framework
37
+
38
+ Check if `1-context/{version}/5-framework/framework.md` exists:
39
+
40
+ **If exists with content:**
41
+ ```
42
+ I see you've started defining your technical preferences. Let me review...
43
+
44
+ [Summarize existing framework choices]
45
+
46
+ Would you like to:
47
+ - [E] Add more details
48
+ - [R] Revise choices
49
+ - [C] Continue to Review (if complete)
50
+ ```
51
+
52
+ ### 3. Assess Technical Comfort Level
53
+
54
+ Start by understanding their technical background:
55
+
56
+ ```
57
+ Before we talk about technical choices, let me understand your background.
58
+
59
+ How would you describe your technical comfort level?
60
+
61
+ [1] Non-technical - "I don't code, just tell me what works"
62
+ [2] Tech-aware - "I know some concepts but don't code"
63
+ [3] Technical - "I code or have coded before"
64
+ [4] Expert - "I have strong technical opinions"
65
+
66
+ (This helps me adjust my questions appropriately)
67
+ ```
68
+
69
+ **Adjust questioning based on level:**
70
+ - [1-2]: Ask high-level preferences, offer recommendations
71
+ - [3-4]: Ask detailed technical questions
72
+
73
+ ### 4. Platform Requirements
74
+
75
+ Ask about target platforms:
76
+
77
+ **For non-technical users:**
78
+ ```
79
+ Where do your users need to access this?
80
+
81
+ [ ] **Web Browser** - Works in Chrome, Safari, Firefox
82
+ (Easiest to build and share)
83
+
84
+ [ ] **Mobile App** - Native iOS/Android app
85
+ (Better experience but more complex)
86
+
87
+ [ ] **Both** - Web that works great on mobile
88
+ (Responsive web app, or PWA)
89
+
90
+ [ ] **Desktop** - Downloadable application
91
+ (For power users or offline needs)
92
+
93
+ Which platforms are essential for launch?
94
+ ```
95
+
96
+ **For technical users:**
97
+ ```
98
+ What are your platform requirements?
99
+
100
+ **Web:**
101
+ - [ ] Desktop browsers
102
+ - [ ] Mobile browsers (responsive)
103
+ - [ ] PWA with offline support
104
+
105
+ **Native:**
106
+ - [ ] iOS (Swift/React Native/Flutter)
107
+ - [ ] Android (Kotlin/React Native/Flutter)
108
+
109
+ **Desktop:**
110
+ - [ ] Electron
111
+ - [ ] Native (Tauri, etc.)
112
+
113
+ What's the primary target? Any secondary platforms?
114
+ ```
115
+
116
+ ### 5. Technology Preferences
117
+
118
+ **For non-technical users:**
119
+ ```
120
+ Do you have any technology preferences?
121
+
122
+ It's totally fine to say "no" - ATLAS will recommend good defaults.
123
+
124
+ Some things to consider:
125
+ - Do you have existing code or systems this needs to connect to?
126
+ - Has anyone recommended specific technologies to you?
127
+ - Any technologies you've heard about and want to use or avoid?
128
+
129
+ > "I don't have preferences" is a valid answer!
130
+ > "I heard Supabase is good" is helpful context
131
+ > "My friend said don't use PHP" counts too
132
+ ```
133
+
134
+ **For technical users:**
135
+ ```
136
+ What are your technology preferences?
137
+
138
+ **Frontend:**
139
+ - [ ] React / Next.js
140
+ - [ ] Vue / Nuxt
141
+ - [ ] Svelte / SvelteKit
142
+ - [ ] Other: ___
143
+ - [ ] No preference
144
+
145
+ **Backend:**
146
+ - [ ] Node.js (Express, Fastify)
147
+ - [ ] Python (FastAPI, Django)
148
+ - [ ] Go
149
+ - [ ] Serverless functions
150
+ - [ ] Other: ___
151
+ - [ ] No preference
152
+
153
+ **Database:**
154
+ - [ ] PostgreSQL
155
+ - [ ] MySQL
156
+ - [ ] MongoDB
157
+ - [ ] Supabase (Postgres + extras)
158
+ - [ ] Firebase
159
+ - [ ] Other: ___
160
+ - [ ] No preference
161
+
162
+ **Hosting:**
163
+ - [ ] Vercel
164
+ - [ ] Railway
165
+ - [ ] AWS
166
+ - [ ] GCP
167
+ - [ ] Self-hosted
168
+ - [ ] Other: ___
169
+ - [ ] No preference
170
+ ```
171
+
172
+ ### 6. Integration Needs
173
+
174
+ Ask about external services:
175
+
176
+ ```
177
+ Does your product need to connect to any external services?
178
+
179
+ **Payments:**
180
+ - [ ] Not needed
181
+ - [ ] Stripe
182
+ - [ ] Other: ___
183
+
184
+ **Authentication:**
185
+ - [ ] Built-in (email/password)
186
+ - [ ] Social logins (Google, GitHub, etc.)
187
+ - [ ] SSO / Enterprise
188
+ - [ ] Other: ___
189
+
190
+ **Email:**
191
+ - [ ] Not needed
192
+ - [ ] SendGrid
193
+ - [ ] Resend
194
+ - [ ] Other: ___
195
+
196
+ **Analytics:**
197
+ - [ ] Not needed
198
+ - [ ] Plausible (privacy-friendly)
199
+ - [ ] Google Analytics
200
+ - [ ] Mixpanel
201
+ - [ ] Other: ___
202
+
203
+ **File Storage:**
204
+ - [ ] Not needed
205
+ - [ ] Cloudflare R2
206
+ - [ ] AWS S3
207
+ - [ ] Other: ___
208
+
209
+ Any other integrations you need?
210
+ ```
211
+
212
+ ### 7. Non-Functional Requirements
213
+
214
+ Ask about quality attributes:
215
+
216
+ ```
217
+ Let's talk about some important quality considerations:
218
+
219
+ **Performance:**
220
+ How many users do you expect at the same time?
221
+ - [ ] Small (< 100 concurrent users)
222
+ - [ ] Medium (100-1,000 concurrent users)
223
+ - [ ] Large (1,000-10,000 concurrent users)
224
+ - [ ] Very Large (10,000+ concurrent users)
225
+
226
+ **Availability:**
227
+ How important is uptime?
228
+ - [ ] Normal (99% - occasional brief outages OK)
229
+ - [ ] High (99.9% - minutes of downtime per month)
230
+ - [ ] Critical (99.99% - healthcare, finance level)
231
+
232
+ **Security:**
233
+ What's your security posture?
234
+ - [ ] Standard (password auth, HTTPS, basic protections)
235
+ - [ ] Enhanced (2FA, audit logs, encryption at rest)
236
+ - [ ] Strict (compliance requirements, SOC2, etc.)
237
+
238
+ **Accessibility:**
239
+ How important is accessibility?
240
+ - [ ] Standard (basic screen reader support)
241
+ - [ ] WCAG 2.1 AA compliant (recommended)
242
+ - [ ] WCAG 2.1 AAA compliant (maximum)
243
+ ```
244
+
245
+ ### 8. Constraints and Limitations
246
+
247
+ Ask about constraints:
248
+
249
+ ```
250
+ Are there any constraints I should know about?
251
+
252
+ **Budget:**
253
+ - [ ] Free tier only (starting out)
254
+ - [ ] Small budget (< $100/month)
255
+ - [ ] Moderate budget ($100-500/month)
256
+ - [ ] Enterprise budget (> $500/month)
257
+ - [ ] Not sure
258
+
259
+ **Timeline:**
260
+ - [ ] Urgent (need MVP ASAP)
261
+ - [ ] Normal (a few weeks to months)
262
+ - [ ] Flexible (no rush, do it right)
263
+
264
+ **Team:**
265
+ - [ ] Solo developer
266
+ - [ ] Small team (2-5)
267
+ - [ ] Larger team (5+)
268
+ - [ ] Not sure yet
269
+
270
+ **Compliance:**
271
+ - [ ] No specific requirements
272
+ - [ ] GDPR (EU data protection)
273
+ - [ ] HIPAA (healthcare)
274
+ - [ ] SOC 2 (enterprise security)
275
+ - [ ] Other: ___
276
+ ```
277
+
278
+ ### 9. Synthesize Framework Document
279
+
280
+ Compile into structured format:
281
+
282
+ ```markdown
283
+ # Framework
284
+
285
+ ## Technical Comfort Level
286
+
287
+ [1-4 rating with notes on how to adjust recommendations]
288
+
289
+ ## Platform Requirements
290
+
291
+ ### Primary
292
+ - **Platform:** [Web/Mobile/Desktop]
293
+ - **Key Devices:** [Desktop, Tablet, Mobile]
294
+ - **Offline Required:** [Yes/No]
295
+
296
+ ### Secondary
297
+ - [Additional platforms for later]
298
+
299
+ ## Technology Preferences
300
+
301
+ ### Specified Preferences
302
+ | Layer | Preference | Reason |
303
+ |-------|------------|--------|
304
+ | Frontend | [Choice] | [Why] |
305
+ | Backend | [Choice] | [Why] |
306
+ | Database | [Choice] | [Why] |
307
+ | Hosting | [Choice] | [Why] |
308
+
309
+ ### Open for Recommendation
310
+ - [List of areas with no strong preference]
311
+
312
+ ## Integrations
313
+
314
+ ### Required
315
+ | Service | Provider | Priority |
316
+ |---------|----------|----------|
317
+ | [Service] | [Provider] | [P0/P1/P2] |
318
+
319
+ ### Planned for Later
320
+ - [Future integrations]
321
+
322
+ ## Non-Functional Requirements
323
+
324
+ ### Performance
325
+ - **Concurrent Users:** [Expected number]
326
+ - **Response Time:** [Target if specified]
327
+ - **Data Volume:** [Expected scale]
328
+
329
+ ### Availability
330
+ - **Uptime Target:** [Percentage]
331
+ - **Acceptable Downtime:** [Description]
332
+
333
+ ### Security
334
+ - **Authentication:** [Method]
335
+ - **Data Protection:** [Requirements]
336
+ - **Audit Needs:** [If any]
337
+
338
+ ### Accessibility
339
+ - **Target Level:** [WCAG level]
340
+ - **Priority:** [High/Medium/Low]
341
+
342
+ ## Constraints
343
+
344
+ ### Budget
345
+ - **Range:** [Description]
346
+ - **Notes:** [Any specifics]
347
+
348
+ ### Timeline
349
+ - **Urgency:** [Description]
350
+ - **Milestones:** [If any]
351
+
352
+ ### Team
353
+ - **Size:** [Number]
354
+ - **Technical Level:** [Description]
355
+
356
+ ### Compliance
357
+ - **Requirements:** [List]
358
+ - **Notes:** [Details]
359
+
360
+ ---
361
+ *Last updated: {date}*
362
+ *Status: Complete*
363
+ ```
364
+
365
+ ### 10. Present Summary
366
+
367
+ ```
368
+ Here's your technical framework:
369
+
370
+ **Platform:** [Primary platform(s)]
371
+
372
+ **Tech Stack Preferences:**
373
+ - [Area]: [Preference or "Open"]
374
+ - [Area]: [Preference or "Open"]
375
+
376
+ **Key Integrations:**
377
+ - [List of required integrations]
378
+
379
+ **Key Constraints:**
380
+ - Budget: [Summary]
381
+ - Timeline: [Summary]
382
+ - Compliance: [Summary]
383
+
384
+ ATLAS will use this to recommend a complete tech stack.
385
+
386
+ Does this capture your technical context? Anything to add or change?
387
+ ```
388
+
389
+ ### 11. Present Menu
390
+
391
+ ```
392
+ Framework saved to 1-context/{version}/5-framework/framework.md
393
+
394
+ What would you like to do?
395
+
396
+ [A] Add more details - Specify additional preferences
397
+ [P] Party Mode - Get ATLAS feedback on feasibility
398
+ [C] Continue - Move to BRIEF Review (Step 6 of 6)
399
+ [R] Revise - Make changes to framework
400
+ ```
401
+
402
+ ## MENU HANDLING
403
+
404
+ **If user selects [A] - Add More:**
405
+ Return to relevant section to gather more details.
406
+ Append to existing file, don't overwrite.
407
+
408
+ **If user selects [P] - Party Mode:**
409
+ Load and execute: `_code/workflows/party/workflow.md`
410
+ Include ATLAS for technical feasibility assessment.
411
+ Return to this step's menu when complete.
412
+
413
+ **If user selects [C] - Continue:**
414
+ Save any final changes, then load: `./step-06-review.md`
415
+ **CRITICAL:** Read the entire next step file before taking action.
416
+
417
+ **If user selects [R] - Revise:**
418
+ Ask what they'd like to change, update the document, present menu again.
419
+
420
+ ## QUALITY CHECKLIST (Before Proceeding)
421
+
422
+ Before allowing [C], verify:
423
+ - [ ] Platform requirements defined
424
+ - [ ] Technology preferences captured (or marked as open)
425
+ - [ ] Required integrations listed
426
+ - [ ] Non-functional requirements stated
427
+ - [ ] Constraints documented
428
+ - [ ] User has confirmed the framework
429
+
430
+ ## RECOMMENDATION DEFAULTS
431
+
432
+ If user has no preferences, suggest these defaults:
433
+
434
+ **Simple Web App:**
435
+ - Frontend: Next.js (React)
436
+ - Backend: Next.js API routes
437
+ - Database: Supabase (PostgreSQL)
438
+ - Hosting: Vercel
439
+ - Auth: Supabase Auth
440
+
441
+ **Mobile-First:**
442
+ - Frontend: React Native or Flutter
443
+ - Backend: Supabase or Firebase
444
+ - Hosting: Expo (React Native) or Firebase
445
+
446
+ **Enterprise:**
447
+ - Frontend: React + TypeScript
448
+ - Backend: Node.js or Go
449
+ - Database: PostgreSQL
450
+ - Hosting: AWS or GCP
451
+ - Auth: Auth0 or Clerk
452
+
453
+ ---
454
+
455
+ **REMEMBER:** It's okay to have no preferences. That gives ATLAS freedom to recommend the best solution. Capture what matters to the user, not what you think they should want.