ai-playbook 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 (424) hide show
  1. package/README.md +146 -0
  2. package/agents/README.md +168 -0
  3. package/agents/SKILL.md +633 -0
  4. package/agents/architect/AGENT.md +44 -0
  5. package/agents/architect/README.md +5 -0
  6. package/agents/coder/AGENT.md +43 -0
  7. package/agents/coder/README.md +5 -0
  8. package/agents/debugger/AGENT.md +42 -0
  9. package/agents/debugger/README.md +6 -0
  10. package/agents/devops/AGENT.md +43 -0
  11. package/agents/devops/README.md +5 -0
  12. package/agents/documentation/AGENT.md +45 -0
  13. package/agents/documentation/README.md +5 -0
  14. package/agents/examples.md +550 -0
  15. package/agents/performance/AGENT.md +45 -0
  16. package/agents/performance/README.md +6 -0
  17. package/agents/planner/AGENT.md +44 -0
  18. package/agents/planner/README.md +6 -0
  19. package/agents/product-owner/AGENT.md +46 -0
  20. package/agents/product-owner/README.md +6 -0
  21. package/agents/refactorer/AGENT.md +44 -0
  22. package/agents/refactorer/README.md +6 -0
  23. package/agents/release-manager/AGENT.md +45 -0
  24. package/agents/release-manager/README.md +6 -0
  25. package/agents/researcher/AGENT.md +44 -0
  26. package/agents/researcher/README.md +6 -0
  27. package/agents/reviewer/AGENT.md +43 -0
  28. package/agents/reviewer/README.md +6 -0
  29. package/agents/security/AGENT.md +46 -0
  30. package/agents/security/README.md +6 -0
  31. package/agents/support/AGENT.md +45 -0
  32. package/agents/support/README.md +6 -0
  33. package/agents/tester/AGENT.md +46 -0
  34. package/agents/tester/README.md +5 -0
  35. package/bin/cli.js +186 -0
  36. package/commands/README.md +266 -0
  37. package/commands/build.md +135 -0
  38. package/commands/clean.md +126 -0
  39. package/commands/deploy-prod.md +171 -0
  40. package/commands/deploy-staging.md +147 -0
  41. package/commands/deps.md +169 -0
  42. package/commands/dev.md +132 -0
  43. package/commands/format.md +142 -0
  44. package/commands/lint.md +125 -0
  45. package/commands/migrate.md +159 -0
  46. package/commands/release.md +183 -0
  47. package/commands/rollback.md +152 -0
  48. package/commands/seed.md +178 -0
  49. package/commands/setup.md +109 -0
  50. package/commands/test.md +134 -0
  51. package/commands/validate.md +147 -0
  52. package/context/README.md +7 -0
  53. package/context/aem.md +47 -0
  54. package/context/architecture.md +51 -0
  55. package/context/bullminder.md +57 -0
  56. package/context/coding-style.md +42 -0
  57. package/context/communication.md +53 -0
  58. package/context/company.md +46 -0
  59. package/context/engineering.md +63 -0
  60. package/context/project-template.md +71 -0
  61. package/context/trading.md +52 -0
  62. package/hooks/README.md +326 -0
  63. package/hooks/code-review/README.md +6 -0
  64. package/hooks/code-review/check-coverage.md +101 -0
  65. package/hooks/custom/README.md +6 -0
  66. package/hooks/custom/project-specific-hooks.md +273 -0
  67. package/hooks/deployment/README.md +6 -0
  68. package/hooks/deployment/health-check.md +102 -0
  69. package/hooks/deployment/pre-deploy-check.md +84 -0
  70. package/hooks/documentation/README.md +6 -0
  71. package/hooks/documentation/update-changelog.md +146 -0
  72. package/hooks/post-task/README.md +5 -0
  73. package/hooks/post-task/run-tests.md +61 -0
  74. package/hooks/pre-commit/README.md +6 -0
  75. package/hooks/pre-commit/format.md +63 -0
  76. package/hooks/pre-commit/lint.md +62 -0
  77. package/hooks/pre-commit/type-check.md +78 -0
  78. package/hooks/pre-task/README.md +6 -0
  79. package/hooks/pre-task/check-branch.md +48 -0
  80. package/hooks/pre-task/validate-environment.md +48 -0
  81. package/hooks/security-check/README.md +6 -0
  82. package/hooks/security-check/dependency-audit.md +85 -0
  83. package/hooks/security-check/secrets-scan.md +77 -0
  84. package/hooks/test-before-finish/README.md +6 -0
  85. package/hooks/test-before-finish/run-all-tests.md +128 -0
  86. package/index.js +69 -0
  87. package/knowledge/README.md +33 -0
  88. package/knowledge/ai-agents.md +74 -0
  89. package/knowledge/decision-making.md +73 -0
  90. package/knowledge/documentation.md +67 -0
  91. package/knowledge/engineering-principles.md +65 -0
  92. package/knowledge/product-discovery.md +68 -0
  93. package/knowledge/security-privacy.md +54 -0
  94. package/knowledge/testing-quality.md +63 -0
  95. package/package.json +63 -0
  96. package/patterns/README.md +7 -0
  97. package/prompts/README.md +208 -0
  98. package/prompts/architect/README.md +96 -0
  99. package/prompts/architect/design-system.md +140 -0
  100. package/prompts/debugger/README.md +96 -0
  101. package/prompts/debugger/diagnose-issue.md +141 -0
  102. package/prompts/developer/README.md +129 -0
  103. package/prompts/developer/fix-bug.md +136 -0
  104. package/prompts/developer/implement-feature.md +133 -0
  105. package/prompts/product-owner/README.md +116 -0
  106. package/prompts/product-owner/define-feature.md +145 -0
  107. package/prompts/reviewer/README.md +91 -0
  108. package/prompts/reviewer/code-review.md +129 -0
  109. package/prompts/support/README.md +154 -0
  110. package/prompts/support/resolve-issue.md +124 -0
  111. package/roles/README.md +6 -0
  112. package/roles/design-architect/README.md +98 -0
  113. package/roles/design-architect/accessibility/README.md +33 -0
  114. package/roles/design-architect/accessibility/checklists.md +29 -0
  115. package/roles/design-architect/accessibility/examples.md +35 -0
  116. package/roles/design-architect/checklists.md +76 -0
  117. package/roles/design-architect/component-library/README.md +35 -0
  118. package/roles/design-architect/component-library/checklists.md +29 -0
  119. package/roles/design-architect/component-library/examples.md +35 -0
  120. package/roles/design-architect/design-system/README.md +35 -0
  121. package/roles/design-architect/design-system/checklists.md +27 -0
  122. package/roles/design-architect/design-system/examples.md +41 -0
  123. package/roles/design-architect/examples/README.md +31 -0
  124. package/roles/design-architect/examples/checklists.md +26 -0
  125. package/roles/design-architect/examples/examples.md +46 -0
  126. package/roles/design-architect/examples.md +90 -0
  127. package/roles/design-architect/figma/README.md +33 -0
  128. package/roles/design-architect/figma/checklists.md +27 -0
  129. package/roles/design-architect/figma/examples.md +38 -0
  130. package/roles/design-architect/responsibilities.md +73 -0
  131. package/roles/design-architect/responsive/README.md +34 -0
  132. package/roles/design-architect/responsive/checklists.md +26 -0
  133. package/roles/design-architect/responsive/examples.md +39 -0
  134. package/roles/design-architect/role.md +129 -0
  135. package/roles/design-architect/skill-map.md +42 -0
  136. package/roles/design-architect/triggers.md +110 -0
  137. package/roles/design-architect/ui/README.md +36 -0
  138. package/roles/design-architect/ui/checklists.md +29 -0
  139. package/roles/design-architect/ui/examples.md +28 -0
  140. package/roles/design-architect/usability/README.md +34 -0
  141. package/roles/design-architect/usability/checklists.md +28 -0
  142. package/roles/design-architect/usability/examples.md +31 -0
  143. package/roles/design-architect/ux/README.md +36 -0
  144. package/roles/design-architect/ux/checklists.md +28 -0
  145. package/roles/design-architect/ux/examples.md +37 -0
  146. package/roles/design-architect/wireframes/README.md +34 -0
  147. package/roles/design-architect/wireframes/checklists.md +25 -0
  148. package/roles/design-architect/wireframes/examples.md +32 -0
  149. package/roles/design-architect/workflow.md +80 -0
  150. package/roles/devops/README.md +101 -0
  151. package/roles/devops/ansible/README.md +6 -0
  152. package/roles/devops/checklists.md +413 -0
  153. package/roles/devops/ci-cd/README.md +169 -0
  154. package/roles/devops/ci-cd/checklists.md +289 -0
  155. package/roles/devops/ci-cd/examples.md +429 -0
  156. package/roles/devops/cloud-platforms/README.md +109 -0
  157. package/roles/devops/cost-optimization/README.md +131 -0
  158. package/roles/devops/disaster-recovery/README.md +118 -0
  159. package/roles/devops/docker/README.md +6 -0
  160. package/roles/devops/examples/README.md +6 -0
  161. package/roles/devops/examples.md +775 -0
  162. package/roles/devops/github-actions/README.md +6 -0
  163. package/roles/devops/helm/README.md +6 -0
  164. package/roles/devops/infrastructure-as-code/README.md +160 -0
  165. package/roles/devops/infrastructure-as-code/checklists.md +124 -0
  166. package/roles/devops/jenkins/README.md +6 -0
  167. package/roles/devops/kubernetes/README.md +150 -0
  168. package/roles/devops/kubernetes/checklists.md +192 -0
  169. package/roles/devops/kubernetes/examples.md +189 -0
  170. package/roles/devops/monitoring/README.md +93 -0
  171. package/roles/devops/networking/README.md +83 -0
  172. package/roles/devops/performance/README.md +104 -0
  173. package/roles/devops/responsibilities.md +95 -0
  174. package/roles/devops/role.md +130 -0
  175. package/roles/devops/security/README.md +126 -0
  176. package/roles/devops/skill-map.md +162 -0
  177. package/roles/devops/terraform/README.md +6 -0
  178. package/roles/devops/triggers.md +241 -0
  179. package/roles/devops/workflow.md +197 -0
  180. package/roles/qa/README.md +16 -0
  181. package/roles/qa/api-testing/README.md +6 -0
  182. package/roles/qa/automation/README.md +6 -0
  183. package/roles/qa/checklists.md +24 -0
  184. package/roles/qa/examples/README.md +6 -0
  185. package/roles/qa/examples.md +27 -0
  186. package/roles/qa/performance/README.md +6 -0
  187. package/roles/qa/playwright/README.md +6 -0
  188. package/roles/qa/responsibilities.md +16 -0
  189. package/roles/qa/role.md +47 -0
  190. package/roles/qa/selenium/README.md +6 -0
  191. package/roles/qa/skill-map.md +14 -0
  192. package/roles/qa/triggers.md +10 -0
  193. package/roles/qa/workflow.md +9 -0
  194. package/roles/software-architect/README.md +16 -0
  195. package/roles/software-architect/agents/README.md +6 -0
  196. package/roles/software-architect/ai-architecture/README.md +6 -0
  197. package/roles/software-architect/aws/README.md +6 -0
  198. package/roles/software-architect/azure/README.md +6 -0
  199. package/roles/software-architect/caching/README.md +6 -0
  200. package/roles/software-architect/checklists.md +25 -0
  201. package/roles/software-architect/cloud/README.md +6 -0
  202. package/roles/software-architect/database-design/README.md +6 -0
  203. package/roles/software-architect/diagrams/README.md +6 -0
  204. package/roles/software-architect/distributed-systems/README.md +7 -0
  205. package/roles/software-architect/docker/README.md +6 -0
  206. package/roles/software-architect/event-driven/README.md +7 -0
  207. package/roles/software-architect/examples/README.md +6 -0
  208. package/roles/software-architect/examples.md +22 -0
  209. package/roles/software-architect/gcp/README.md +6 -0
  210. package/roles/software-architect/kubernetes/README.md +6 -0
  211. package/roles/software-architect/messaging/README.md +6 -0
  212. package/roles/software-architect/rag/README.md +7 -0
  213. package/roles/software-architect/responsibilities.md +17 -0
  214. package/roles/software-architect/role.md +46 -0
  215. package/roles/software-architect/scalability/README.md +6 -0
  216. package/roles/software-architect/security/README.md +6 -0
  217. package/roles/software-architect/skill-map.md +15 -0
  218. package/roles/software-architect/system-design/README.md +6 -0
  219. package/roles/software-architect/triggers.md +10 -0
  220. package/roles/software-architect/vector-db/README.md +6 -0
  221. package/roles/software-architect/workflow.md +9 -0
  222. package/roles/software-developer/README.md +116 -0
  223. package/roles/software-developer/api/README.md +365 -0
  224. package/roles/software-developer/api/checklist.md +131 -0
  225. package/roles/software-developer/api/examples.md +459 -0
  226. package/roles/software-developer/authentication/README.md +26 -0
  227. package/roles/software-developer/authentication/checklists.md +22 -0
  228. package/roles/software-developer/authentication/examples.md +32 -0
  229. package/roles/software-developer/authorization/README.md +26 -0
  230. package/roles/software-developer/authorization/checklists.md +21 -0
  231. package/roles/software-developer/authorization/examples.md +27 -0
  232. package/roles/software-developer/backend/README.md +26 -0
  233. package/roles/software-developer/backend/checklists.md +21 -0
  234. package/roles/software-developer/backend/examples.md +21 -0
  235. package/roles/software-developer/cache/README.md +25 -0
  236. package/roles/software-developer/cache/checklists.md +21 -0
  237. package/roles/software-developer/cache/examples.md +22 -0
  238. package/roles/software-developer/checklists.md +122 -0
  239. package/roles/software-developer/code-review/README.md +23 -0
  240. package/roles/software-developer/code-review/checklists.md +22 -0
  241. package/roles/software-developer/code-review/examples.md +20 -0
  242. package/roles/software-developer/database/README.md +27 -0
  243. package/roles/software-developer/database/checklists.md +21 -0
  244. package/roles/software-developer/database/examples.md +27 -0
  245. package/roles/software-developer/debugging/README.md +24 -0
  246. package/roles/software-developer/debugging/checklists.md +20 -0
  247. package/roles/software-developer/debugging/examples.md +28 -0
  248. package/roles/software-developer/examples/README.md +22 -0
  249. package/roles/software-developer/examples/checklists.md +8 -0
  250. package/roles/software-developer/examples/examples.md +25 -0
  251. package/roles/software-developer/examples.md +378 -0
  252. package/roles/software-developer/frontend/README.md +76 -0
  253. package/roles/software-developer/frontend/accessibility/README.md +136 -0
  254. package/roles/software-developer/frontend/accessibility/best-practices.md +368 -0
  255. package/roles/software-developer/frontend/code-quality/README.md +136 -0
  256. package/roles/software-developer/frontend/code-quality/best-practices.md +309 -0
  257. package/roles/software-developer/frontend/components/README.md +65 -0
  258. package/roles/software-developer/frontend/components/best-practices.md +273 -0
  259. package/roles/software-developer/frontend/debugging/README.md +149 -0
  260. package/roles/software-developer/frontend/debugging/best-practices.md +329 -0
  261. package/roles/software-developer/frontend/examples/README.md +19 -0
  262. package/roles/software-developer/frontend/examples/checklists.md +8 -0
  263. package/roles/software-developer/frontend/examples/examples.md +17 -0
  264. package/roles/software-developer/frontend/logging-observability/README.md +196 -0
  265. package/roles/software-developer/frontend/logging-observability/best-practices.md +430 -0
  266. package/roles/software-developer/frontend/performance/README.md +99 -0
  267. package/roles/software-developer/frontend/performance/best-practices.md +350 -0
  268. package/roles/software-developer/frontend/state-management/README.md +85 -0
  269. package/roles/software-developer/frontend/state-management/best-practices.md +344 -0
  270. package/roles/software-developer/frontend/testing/README.md +114 -0
  271. package/roles/software-developer/frontend/testing/best-practices.md +272 -0
  272. package/roles/software-developer/fullstack/README.md +25 -0
  273. package/roles/software-developer/fullstack/checklists.md +19 -0
  274. package/roles/software-developer/fullstack/examples.md +14 -0
  275. package/roles/software-developer/graphql/README.md +24 -0
  276. package/roles/software-developer/graphql/checklists.md +20 -0
  277. package/roles/software-developer/graphql/examples.md +24 -0
  278. package/roles/software-developer/integration-tests/README.md +25 -0
  279. package/roles/software-developer/integration-tests/checklists.md +20 -0
  280. package/roles/software-developer/integration-tests/examples.md +18 -0
  281. package/roles/software-developer/java/README.md +24 -0
  282. package/roles/software-developer/java/checklists.md +16 -0
  283. package/roles/software-developer/java/examples.md +22 -0
  284. package/roles/software-developer/javascript/README.md +24 -0
  285. package/roles/software-developer/javascript/checklists.md +15 -0
  286. package/roles/software-developer/javascript/examples.md +18 -0
  287. package/roles/software-developer/logging/README.md +105 -0
  288. package/roles/software-developer/logging/checklists.md +48 -0
  289. package/roles/software-developer/logging/examples.md +135 -0
  290. package/roles/software-developer/messaging/README.md +24 -0
  291. package/roles/software-developer/messaging/checklists.md +21 -0
  292. package/roles/software-developer/messaging/examples.md +26 -0
  293. package/roles/software-developer/microservices/README.md +25 -0
  294. package/roles/software-developer/microservices/checklists.md +21 -0
  295. package/roles/software-developer/microservices/examples.md +21 -0
  296. package/roles/software-developer/node/README.md +25 -0
  297. package/roles/software-developer/node/checklists.md +15 -0
  298. package/roles/software-developer/node/examples.md +15 -0
  299. package/roles/software-developer/nosql/README.md +24 -0
  300. package/roles/software-developer/nosql/checklists.md +21 -0
  301. package/roles/software-developer/nosql/examples.md +20 -0
  302. package/roles/software-developer/observability/README.md +25 -0
  303. package/roles/software-developer/observability/checklists.md +21 -0
  304. package/roles/software-developer/observability/examples.md +22 -0
  305. package/roles/software-developer/performance/README.md +26 -0
  306. package/roles/software-developer/performance/checklists.md +20 -0
  307. package/roles/software-developer/performance/examples.md +20 -0
  308. package/roles/software-developer/python/README.md +25 -0
  309. package/roles/software-developer/python/checklists.md +15 -0
  310. package/roles/software-developer/python/examples.md +17 -0
  311. package/roles/software-developer/react/README.md +24 -0
  312. package/roles/software-developer/react/checklists.md +15 -0
  313. package/roles/software-developer/react/examples.md +22 -0
  314. package/roles/software-developer/refactoring/README.md +23 -0
  315. package/roles/software-developer/refactoring/checklists.md +21 -0
  316. package/roles/software-developer/refactoring/examples.md +11 -0
  317. package/roles/software-developer/responsibilities.md +58 -0
  318. package/roles/software-developer/role.md +127 -0
  319. package/roles/software-developer/skill-map.md +88 -0
  320. package/roles/software-developer/springboot/README.md +25 -0
  321. package/roles/software-developer/springboot/checklists.md +15 -0
  322. package/roles/software-developer/springboot/examples.md +21 -0
  323. package/roles/software-developer/sql/README.md +24 -0
  324. package/roles/software-developer/sql/checklists.md +22 -0
  325. package/roles/software-developer/sql/examples.md +20 -0
  326. package/roles/software-developer/testing/README.md +25 -0
  327. package/roles/software-developer/testing/checklists.md +21 -0
  328. package/roles/software-developer/testing/examples.md +19 -0
  329. package/roles/software-developer/triggers.md +550 -0
  330. package/roles/software-developer/typescript/README.md +25 -0
  331. package/roles/software-developer/typescript/checklists.md +15 -0
  332. package/roles/software-developer/typescript/examples.md +18 -0
  333. package/roles/software-developer/unit-tests/README.md +24 -0
  334. package/roles/software-developer/unit-tests/checklists.md +19 -0
  335. package/roles/software-developer/unit-tests/examples.md +22 -0
  336. package/roles/software-developer/workflow.md +196 -0
  337. package/roles/sre/README.md +16 -0
  338. package/roles/sre/alerts/README.md +6 -0
  339. package/roles/sre/availability/README.md +6 -0
  340. package/roles/sre/chaos/README.md +6 -0
  341. package/roles/sre/checklists.md +24 -0
  342. package/roles/sre/examples/README.md +6 -0
  343. package/roles/sre/examples.md +19 -0
  344. package/roles/sre/observability/README.md +6 -0
  345. package/roles/sre/reliability/README.md +6 -0
  346. package/roles/sre/responsibilities.md +16 -0
  347. package/roles/sre/role.md +46 -0
  348. package/roles/sre/skill-map.md +14 -0
  349. package/roles/sre/slos/README.md +6 -0
  350. package/roles/sre/triggers.md +10 -0
  351. package/roles/sre/workflow.md +9 -0
  352. package/roles/support-engineer/README.md +16 -0
  353. package/roles/support-engineer/checklists.md +24 -0
  354. package/roles/support-engineer/datadog/README.md +6 -0
  355. package/roles/support-engineer/examples/README.md +6 -0
  356. package/roles/support-engineer/examples.md +17 -0
  357. package/roles/support-engineer/incident-response/README.md +6 -0
  358. package/roles/support-engineer/kubernetes/README.md +6 -0
  359. package/roles/support-engineer/linux/README.md +6 -0
  360. package/roles/support-engineer/logs/README.md +6 -0
  361. package/roles/support-engineer/monitoring/README.md +6 -0
  362. package/roles/support-engineer/networking/README.md +6 -0
  363. package/roles/support-engineer/newrelic/README.md +6 -0
  364. package/roles/support-engineer/postmortem/README.md +6 -0
  365. package/roles/support-engineer/production/README.md +6 -0
  366. package/roles/support-engineer/responsibilities.md +16 -0
  367. package/roles/support-engineer/role.md +47 -0
  368. package/roles/support-engineer/root-cause-analysis/README.md +6 -0
  369. package/roles/support-engineer/runbooks/README.md +6 -0
  370. package/roles/support-engineer/skill-map.md +14 -0
  371. package/roles/support-engineer/splunk/README.md +6 -0
  372. package/roles/support-engineer/triggers.md +10 -0
  373. package/roles/support-engineer/troubleshooting/README.md +6 -0
  374. package/roles/support-engineer/workflow.md +9 -0
  375. package/setup.sh +204 -0
  376. package/skills/.claude/README.md +7 -0
  377. package/skills/README.md +21 -0
  378. package/skills/ai-agents/README.md +207 -0
  379. package/skills/ai-agents/examples.md +335 -0
  380. package/skills/ai-agents/skill.md +392 -0
  381. package/skills/architecture/README.md +198 -0
  382. package/skills/architecture/examples.md +316 -0
  383. package/skills/architecture/skill.md +189 -0
  384. package/skills/design-architecture/README.md +107 -0
  385. package/skills/design-architecture/examples.md +84 -0
  386. package/skills/design-architecture/skill.md +192 -0
  387. package/skills/devops/README.md +177 -0
  388. package/skills/devops/examples.md +376 -0
  389. package/skills/devops/skill.md +210 -0
  390. package/skills/documentation/README.md +182 -0
  391. package/skills/documentation/examples.md +364 -0
  392. package/skills/documentation/skill.md +200 -0
  393. package/skills/performance/README.md +177 -0
  394. package/skills/performance/examples.md +376 -0
  395. package/skills/performance/skill.md +199 -0
  396. package/skills/qa/README.md +106 -0
  397. package/skills/qa/examples.md +84 -0
  398. package/skills/qa/skill.md +384 -0
  399. package/skills/security/README.md +108 -0
  400. package/skills/security/examples.md +85 -0
  401. package/skills/security/skill.md +223 -0
  402. package/skills/software-development/README.md +239 -0
  403. package/skills/software-development/assessment.md +0 -0
  404. package/skills/software-development/checklists.md +0 -0
  405. package/skills/software-development/examples.md +375 -0
  406. package/skills/software-development/prompts.md +0 -0
  407. package/skills/software-development/skill.md +390 -0
  408. package/skills/software-development/templates/README.md +7 -0
  409. package/skills/software-development/templates/api-development.md +0 -0
  410. package/skills/software-development/templates/bug-fix.md +0 -0
  411. package/skills/software-development/templates/code-review.md +0 -0
  412. package/skills/software-development/templates/feature-implementation.md +0 -0
  413. package/skills/software-development/templates/llm-integration.md +0 -0
  414. package/skills/software-development/templates/performance-review.md +0 -0
  415. package/skills/software-development/templates/security-review.md +0 -0
  416. package/skills/software-development/templates/test-generation.md +0 -0
  417. package/skills/software-development/tools.md +0 -0
  418. package/skills/software-development/workflows.md +0 -0
  419. package/skills/sre/README.md +107 -0
  420. package/skills/sre/examples.md +379 -0
  421. package/skills/sre/skill.md +256 -0
  422. package/skills/support-engineering/README.md +107 -0
  423. package/skills/support-engineering/examples.md +85 -0
  424. package/skills/support-engineering/skill.md +103 -0
