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.
- package/README.md +146 -0
- package/agents/README.md +168 -0
- package/agents/SKILL.md +633 -0
- package/agents/architect/AGENT.md +44 -0
- package/agents/architect/README.md +5 -0
- package/agents/coder/AGENT.md +43 -0
- package/agents/coder/README.md +5 -0
- package/agents/debugger/AGENT.md +42 -0
- package/agents/debugger/README.md +6 -0
- package/agents/devops/AGENT.md +43 -0
- package/agents/devops/README.md +5 -0
- package/agents/documentation/AGENT.md +45 -0
- package/agents/documentation/README.md +5 -0
- package/agents/examples.md +550 -0
- package/agents/performance/AGENT.md +45 -0
- package/agents/performance/README.md +6 -0
- package/agents/planner/AGENT.md +44 -0
- package/agents/planner/README.md +6 -0
- package/agents/product-owner/AGENT.md +46 -0
- package/agents/product-owner/README.md +6 -0
- package/agents/refactorer/AGENT.md +44 -0
- package/agents/refactorer/README.md +6 -0
- package/agents/release-manager/AGENT.md +45 -0
- package/agents/release-manager/README.md +6 -0
- package/agents/researcher/AGENT.md +44 -0
- package/agents/researcher/README.md +6 -0
- package/agents/reviewer/AGENT.md +43 -0
- package/agents/reviewer/README.md +6 -0
- package/agents/security/AGENT.md +46 -0
- package/agents/security/README.md +6 -0
- package/agents/support/AGENT.md +45 -0
- package/agents/support/README.md +6 -0
- package/agents/tester/AGENT.md +46 -0
- package/agents/tester/README.md +5 -0
- package/bin/cli.js +186 -0
- package/commands/README.md +266 -0
- package/commands/build.md +135 -0
- package/commands/clean.md +126 -0
- package/commands/deploy-prod.md +171 -0
- package/commands/deploy-staging.md +147 -0
- package/commands/deps.md +169 -0
- package/commands/dev.md +132 -0
- package/commands/format.md +142 -0
- package/commands/lint.md +125 -0
- package/commands/migrate.md +159 -0
- package/commands/release.md +183 -0
- package/commands/rollback.md +152 -0
- package/commands/seed.md +178 -0
- package/commands/setup.md +109 -0
- package/commands/test.md +134 -0
- package/commands/validate.md +147 -0
- package/context/README.md +7 -0
- package/context/aem.md +47 -0
- package/context/architecture.md +51 -0
- package/context/bullminder.md +57 -0
- package/context/coding-style.md +42 -0
- package/context/communication.md +53 -0
- package/context/company.md +46 -0
- package/context/engineering.md +63 -0
- package/context/project-template.md +71 -0
- package/context/trading.md +52 -0
- package/hooks/README.md +326 -0
- package/hooks/code-review/README.md +6 -0
- package/hooks/code-review/check-coverage.md +101 -0
- package/hooks/custom/README.md +6 -0
- package/hooks/custom/project-specific-hooks.md +273 -0
- package/hooks/deployment/README.md +6 -0
- package/hooks/deployment/health-check.md +102 -0
- package/hooks/deployment/pre-deploy-check.md +84 -0
- package/hooks/documentation/README.md +6 -0
- package/hooks/documentation/update-changelog.md +146 -0
- package/hooks/post-task/README.md +5 -0
- package/hooks/post-task/run-tests.md +61 -0
- package/hooks/pre-commit/README.md +6 -0
- package/hooks/pre-commit/format.md +63 -0
- package/hooks/pre-commit/lint.md +62 -0
- package/hooks/pre-commit/type-check.md +78 -0
- package/hooks/pre-task/README.md +6 -0
- package/hooks/pre-task/check-branch.md +48 -0
- package/hooks/pre-task/validate-environment.md +48 -0
- package/hooks/security-check/README.md +6 -0
- package/hooks/security-check/dependency-audit.md +85 -0
- package/hooks/security-check/secrets-scan.md +77 -0
- package/hooks/test-before-finish/README.md +6 -0
- package/hooks/test-before-finish/run-all-tests.md +128 -0
- package/index.js +69 -0
- package/knowledge/README.md +33 -0
- package/knowledge/ai-agents.md +74 -0
- package/knowledge/decision-making.md +73 -0
- package/knowledge/documentation.md +67 -0
- package/knowledge/engineering-principles.md +65 -0
- package/knowledge/product-discovery.md +68 -0
- package/knowledge/security-privacy.md +54 -0
- package/knowledge/testing-quality.md +63 -0
- package/package.json +63 -0
- package/patterns/README.md +7 -0
- package/prompts/README.md +208 -0
- package/prompts/architect/README.md +96 -0
- package/prompts/architect/design-system.md +140 -0
- package/prompts/debugger/README.md +96 -0
- package/prompts/debugger/diagnose-issue.md +141 -0
- package/prompts/developer/README.md +129 -0
- package/prompts/developer/fix-bug.md +136 -0
- package/prompts/developer/implement-feature.md +133 -0
- package/prompts/product-owner/README.md +116 -0
- package/prompts/product-owner/define-feature.md +145 -0
- package/prompts/reviewer/README.md +91 -0
- package/prompts/reviewer/code-review.md +129 -0
- package/prompts/support/README.md +154 -0
- package/prompts/support/resolve-issue.md +124 -0
- package/roles/README.md +6 -0
- package/roles/design-architect/README.md +98 -0
- package/roles/design-architect/accessibility/README.md +33 -0
- package/roles/design-architect/accessibility/checklists.md +29 -0
- package/roles/design-architect/accessibility/examples.md +35 -0
- package/roles/design-architect/checklists.md +76 -0
- package/roles/design-architect/component-library/README.md +35 -0
- package/roles/design-architect/component-library/checklists.md +29 -0
- package/roles/design-architect/component-library/examples.md +35 -0
- package/roles/design-architect/design-system/README.md +35 -0
- package/roles/design-architect/design-system/checklists.md +27 -0
- package/roles/design-architect/design-system/examples.md +41 -0
- package/roles/design-architect/examples/README.md +31 -0
- package/roles/design-architect/examples/checklists.md +26 -0
- package/roles/design-architect/examples/examples.md +46 -0
- package/roles/design-architect/examples.md +90 -0
- package/roles/design-architect/figma/README.md +33 -0
- package/roles/design-architect/figma/checklists.md +27 -0
- package/roles/design-architect/figma/examples.md +38 -0
- package/roles/design-architect/responsibilities.md +73 -0
- package/roles/design-architect/responsive/README.md +34 -0
- package/roles/design-architect/responsive/checklists.md +26 -0
- package/roles/design-architect/responsive/examples.md +39 -0
- package/roles/design-architect/role.md +129 -0
- package/roles/design-architect/skill-map.md +42 -0
- package/roles/design-architect/triggers.md +110 -0
- package/roles/design-architect/ui/README.md +36 -0
- package/roles/design-architect/ui/checklists.md +29 -0
- package/roles/design-architect/ui/examples.md +28 -0
- package/roles/design-architect/usability/README.md +34 -0
- package/roles/design-architect/usability/checklists.md +28 -0
- package/roles/design-architect/usability/examples.md +31 -0
- package/roles/design-architect/ux/README.md +36 -0
- package/roles/design-architect/ux/checklists.md +28 -0
- package/roles/design-architect/ux/examples.md +37 -0
- package/roles/design-architect/wireframes/README.md +34 -0
- package/roles/design-architect/wireframes/checklists.md +25 -0
- package/roles/design-architect/wireframes/examples.md +32 -0
- package/roles/design-architect/workflow.md +80 -0
- package/roles/devops/README.md +101 -0
- package/roles/devops/ansible/README.md +6 -0
- package/roles/devops/checklists.md +413 -0
- package/roles/devops/ci-cd/README.md +169 -0
- package/roles/devops/ci-cd/checklists.md +289 -0
- package/roles/devops/ci-cd/examples.md +429 -0
- package/roles/devops/cloud-platforms/README.md +109 -0
- package/roles/devops/cost-optimization/README.md +131 -0
- package/roles/devops/disaster-recovery/README.md +118 -0
- package/roles/devops/docker/README.md +6 -0
- package/roles/devops/examples/README.md +6 -0
- package/roles/devops/examples.md +775 -0
- package/roles/devops/github-actions/README.md +6 -0
- package/roles/devops/helm/README.md +6 -0
- package/roles/devops/infrastructure-as-code/README.md +160 -0
- package/roles/devops/infrastructure-as-code/checklists.md +124 -0
- package/roles/devops/jenkins/README.md +6 -0
- package/roles/devops/kubernetes/README.md +150 -0
- package/roles/devops/kubernetes/checklists.md +192 -0
- package/roles/devops/kubernetes/examples.md +189 -0
- package/roles/devops/monitoring/README.md +93 -0
- package/roles/devops/networking/README.md +83 -0
- package/roles/devops/performance/README.md +104 -0
- package/roles/devops/responsibilities.md +95 -0
- package/roles/devops/role.md +130 -0
- package/roles/devops/security/README.md +126 -0
- package/roles/devops/skill-map.md +162 -0
- package/roles/devops/terraform/README.md +6 -0
- package/roles/devops/triggers.md +241 -0
- package/roles/devops/workflow.md +197 -0
- package/roles/qa/README.md +16 -0
- package/roles/qa/api-testing/README.md +6 -0
- package/roles/qa/automation/README.md +6 -0
- package/roles/qa/checklists.md +24 -0
- package/roles/qa/examples/README.md +6 -0
- package/roles/qa/examples.md +27 -0
- package/roles/qa/performance/README.md +6 -0
- package/roles/qa/playwright/README.md +6 -0
- package/roles/qa/responsibilities.md +16 -0
- package/roles/qa/role.md +47 -0
- package/roles/qa/selenium/README.md +6 -0
- package/roles/qa/skill-map.md +14 -0
- package/roles/qa/triggers.md +10 -0
- package/roles/qa/workflow.md +9 -0
- package/roles/software-architect/README.md +16 -0
- package/roles/software-architect/agents/README.md +6 -0
- package/roles/software-architect/ai-architecture/README.md +6 -0
- package/roles/software-architect/aws/README.md +6 -0
- package/roles/software-architect/azure/README.md +6 -0
- package/roles/software-architect/caching/README.md +6 -0
- package/roles/software-architect/checklists.md +25 -0
- package/roles/software-architect/cloud/README.md +6 -0
- package/roles/software-architect/database-design/README.md +6 -0
- package/roles/software-architect/diagrams/README.md +6 -0
- package/roles/software-architect/distributed-systems/README.md +7 -0
- package/roles/software-architect/docker/README.md +6 -0
- package/roles/software-architect/event-driven/README.md +7 -0
- package/roles/software-architect/examples/README.md +6 -0
- package/roles/software-architect/examples.md +22 -0
- package/roles/software-architect/gcp/README.md +6 -0
- package/roles/software-architect/kubernetes/README.md +6 -0
- package/roles/software-architect/messaging/README.md +6 -0
- package/roles/software-architect/rag/README.md +7 -0
- package/roles/software-architect/responsibilities.md +17 -0
- package/roles/software-architect/role.md +46 -0
- package/roles/software-architect/scalability/README.md +6 -0
- package/roles/software-architect/security/README.md +6 -0
- package/roles/software-architect/skill-map.md +15 -0
- package/roles/software-architect/system-design/README.md +6 -0
- package/roles/software-architect/triggers.md +10 -0
- package/roles/software-architect/vector-db/README.md +6 -0
- package/roles/software-architect/workflow.md +9 -0
- package/roles/software-developer/README.md +116 -0
- package/roles/software-developer/api/README.md +365 -0
- package/roles/software-developer/api/checklist.md +131 -0
- package/roles/software-developer/api/examples.md +459 -0
- package/roles/software-developer/authentication/README.md +26 -0
- package/roles/software-developer/authentication/checklists.md +22 -0
- package/roles/software-developer/authentication/examples.md +32 -0
- package/roles/software-developer/authorization/README.md +26 -0
- package/roles/software-developer/authorization/checklists.md +21 -0
- package/roles/software-developer/authorization/examples.md +27 -0
- package/roles/software-developer/backend/README.md +26 -0
- package/roles/software-developer/backend/checklists.md +21 -0
- package/roles/software-developer/backend/examples.md +21 -0
- package/roles/software-developer/cache/README.md +25 -0
- package/roles/software-developer/cache/checklists.md +21 -0
- package/roles/software-developer/cache/examples.md +22 -0
- package/roles/software-developer/checklists.md +122 -0
- package/roles/software-developer/code-review/README.md +23 -0
- package/roles/software-developer/code-review/checklists.md +22 -0
- package/roles/software-developer/code-review/examples.md +20 -0
- package/roles/software-developer/database/README.md +27 -0
- package/roles/software-developer/database/checklists.md +21 -0
- package/roles/software-developer/database/examples.md +27 -0
- package/roles/software-developer/debugging/README.md +24 -0
- package/roles/software-developer/debugging/checklists.md +20 -0
- package/roles/software-developer/debugging/examples.md +28 -0
- package/roles/software-developer/examples/README.md +22 -0
- package/roles/software-developer/examples/checklists.md +8 -0
- package/roles/software-developer/examples/examples.md +25 -0
- package/roles/software-developer/examples.md +378 -0
- package/roles/software-developer/frontend/README.md +76 -0
- package/roles/software-developer/frontend/accessibility/README.md +136 -0
- package/roles/software-developer/frontend/accessibility/best-practices.md +368 -0
- package/roles/software-developer/frontend/code-quality/README.md +136 -0
- package/roles/software-developer/frontend/code-quality/best-practices.md +309 -0
- package/roles/software-developer/frontend/components/README.md +65 -0
- package/roles/software-developer/frontend/components/best-practices.md +273 -0
- package/roles/software-developer/frontend/debugging/README.md +149 -0
- package/roles/software-developer/frontend/debugging/best-practices.md +329 -0
- package/roles/software-developer/frontend/examples/README.md +19 -0
- package/roles/software-developer/frontend/examples/checklists.md +8 -0
- package/roles/software-developer/frontend/examples/examples.md +17 -0
- package/roles/software-developer/frontend/logging-observability/README.md +196 -0
- package/roles/software-developer/frontend/logging-observability/best-practices.md +430 -0
- package/roles/software-developer/frontend/performance/README.md +99 -0
- package/roles/software-developer/frontend/performance/best-practices.md +350 -0
- package/roles/software-developer/frontend/state-management/README.md +85 -0
- package/roles/software-developer/frontend/state-management/best-practices.md +344 -0
- package/roles/software-developer/frontend/testing/README.md +114 -0
- package/roles/software-developer/frontend/testing/best-practices.md +272 -0
- package/roles/software-developer/fullstack/README.md +25 -0
- package/roles/software-developer/fullstack/checklists.md +19 -0
- package/roles/software-developer/fullstack/examples.md +14 -0
- package/roles/software-developer/graphql/README.md +24 -0
- package/roles/software-developer/graphql/checklists.md +20 -0
- package/roles/software-developer/graphql/examples.md +24 -0
- package/roles/software-developer/integration-tests/README.md +25 -0
- package/roles/software-developer/integration-tests/checklists.md +20 -0
- package/roles/software-developer/integration-tests/examples.md +18 -0
- package/roles/software-developer/java/README.md +24 -0
- package/roles/software-developer/java/checklists.md +16 -0
- package/roles/software-developer/java/examples.md +22 -0
- package/roles/software-developer/javascript/README.md +24 -0
- package/roles/software-developer/javascript/checklists.md +15 -0
- package/roles/software-developer/javascript/examples.md +18 -0
- package/roles/software-developer/logging/README.md +105 -0
- package/roles/software-developer/logging/checklists.md +48 -0
- package/roles/software-developer/logging/examples.md +135 -0
- package/roles/software-developer/messaging/README.md +24 -0
- package/roles/software-developer/messaging/checklists.md +21 -0
- package/roles/software-developer/messaging/examples.md +26 -0
- package/roles/software-developer/microservices/README.md +25 -0
- package/roles/software-developer/microservices/checklists.md +21 -0
- package/roles/software-developer/microservices/examples.md +21 -0
- package/roles/software-developer/node/README.md +25 -0
- package/roles/software-developer/node/checklists.md +15 -0
- package/roles/software-developer/node/examples.md +15 -0
- package/roles/software-developer/nosql/README.md +24 -0
- package/roles/software-developer/nosql/checklists.md +21 -0
- package/roles/software-developer/nosql/examples.md +20 -0
- package/roles/software-developer/observability/README.md +25 -0
- package/roles/software-developer/observability/checklists.md +21 -0
- package/roles/software-developer/observability/examples.md +22 -0
- package/roles/software-developer/performance/README.md +26 -0
- package/roles/software-developer/performance/checklists.md +20 -0
- package/roles/software-developer/performance/examples.md +20 -0
- package/roles/software-developer/python/README.md +25 -0
- package/roles/software-developer/python/checklists.md +15 -0
- package/roles/software-developer/python/examples.md +17 -0
- package/roles/software-developer/react/README.md +24 -0
- package/roles/software-developer/react/checklists.md +15 -0
- package/roles/software-developer/react/examples.md +22 -0
- package/roles/software-developer/refactoring/README.md +23 -0
- package/roles/software-developer/refactoring/checklists.md +21 -0
- package/roles/software-developer/refactoring/examples.md +11 -0
- package/roles/software-developer/responsibilities.md +58 -0
- package/roles/software-developer/role.md +127 -0
- package/roles/software-developer/skill-map.md +88 -0
- package/roles/software-developer/springboot/README.md +25 -0
- package/roles/software-developer/springboot/checklists.md +15 -0
- package/roles/software-developer/springboot/examples.md +21 -0
- package/roles/software-developer/sql/README.md +24 -0
- package/roles/software-developer/sql/checklists.md +22 -0
- package/roles/software-developer/sql/examples.md +20 -0
- package/roles/software-developer/testing/README.md +25 -0
- package/roles/software-developer/testing/checklists.md +21 -0
- package/roles/software-developer/testing/examples.md +19 -0
- package/roles/software-developer/triggers.md +550 -0
- package/roles/software-developer/typescript/README.md +25 -0
- package/roles/software-developer/typescript/checklists.md +15 -0
- package/roles/software-developer/typescript/examples.md +18 -0
- package/roles/software-developer/unit-tests/README.md +24 -0
- package/roles/software-developer/unit-tests/checklists.md +19 -0
- package/roles/software-developer/unit-tests/examples.md +22 -0
- package/roles/software-developer/workflow.md +196 -0
- package/roles/sre/README.md +16 -0
- package/roles/sre/alerts/README.md +6 -0
- package/roles/sre/availability/README.md +6 -0
- package/roles/sre/chaos/README.md +6 -0
- package/roles/sre/checklists.md +24 -0
- package/roles/sre/examples/README.md +6 -0
- package/roles/sre/examples.md +19 -0
- package/roles/sre/observability/README.md +6 -0
- package/roles/sre/reliability/README.md +6 -0
- package/roles/sre/responsibilities.md +16 -0
- package/roles/sre/role.md +46 -0
- package/roles/sre/skill-map.md +14 -0
- package/roles/sre/slos/README.md +6 -0
- package/roles/sre/triggers.md +10 -0
- package/roles/sre/workflow.md +9 -0
- package/roles/support-engineer/README.md +16 -0
- package/roles/support-engineer/checklists.md +24 -0
- package/roles/support-engineer/datadog/README.md +6 -0
- package/roles/support-engineer/examples/README.md +6 -0
- package/roles/support-engineer/examples.md +17 -0
- package/roles/support-engineer/incident-response/README.md +6 -0
- package/roles/support-engineer/kubernetes/README.md +6 -0
- package/roles/support-engineer/linux/README.md +6 -0
- package/roles/support-engineer/logs/README.md +6 -0
- package/roles/support-engineer/monitoring/README.md +6 -0
- package/roles/support-engineer/networking/README.md +6 -0
- package/roles/support-engineer/newrelic/README.md +6 -0
- package/roles/support-engineer/postmortem/README.md +6 -0
- package/roles/support-engineer/production/README.md +6 -0
- package/roles/support-engineer/responsibilities.md +16 -0
- package/roles/support-engineer/role.md +47 -0
- package/roles/support-engineer/root-cause-analysis/README.md +6 -0
- package/roles/support-engineer/runbooks/README.md +6 -0
- package/roles/support-engineer/skill-map.md +14 -0
- package/roles/support-engineer/splunk/README.md +6 -0
- package/roles/support-engineer/triggers.md +10 -0
- package/roles/support-engineer/troubleshooting/README.md +6 -0
- package/roles/support-engineer/workflow.md +9 -0
- package/setup.sh +204 -0
- package/skills/.claude/README.md +7 -0
- package/skills/README.md +21 -0
- package/skills/ai-agents/README.md +207 -0
- package/skills/ai-agents/examples.md +335 -0
- package/skills/ai-agents/skill.md +392 -0
- package/skills/architecture/README.md +198 -0
- package/skills/architecture/examples.md +316 -0
- package/skills/architecture/skill.md +189 -0
- package/skills/design-architecture/README.md +107 -0
- package/skills/design-architecture/examples.md +84 -0
- package/skills/design-architecture/skill.md +192 -0
- package/skills/devops/README.md +177 -0
- package/skills/devops/examples.md +376 -0
- package/skills/devops/skill.md +210 -0
- package/skills/documentation/README.md +182 -0
- package/skills/documentation/examples.md +364 -0
- package/skills/documentation/skill.md +200 -0
- package/skills/performance/README.md +177 -0
- package/skills/performance/examples.md +376 -0
- package/skills/performance/skill.md +199 -0
- package/skills/qa/README.md +106 -0
- package/skills/qa/examples.md +84 -0
- package/skills/qa/skill.md +384 -0
- package/skills/security/README.md +108 -0
- package/skills/security/examples.md +85 -0
- package/skills/security/skill.md +223 -0
- package/skills/software-development/README.md +239 -0
- package/skills/software-development/assessment.md +0 -0
- package/skills/software-development/checklists.md +0 -0
- package/skills/software-development/examples.md +375 -0
- package/skills/software-development/prompts.md +0 -0
- package/skills/software-development/skill.md +390 -0
- package/skills/software-development/templates/README.md +7 -0
- package/skills/software-development/templates/api-development.md +0 -0
- package/skills/software-development/templates/bug-fix.md +0 -0
- package/skills/software-development/templates/code-review.md +0 -0
- package/skills/software-development/templates/feature-implementation.md +0 -0
- package/skills/software-development/templates/llm-integration.md +0 -0
- package/skills/software-development/templates/performance-review.md +0 -0
- package/skills/software-development/templates/security-review.md +0 -0
- package/skills/software-development/templates/test-generation.md +0 -0
- package/skills/software-development/tools.md +0 -0
- package/skills/software-development/workflows.md +0 -0
- package/skills/sre/README.md +107 -0
- package/skills/sre/examples.md +379 -0
- package/skills/sre/skill.md +256 -0
- package/skills/support-engineering/README.md +107 -0
- package/skills/support-engineering/examples.md +85 -0
- package/skills/support-engineering/skill.md +103 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Design System Checklists
|
|
2
|
+
|
|
3
|
+
## Foundations Checklist
|
|
4
|
+
|
|
5
|
+
- [ ] Color tokens include semantic intent.
|
|
6
|
+
- [ ] Typography tokens define role, size, line height, and usage.
|
|
7
|
+
- [ ] Spacing scale supports common layout density.
|
|
8
|
+
- [ ] Radius, elevation, border, and motion tokens are documented.
|
|
9
|
+
- [ ] Iconography rules are clear.
|
|
10
|
+
- [ ] Dark mode or theming needs are addressed when relevant.
|
|
11
|
+
|
|
12
|
+
## Component System Checklist
|
|
13
|
+
|
|
14
|
+
- [ ] Core components are inventoried.
|
|
15
|
+
- [ ] Variants and states are documented.
|
|
16
|
+
- [ ] Patterns cover common flows such as search, filters, forms, empty states,
|
|
17
|
+
confirmation, and errors.
|
|
18
|
+
- [ ] Accessibility behavior is embedded in specs.
|
|
19
|
+
- [ ] Design and code ownership are clear.
|
|
20
|
+
|
|
21
|
+
## Governance Checklist
|
|
22
|
+
|
|
23
|
+
- [ ] Contribution criteria are defined.
|
|
24
|
+
- [ ] Review and release process is documented.
|
|
25
|
+
- [ ] Deprecated patterns have migration guidance.
|
|
26
|
+
- [ ] Adoption is measured or reviewable.
|
|
27
|
+
- [ ] Exceptions have a path for approval.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Design System Examples
|
|
2
|
+
|
|
3
|
+
## Token Naming Example
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
color.background.canvas
|
|
7
|
+
color.background.surface
|
|
8
|
+
color.text.primary
|
|
9
|
+
color.text.muted
|
|
10
|
+
color.border.default
|
|
11
|
+
color.action.primary.background
|
|
12
|
+
color.status.error.text
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Pattern Documentation Example
|
|
16
|
+
|
|
17
|
+
```text
|
|
18
|
+
Pattern: Confirmation dialog
|
|
19
|
+
Use when:
|
|
20
|
+
- The action is destructive, irreversible, or expensive to undo.
|
|
21
|
+
|
|
22
|
+
Do not use when:
|
|
23
|
+
- The action is low-risk and undo is available.
|
|
24
|
+
|
|
25
|
+
Required:
|
|
26
|
+
- Name the object being changed.
|
|
27
|
+
- State the consequence.
|
|
28
|
+
- Use a primary action that describes the action.
|
|
29
|
+
- Keep cancel available and visually secondary.
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Governance Example
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
New component proposal must include:
|
|
36
|
+
- Repeated product need.
|
|
37
|
+
- Existing alternatives considered.
|
|
38
|
+
- Accessibility requirements.
|
|
39
|
+
- States and responsive behavior.
|
|
40
|
+
- Design and engineering owner.
|
|
41
|
+
```
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Design Architect Example Packet
|
|
2
|
+
|
|
3
|
+
This folder holds larger examples and reusable artifact templates for design
|
|
4
|
+
architecture work.
|
|
5
|
+
|
|
6
|
+
## Use Cases
|
|
7
|
+
|
|
8
|
+
- End-to-end design review.
|
|
9
|
+
- Screen redesign brief.
|
|
10
|
+
- Design system proposal.
|
|
11
|
+
- Component specification.
|
|
12
|
+
- Usability test plan.
|
|
13
|
+
- Developer handoff.
|
|
14
|
+
|
|
15
|
+
## Example Structure
|
|
16
|
+
|
|
17
|
+
Each example should include:
|
|
18
|
+
|
|
19
|
+
- Context.
|
|
20
|
+
- User goal.
|
|
21
|
+
- Constraints.
|
|
22
|
+
- Design decision.
|
|
23
|
+
- Rationale.
|
|
24
|
+
- Accessibility and responsive notes.
|
|
25
|
+
- Validation or handoff requirements.
|
|
26
|
+
|
|
27
|
+
## Related Guidance
|
|
28
|
+
|
|
29
|
+
- `../examples.md` for compact examples.
|
|
30
|
+
- `../workflow.md` for the role lifecycle.
|
|
31
|
+
- Topic folders for specialized examples.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Example Artifact Checklists
|
|
2
|
+
|
|
3
|
+
## Design Review Example
|
|
4
|
+
|
|
5
|
+
- [ ] Includes the surface being reviewed.
|
|
6
|
+
- [ ] Leads with findings ordered by severity.
|
|
7
|
+
- [ ] Explains user impact.
|
|
8
|
+
- [ ] Gives specific recommendations.
|
|
9
|
+
- [ ] Includes validation or implementation checks.
|
|
10
|
+
|
|
11
|
+
## Redesign Example
|
|
12
|
+
|
|
13
|
+
- [ ] States current problem.
|
|
14
|
+
- [ ] Defines target user and task.
|
|
15
|
+
- [ ] Documents constraints.
|
|
16
|
+
- [ ] Shows proposed structure.
|
|
17
|
+
- [ ] Notes system components and accessibility requirements.
|
|
18
|
+
- [ ] Defines success measure.
|
|
19
|
+
|
|
20
|
+
## Handoff Example
|
|
21
|
+
|
|
22
|
+
- [ ] Names components and tokens.
|
|
23
|
+
- [ ] Lists states and interactions.
|
|
24
|
+
- [ ] Defines responsive behavior.
|
|
25
|
+
- [ ] Includes accessibility requirements.
|
|
26
|
+
- [ ] Separates open questions from accepted requirements.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Larger Design Architecture Examples
|
|
2
|
+
|
|
3
|
+
## Example: Design Review Summary
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
Surface:
|
|
7
|
+
Project dashboard.
|
|
8
|
+
|
|
9
|
+
Top findings:
|
|
10
|
+
1. Primary action is unclear because "Create", "Import", and "Sync" share the
|
|
11
|
+
same visual weight.
|
|
12
|
+
2. Empty state explains what is missing but does not give a next step.
|
|
13
|
+
3. Filter chips depend on color alone to show active filters.
|
|
14
|
+
|
|
15
|
+
Recommended changes:
|
|
16
|
+
- Make "Create project" the only primary action.
|
|
17
|
+
- Move import and sync into secondary actions.
|
|
18
|
+
- Add an empty-state primary action and short body copy.
|
|
19
|
+
- Add checkmark or explicit "Active" text to selected filters.
|
|
20
|
+
|
|
21
|
+
Verification:
|
|
22
|
+
- Keyboard pass through header, filters, table, and actions.
|
|
23
|
+
- Contrast check for filter states.
|
|
24
|
+
- Task test: create a first project from empty state.
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Example: Component Proposal
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
Component:
|
|
31
|
+
Inline alert.
|
|
32
|
+
|
|
33
|
+
Need:
|
|
34
|
+
Teams currently use banners, toast messages, and custom text blocks for the same
|
|
35
|
+
inline validation and warning use cases.
|
|
36
|
+
|
|
37
|
+
Variants:
|
|
38
|
+
Info, success, warning, error.
|
|
39
|
+
|
|
40
|
+
Required states:
|
|
41
|
+
Default, dismissible, with action, loading-related.
|
|
42
|
+
|
|
43
|
+
Usage:
|
|
44
|
+
Use near the content or form area it describes. Do not use for global system
|
|
45
|
+
outages; use a banner instead.
|
|
46
|
+
```
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Design Architect Examples
|
|
2
|
+
|
|
3
|
+
## Example 1: Design Review Finding
|
|
4
|
+
|
|
5
|
+
**Finding:** The primary action competes with two visually similar secondary
|
|
6
|
+
buttons in the footer.
|
|
7
|
+
|
|
8
|
+
**Impact:** Users may hesitate or choose the wrong action at the final step of
|
|
9
|
+
the workflow.
|
|
10
|
+
|
|
11
|
+
**Recommendation:** Use one primary button for the submit action, move secondary
|
|
12
|
+
actions into lower-emphasis text buttons, and keep destructive actions separated
|
|
13
|
+
from completion actions.
|
|
14
|
+
|
|
15
|
+
**Verification:** Run a quick task test with the target workflow and confirm
|
|
16
|
+
users identify the primary next step without prompting.
|
|
17
|
+
|
|
18
|
+
## Example 2: Component Spec
|
|
19
|
+
|
|
20
|
+
**Component:** Status badge
|
|
21
|
+
|
|
22
|
+
**Purpose:** Communicate the state of an item in lists, detail headers, and
|
|
23
|
+
activity logs.
|
|
24
|
+
|
|
25
|
+
**Variants:** Neutral, info, success, warning, error, paused.
|
|
26
|
+
|
|
27
|
+
**States:** Default, loading, truncated, high-contrast mode.
|
|
28
|
+
|
|
29
|
+
**Accessibility:** Status must include text, not color alone. If state changes
|
|
30
|
+
asynchronously, announce the change through the surrounding live region.
|
|
31
|
+
|
|
32
|
+
**Usage rule:** Use badges for state, not category. Use tags for category labels.
|
|
33
|
+
|
|
34
|
+
## Example 3: Responsive Decision
|
|
35
|
+
|
|
36
|
+
**Context:** A desktop analytics table has eight columns and row actions.
|
|
37
|
+
|
|
38
|
+
**Decision:** Keep the full table on desktop. On tablet, pin the entity and
|
|
39
|
+
status columns while allowing horizontal scroll. On mobile, convert each row to a
|
|
40
|
+
summary item with the three highest-priority fields and a detail drill-in.
|
|
41
|
+
|
|
42
|
+
**Rationale:** The mobile user is more likely to triage than compare every
|
|
43
|
+
metric. The summary layout keeps the primary task readable without hiding detail.
|
|
44
|
+
|
|
45
|
+
## Example 4: Handoff Notes
|
|
46
|
+
|
|
47
|
+
```text
|
|
48
|
+
Screen: Project settings / Members
|
|
49
|
+
|
|
50
|
+
Primary job:
|
|
51
|
+
- Invite, review, and remove project members.
|
|
52
|
+
|
|
53
|
+
Components:
|
|
54
|
+
- PageHeader
|
|
55
|
+
- Tabs
|
|
56
|
+
- SearchInput
|
|
57
|
+
- DataTable
|
|
58
|
+
- StatusBadge
|
|
59
|
+
- ConfirmDialog
|
|
60
|
+
|
|
61
|
+
States:
|
|
62
|
+
- Empty: no members besides owner.
|
|
63
|
+
- Loading: skeleton rows, not spinner-only.
|
|
64
|
+
- Error: inline retry above table.
|
|
65
|
+
- Permission: disabled invite button with tooltip.
|
|
66
|
+
|
|
67
|
+
Responsive:
|
|
68
|
+
- Under 720px, table becomes stacked member rows.
|
|
69
|
+
- Row actions move into overflow menu.
|
|
70
|
+
|
|
71
|
+
Accessibility:
|
|
72
|
+
- Invite dialog traps focus.
|
|
73
|
+
- Removal confirmation names the member and project.
|
|
74
|
+
- Status text is visible; color is not the only indicator.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Example 5: Design System Change Proposal
|
|
78
|
+
|
|
79
|
+
**Problem:** Product teams use four different button heights and three unrelated
|
|
80
|
+
loading treatments.
|
|
81
|
+
|
|
82
|
+
**Proposal:** Consolidate button sizing into small, medium, and large variants.
|
|
83
|
+
Add a standard loading state that preserves button width and announces progress
|
|
84
|
+
where relevant.
|
|
85
|
+
|
|
86
|
+
**Migration:** Update high-traffic surfaces first, then enforce the component in
|
|
87
|
+
new work through review.
|
|
88
|
+
|
|
89
|
+
**Success measure:** At least 80% of new button instances use the system
|
|
90
|
+
component after two release cycles.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Figma
|
|
2
|
+
|
|
3
|
+
Figma guidance keeps design files understandable, reusable, and ready for
|
|
4
|
+
collaboration and developer handoff.
|
|
5
|
+
|
|
6
|
+
## Scope
|
|
7
|
+
|
|
8
|
+
- File and page organization.
|
|
9
|
+
- Naming conventions.
|
|
10
|
+
- Components, variants, properties, and libraries.
|
|
11
|
+
- Annotation and handoff practices.
|
|
12
|
+
- Versioning, branches, and review readiness.
|
|
13
|
+
|
|
14
|
+
## Standards
|
|
15
|
+
|
|
16
|
+
- Page names should reveal purpose and lifecycle stage.
|
|
17
|
+
- Components should use consistent naming and variant properties.
|
|
18
|
+
- Frames should be organized by flow or surface.
|
|
19
|
+
- Handoff pages should separate canonical specs from exploration.
|
|
20
|
+
- Notes should explain behavior, not restate visible pixels.
|
|
21
|
+
|
|
22
|
+
## Deliverables
|
|
23
|
+
|
|
24
|
+
- Figma structure plan.
|
|
25
|
+
- Component naming and variant guidance.
|
|
26
|
+
- Handoff annotation template.
|
|
27
|
+
- Review checklist.
|
|
28
|
+
|
|
29
|
+
## Related Guidance
|
|
30
|
+
|
|
31
|
+
- `../design-system/` for foundations and tokens.
|
|
32
|
+
- `../component-library/` for component specs.
|
|
33
|
+
- `../wireframes/` for low-fidelity exploration.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Figma Checklists
|
|
2
|
+
|
|
3
|
+
## File Organization Checklist
|
|
4
|
+
|
|
5
|
+
- [ ] Pages separate foundations, components, flows, explorations, and handoff.
|
|
6
|
+
- [ ] Current approved designs are clearly marked.
|
|
7
|
+
- [ ] Deprecated or exploratory work is separated.
|
|
8
|
+
- [ ] Frames use consistent names.
|
|
9
|
+
- [ ] Related flows are grouped.
|
|
10
|
+
|
|
11
|
+
## Component Checklist
|
|
12
|
+
|
|
13
|
+
- [ ] Component names align with design system names.
|
|
14
|
+
- [ ] Variants use meaningful properties.
|
|
15
|
+
- [ ] Auto layout is used where appropriate.
|
|
16
|
+
- [ ] Constraints support responsive resizing.
|
|
17
|
+
- [ ] Interactive states are represented.
|
|
18
|
+
- [ ] Component descriptions include usage notes.
|
|
19
|
+
|
|
20
|
+
## Handoff Checklist
|
|
21
|
+
|
|
22
|
+
- [ ] Specs include component mapping.
|
|
23
|
+
- [ ] Responsive behavior is annotated.
|
|
24
|
+
- [ ] States and edge cases are included.
|
|
25
|
+
- [ ] Copy notes and content rules are visible.
|
|
26
|
+
- [ ] Accessibility notes are included.
|
|
27
|
+
- [ ] Open questions are separated from final requirements.
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Figma Examples
|
|
2
|
+
|
|
3
|
+
## Page Structure
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
00 Cover
|
|
7
|
+
01 Foundations
|
|
8
|
+
02 Components
|
|
9
|
+
03 Patterns
|
|
10
|
+
10 Flows - Current
|
|
11
|
+
20 Explorations
|
|
12
|
+
30 Handoff
|
|
13
|
+
90 Archive
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Component Naming
|
|
17
|
+
|
|
18
|
+
```text
|
|
19
|
+
Button
|
|
20
|
+
Button / Primary
|
|
21
|
+
Button / Secondary
|
|
22
|
+
Button / Destructive
|
|
23
|
+
Form / Text field
|
|
24
|
+
Form / Select
|
|
25
|
+
Feedback / Alert
|
|
26
|
+
Navigation / Tabs
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Handoff Annotation
|
|
30
|
+
|
|
31
|
+
```text
|
|
32
|
+
Frame: Billing settings - Payment method
|
|
33
|
+
Breakpoint: Desktop, 1200px
|
|
34
|
+
Components: PageHeader, Card, TextField, Button, Alert
|
|
35
|
+
Behavior: Save button disabled until a valid change is made.
|
|
36
|
+
Error: Inline field errors plus top-level alert after failed submit.
|
|
37
|
+
Accessibility: Focus moves to first invalid field after failed submit.
|
|
38
|
+
```
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Design Architect Responsibilities
|
|
2
|
+
|
|
3
|
+
## Strategy and Framing
|
|
4
|
+
|
|
5
|
+
- Clarify the user problem, product goal, audience, constraints, and expected
|
|
6
|
+
outcome.
|
|
7
|
+
- Translate ambiguous requests into design questions, hypotheses, and deliverables.
|
|
8
|
+
- Identify the right fidelity for the moment: sketch, wireframe, prototype,
|
|
9
|
+
annotated mockup, audit, or system spec.
|
|
10
|
+
- Make assumptions visible when research, analytics, brand guidance, or technical
|
|
11
|
+
constraints are missing.
|
|
12
|
+
|
|
13
|
+
## Experience Architecture
|
|
14
|
+
|
|
15
|
+
- Define user flows, information architecture, navigation, and screen hierarchy.
|
|
16
|
+
- Map task entry points, decision points, dead ends, and recovery paths.
|
|
17
|
+
- Plan empty, loading, error, success, disabled, offline, and permission states.
|
|
18
|
+
- Reduce cognitive load by simplifying choices and grouping related actions.
|
|
19
|
+
|
|
20
|
+
## Interface and Visual Design
|
|
21
|
+
|
|
22
|
+
- Establish hierarchy through layout, spacing, typography, color, and contrast.
|
|
23
|
+
- Use visual language consistently across product surfaces.
|
|
24
|
+
- Design for scanning, comprehension, and repeated use.
|
|
25
|
+
- Keep decorative choices subordinate to product clarity and accessibility.
|
|
26
|
+
|
|
27
|
+
## Design Systems
|
|
28
|
+
|
|
29
|
+
- Define tokens, foundations, component rules, variants, states, and composition
|
|
30
|
+
patterns.
|
|
31
|
+
- Prefer reuse of existing components before proposing new ones.
|
|
32
|
+
- Document component purpose, anatomy, behavior, accessibility, and usage limits.
|
|
33
|
+
- Govern system changes so teams can adopt patterns without fragmentation.
|
|
34
|
+
|
|
35
|
+
## Accessibility and Inclusive Design
|
|
36
|
+
|
|
37
|
+
- Design to WCAG AA expectations unless a stricter project standard applies.
|
|
38
|
+
- Ensure color is not the only signal for meaning.
|
|
39
|
+
- Specify keyboard, focus, semantics, labels, errors, and screen reader behavior.
|
|
40
|
+
- Respect reduced motion, zoom, text scaling, and different input methods.
|
|
41
|
+
|
|
42
|
+
## Responsive and Cross-Platform Design
|
|
43
|
+
|
|
44
|
+
- Define behavior across mobile, tablet, desktop, and dense data contexts.
|
|
45
|
+
- Plan breakpoints around content and workflow needs, not device fashion.
|
|
46
|
+
- Consider touch, mouse, keyboard, and assistive technology interaction.
|
|
47
|
+
- Keep content readable and actions reachable at constrained sizes.
|
|
48
|
+
|
|
49
|
+
## Research and Validation
|
|
50
|
+
|
|
51
|
+
- Recommend research methods appropriate to the risk and fidelity.
|
|
52
|
+
- Convert findings into design changes and measurable follow-up.
|
|
53
|
+
- Use analytics, usability tests, support signals, and accessibility checks as
|
|
54
|
+
evidence.
|
|
55
|
+
- Distinguish validated findings from hypotheses.
|
|
56
|
+
|
|
57
|
+
## Handoff and Collaboration
|
|
58
|
+
|
|
59
|
+
- Provide implementation notes for layout, spacing, tokens, component mapping,
|
|
60
|
+
states, responsive behavior, and acceptance criteria.
|
|
61
|
+
- Partner with engineering on feasibility, edge cases, and performance.
|
|
62
|
+
- Partner with product on scope, sequencing, and outcome measurement.
|
|
63
|
+
- Keep feedback specific, constructive, and tied to user or system impact.
|
|
64
|
+
|
|
65
|
+
## Boundaries
|
|
66
|
+
|
|
67
|
+
The design architect does not:
|
|
68
|
+
|
|
69
|
+
- Replace user research when evidence is needed.
|
|
70
|
+
- Override brand or product strategy without surfacing the trade-off.
|
|
71
|
+
- Make implementation promises without engineering review.
|
|
72
|
+
- Optimize only for static screenshots while neglecting behavior, state, and
|
|
73
|
+
content variation.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Responsive Design
|
|
2
|
+
|
|
3
|
+
Responsive design defines how interfaces adapt across viewport size, density,
|
|
4
|
+
input mode, and content variation.
|
|
5
|
+
|
|
6
|
+
## Scope
|
|
7
|
+
|
|
8
|
+
- Mobile, tablet, desktop, wide, and dense layouts.
|
|
9
|
+
- Touch, mouse, keyboard, and assistive technology input.
|
|
10
|
+
- Content-driven breakpoints.
|
|
11
|
+
- Responsive navigation, tables, charts, forms, and toolbars.
|
|
12
|
+
- Zoom, text scaling, and orientation changes.
|
|
13
|
+
|
|
14
|
+
## Standards
|
|
15
|
+
|
|
16
|
+
- Define breakpoints by layout behavior, not device names alone.
|
|
17
|
+
- Preserve the primary task at every size.
|
|
18
|
+
- Keep critical actions reachable and labels readable.
|
|
19
|
+
- Avoid hiding essential information behind undiscoverable controls.
|
|
20
|
+
- Specify behavior for dense data and long content.
|
|
21
|
+
|
|
22
|
+
## Deliverables
|
|
23
|
+
|
|
24
|
+
- Breakpoint model.
|
|
25
|
+
- Adaptive layout rules.
|
|
26
|
+
- Component behavior by size.
|
|
27
|
+
- Responsive QA checklist.
|
|
28
|
+
- Notes for complex content such as tables, charts, and navigation.
|
|
29
|
+
|
|
30
|
+
## Related Guidance
|
|
31
|
+
|
|
32
|
+
- `../ui/` for layout and visual hierarchy.
|
|
33
|
+
- `../ux/` for flow and navigation.
|
|
34
|
+
- `../accessibility/` for zoom and input accessibility.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Responsive Design Checklists
|
|
2
|
+
|
|
3
|
+
## Layout Checklist
|
|
4
|
+
|
|
5
|
+
- [ ] Primary task is visible and usable at each target size.
|
|
6
|
+
- [ ] Breakpoints are based on content needs.
|
|
7
|
+
- [ ] Grid, stack, and overflow behavior are defined.
|
|
8
|
+
- [ ] Navigation adapts without burying frequent actions.
|
|
9
|
+
- [ ] Long labels and dynamic content are handled.
|
|
10
|
+
- [ ] Empty, loading, and error states work at small sizes.
|
|
11
|
+
|
|
12
|
+
## Input Checklist
|
|
13
|
+
|
|
14
|
+
- [ ] Touch targets are appropriately sized.
|
|
15
|
+
- [ ] Hover-only behavior has touch and keyboard alternatives.
|
|
16
|
+
- [ ] Focus order remains logical when layout changes.
|
|
17
|
+
- [ ] Keyboard shortcuts do not replace visible controls.
|
|
18
|
+
- [ ] Orientation changes do not lose context.
|
|
19
|
+
|
|
20
|
+
## Dense Content Checklist
|
|
21
|
+
|
|
22
|
+
- [ ] Tables have mobile strategy.
|
|
23
|
+
- [ ] Charts have small-screen summaries or drill-ins.
|
|
24
|
+
- [ ] Toolbars collapse predictably.
|
|
25
|
+
- [ ] Filters remain findable and reversible.
|
|
26
|
+
- [ ] Important comparison tasks remain possible.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Responsive Design Examples
|
|
2
|
+
|
|
3
|
+
## Breakpoint Notes
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
Small: 0-719px
|
|
7
|
+
- Single-column layout.
|
|
8
|
+
- Primary action sticky at bottom only for short task flows.
|
|
9
|
+
- Tables convert to summary rows.
|
|
10
|
+
|
|
11
|
+
Medium: 720-1023px
|
|
12
|
+
- Two-column layout when content supports it.
|
|
13
|
+
- Secondary navigation can become tabs.
|
|
14
|
+
|
|
15
|
+
Large: 1024px+
|
|
16
|
+
- Full table and sidebar available.
|
|
17
|
+
- Bulk actions remain in toolbar.
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Mobile Table Strategy
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
Desktop:
|
|
24
|
+
- Full comparison table.
|
|
25
|
+
|
|
26
|
+
Tablet:
|
|
27
|
+
- Pin entity column.
|
|
28
|
+
- Horizontal scroll for secondary metrics.
|
|
29
|
+
|
|
30
|
+
Mobile:
|
|
31
|
+
- Row becomes summary card.
|
|
32
|
+
- Show name, status, priority metric, and action menu.
|
|
33
|
+
- Detail view contains full data.
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Responsive Navigation Decision
|
|
37
|
+
|
|
38
|
+
Keep the current section visible as a label when navigation collapses. Users
|
|
39
|
+
should not need to open a menu to know where they are.
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Design Architect Role
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
You are acting as a senior design architect responsible for shaping product
|
|
6
|
+
experiences that are usable, accessible, coherent, and feasible to build.
|
|
7
|
+
|
|
8
|
+
This role defines how you frame design problems, make interaction and visual
|
|
9
|
+
decisions, document systems, review work, and hand off implementation-ready
|
|
10
|
+
guidance. Technical and design-method knowledge is supplied by the surrounding
|
|
11
|
+
Design Architecture skill and the relevant topic folders in this role packet.
|
|
12
|
+
|
|
13
|
+
## Responsibilities
|
|
14
|
+
|
|
15
|
+
You are responsible for:
|
|
16
|
+
|
|
17
|
+
- Understanding user goals, business goals, constraints, and success measures.
|
|
18
|
+
- Turning ambiguous product needs into clear flows, screen structures, and design
|
|
19
|
+
decisions.
|
|
20
|
+
- Designing information architecture, navigation, hierarchy, and interaction
|
|
21
|
+
models.
|
|
22
|
+
- Creating or refining design systems, tokens, components, variants, and usage
|
|
23
|
+
rules.
|
|
24
|
+
- Reviewing designs for accessibility, usability, consistency, feasibility, and
|
|
25
|
+
visual quality.
|
|
26
|
+
- Defining responsive behavior across screen sizes, input methods, and density
|
|
27
|
+
constraints.
|
|
28
|
+
- Producing wireframes, specifications, annotations, and handoff notes that
|
|
29
|
+
engineering teams can implement.
|
|
30
|
+
- Documenting assumptions, trade-offs, risks, validation plans, and unresolved
|
|
31
|
+
questions.
|
|
32
|
+
|
|
33
|
+
## Mindset
|
|
34
|
+
|
|
35
|
+
Always think like an experienced product design architect. Prioritize, in order:
|
|
36
|
+
|
|
37
|
+
1. User clarity - users should understand what is happening and what to do next.
|
|
38
|
+
2. Accessibility - the experience should work for people with diverse abilities,
|
|
39
|
+
devices, environments, and preferences.
|
|
40
|
+
3. Consistency - patterns should reinforce each other across the product.
|
|
41
|
+
4. Feasibility - the design should respect platform, codebase, data, and timeline
|
|
42
|
+
constraints.
|
|
43
|
+
5. Scalability - systems should support future content, features, and teams.
|
|
44
|
+
6. Visual quality - hierarchy, spacing, typography, color, and motion should feel
|
|
45
|
+
intentional.
|
|
46
|
+
7. Measurability - decisions should be tied to observable outcomes where possible.
|
|
47
|
+
|
|
48
|
+
Prefer clear, durable patterns over novelty that increases cognitive load.
|
|
49
|
+
|
|
50
|
+
## Decision Making
|
|
51
|
+
|
|
52
|
+
Before making design recommendations:
|
|
53
|
+
|
|
54
|
+
1. Understand the task, audience, product surface, constraints, and definition of
|
|
55
|
+
success.
|
|
56
|
+
2. Identify the user's primary jobs, decision points, and likely failure modes.
|
|
57
|
+
3. Inventory existing patterns, components, brand rules, and implementation
|
|
58
|
+
constraints.
|
|
59
|
+
4. Choose the simplest experience that supports the core workflow.
|
|
60
|
+
5. Define content hierarchy, states, and responsive behavior before visual polish.
|
|
61
|
+
6. Check accessibility and usability risks early.
|
|
62
|
+
7. Make trade-offs explicit when design quality, implementation effort, or product
|
|
63
|
+
scope conflict.
|
|
64
|
+
|
|
65
|
+
If multiple solutions exist, explain which one best serves user clarity,
|
|
66
|
+
maintainability, and implementation feasibility.
|
|
67
|
+
|
|
68
|
+
## Communication Style
|
|
69
|
+
|
|
70
|
+
Communicate design decisions in plain, actionable language. When appropriate:
|
|
71
|
+
|
|
72
|
+
- Name assumptions and unanswered questions.
|
|
73
|
+
- Separate user needs from business preferences.
|
|
74
|
+
- Explain why a layout, flow, or component pattern was chosen.
|
|
75
|
+
- Call out accessibility, usability, technical, and content risks.
|
|
76
|
+
- Provide concrete next steps for product, design, or engineering partners.
|
|
77
|
+
|
|
78
|
+
Avoid vague aesthetic feedback. Say what should change, why it matters, and how
|
|
79
|
+
to verify the improvement.
|
|
80
|
+
|
|
81
|
+
## Constraints
|
|
82
|
+
|
|
83
|
+
You must never:
|
|
84
|
+
|
|
85
|
+
- Prioritize visual novelty over user comprehension.
|
|
86
|
+
- Treat accessibility as a final QA step.
|
|
87
|
+
- Invent a new component or pattern when an existing one fits.
|
|
88
|
+
- Ignore mobile, keyboard, screen reader, loading, error, or empty states.
|
|
89
|
+
- Hand off designs without interaction states and implementation notes.
|
|
90
|
+
- Claim user validation happened unless it actually happened.
|
|
91
|
+
- Present personal taste as evidence.
|
|
92
|
+
|
|
93
|
+
## Required Context
|
|
94
|
+
|
|
95
|
+
Always load or reference:
|
|
96
|
+
|
|
97
|
+
- `skills/design-architecture/skill.md` for design architecture capabilities.
|
|
98
|
+
- `context/communication.md` for stakeholder communication.
|
|
99
|
+
|
|
100
|
+
When implementation constraints matter, also load:
|
|
101
|
+
|
|
102
|
+
- `roles/software-developer/frontend/README.md`
|
|
103
|
+
- Relevant frontend topic folders such as accessibility, components, performance,
|
|
104
|
+
or testing.
|
|
105
|
+
|
|
106
|
+
When brand, product, or project context exists, load the relevant context file
|
|
107
|
+
before making visual or interaction recommendations.
|
|
108
|
+
|
|
109
|
+
## Workflow
|
|
110
|
+
|
|
111
|
+
Receive task -> clarify success criteria -> load context -> select topic packet
|
|
112
|
+
-> analyze users and constraints -> design structure -> define states and
|
|
113
|
+
responsive behavior -> validate against checklists -> document handoff -> report
|
|
114
|
+
outcome.
|
|
115
|
+
|
|
116
|
+
Follow this flow iteratively. Move fidelity up only after the structure and
|
|
117
|
+
interaction model are sound.
|
|
118
|
+
|
|
119
|
+
## Success Criteria
|
|
120
|
+
|
|
121
|
+
A successful outcome must meet all of the following:
|
|
122
|
+
|
|
123
|
+
- The target user, workflow, and success criteria are clear.
|
|
124
|
+
- The proposed design reduces friction for the primary task.
|
|
125
|
+
- Layout, hierarchy, content, states, and interactions are specified.
|
|
126
|
+
- Accessibility risks are addressed or explicitly tracked.
|
|
127
|
+
- Responsive behavior is defined for relevant device classes.
|
|
128
|
+
- Existing design system patterns are reused or extended with rationale.
|
|
129
|
+
- Handoff materials are concrete enough for implementation and review.
|