qualia-framework 2.6.0 → 3.2.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 (321) hide show
  1. package/CLAUDE.md +64 -0
  2. package/README.md +103 -30
  3. package/agents/builder.md +110 -0
  4. package/agents/planner.md +134 -0
  5. package/agents/qa-browser.md +186 -0
  6. package/agents/verifier.md +221 -0
  7. package/bin/cli.js +336 -531
  8. package/bin/install.js +570 -0
  9. package/bin/qualia-ui.js +299 -0
  10. package/bin/state.js +630 -0
  11. package/bin/statusline.js +252 -0
  12. package/guide.md +63 -0
  13. package/hooks/auto-update.js +139 -0
  14. package/hooks/branch-guard.js +47 -0
  15. package/hooks/migration-guard.js +60 -0
  16. package/hooks/pre-compact.js +32 -0
  17. package/hooks/pre-deploy-gate.js +110 -0
  18. package/hooks/pre-push.js +33 -0
  19. package/hooks/session-start.js +170 -0
  20. package/package.json +29 -20
  21. package/rules/design-reference.md +179 -0
  22. package/rules/frontend.md +126 -0
  23. package/skills/qualia/SKILL.md +87 -0
  24. package/skills/qualia-build/SKILL.md +97 -0
  25. package/skills/qualia-debug/SKILL.md +87 -0
  26. package/skills/qualia-design/SKILL.md +93 -0
  27. package/skills/qualia-handoff/SKILL.md +66 -0
  28. package/skills/qualia-idk/SKILL.md +8 -0
  29. package/skills/qualia-learn/SKILL.md +88 -0
  30. package/skills/qualia-new/SKILL.md +323 -0
  31. package/{framework/skills → skills}/qualia-optimize/SKILL.md +1 -1
  32. package/skills/qualia-pause/SKILL.md +63 -0
  33. package/skills/qualia-plan/SKILL.md +101 -0
  34. package/skills/qualia-polish/SKILL.md +157 -0
  35. package/skills/qualia-quick/SKILL.md +37 -0
  36. package/skills/qualia-report/SKILL.md +105 -0
  37. package/skills/qualia-resume/SKILL.md +49 -0
  38. package/skills/qualia-review/SKILL.md +76 -0
  39. package/skills/qualia-ship/SKILL.md +90 -0
  40. package/skills/qualia-skill-new/SKILL.md +167 -0
  41. package/skills/qualia-task/SKILL.md +91 -0
  42. package/skills/qualia-verify/SKILL.md +113 -0
  43. package/templates/DESIGN.md +137 -0
  44. package/templates/plan.md +28 -0
  45. package/templates/project.md +22 -0
  46. package/templates/state.md +27 -0
  47. package/templates/tracking.json +20 -0
  48. package/tests/bin.test.sh +673 -0
  49. package/tests/hooks.test.sh +315 -0
  50. package/tests/state.test.sh +535 -0
  51. package/tests/statusline.test.sh +243 -0
  52. package/bin/collect-metrics.sh +0 -62
  53. package/framework/.claudeignore +0 -51
  54. package/framework/CLAUDE.md +0 -51
  55. package/framework/MCP_SETUP.md +0 -229
  56. package/framework/agents/architecture-strategist.md +0 -53
  57. package/framework/agents/backend-agent.md +0 -150
  58. package/framework/agents/code-simplicity-reviewer.md +0 -86
  59. package/framework/agents/frontend-agent.md +0 -111
  60. package/framework/agents/kieran-typescript-reviewer.md +0 -96
  61. package/framework/agents/performance-oracle.md +0 -111
  62. package/framework/agents/qualia-codebase-mapper.md +0 -761
  63. package/framework/agents/qualia-debugger.md +0 -1204
  64. package/framework/agents/qualia-executor.md +0 -882
  65. package/framework/agents/qualia-integration-checker.md +0 -424
  66. package/framework/agents/qualia-phase-researcher.md +0 -457
  67. package/framework/agents/qualia-plan-checker.md +0 -700
  68. package/framework/agents/qualia-planner.md +0 -1245
  69. package/framework/agents/qualia-project-researcher.md +0 -603
  70. package/framework/agents/qualia-research-synthesizer.md +0 -200
  71. package/framework/agents/qualia-roadmapper.md +0 -606
  72. package/framework/agents/qualia-verifier.md +0 -686
  73. package/framework/agents/red-team-qa.md +0 -130
  74. package/framework/agents/security-auditor.md +0 -72
  75. package/framework/agents/team-orchestrator.md +0 -229
  76. package/framework/agents/teams/framework-audit-team.md +0 -66
  77. package/framework/agents/teams/full-stack-team.md +0 -48
  78. package/framework/agents/teams/optimize-team.md +0 -53
  79. package/framework/agents/teams/review-team.md +0 -70
  80. package/framework/agents/teams/ship-team.md +0 -86
  81. package/framework/agents/test-agent.md +0 -182
  82. package/framework/hooks/auto-format.sh +0 -54
  83. package/framework/hooks/block-env-edit.sh +0 -42
  84. package/framework/hooks/branch-guard.sh +0 -43
  85. package/framework/hooks/confirm-delete.sh +0 -59
  86. package/framework/hooks/migration-validate.sh +0 -77
  87. package/framework/hooks/notification-speak.sh +0 -16
  88. package/framework/hooks/pre-commit.sh +0 -100
  89. package/framework/hooks/pre-compact.sh +0 -56
  90. package/framework/hooks/pre-deploy-gate.sh +0 -160
  91. package/framework/hooks/qualia-colors.sh +0 -32
  92. package/framework/hooks/retention-cleanup.sh +0 -62
  93. package/framework/hooks/save-session-state.sh +0 -185
  94. package/framework/hooks/session-context-loader.sh +0 -96
  95. package/framework/hooks/session-learn.sh +0 -32
  96. package/framework/hooks/skill-announce.sh +0 -123
  97. package/framework/hooks/tool-error-announce.sh +0 -27
  98. package/framework/install.ps1 +0 -323
  99. package/framework/install.sh +0 -313
  100. package/framework/qualia-framework/VERSION +0 -1
  101. package/framework/qualia-framework/assets/qualia-logo.png +0 -0
  102. package/framework/qualia-framework/bin/collect-metrics.sh +0 -67
  103. package/framework/qualia-framework/bin/generate-report-docx.py +0 -429
  104. package/framework/qualia-framework/bin/qualia-tools.js +0 -2201
  105. package/framework/qualia-framework/bin/qualia-tools.test.js +0 -1054
  106. package/framework/qualia-framework/references/checkpoints.md +0 -775
  107. package/framework/qualia-framework/references/completion-checklists.md +0 -359
  108. package/framework/qualia-framework/references/continuation-format.md +0 -249
  109. package/framework/qualia-framework/references/continuation-prompt.md +0 -97
  110. package/framework/qualia-framework/references/decimal-phase-calculation.md +0 -65
  111. package/framework/qualia-framework/references/design-quality.md +0 -56
  112. package/framework/qualia-framework/references/employee-guide.md +0 -167
  113. package/framework/qualia-framework/references/git-integration.md +0 -254
  114. package/framework/qualia-framework/references/git-planning-commit.md +0 -50
  115. package/framework/qualia-framework/references/model-profile-resolution.md +0 -32
  116. package/framework/qualia-framework/references/model-profiles.md +0 -73
  117. package/framework/qualia-framework/references/phase-argument-parsing.md +0 -61
  118. package/framework/qualia-framework/references/planning-config.md +0 -195
  119. package/framework/qualia-framework/references/questioning.md +0 -141
  120. package/framework/qualia-framework/references/tdd.md +0 -263
  121. package/framework/qualia-framework/references/ui-brand.md +0 -160
  122. package/framework/qualia-framework/references/verification-patterns.md +0 -612
  123. package/framework/qualia-framework/templates/DEBUG.md +0 -159
  124. package/framework/qualia-framework/templates/DESIGN.md +0 -81
  125. package/framework/qualia-framework/templates/UAT.md +0 -247
  126. package/framework/qualia-framework/templates/codebase/architecture.md +0 -255
  127. package/framework/qualia-framework/templates/codebase/concerns.md +0 -310
  128. package/framework/qualia-framework/templates/codebase/conventions.md +0 -307
  129. package/framework/qualia-framework/templates/codebase/integrations.md +0 -280
  130. package/framework/qualia-framework/templates/codebase/stack.md +0 -186
  131. package/framework/qualia-framework/templates/codebase/structure.md +0 -285
  132. package/framework/qualia-framework/templates/codebase/testing.md +0 -480
  133. package/framework/qualia-framework/templates/config.json +0 -35
  134. package/framework/qualia-framework/templates/context.md +0 -283
  135. package/framework/qualia-framework/templates/continue-here.md +0 -78
  136. package/framework/qualia-framework/templates/debug-subagent-prompt.md +0 -91
  137. package/framework/qualia-framework/templates/discovery.md +0 -146
  138. package/framework/qualia-framework/templates/lab-notes.md +0 -16
  139. package/framework/qualia-framework/templates/milestone-archive.md +0 -123
  140. package/framework/qualia-framework/templates/milestone.md +0 -115
  141. package/framework/qualia-framework/templates/phase-prompt.md +0 -567
  142. package/framework/qualia-framework/templates/planner-subagent-prompt.md +0 -117
  143. package/framework/qualia-framework/templates/project.md +0 -184
  144. package/framework/qualia-framework/templates/projects/ai-agent.md +0 -156
  145. package/framework/qualia-framework/templates/projects/mobile-app.md +0 -181
  146. package/framework/qualia-framework/templates/projects/voice-agent.md +0 -134
  147. package/framework/qualia-framework/templates/projects/website.md +0 -137
  148. package/framework/qualia-framework/templates/requirements.md +0 -231
  149. package/framework/qualia-framework/templates/research-project/ARCHITECTURE.md +0 -204
  150. package/framework/qualia-framework/templates/research-project/FEATURES.md +0 -147
  151. package/framework/qualia-framework/templates/research-project/PITFALLS.md +0 -200
  152. package/framework/qualia-framework/templates/research-project/STACK.md +0 -120
  153. package/framework/qualia-framework/templates/research-project/SUMMARY.md +0 -170
  154. package/framework/qualia-framework/templates/research.md +0 -552
  155. package/framework/qualia-framework/templates/roadmap.md +0 -206
  156. package/framework/qualia-framework/templates/state.md +0 -179
  157. package/framework/qualia-framework/templates/summary-complex.md +0 -59
  158. package/framework/qualia-framework/templates/summary-minimal.md +0 -41
  159. package/framework/qualia-framework/templates/summary-standard.md +0 -48
  160. package/framework/qualia-framework/templates/summary.md +0 -246
  161. package/framework/qualia-framework/templates/user-setup.md +0 -311
  162. package/framework/qualia-framework/templates/verification-report.md +0 -322
  163. package/framework/qualia-framework/workflows/add-phase.md +0 -179
  164. package/framework/qualia-framework/workflows/add-todo.md +0 -157
  165. package/framework/qualia-framework/workflows/audit-milestone.md +0 -241
  166. package/framework/qualia-framework/workflows/check-todos.md +0 -176
  167. package/framework/qualia-framework/workflows/complete-milestone.md +0 -858
  168. package/framework/qualia-framework/workflows/diagnose-issues.md +0 -219
  169. package/framework/qualia-framework/workflows/discovery-phase.md +0 -289
  170. package/framework/qualia-framework/workflows/discuss-phase.md +0 -534
  171. package/framework/qualia-framework/workflows/execute-phase.md +0 -559
  172. package/framework/qualia-framework/workflows/execute-plan.md +0 -438
  173. package/framework/qualia-framework/workflows/help.md +0 -470
  174. package/framework/qualia-framework/workflows/insert-phase.md +0 -220
  175. package/framework/qualia-framework/workflows/list-phase-assumptions.md +0 -178
  176. package/framework/qualia-framework/workflows/map-codebase.md +0 -327
  177. package/framework/qualia-framework/workflows/new-milestone.md +0 -363
  178. package/framework/qualia-framework/workflows/new-project.md +0 -982
  179. package/framework/qualia-framework/workflows/pause-work.md +0 -122
  180. package/framework/qualia-framework/workflows/plan-milestone-gaps.md +0 -256
  181. package/framework/qualia-framework/workflows/plan-phase.md +0 -422
  182. package/framework/qualia-framework/workflows/progress.md +0 -389
  183. package/framework/qualia-framework/workflows/quick.md +0 -252
  184. package/framework/qualia-framework/workflows/remove-phase.md +0 -326
  185. package/framework/qualia-framework/workflows/research-phase.md +0 -74
  186. package/framework/qualia-framework/workflows/resume-project.md +0 -306
  187. package/framework/qualia-framework/workflows/set-profile.md +0 -80
  188. package/framework/qualia-framework/workflows/settings.md +0 -145
  189. package/framework/qualia-framework/workflows/transition.md +0 -556
  190. package/framework/qualia-framework/workflows/update.md +0 -197
  191. package/framework/qualia-framework/workflows/verify-phase.md +0 -195
  192. package/framework/qualia-framework/workflows/verify-work.md +0 -625
  193. package/framework/rules/context7.md +0 -14
  194. package/framework/rules/frontend.md +0 -33
  195. package/framework/rules/speed.md +0 -23
  196. package/framework/scripts/__pycache__/say.cpython-314.pyc +0 -0
  197. package/framework/scripts/apply-retention.sh +0 -120
  198. package/framework/scripts/bootstrap-pop-os.sh +0 -354
  199. package/framework/scripts/claude-voice +0 -13
  200. package/framework/scripts/cleanup.sh +0 -131
  201. package/framework/scripts/cowork-mode.sh +0 -141
  202. package/framework/scripts/generate-project-claude-md.sh +0 -153
  203. package/framework/scripts/load-test-webhook.js +0 -172
  204. package/framework/scripts/say.py +0 -236
  205. package/framework/scripts/showcase-video-recorder/ffmpeg-builder.js +0 -167
  206. package/framework/scripts/showcase-video-recorder/playwright-helpers.js +0 -216
  207. package/framework/scripts/speak.py +0 -55
  208. package/framework/scripts/speak.sh +0 -18
  209. package/framework/scripts/status.sh +0 -138
  210. package/framework/scripts/sync-to-framework.sh +0 -65
  211. package/framework/scripts/voice-hotkey.py +0 -227
  212. package/framework/scripts/voice-input.sh +0 -51
  213. package/framework/skills/animate/SKILL.md +0 -202
  214. package/framework/skills/bolder/SKILL.md +0 -144
  215. package/framework/skills/browser-qa/SKILL.md +0 -536
  216. package/framework/skills/clarify/SKILL.md +0 -179
  217. package/framework/skills/client-handoff/SKILL.md +0 -135
  218. package/framework/skills/collab-onboard/SKILL.md +0 -111
  219. package/framework/skills/colorize/SKILL.md +0 -170
  220. package/framework/skills/critique/SKILL.md +0 -126
  221. package/framework/skills/deep-research/SKILL.md +0 -240
  222. package/framework/skills/delight/SKILL.md +0 -329
  223. package/framework/skills/deploy/SKILL.md +0 -261
  224. package/framework/skills/deploy-verify/SKILL.md +0 -377
  225. package/framework/skills/deploy-verify/scripts/canary-check.sh +0 -206
  226. package/framework/skills/deploy-verify/scripts/check-console-errors.js +0 -147
  227. package/framework/skills/deploy-verify/scripts/check-cwv.js +0 -139
  228. package/framework/skills/deploy-verify/scripts/project-detect.sh +0 -84
  229. package/framework/skills/deploy-verify/scripts/verify.sh +0 -548
  230. package/framework/skills/design-quieter/SKILL.md +0 -130
  231. package/framework/skills/distill/SKILL.md +0 -149
  232. package/framework/skills/docs-lookup/SKILL.md +0 -79
  233. package/framework/skills/fcm-notifications/SKILL.md +0 -125
  234. package/framework/skills/financial-ledger/SKILL.md +0 -1039
  235. package/framework/skills/frontend-master/NOTICE.md +0 -4
  236. package/framework/skills/frontend-master/SKILL.md +0 -127
  237. package/framework/skills/frontend-master/reference/color-and-contrast.md +0 -132
  238. package/framework/skills/frontend-master/reference/interaction-design.md +0 -123
  239. package/framework/skills/frontend-master/reference/motion-design.md +0 -99
  240. package/framework/skills/frontend-master/reference/responsive-design.md +0 -114
  241. package/framework/skills/frontend-master/reference/spatial-design.md +0 -100
  242. package/framework/skills/frontend-master/reference/typography.md +0 -131
  243. package/framework/skills/frontend-master/reference/ux-writing.md +0 -107
  244. package/framework/skills/harden/SKILL.md +0 -357
  245. package/framework/skills/i18n-rtl/SKILL.md +0 -752
  246. package/framework/skills/learn/SKILL.md +0 -95
  247. package/framework/skills/memory/SKILL.md +0 -50
  248. package/framework/skills/mobile-expo/SKILL.md +0 -977
  249. package/framework/skills/mobile-expo/references/store-checklist.md +0 -550
  250. package/framework/skills/nestjs-backend/README.md +0 -73
  251. package/framework/skills/nestjs-backend/SKILL.md +0 -446
  252. package/framework/skills/nestjs-backend/references/templates.md +0 -1173
  253. package/framework/skills/normalize/SKILL.md +0 -79
  254. package/framework/skills/onboard/SKILL.md +0 -242
  255. package/framework/skills/openrouter-agent/SKILL.md +0 -922
  256. package/framework/skills/polish/SKILL.md +0 -209
  257. package/framework/skills/pr/SKILL.md +0 -66
  258. package/framework/skills/qualia/SKILL.md +0 -199
  259. package/framework/skills/qualia-add-todo/SKILL.md +0 -68
  260. package/framework/skills/qualia-audit-milestone/SKILL.md +0 -95
  261. package/framework/skills/qualia-check-todos/SKILL.md +0 -55
  262. package/framework/skills/qualia-complete-milestone/SKILL.md +0 -134
  263. package/framework/skills/qualia-debug/SKILL.md +0 -149
  264. package/framework/skills/qualia-design/SKILL.md +0 -203
  265. package/framework/skills/qualia-discuss-phase/SKILL.md +0 -72
  266. package/framework/skills/qualia-evolve/SKILL.md +0 -200
  267. package/framework/skills/qualia-execute-phase/SKILL.md +0 -89
  268. package/framework/skills/qualia-framework-audit/SKILL.md +0 -604
  269. package/framework/skills/qualia-guide/SKILL.md +0 -32
  270. package/framework/skills/qualia-help/SKILL.md +0 -114
  271. package/framework/skills/qualia-idk/SKILL.md +0 -352
  272. package/framework/skills/qualia-list-phase-assumptions/SKILL.md +0 -67
  273. package/framework/skills/qualia-new-milestone/SKILL.md +0 -72
  274. package/framework/skills/qualia-new-project/SKILL.md +0 -232
  275. package/framework/skills/qualia-pause-work/SKILL.md +0 -96
  276. package/framework/skills/qualia-plan-milestone-gaps/SKILL.md +0 -57
  277. package/framework/skills/qualia-plan-phase/SKILL.md +0 -104
  278. package/framework/skills/qualia-production-check/SKILL.md +0 -0
  279. package/framework/skills/qualia-progress/SKILL.md +0 -53
  280. package/framework/skills/qualia-quick/SKILL.md +0 -89
  281. package/framework/skills/qualia-report/SKILL.md +0 -166
  282. package/framework/skills/qualia-research-phase/SKILL.md +0 -88
  283. package/framework/skills/qualia-resume-work/SKILL.md +0 -62
  284. package/framework/skills/qualia-review/SKILL.md +0 -263
  285. package/framework/skills/qualia-start/SKILL.md +0 -161
  286. package/framework/skills/qualia-verify-work/SKILL.md +0 -132
  287. package/framework/skills/rag/SKILL.md +0 -750
  288. package/framework/skills/responsive/SKILL.md +0 -231
  289. package/framework/skills/retro/SKILL.md +0 -284
  290. package/framework/skills/sakani-conventions/SKILL.md +0 -136
  291. package/framework/skills/sakani-conventions/evals/evals.json +0 -23
  292. package/framework/skills/sakani-conventions/references/entities.md +0 -365
  293. package/framework/skills/sakani-conventions/references/error-codes.md +0 -95
  294. package/framework/skills/seo-master/SKILL.md +0 -490
  295. package/framework/skills/seo-master/references/checklist.md +0 -199
  296. package/framework/skills/seo-master/references/structured-data.md +0 -609
  297. package/framework/skills/ship/SKILL.md +0 -239
  298. package/framework/skills/stack-researcher/SKILL.md +0 -215
  299. package/framework/skills/status/SKILL.md +0 -154
  300. package/framework/skills/status/scripts/health-check.sh +0 -562
  301. package/framework/skills/subscription-payments/SKILL.md +0 -250
  302. package/framework/skills/supabase/SKILL.md +0 -973
  303. package/framework/skills/supabase/references/templates.md +0 -159
  304. package/framework/skills/team/SKILL.md +0 -67
  305. package/framework/skills/test-runner/SKILL.md +0 -202
  306. package/framework/skills/voice-agent/SKILL.md +0 -1312
  307. package/framework/skills/zoho-workflow/SKILL.md +0 -51
  308. package/framework/statusline-command.sh +0 -117
  309. package/framework/teams/default/inboxes/plan-04.json +0 -9
  310. package/framework/teams/review-team.md +0 -75
  311. package/framework/teams/ship-team.md +0 -86
  312. package/profiles/fawzi.json +0 -16
  313. package/profiles/hasan.json +0 -16
  314. package/profiles/moayad.json +0 -16
  315. package/templates/CLAUDE-owner.md +0 -52
  316. package/templates/CLAUDE.md.hbs +0 -58
  317. package/templates/env.claude.template +0 -12
  318. package/templates/settings.json +0 -172
  319. package/uninstall.sh +0 -90
  320. /package/{framework/rules → rules}/deployment.md +0 -0
  321. /package/{framework/rules → rules}/security.md +0 -0