@@ -0,0 +1,154 @@
1
+ # Support Prompts
2
+
3
+ Reusable prompts for customer support and issue resolution.
4
+
5
+ ## Available Prompts
6
+
7
+ ### [resolve-issue.md](resolve-issue.md)
8
+
9
+ **Use when:** Helping customers resolve issues
10
+
11
+ **Covers:**
12
+ - Issue description
13
+ - Customer context
14
+ - Troubleshooting info
15
+ - What customer tried
16
+ - System status
17
+ - Solution/resolution
18
+
19
+ **Good for:**
20
+ - Customer support
21
+ - Technical troubleshooting
22
+ - Help documentation
23
+ - Issue resolution
24
+
25
+ ## Using Support Prompts
26
+
27
+ ### Support Process
28
+
29
+ 1. **Listen** - Understand customer issue
30
+ 2. **Gather info** - Environment, steps, errors
31
+ 3. **Troubleshoot** - Ask diagnostic questions
32
+ 4. **Root cause** - Identify underlying issue
33
+ 5. **Solution** - Provide resolution
34
+ 6. **Verify** - Confirm issue is fixed
35
+ 7. **Prevent** - Advise on prevention
36
+ 8. **Document** - Create help article if needed
37
+
38
+ ## What Gets Delivered
39
+
40
+ ✓ Issue understood
41
+ ✓ Root cause identified
42
+ ✓ Solution provided
43
+ ✓ Clear instructions
44
+ ✓ Follow-up plan
45
+ ✓ Prevention advice
46
+
47
+ ## Quality Gates
48
+
49
+ Support must provide:
50
+
51
+ ✓ **Understanding** - Issue fully understood
52
+ ✓ **Solution** - Fix that works
53
+ ✓ **Clarity** - Instructions easy to follow
54
+ ✓ **Empathy** - Respectful, patient tone
55
+ ✓ **Documentation** - Help article created
56
+
57
+ ## Support Checklist
58
+
59
+ - [ ] Understand the issue
60
+ - [ ] Gather all information
61
+ - [ ] Identify root cause
62
+ - [ ] Provide solution
63
+ - [ ] Verify it works
64
+ - [ ] Clear instructions given
65
+ - [ ] Prevention advice provided
66
+ - [ ] Follow-up scheduled
67
+ - [ ] Help doc created
68
+ - [ ] Customer satisfied
69
+
70
+ ## Communication Guidelines
71
+
72
+ ### Do's
73
+
74
+ - ✓ Ask clarifying questions
75
+ - ✓ Explain in simple terms
76
+ - ✓ Step-by-step instructions
77
+ - ✓ Show understanding
78
+ - ✓ Take accountability
79
+ - ✓ Follow up
80
+ - ✓ Document for future
81
+
82
+ ### Don'ts
83
+
84
+ - ✗ Use technical jargon
85
+ - ✗ Blame the customer
86
+ - ✗ Rush to judgment
87
+ - ✗ Assume too much
88
+ - ✗ Ignore follow-ups
89
+ - ✗ Create one-time fixes
90
+ - ✗ Lack empathy
91
+
92
+ ## Issue Categories
93
+
94
+ ### Technical Issues
95
+ - Bug reproduction
96
+ - Error diagnosis
97
+ - Configuration help
98
+ - Integration support
99
+
100
+ ### Account Issues
101
+ - Login problems
102
+ - Password resets
103
+ - Billing questions
104
+ - Access issues
105
+
106
+ ### Usage Questions
107
+ - Feature explanation
108
+ - Best practices
109
+ - Workflow help
110
+ - Documentation
111
+
112
+ ## Escalation Criteria
113
+
114
+ Escalate to engineering when:
115
+ - Bug in product
116
+ - Data loss/corruption
117
+ - Security concern
118
+ - Feature request
119
+ - Complex investigation needed
120
+
121
+ ## Documentation
122
+
123
+ Create help articles for:
124
+ - Common issues
125
+ - Workarounds
126
+ - Setup guides
127
+ - Troubleshooting steps
128
+ - FAQ entries
129
+
130
+ ## Best Practices
131
+
132
+ ### Effective Support
133
+
134
+ - Listen first, suggest second
135
+ - Validate customer concerns
136
+ - Be transparent about issues
137
+ - Provide options
138
+ - Follow up proactively
139
+ - Document thoroughly
140
+ - Learn from issues
141
+ - Improve processes
142
+
143
+ ### Response Time
144
+
145
+ - Critical issues: < 30 minutes
146
+ - High priority: < 1 hour
147
+ - Medium: < 4 hours
148
+ - Low: < 24 hours
149
+
150
+ ## Related Documentation
151
+
152
+ - See `../README.md` for overview
153
+ - Check hooks/ for troubleshooting automation
154
+ - Review commands/ for self-service options
@@ -0,0 +1,124 @@
1
+ # Resolve Support Issue Prompt
2
+
3
+ **Role:** Support
4
+ **Type:** Customer Support Resolution
5
+ **Context Needed:** Issue description, customer context, logs, system status
6
+
7
+ ## Template
8
+
9
+ ```
10
+ Help customer resolve: [Issue Title]
11
+
12
+ ## Customer Issue
13
+ [What the customer reports]
14
+
15
+ ## Customer Context
16
+ - Account: [Account/user info]
17
+ - Usage: [How they use it]
18
+ - Affected since: [When it started]
19
+ - Impact: [What's blocked]
20
+
21
+ ## Troubleshooting Info
22
+ - Logs: [Relevant logs]
23
+ - Error message: [Exact error]
24
+ - Environment: [Browser/OS/version]
25
+ - Steps to reproduce: [Steps]
26
+
27
+ ## What I've Tried
28
+ [What customer already tried]
29
+
30
+ ## System Status
31
+ [Any known issues, deployments, etc.]
32
+
33
+ ## Expected Deliverables
34
+ - Root cause identified
35
+ - Solution/workaround provided
36
+ - Next steps for customer
37
+ - Prevention advice
38
+ - Documentation (if needed)
39
+ ```
40
+
41
+ ## When to Use
42
+
43
+ - Responding to customer issues
44
+ - Troubleshooting problems
45
+ - Providing technical support
46
+ - Creating help documentation
47
+ - Resolving service issues
48
+
49
+ ## Required Context
50
+
51
+ - Complete issue description
52
+ - Steps to reproduce
53
+ - Customer environment details
54
+ - Error messages/logs
55
+ - What customer tried
56
+ - Expected behavior
57
+
58
+ ## Expected Output
59
+
60
+ - ✓ Issue understood
61
+ - ✓ Root cause found
62
+ - ✓ Solution provided
63
+ - ✓ Clear instructions
64
+ - ✓ Follow-up plan
65
+ - ✓ Preventive advice
66
+
67
+ ## Quality Gates
68
+
69
+ ```
70
+ Understanding:
71
+ ✓ Issue fully understood
72
+ ✓ Customer context clear
73
+ ✓ All details gathered
74
+
75
+ Resolution:
76
+ ✓ Solution works
77
+ ✓ Instructions clear
78
+ ✓ Expected outcome stated
79
+
80
+ Communication:
81
+ ✓ Language simple
82
+ ✓ Non-technical jargon
83
+ ✓ Empathetic tone
84
+ ```
85
+
86
+ ## Example Usage
87
+
88
+ ```
89
+ Help customer: Cannot export data
90
+
91
+ ## Customer Issue
92
+ Customer cannot export CSV of their data. Button greyed out.
93
+
94
+ ## Customer Context
95
+ - Account: Enterprise plan
96
+ - Usage: 2 years
97
+ - Affected since: Yesterday after upgrade
98
+ - Impact: Weekly reporting blocked
99
+
100
+ ## Troubleshooting Info
101
+ Error: "Export feature unavailable"
102
+ Browser: Chrome 120 on macOS
103
+ Steps: Click Settings → Export → CSV
104
+
105
+ ## What I've Tried
106
+ - Refreshed page
107
+ - Cleared cache
108
+ - Different browser
109
+
110
+ ## System Status
111
+ Deployed new export feature yesterday
112
+ Some users reporting issues with large datasets
113
+ ```
114
+
115
+ ## Tips
116
+
117
+ - Ask clarifying questions
118
+ - Gather all information first
119
+ - Verify understanding
120
+ - Provide step-by-step instructions
121
+ - Use screenshots/videos
122
+ - Explain the why
123
+ - Prevent future issues
124
+ - Be patient and empathetic
@@ -0,0 +1,6 @@
1
+ # Roles
2
+
3
+ Use this folder for role operating models.
4
+
5
+ Each role should explain responsibilities, decision posture, workflows,
6
+ triggers, skill routing, checklists, and examples.
@@ -0,0 +1,98 @@
1
+ # Design Architect Role
2
+
3
+ This packet defines how an AI-supported design architect should shape usable,
4
+ accessible, coherent product experiences from early framing through developer
5
+ handoff. It focuses on design systems, interface structure, interaction models,
6
+ visual hierarchy, and evidence-based design decisions.
7
+
8
+ ## Contract
9
+
10
+ Use this role when the work involves:
11
+
12
+ - Designing or redesigning product screens, flows, navigation, or layouts.
13
+ - Creating design systems, component libraries, tokens, or pattern guidance.
14
+ - Reviewing UI quality, accessibility, usability, or visual consistency.
15
+ - Producing wireframes, design specs, prototypes, or implementation-ready notes.
16
+ - Translating product goals and user needs into structured interface decisions.
17
+
18
+ The role must always preserve these priorities:
19
+
20
+ 1. User clarity.
21
+ 2. Accessibility.
22
+ 3. Consistency.
23
+ 4. Technical feasibility.
24
+ 5. Scalability.
25
+ 6. Visual quality.
26
+ 7. Clear handoff.
27
+
28
+ ## Files
29
+
30
+ | File or folder | Meaning |
31
+ | --- | --- |
32
+ | `role.md` | Core behavior, mindset, constraints, and success criteria. |
33
+ | `responsibilities.md` | Ownership areas for design strategy, systems, review, and handoff. |
34
+ | `workflow.md` | Canonical lifecycle from intake through validation and delivery. |
35
+ | `triggers.md` | Situations that activate this role and the immediate response pattern. |
36
+ | `skill-map.md` | Skills to load or reference for common design architecture work. |
37
+ | `checklists.md` | Reusable quality gates for screens, systems, accessibility, and handoff. |
38
+ | `examples.md` | Example decisions, reviews, artifacts, and handoff notes. |
39
+ | `accessibility/` | Inclusive design and WCAG-oriented design checks. |
40
+ | `component-library/` | Component inventory, variants, states, and governance. |
41
+ | `design-system/` | Tokens, patterns, foundations, documentation, and adoption. |
42
+ | `figma/` | Figma file structure, naming, components, and handoff hygiene. |
43
+ | `responsive/` | Breakpoints, adaptive layouts, input modes, and device checks. |
44
+ | `ui/` | Visual design, layout, hierarchy, typography, color, and polish. |
45
+ | `usability/` | Task success, friction reduction, research, and validation. |
46
+ | `ux/` | Flows, information architecture, interaction models, and journey design. |
47
+ | `wireframes/` | Low-fidelity structure, content priority, and flow exploration. |
48
+ | `examples/` | Larger scenario templates and example design artifacts. |
49
+
50
+ ## Loading Order
51
+
52
+ When applying this role, load files in this order:
53
+
54
+ 1. `role.md` to establish behavior and constraints.
55
+ 2. `triggers.md` if the request type is ambiguous.
56
+ 3. `workflow.md` for the lifecycle stage.
57
+ 4. `skill-map.md` to select supporting skills.
58
+ 5. `checklists.md` for execution gates.
59
+ 6. Topic folders such as `design-system/`, `ui/`, `ux/`, `accessibility/`,
60
+ `responsive/`, `component-library/`, `figma/`, or `wireframes/` when the
61
+ task touches that area.
62
+ 7. `examples.md` when artifact shape or review style needs concrete reference.
63
+
64
+ For product work, also load `context/communication.md`, relevant project or
65
+ brand context, and frontend engineering guidance when implementation constraints
66
+ matter.
67
+
68
+ ## Topic Folders
69
+
70
+ Each topic folder follows the same mini-packet shape:
71
+
72
+ - `README.md` explains scope, standards, and related folders.
73
+ - `checklists.md` lists design, review, validation, and handoff gates.
74
+ - `examples.md` provides starter examples or templates.
75
+
76
+ Load only the topic packets that match the current task. A design system request
77
+ might load `design-system/`, `component-library/`, `accessibility/`, and
78
+ `figma/`; a mobile redesign might load `ux/`, `ui/`, `responsive/`,
79
+ `usability/`, and `accessibility/`.
80
+
81
+ ## Completion Standard
82
+
83
+ A design architecture task is complete only when:
84
+
85
+ - The user problem and success criteria are explicit.
86
+ - The proposed experience has clear hierarchy, states, and flows.
87
+ - Accessibility is considered from the design stage.
88
+ - The design can be implemented with the project's platform constraints.
89
+ - Reusable patterns and components are identified.
90
+ - Trade-offs, open questions, and validation needs are documented.
91
+ - Handoff notes are specific enough for design, product, and engineering partners.
92
+
93
+ ## Related Repository Areas
94
+
95
+ - `skills/design-architecture/` for core design architecture competency.
96
+ - `roles/software-developer/frontend/` for frontend implementation constraints.
97
+ - `context/communication.md` for stakeholder communication norms.
98
+ - `STYLE_GUIDE.md` for repository writing style.
@@ -0,0 +1,33 @@
1
+ # Accessibility Design
2
+
3
+ Accessibility design ensures product experiences are perceivable, operable,
4
+ understandable, and robust before implementation begins.
5
+
6
+ ## Scope
7
+
8
+ - WCAG-oriented design requirements.
9
+ - Contrast, typography, focus, keyboard, and screen reader behavior.
10
+ - Inclusive interaction patterns for forms, dialogs, navigation, media, and data.
11
+ - Reduced motion, zoom, text scaling, and multiple input methods.
12
+
13
+ ## Standards
14
+
15
+ - Target WCAG AA unless the project defines a stricter standard.
16
+ - Do not rely on color alone for meaning.
17
+ - Design visible focus states for every interactive element.
18
+ - Specify labels, descriptions, error messages, and announcements.
19
+ - Include keyboard and assistive technology behavior in component specs.
20
+
21
+ ## Deliverables
22
+
23
+ - Accessibility review notes.
24
+ - WCAG mapping for high-risk issues.
25
+ - Component accessibility requirements.
26
+ - Keyboard and focus behavior notes.
27
+ - Verification plan for automated and manual checks.
28
+
29
+ ## Related Guidance
30
+
31
+ - `../component-library/` for component-level behavior.
32
+ - `../ui/` for contrast, hierarchy, typography, and motion.
33
+ - `../responsive/` for zoom, text scaling, and device variation.
@@ -0,0 +1,29 @@
1
+ # Accessibility Checklists
2
+
3
+ ## Design Checklist
4
+
5
+ - [ ] Text contrast meets WCAG AA or project standard.
6
+ - [ ] Color is never the only signal for status or validation.
7
+ - [ ] Interactive elements have visible focus states.
8
+ - [ ] Touch targets and click targets are appropriately sized.
9
+ - [ ] Headings and labels communicate structure.
10
+ - [ ] Form errors include explanation and recovery.
11
+ - [ ] Dialogs define focus entry, focus trap, and close behavior.
12
+ - [ ] Motion is optional or respects reduced-motion preferences.
13
+ - [ ] Content remains usable at 200% zoom and with larger text.
14
+
15
+ ## Component Checklist
16
+
17
+ - [ ] Component has an accessible name.
18
+ - [ ] Required ARIA is specified only when native semantics are insufficient.
19
+ - [ ] Keyboard behavior is documented.
20
+ - [ ] Disabled and loading states communicate availability.
21
+ - [ ] Error and success states are not color-only.
22
+ - [ ] Screen reader announcements are defined for dynamic changes.
23
+
24
+ ## Review Checklist
25
+
26
+ - [ ] Findings include severity and user impact.
27
+ - [ ] Fixes are specific enough for implementation.
28
+ - [ ] Automated checks are paired with manual keyboard and screen reader checks.
29
+ - [ ] Any unresolved accessibility risk is documented.
@@ -0,0 +1,35 @@
1
+ # Accessibility Examples
2
+
3
+ ## Form Error Pattern
4
+
5
+ ```text
6
+ Input: Email address
7
+ Error text: Enter an email address in the format name@example.com.
8
+ Behavior:
9
+ - Error appears below the field.
10
+ - Field references the error with accessible description.
11
+ - Summary at top links to the field after failed submit.
12
+ - Focus moves to the summary only after submit, not while typing.
13
+ ```
14
+
15
+ ## Dialog Focus Pattern
16
+
17
+ ```text
18
+ On open:
19
+ - Focus moves to dialog title or first meaningful control.
20
+ - Background content is inert.
21
+
22
+ Inside dialog:
23
+ - Tab cycles through interactive elements.
24
+ - Escape closes unless the action is destructive and needs explicit choice.
25
+
26
+ On close:
27
+ - Focus returns to the element that opened the dialog.
28
+ ```
29
+
30
+ ## Status Pattern
31
+
32
+ Use text and visual treatment together:
33
+
34
+ - Good: `Failed` with error color and error icon.
35
+ - Avoid: red dot with no text label.
@@ -0,0 +1,76 @@
1
+ # Design Architect Checklists
2
+
3
+ ## Intake Checklist
4
+
5
+ - [ ] User audience and primary job are identified.
6
+ - [ ] Product goal and success metric are stated.
7
+ - [ ] Deliverable and fidelity are clear.
8
+ - [ ] Platform, device, brand, timeline, and technical constraints are known.
9
+ - [ ] Existing components, tokens, patterns, and content are considered.
10
+ - [ ] Assumptions and open questions are documented.
11
+
12
+ ## UX and Flow Checklist
13
+
14
+ - [ ] Primary path is clear and short.
15
+ - [ ] Secondary paths do not compete with the main task.
16
+ - [ ] Entry points and exits are defined.
17
+ - [ ] Empty, loading, error, success, disabled, and permission states are included.
18
+ - [ ] Forms prevent avoidable errors and explain recovery.
19
+ - [ ] Navigation labels match user language.
20
+ - [ ] Destructive or irreversible actions have appropriate confirmation.
21
+
22
+ ## UI Quality Checklist
23
+
24
+ - [ ] Visual hierarchy makes the next action obvious.
25
+ - [ ] Typography is readable and consistently scaled.
26
+ - [ ] Spacing and alignment follow a repeatable system.
27
+ - [ ] Color supports meaning without being the only signal.
28
+ - [ ] Actions are visually differentiated by importance.
29
+ - [ ] Icons are recognizable or labeled.
30
+ - [ ] Motion has a functional purpose and respects reduced-motion needs.
31
+
32
+ ## Accessibility Checklist
33
+
34
+ - [ ] Text contrast meets WCAG AA or the project standard.
35
+ - [ ] Focus order and keyboard behavior are defined.
36
+ - [ ] Controls have accessible names and visible labels where needed.
37
+ - [ ] Error messages are specific and associated with the related fields.
38
+ - [ ] Non-text content has alt text or is marked decorative.
39
+ - [ ] Layout works at 200% zoom and with text scaling.
40
+ - [ ] Color, shape, text, or iconography provide redundant meaning for status.
41
+
42
+ ## Responsive Checklist
43
+
44
+ - [ ] Small, medium, large, and high-density layouts are considered.
45
+ - [ ] Breakpoints are based on content behavior.
46
+ - [ ] Touch targets are large enough on touch devices.
47
+ - [ ] Navigation adapts without hiding critical actions.
48
+ - [ ] Tables, charts, and dense controls have mobile strategies.
49
+ - [ ] Content does not overlap or truncate critical information.
50
+
51
+ ## Design System Checklist
52
+
53
+ - [ ] Tokens cover color, type, spacing, radius, elevation, and motion.
54
+ - [ ] Components include anatomy, variants, states, and usage guidance.
55
+ - [ ] Accessibility behavior is documented per component.
56
+ - [ ] Naming is consistent across design and code.
57
+ - [ ] Exceptions and contribution rules are defined.
58
+ - [ ] Adoption and migration path are practical for teams.
59
+
60
+ ## Handoff Checklist
61
+
62
+ - [ ] Component mapping is documented.
63
+ - [ ] Layout, spacing, sizing, and responsive rules are specified.
64
+ - [ ] Interaction states and transitions are included.
65
+ - [ ] Copy, validation, and error behavior are clear.
66
+ - [ ] Accessibility requirements are explicit.
67
+ - [ ] Analytics or success measurement needs are noted.
68
+ - [ ] Risks, assumptions, and open questions are visible.
69
+
70
+ ## Review Checklist
71
+
72
+ - [ ] Findings are prioritized by user and system impact.
73
+ - [ ] Each critique explains the issue, why it matters, and a specific fix.
74
+ - [ ] Feedback avoids vague taste language.
75
+ - [ ] Recommendations fit current constraints.
76
+ - [ ] Required validation or engineering checks are named.
@@ -0,0 +1,35 @@
1
+ # Component Library
2
+
3
+ A component library defines reusable interface building blocks, their variants,
4
+ states, behavior, accessibility requirements, and usage rules.
5
+
6
+ ## Scope
7
+
8
+ - Component inventory and naming.
9
+ - Anatomy, slots, variants, and states.
10
+ - Composition rules and responsive behavior.
11
+ - Accessibility and interaction specifications.
12
+ - Adoption, contribution, and deprecation guidance.
13
+
14
+ ## Standards
15
+
16
+ - Components should solve repeated product needs.
17
+ - Each component needs a clear purpose and usage boundary.
18
+ - Variants should be meaningful, not cosmetic drift.
19
+ - States must include default, hover, focus, active, disabled, loading, error,
20
+ success, empty, and selected when relevant.
21
+ - Design and code names should align whenever possible.
22
+
23
+ ## Deliverables
24
+
25
+ - Component inventory.
26
+ - Component specs.
27
+ - Variant and state matrix.
28
+ - Usage guidance and anti-patterns.
29
+ - Migration or contribution notes.
30
+
31
+ ## Related Guidance
32
+
33
+ - `../design-system/` for tokens and foundations.
34
+ - `../accessibility/` for inclusive behavior.
35
+ - `../figma/` for component sets and handoff.
@@ -0,0 +1,29 @@
1
+ # Component Library Checklists
2
+
3
+ ## Component Definition Checklist
4
+
5
+ - [ ] Purpose is clear.
6
+ - [ ] Anatomy and slots are named.
7
+ - [ ] Props or configuration options are documented conceptually.
8
+ - [ ] Variants are limited and meaningful.
9
+ - [ ] Required states are specified.
10
+ - [ ] Content rules and truncation behavior are defined.
11
+ - [ ] Accessibility behavior is documented.
12
+ - [ ] Responsive behavior is documented.
13
+ - [ ] Usage examples and anti-patterns are included.
14
+
15
+ ## Library Governance Checklist
16
+
17
+ - [ ] Component owner or review path is identified.
18
+ - [ ] Contribution criteria are defined.
19
+ - [ ] Deprecation and migration process exists.
20
+ - [ ] Design and code naming are aligned.
21
+ - [ ] New components are justified by repeated need.
22
+ - [ ] Documentation is easy to find and update.
23
+
24
+ ## Review Checklist
25
+
26
+ - [ ] Component does not duplicate an existing pattern.
27
+ - [ ] Variants do not encode one-off product requests.
28
+ - [ ] States are complete enough for implementation.
29
+ - [ ] Accessibility requirements are testable.
@@ -0,0 +1,35 @@
1
+ # Component Library Examples
2
+
3
+ ## Component Spec Template
4
+
5
+ ```text
6
+ Component:
7
+ Purpose:
8
+ Anatomy:
9
+ Variants:
10
+ States:
11
+ Content rules:
12
+ Interactions:
13
+ Responsive behavior:
14
+ Accessibility:
15
+ Do:
16
+ Do not:
17
+ Related components:
18
+ ```
19
+
20
+ ## Example: Empty State
21
+
22
+ ```text
23
+ Component: EmptyState
24
+ Purpose: Explain why content is absent and guide the next useful action.
25
+ Variants: No data, no results, permission blocked, first use.
26
+ Anatomy: Illustration or icon, title, body, primary action, optional secondary action.
27
+ States: Default, loading replacement, compact.
28
+ Accessibility: Icon is decorative unless it conveys meaning. Title is announced as part of page structure.
29
+ Do not: Use as a generic error state.
30
+ ```
31
+
32
+ ## Variant Rule
33
+
34
+ Add a new variant when the component needs a distinct behavior or semantic role.
35
+ Do not add a variant only to preserve a one-off visual tweak.
@@ -0,0 +1,35 @@
1
+ # Design System
2
+
3
+ A design system is the shared product language for foundations, components,
4
+ patterns, documentation, and governance.
5
+
6
+ ## Scope
7
+
8
+ - Foundations: color, type, spacing, radius, elevation, iconography, motion.
9
+ - Tokens and theming.
10
+ - Component and pattern standards.
11
+ - Documentation and contribution workflows.
12
+ - Adoption, migration, and governance.
13
+
14
+ ## Standards
15
+
16
+ - Tokens should describe intent, not only raw values.
17
+ - Components should map to real product use cases.
18
+ - Documentation should explain when to use a pattern and when not to.
19
+ - Accessibility must be built into foundations and components.
20
+ - Governance should make reuse easier than reinvention.
21
+
22
+ ## Deliverables
23
+
24
+ - System audit.
25
+ - Token model.
26
+ - Component inventory.
27
+ - Pattern library outline.
28
+ - Governance model.
29
+ - Adoption and migration plan.
30
+
31
+ ## Related Guidance
32
+
33
+ - `../component-library/` for component specs.
34
+ - `../figma/` for design asset structure.
35
+ - `../accessibility/` for inclusive foundations.