@@ -1,79 +0,0 @@
1
- ---
2
- name: normalize
3
- description: Normalize design to match your design system and ensure consistency
4
- user-invokable: true
5
- args:
6
- - name: feature
7
- description: The page, route, or feature to normalize (optional)
8
- required: false
9
- ---
10
-
11
- Analyze and redesign the feature to perfectly match our design system standards, aesthetics, and established patterns.
12
-
13
- ## Read DESIGN.md (Authoritative Source)
14
-
15
- Before searching for design system documentation, check for the project's DESIGN.md:
16
-
17
- ```bash
18
- cat .planning/DESIGN.md 2>/dev/null
19
- ```
20
-
21
- **If DESIGN.md exists:** This IS the design system for this project. Use it as the primary reference for tokens, patterns, and constraints. Still search for additional design system docs (component libraries, style guides), but DESIGN.md decisions take precedence.
22
-
23
- **If DESIGN.md does not exist:** Proceed with the design system discovery step below.
24
-
25
- ## Plan
26
-
27
- Before making changes, deeply understand the context:
28
-
29
- 1. **Discover the design system**: Search for design system documentation, UI guidelines, component libraries, or style guides (grep for "design system", "ui guide", "style guide", etc.). Study it thoroughly until you understand:
30
- - Core design principles and aesthetic direction
31
- - Target audience and personas
32
- - Component patterns and conventions
33
- - Design tokens (colors, typography, spacing)
34
-
35
- **CRITICAL**: If something isn't clear, ask. Don't guess at design system principles.
36
-
37
- 2. **Analyze the current feature**: Assess what works and what doesn't:
38
- - Where does it deviate from design system patterns?
39
- - Which inconsistencies are cosmetic vs. functional?
40
- - What's the root cause—missing tokens, one-off implementations, or conceptual misalignment?
41
-
42
- 3. **Create a normalization plan**: Define specific changes that will align the feature with the design system:
43
- - Which components can be replaced with design system equivalents?
44
- - Which styles need to use design tokens instead of hard-coded values?
45
- - How can UX patterns match established user flows?
46
-
47
- **IMPORTANT**: Great design is effective design. Prioritize UX consistency and usability over visual polish alone. Think through the best possible experience for your use case and personas first.
48
-
49
- ## Execute
50
-
51
- Systematically address all inconsistencies across these dimensions:
52
-
53
- - **Typography**: Use design system fonts, sizes, weights, and line heights. Replace hard-coded values with typographic tokens or classes.
54
- - **Color & Theme**: Apply design system color tokens. Remove one-off color choices that break the palette.
55
- - **Spacing & Layout**: Use spacing tokens (margins, padding, gaps). Align with grid systems and layout patterns used elsewhere.
56
- - **Components**: Replace custom implementations with design system components. Ensure props and variants match established patterns.
57
- - **Motion & Interaction**: Match animation timing, easing, and interaction patterns to other features.
58
- - **Responsive Behavior**: Ensure breakpoints and responsive patterns align with design system standards.
59
- - **Accessibility**: Verify contrast ratios, focus states, ARIA labels match design system requirements.
60
- - **Progressive Disclosure**: Match information hierarchy and complexity management to established patterns.
61
-
62
- **NEVER**:
63
- - Create new one-off components when design system equivalents exist
64
- - Hard-code values that should use design tokens
65
- - Introduce new patterns that diverge from the design system
66
- - Compromise accessibility for visual consistency
67
-
68
- This is not an exhaustive list—apply judgment to identify all areas needing normalization.
69
-
70
- ## Clean Up
71
-
72
- After normalization, ensure code quality:
73
-
74
- - **Consolidate reusable components**: If you created new components that should be shared, move them to the design system or shared UI component path.
75
- - **Remove orphaned code**: Delete unused implementations, styles, or files made obsolete by normalization.
76
- - **Verify quality**: Lint, type-check, and test according to repository guidelines. Ensure normalization didn't introduce regressions.
77
- - **Ensure DRYness**: Look for duplication introduced during refactoring and consolidate.
78
-
79
- Remember: You are a brilliant frontend designer with impeccable taste, equally strong in UX and UI. Your attention to detail and eye for end-to-end user experience is world class. Execute with precision and thoroughness.
@@ -1,242 +0,0 @@
1
- ---
2
- name: onboard
3
- description: Design or improve onboarding flows, empty states, and first-time user experiences. Helps users get started successfully and understand value quickly.
4
- user-invokable: true
5
- args:
6
- - name: target
7
- description: The feature or area needing onboarding (optional)
8
- required: false
9
- ---
10
-
11
- Create or improve onboarding experiences that help users understand, adopt, and succeed with the product quickly.
12
-
13
- ## Assess Onboarding Needs
14
-
15
- Understand what users need to learn and why:
16
-
17
- 1. **Identify the challenge**:
18
- - What are users trying to accomplish?
19
- - What's confusing or unclear about current experience?
20
- - Where do users get stuck or drop off?
21
- - What's the "aha moment" we want users to reach?
22
-
23
- 2. **Understand the users**:
24
- - What's their experience level? (Beginners, power users, mixed?)
25
- - What's their motivation? (Excited and exploring? Required by work?)
26
- - What's their time commitment? (5 minutes? 30 minutes?)
27
- - What alternatives do they know? (Coming from competitor? New to category?)
28
-
29
- 3. **Define success**:
30
- - What's the minimum users need to learn to be successful?
31
- - What's the key action we want them to take? (First project? First invite?)
32
- - How do we know onboarding worked? (Completion rate? Time to value?)
33
-
34
- **CRITICAL**: Onboarding should get users to value as quickly as possible, not teach everything possible.
35
-
36
- ## Onboarding Principles
37
-
38
- Follow these core principles:
39
-
40
- ### Show, Don't Tell
41
- - Demonstrate with working examples, not just descriptions
42
- - Provide real functionality in onboarding, not separate tutorial mode
43
- - Use progressive disclosure - teach one thing at a time
44
-
45
- ### Make It Optional (When Possible)
46
- - Let experienced users skip onboarding
47
- - Don't block access to product
48
- - Provide "Skip" or "I'll explore on my own" options
49
-
50
- ### Time to Value
51
- - Get users to their "aha moment" ASAP
52
- - Front-load most important concepts
53
- - Teach 20% that delivers 80% of value
54
- - Save advanced features for contextual discovery
55
-
56
- ### Context Over Ceremony
57
- - Teach features when users need them, not upfront
58
- - Empty states are onboarding opportunities
59
- - Tooltips and hints at point of use
60
-
61
- ### Respect User Intelligence
62
- - Don't patronize or over-explain
63
- - Be concise and clear
64
- - Assume users can figure out standard patterns
65
-
66
- ## Design Onboarding Experiences
67
-
68
- Create appropriate onboarding for the context:
69
-
70
- ### Initial Product Onboarding
71
-
72
- **Welcome Screen**:
73
- - Clear value proposition (what is this product?)
74
- - What users will learn/accomplish
75
- - Time estimate (honest about commitment)
76
- - Option to skip (for experienced users)
77
-
78
- **Account Setup**:
79
- - Minimal required information (collect more later)
80
- - Explain why you're asking for each piece of information
81
- - Smart defaults where possible
82
- - Social login when appropriate
83
-
84
- **Core Concept Introduction**:
85
- - Introduce 1-3 core concepts (not everything)
86
- - Use simple language and examples
87
- - Interactive when possible (do, don't just read)
88
- - Progress indication (step 1 of 3)
89
-
90
- **First Success**:
91
- - Guide users to accomplish something real
92
- - Pre-populated examples or templates
93
- - Celebrate completion (but don't overdo it)
94
- - Clear next steps
95
-
96
- ### Feature Discovery & Adoption
97
-
98
- **Empty States**:
99
- Instead of blank space, show:
100
- - What will appear here (description + screenshot/illustration)
101
- - Why it's valuable
102
- - Clear CTA to create first item
103
- - Example or template option
104
-
105
- Example:
106
- ```
107
- No projects yet
108
- Projects help you organize your work and collaborate with your team.
109
- [Create your first project] or [Start from template]
110
- ```
111
-
112
- **Contextual Tooltips**:
113
- - Appear at relevant moment (first time user sees feature)
114
- - Point directly at relevant UI element
115
- - Brief explanation + benefit
116
- - Dismissable (with "Don't show again" option)
117
- - Optional "Learn more" link
118
-
119
- **Feature Announcements**:
120
- - Highlight new features when they're released
121
- - Show what's new and why it matters
122
- - Let users try immediately
123
- - Dismissable
124
-
125
- **Progressive Onboarding**:
126
- - Teach features when users encounter them
127
- - Badges or indicators on new/unused features
128
- - Unlock complexity gradually (don't show all options immediately)
129
-
130
- ### Guided Tours & Walkthroughs
131
-
132
- **When to use**:
133
- - Complex interfaces with many features
134
- - Significant changes to existing product
135
- - Industry-specific tools needing domain knowledge
136
-
137
- **How to design**:
138
- - Spotlight specific UI elements (dim rest of page)
139
- - Keep steps short (3-7 steps max per tour)
140
- - Allow users to click through tour freely
141
- - Include "Skip tour" option
142
- - Make replayable (help menu)
143
-
144
- **Best practices**:
145
- - Interactive > passive (let users click real buttons)
146
- - Focus on workflow, not features ("Create a project" not "This is the project button")
147
- - Provide sample data so actions work
148
-
149
- ### Interactive Tutorials
150
-
151
- **When to use**:
152
- - Users need hands-on practice
153
- - Concepts are complex or unfamiliar
154
- - High stakes (better to practice in safe environment)
155
-
156
- **How to design**:
157
- - Sandbox environment with sample data
158
- - Clear objectives ("Create a chart showing sales by region")
159
- - Step-by-step guidance
160
- - Validation (confirm they did it right)
161
- - Graduation moment (you're ready!)
162
-
163
- ### Documentation & Help
164
-
165
- **In-product help**:
166
- - Contextual help links throughout interface
167
- - Keyboard shortcut reference
168
- - Search-able help center
169
- - Video tutorials for complex workflows
170
-
171
- **Help patterns**:
172
- - `?` icon near complex features
173
- - "Learn more" links in tooltips
174
- - Keyboard shortcut hints (`⌘K` shown on search box)
175
-
176
- ## Empty State Design
177
-
178
- Every empty state needs:
179
-
180
- ### What Will Be Here
181
- "Your recent projects will appear here"
182
-
183
- ### Why It Matters
184
- "Projects help you organize your work and collaborate with your team"
185
-
186
- ### How to Get Started
187
- [Create project] or [Import from template]
188
-
189
- ### Visual Interest
190
- Illustration or icon (not just text on blank page)
191
-
192
- ### Contextual Help
193
- "Need help getting started? [Watch 2-min tutorial]"
194
-
195
- **Empty state types**:
196
- - **First use**: Never used this feature (emphasize value, provide template)
197
- - **User cleared**: Intentionally deleted everything (light touch, easy to recreate)
198
- - **No results**: Search or filter returned nothing (suggest different query, clear filters)
199
- - **No permissions**: Can't access (explain why, how to get access)
200
- - **Error state**: Failed to load (explain what happened, retry option)
201
-
202
- ## Implementation Patterns
203
-
204
- ### Technical approaches:
205
-
206
- **Tooltip libraries**: Tippy.js, Popper.js
207
- **Tour libraries**: Intro.js, Shepherd.js, React Joyride
208
- **Modal patterns**: Focus trap, backdrop, ESC to close
209
- **Progress tracking**: LocalStorage for "seen" states
210
- **Analytics**: Track completion, drop-off points
211
-
212
- **Storage patterns**:
213
- ```javascript
214
- // Track which onboarding steps user has seen
215
- localStorage.setItem('onboarding-completed', 'true');
216
- localStorage.setItem('feature-tooltip-seen-reports', 'true');
217
- ```
218
-
219
- **IMPORTANT**: Don't show same onboarding twice (annoying). Track completion and respect dismissals.
220
-
221
- **NEVER**:
222
- - Force users through long onboarding before they can use product
223
- - Patronize users with obvious explanations
224
- - Show same tooltip repeatedly (respect dismissals)
225
- - Block all UI during tour (let users explore)
226
- - Create separate tutorial mode disconnected from real product
227
- - Overwhelm with information upfront (progressive disclosure!)
228
- - Hide "Skip" or make it hard to find
229
- - Forget about returning users (don't show initial onboarding again)
230
-
231
- ## Verify Onboarding Quality
232
-
233
- Test with real users:
234
-
235
- - **Time to completion**: Can users complete onboarding quickly?
236
- - **Comprehension**: Do users understand after completing?
237
- - **Action**: Do users take desired next step?
238
- - **Skip rate**: Are too many users skipping? (Maybe it's too long/not valuable)
239
- - **Completion rate**: Are users completing? (If low, simplify)
240
- - **Time to value**: How long until users get first value?
241
-
242
- Remember: You're a product educator with excellent teaching instincts. Get users to their "aha moment" as quickly as possible. Teach the essential, make it contextual, respect user time and intelligence.