@umacloud/knowledge 1.0.1
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/00-governance/governance-capabilities.md +557 -0
- package/00-governance/knowledge-map.md +39 -0
- package/00-governance/maintenance-policy.md +76 -0
- package/00-governance/review-checklist.md +81 -0
- package/README.md +13 -0
- package/ai/01-standards/agent-development-complete.md +691 -0
- package/ai/01-standards/llm-application-complete.md +488 -0
- package/ai/01-standards/mlops-complete.md +798 -0
- package/ai/01-standards/prompt-engineering-complete.md +646 -0
- package/ai/01-standards/rag-architecture-complete.md +649 -0
- package/ai/02-playbooks/llm-evaluation-playbook.md +847 -0
- package/ai/03-checklists/ai-project-checklist.md +215 -0
- package/ai/04-antipatterns/ai-antipatterns.md +661 -0
- package/ai/05-cases/case-rag-production.md +147 -0
- package/ai/06-glossary/ai-glossary.md +162 -0
- package/ai/agent-evaluation-benchmark.md +53 -0
- package/ai/ai-agent-memory-context-management.md +41 -0
- package/ai/ai-cost-capacity-optimization-playbook.md +42 -0
- package/ai/ai-data-security-and-compliance-playbook.md +37 -0
- package/ai/ai-domain-index-and-checklist.md +40 -0
- package/ai/ai-governance-maturity-model.md +50 -0
- package/ai/ai-model-selection-and-routing-strategy.md +47 -0
- package/ai/ai-observability-and-oncall-runbook.md +52 -0
- package/ai/ai-rag-engineering-playbook.md +42 -0
- package/ai/ai-red-team-and-safety-evaluation.md +42 -0
- package/ai/ai-release-readiness-and-rollback-gate.md +42 -0
- package/ai/llm-agent-engineering-deep-dive.md +57 -0
- package/ai/prompt-and-tool-guardrails.md +52 -0
- package/api/01-standards/enterprise-api-standards.md +198 -0
- package/api/01-standards/rest-api-design-guide.md +63 -0
- package/api/02-playbooks/api-pagination-playbook.md +93 -0
- package/api/02-playbooks/graphql-production-playbook.md +176 -0
- package/api/03-checklists/api-review-checklist.md +55 -0
- package/api/04-antipatterns/api-antipatterns.md +112 -0
- package/architecture/01-standards/api-gateway-patterns.md +496 -0
- package/architecture/01-standards/cloud-native-patterns.md +644 -0
- package/architecture/01-standards/distributed-systems-patterns.md +591 -0
- package/architecture/01-standards/event-driven-architecture.md +595 -0
- package/architecture/01-standards/microservices-patterns-complete.md +968 -0
- package/architecture/01-standards/microservices-patterns.md +495 -0
- package/architecture/01-standards/system-design-interview.md +664 -0
- package/architecture/02-playbooks/microservices-patterns-playbook.md +137 -0
- package/architecture/02-playbooks/migration-playbook.md +780 -0
- package/architecture/02-playbooks/system-design-playbook.md +779 -0
- package/architecture/03-checklists/architecture-decision-checklist.md +297 -0
- package/architecture/04-antipatterns/architecture-antipatterns.md +417 -0
- package/architecture/05-cases/case-netflix-microservices.md +413 -0
- package/architecture/06-glossary/architecture-glossary.md +164 -0
- package/architecture/adr-template-and-examples.md +38 -0
- package/architecture/api-gateway-deep-dive.md +1291 -0
- package/architecture/configuration-management.md +1162 -0
- package/architecture/distributed-transactions.md +1220 -0
- package/architecture/microservices-complete.md +735 -0
- package/architecture/resilience-and-disaster-patterns.md +37 -0
- package/architecture/service-governance.md +1198 -0
- package/architecture/system-architecture-deep-dive.md +37 -0
- package/backend/01-standards/analytics-and-growth.md +65 -0
- package/backend/01-standards/api-and-error-conventions.md +120 -0
- package/backend/01-standards/application-layering-and-packaging.md +160 -0
- package/backend/01-standards/auth-implementation.md +104 -0
- package/backend/01-standards/backend-framework-idioms.md +74 -0
- package/backend/01-standards/background-jobs-and-async.md +66 -0
- package/backend/01-standards/caching-strategies-complete.md +390 -0
- package/backend/01-standards/config-and-observability.md +77 -0
- package/backend/01-standards/data-modeling-and-persistence.md +94 -0
- package/backend/01-standards/django-complete.md +1765 -0
- package/backend/01-standards/email-and-notifications.md +64 -0
- package/backend/01-standards/fastapi-complete.md +925 -0
- package/backend/01-standards/file-upload-and-storage.md +66 -0
- package/backend/01-standards/graphql-api-complete.md +416 -0
- package/backend/01-standards/llm-application-standard.md +78 -0
- package/backend/01-standards/message-queue-patterns.md +379 -0
- package/backend/01-standards/microservices-and-distributed.md +78 -0
- package/backend/01-standards/nestjs-complete.md +2167 -0
- package/backend/01-standards/payment-integration.md +80 -0
- package/backend/01-standards/rate-limiting-complete.md +451 -0
- package/backend/01-standards/realtime-and-websocket.md +65 -0
- package/backend/01-standards/search-and-filtering.md +64 -0
- package/backend/01-standards/spring-boot-complete.md +445 -0
- package/backend/02-playbooks/api-design-playbook.md +718 -0
- package/backend/02-playbooks/email-send-playbook.md +130 -0
- package/backend/02-playbooks/file-upload-s3-playbook.md +153 -0
- package/backend/02-playbooks/typescript-enterprise-playbook.md +133 -0
- package/backend/02-playbooks/websocket-realtime-playbook.md +154 -0
- package/backend/03-checklists/api-launch-checklist.md +189 -0
- package/backend/04-antipatterns/backend-antipatterns.md +1051 -0
- package/blockchain/01-standards/blockchain-basics.md +557 -0
- package/blockchain/01-standards/smart-contract-development.md +1315 -0
- package/cicd/01-standards/deployment-and-delivery-standard.md +96 -0
- package/cicd/01-standards/github-actions-complete.md +473 -0
- package/cicd/01-standards/release-and-store-submission.md +75 -0
- package/cicd/02-playbooks/cicd-pipeline-playbook.md +144 -0
- package/cicd/02-playbooks/release-management-playbook.md +605 -0
- package/cicd/03-checklists/pipeline-security-checklist.md +168 -0
- package/cicd/04-antipatterns/cicd-antipatterns.md +589 -0
- package/cicd/05-cases/case-deployment-automation.md +221 -0
- package/cicd/05-cases/case-gitops-transformation.md +212 -0
- package/cicd/06-glossary/cicd-glossary.md +114 -0
- package/cicd/cicd-blueprint-deep-dive.md +38 -0
- package/cicd/release-readiness-gate.md +37 -0
- package/cloud-native/01-standards/container-security.md +741 -0
- package/cloud-native/01-standards/kubernetes-complete.md +812 -0
- package/cloud-native/02-playbooks/api-gateway-playbook.md +155 -0
- package/cloud-native/02-playbooks/gitops-with-argocd.md +760 -0
- package/cloud-native/02-playbooks/k8s-troubleshooting-playbook.md +1942 -0
- package/cloud-native/02-playbooks/message-queue-playbook.md +129 -0
- package/cloud-native/02-playbooks/multicloud-governance.md +726 -0
- package/cloud-native/02-playbooks/serverless-patterns.md +788 -0
- package/cloud-native/02-playbooks/service-mesh-playbook.md +612 -0
- package/cloud-native/02-playbooks/terraform-iac-playbook.md +143 -0
- package/cloud-native/03-checklists/container-security-checklist.md +431 -0
- package/cloud-native/03-checklists/k8s-production-readiness-checklist.md +460 -0
- package/cloud-native/04-antipatterns/container-antipatterns.md +660 -0
- package/cloud-native/04-antipatterns/k8s-antipatterns.md +743 -0
- package/cloud-native/05-cases/case-k8s-migration.md +478 -0
- package/cloud-native/05-cases/case-k8s-scaling.md +642 -0
- package/cloud-native/05-cases/case-k8s-security-incident.md +397 -0
- package/cloud-native/06-glossary/cloud-native-glossary.md +337 -0
- package/cross-platform/01-standards/cross-platform-frameworks.md +83 -0
- package/cross-platform/01-standards/platform-selection-and-architecture.md +77 -0
- package/data/01-standards/elasticsearch-complete.md +2098 -0
- package/data/01-standards/postgresql-complete.md +1613 -0
- package/data/01-standards/redis-complete.md +1527 -0
- package/data/02-playbooks/database-optimization-playbook.md +403 -0
- package/data/02-playbooks/elasticsearch-production-playbook.md +132 -0
- package/data/03-checklists/database-launch-checklist.md +187 -0
- package/data/04-antipatterns/database-antipatterns.md +873 -0
- package/data/05-cases/case-database-migration.md +310 -0
- package/data/06-glossary/database-glossary.md +440 -0
- package/data/data-governance-and-modeling-deep-dive.md +39 -0
- package/data-engineering/01-standards/airflow-complete.md +523 -0
- package/data-engineering/01-standards/kafka-complete.md +1521 -0
- package/data-engineering/02-playbooks/spark-etl-playbook.md +496 -0
- package/data-engineering/03-checklists/pipeline-launch-checklist.md +194 -0
- package/data-engineering/04-antipatterns/data-pipeline-antipatterns.md +684 -0
- package/data-engineering/05-cases/case-real-time-pipeline.md +355 -0
- package/data-engineering/06-glossary/data-engineering-glossary.md +429 -0
- package/database/01-standards/database-schema-standards.md +147 -0
- package/database/02-playbooks/postgresql-optimization-quick.md +52 -0
- package/database/02-playbooks/postgresql-performance-optimization.md +58 -0
- package/database/02-playbooks/postgresql-production-playbook.md +146 -0
- package/database/02-playbooks/redis-caching-playbook.md +117 -0
- package/database/03-checklists/database-review-checklist.md +50 -0
- package/database/04-antipatterns/database-antipatterns.md +112 -0
- package/design/01-standards/ui-design-system-complete.md +423 -0
- package/design/02-playbooks/design-handoff-playbook.md +254 -0
- package/design/02-playbooks/design-review-playbook.md +388 -0
- package/design/03-checklists/design-review-checklist.md +246 -0
- package/design/04-antipatterns/design-antipatterns.md +378 -0
- package/design/05-cases/case-design-system-adoption.md +328 -0
- package/design/06-glossary/design-glossary.md +329 -0
- package/design/ui-full-lifecycle-cross-platform-playbook.md +571 -0
- package/design/ux-system-deep-dive.md +38 -0
- package/design-systems/00-craft-rules.md +71 -0
- package/design-systems/aesthetic-families.md +43 -0
- package/design-systems/anti-ai-slop.md +162 -0
- package/design-systems/bold-geometric.md +120 -0
- package/design-systems/brutalist-bold.md +103 -0
- package/design-systems/editorial-clean.md +109 -0
- package/design-systems/glass-aurora.md +108 -0
- package/design-systems/modern-minimal.md +145 -0
- package/design-systems/premium-luxury.md +106 -0
- package/design-systems/product-type-design-map.md +48 -0
- package/design-systems/soft-warm.md +123 -0
- package/design-systems/tech-utility.md +113 -0
- package/desktop/01-standards/desktop-app-standard.md +72 -0
- package/desktop/01-standards/desktop-design.md +71 -0
- package/development/00-governance/document-template.md +41 -0
- package/development/01-standards/api-versioning-strategies.md +432 -0
- package/development/01-standards/authentication-patterns-complete.md +479 -0
- package/development/01-standards/css-architecture-complete.md +550 -0
- package/development/01-standards/database-migration-strategies.md +484 -0
- package/development/01-standards/elasticsearch-complete.md +347 -0
- package/development/01-standards/git-complete.md +371 -0
- package/development/01-standards/golang-complete.md +1565 -0
- package/development/01-standards/graphql-complete.md +298 -0
- package/development/01-standards/javascript-bundlers-complete.md +469 -0
- package/development/01-standards/javascript-typescript-complete.md +528 -0
- package/development/01-standards/jest-complete.md +275 -0
- package/development/01-standards/linux-complete.md +234 -0
- package/development/01-standards/logging-observability-complete.md +526 -0
- package/development/01-standards/microservices-communication.md +502 -0
- package/development/01-standards/mongodb-complete.md +406 -0
- package/development/01-standards/oauth2-complete.md +285 -0
- package/development/01-standards/performance-optimization-complete.md +289 -0
- package/development/01-standards/playwright-complete.md +247 -0
- package/development/01-standards/postgresql-complete.md +456 -0
- package/development/01-standards/pytest-complete.md +340 -0
- package/development/01-standards/python-async-programming.md +902 -0
- package/development/01-standards/python-complete.md +956 -0
- package/development/01-standards/python-decorators-complete.md +799 -0
- package/development/01-standards/python-design-patterns.md +2854 -0
- package/development/01-standards/python-packaging-distribution.md +420 -0
- package/development/01-standards/python-testing-strategies.md +607 -0
- package/development/01-standards/python-web-frameworks-comparison.md +471 -0
- package/development/01-standards/redis-complete.md +317 -0
- package/development/01-standards/rest-api-complete.md +316 -0
- package/development/01-standards/rust-complete.md +578 -0
- package/development/01-standards/typescript-advanced-types.md +1513 -0
- package/development/01-standards/web-security-complete.md +292 -0
- package/development/02-playbooks/api-design-playbook.md +810 -0
- package/development/02-playbooks/database-migration-playbook.md +580 -0
- package/development/02-playbooks/debugging-playbook.md +692 -0
- package/development/02-playbooks/feature-delivery-playbook.md +430 -0
- package/development/02-playbooks/incident-hotfix-playbook.md +387 -0
- package/development/02-playbooks/performance-optimization-playbook.md +531 -0
- package/development/02-playbooks/performance-tuning-playbook.md +652 -0
- package/development/02-playbooks/refactor-playbook.md +403 -0
- package/development/02-playbooks/release-playbook.md +469 -0
- package/development/03-checklists/architecture-review-checklist.md +168 -0
- package/development/03-checklists/data-migration-checklist.md +157 -0
- package/development/03-checklists/oncall-handover-checklist.md +173 -0
- package/development/03-checklists/pr-checklist.md +158 -0
- package/development/03-checklists/production-readiness-checklist.md +190 -0
- package/development/03-checklists/release-readiness-checklist.md +154 -0
- package/development/03-checklists/security-review-checklist.md +182 -0
- package/development/04-antipatterns/api-antipatterns.md +657 -0
- package/development/04-antipatterns/architecture-antipatterns.md +686 -0
- package/development/04-antipatterns/backend-antipatterns.md +648 -0
- package/development/04-antipatterns/cicd-antipatterns.md +540 -0
- package/development/04-antipatterns/code-smell-antipatterns.md +571 -0
- package/development/04-antipatterns/data-antipatterns.md +658 -0
- package/development/04-antipatterns/database-antipatterns.md +578 -0
- package/development/04-antipatterns/frontend-antipatterns.md +635 -0
- package/development/04-antipatterns/reliability-antipatterns.md +700 -0
- package/development/04-antipatterns/security-antipatterns.md +747 -0
- package/development/05-cases/case-api-version-migration.md +428 -0
- package/development/05-cases/case-authorization-hardening.md +383 -0
- package/development/05-cases/case-bluegreen-rollback.md +466 -0
- package/development/05-cases/case-cache-snowball-protection.md +485 -0
- package/development/05-cases/case-ci-cd-pipeline.md +544 -0
- package/development/05-cases/case-database-scaling.md +500 -0
- package/development/05-cases/case-db-hotspot-optimization.md +487 -0
- package/development/05-cases/case-incident-mttr-reduction.md +563 -0
- package/development/05-cases/case-microservice-migration.md +375 -0
- package/development/05-cases/case-performance-optimization.md +406 -0
- package/development/05-cases/case-security-incident-response.md +345 -0
- package/development/06-glossary/full-stack-glossary.md +166 -0
- package/development/09-maturity/quarterly-audit-template.md +35 -0
- package/development/11-ui-excellence/ui-aesthetic-system.md +41 -0
- package/development/11-ui-excellence/ui-engineering-excellence.md +435 -0
- package/development/12-scenarios/development-scenarios-guide.md +565 -0
- package/development/13-implementation-assets/implementation-toolkit.md +282 -0
- package/development/13-implementation-assets/knowledge-gates-execution.md +43 -0
- package/development/14-full-lifecycle/software-lifecycle-gates.md +511 -0
- package/development/15-lifecycle-templates/project-templates-collection.md +791 -0
- package/development/api-contract-and-versioning-guide.md +36 -0
- package/development/api-governance-complete.md +43 -0
- package/development/backend-engineering-complete.md +43 -0
- package/development/code-review-quality-complete.md +43 -0
- package/development/concurrency-reliability-complete.md +43 -0
- package/development/database-engineering-complete.md +43 -0
- package/development/engineering-effectiveness-complete.md +43 -0
- package/development/engineering-standards-deep-dive.md +38 -0
- package/development/frontend-engineering-complete.md +43 -0
- package/development/performance-capacity-complete.md +43 -0
- package/development/refactor-migration-complete.md +42 -0
- package/development/refactoring-and-techdebt-playbook.md +37 -0
- package/development/security-in-development-complete.md +43 -0
- package/devops/01-standards/cicd-pipeline-complete.md +262 -0
- package/devops/01-standards/docker-complete.md +1490 -0
- package/devops/01-standards/github-actions-complete.md +337 -0
- package/devops/01-standards/kubernetes-complete.md +638 -0
- package/devops/01-standards/terraform-complete.md +2117 -0
- package/devops/02-playbooks/docker-compose-playbook.md +233 -0
- package/devops/02-playbooks/docker-k8s-production-playbook.md +186 -0
- package/devops/02-playbooks/docker-production-playbook.md +952 -0
- package/edge-iot/01-standards/edge-iot-complete.md +473 -0
- package/experts/architect/api-design.md +178 -0
- package/experts/architect/methodology.md +124 -0
- package/experts/architect/security.md +75 -0
- package/experts/backend-lead/methodology.md +216 -0
- package/experts/devops/methodology.md +160 -0
- package/experts/frontend-lead/methodology.md +178 -0
- package/experts/product-manager/industry/ecommerce.md +43 -0
- package/experts/product-manager/industry/saas.md +40 -0
- package/experts/product-manager/methodology.md +97 -0
- package/experts/qa-lead/methodology.md +123 -0
- package/experts/qa-lead/test-strategy.md +128 -0
- package/experts/uiux-designer/methodology.md +125 -0
- package/frontend/01-standards/accessibility-complete.md +532 -0
- package/frontend/01-standards/accessibility-standard.md +74 -0
- package/frontend/01-standards/admin-dashboard-and-crud.md +72 -0
- package/frontend/01-standards/design-tokens-complete.md +444 -0
- package/frontend/01-standards/forms-and-validation.md +77 -0
- package/frontend/01-standards/frontend-architecture-and-layering.md +119 -0
- package/frontend/01-standards/i18n-and-localization.md +65 -0
- package/frontend/01-standards/nextjs-complete.md +451 -0
- package/frontend/01-standards/react-complete.md +713 -0
- package/frontend/01-standards/react-hooks-complete-guide.md +1100 -0
- package/frontend/01-standards/react-hooks-complete.md +1171 -0
- package/frontend/01-standards/seo-and-web-vitals.md +77 -0
- package/frontend/01-standards/state-management-complete.md +444 -0
- package/frontend/01-standards/vue-complete.md +499 -0
- package/frontend/01-standards/vue3-complete.md +2002 -0
- package/frontend/01-standards/web-framework-best-practices.md +64 -0
- package/frontend/01-standards/web-performance-complete.md +495 -0
- package/frontend/02-playbooks/accessibility-a11y-playbook.md +161 -0
- package/frontend/02-playbooks/frontend-performance-playbook.md +707 -0
- package/frontend/02-playbooks/i18n-internationalization-playbook.md +120 -0
- package/frontend/02-playbooks/performance-optimization-playbook.md +163 -0
- package/frontend/02-playbooks/react-nextjs-production-playbook.md +167 -0
- package/frontend/02-playbooks/react-state-management-playbook.md +173 -0
- package/frontend/03-checklists/component-quality-checklist.md +166 -0
- package/frontend/03-checklists/frontend-launch-checklist.md +299 -0
- package/frontend/04-antipatterns/frontend-antipatterns.md +886 -0
- package/frontend/05-cases/case-performance-optimization.md +274 -0
- package/harmony/01-standards/harmonyos-arkts-standard.md +75 -0
- package/harmony/01-standards/harmonyos-design.md +65 -0
- package/high-quality-engineering-playbook.md +54 -0
- package/incident/01-standards/incident-response-complete.md +303 -0
- package/incident/02-playbooks/chaos-engineering-playbook.md +883 -0
- package/incident/02-playbooks/postmortem-playbook.md +398 -0
- package/incident/03-checklists/incident-readiness-checklist.md +181 -0
- package/incident/04-antipatterns/incident-antipatterns.md +490 -0
- package/incident/05-cases/case-cascade-failure.md +176 -0
- package/incident/06-glossary/incident-glossary.md +114 -0
- package/incident/postmortem-and-response-deep-dive.md +39 -0
- package/industries/ecommerce/ecommerce-complete.md +631 -0
- package/industries/education/education-complete.md +555 -0
- package/industries/fintech/fintech-complete.md +501 -0
- package/industries/gaming/gaming-complete.md +587 -0
- package/industries/healthcare/healthcare-complete.md +452 -0
- package/low-code/01-standards/low-code-complete.md +944 -0
- package/miniprogram/01-standards/ai-common-mistakes.md +61 -0
- package/miniprogram/01-standards/miniprogram-custom-navbar-capsule.md +77 -0
- package/miniprogram/01-standards/miniprogram-design.md +61 -0
- package/miniprogram/01-standards/miniprogram-standard.md +81 -0
- package/mobile/01-standards/android-material-design.md +70 -0
- package/mobile/01-standards/flutter-complete.md +384 -0
- package/mobile/01-standards/ios-design-hig.md +78 -0
- package/mobile/01-standards/mobile-app-standard.md +85 -0
- package/mobile/01-standards/react-native-complete.md +352 -0
- package/mobile/02-playbooks/mobile-cross-platform-playbook.md +175 -0
- package/mobile/02-playbooks/mobile-performance.md +473 -0
- package/mobile/03-checklists/mobile-release-checklist.md +234 -0
- package/mobile/04-antipatterns/mobile-antipatterns.md +798 -0
- package/mobile/05-cases/case-app-performance.md +500 -0
- package/mobile/05-cases/case-app-startup-optimization.md +218 -0
- package/mobile/06-glossary/mobile-glossary.md +484 -0
- package/observability/01-standards/observability-standards.md +103 -0
- package/observability/02-playbooks/prometheus-grafana-playbook.md +135 -0
- package/observability/02-playbooks/structured-logging-playbook.md +73 -0
- package/observability/03-checklists/observability-checklist.md +54 -0
- package/observability/04-antipatterns/observability-antipatterns.md +106 -0
- package/operations/01-standards/prometheus-monitoring-complete.md +1578 -0
- package/operations/02-playbooks/capacity-planning-playbook.md +620 -0
- package/operations/03-checklists/production-launch-checklist.md +365 -0
- package/operations/04-antipatterns/operations-antipatterns.md +664 -0
- package/operations/05-cases/case-sre-practices.md +581 -0
- package/operations/06-glossary/operations-glossary.md +120 -0
- package/operations/aiops-anomaly-detection.md +758 -0
- package/operations/capacity-planning.md +1061 -0
- package/operations/chaos-engineering.md +659 -0
- package/operations/incident-command-system.md +38 -0
- package/operations/observability-complete.md +442 -0
- package/operations/slo-sli-playbook.md +517 -0
- package/operations/sre-operations-deep-dive.md +39 -0
- package/package.json +8 -0
- package/performance/01-standards/performance-and-scalability.md +80 -0
- package/performance/01-standards/performance-standards.md +156 -0
- package/performance/02-playbooks/query-optimization-playbook.md +103 -0
- package/performance/03-checklists/performance-checklist.md +56 -0
- package/performance/04-antipatterns/performance-antipatterns.md +146 -0
- package/product/01-standards/product-management-complete.md +285 -0
- package/product/02-playbooks/feature-launch-playbook.md +207 -0
- package/product/02-playbooks/user-research-playbook.md +532 -0
- package/product/03-checklists/feature-launch-checklist.md +275 -0
- package/product/04-antipatterns/product-antipatterns.md +355 -0
- package/product/05-cases/case-mvp-to-scale.md +384 -0
- package/product/06-glossary/product-glossary.md +462 -0
- package/product/feature-prioritization-framework.md +40 -0
- package/product/kpi-and-metric-tree.md +37 -0
- package/product/product-discovery-and-prd-deep-dive.md +41 -0
- package/quantum/01-standards/quantum-complete.md +1186 -0
- package/security/01-standards/api-security-complete.md +511 -0
- package/security/01-standards/container-runtime-security.md +574 -0
- package/security/01-standards/data-protection-gdpr.md +543 -0
- package/security/01-standards/owasp-top10-complete.md +1890 -0
- package/security/01-standards/secure-coding-baseline.md +90 -0
- package/security/01-standards/supply-chain-security.md +441 -0
- package/security/01-standards/web-security-checklist.md +108 -0
- package/security/01-standards/zero-trust-architecture.md +521 -0
- package/security/02-playbooks/auth-sso-playbook.md +166 -0
- package/security/02-playbooks/incident-response-security-playbook.md +588 -0
- package/security/02-playbooks/owasp-api-security-playbook.md +129 -0
- package/security/02-playbooks/payment-integration-playbook.md +119 -0
- package/security/02-playbooks/penetration-testing-playbook.md +517 -0
- package/security/03-checklists/security-audit-checklist.md +356 -0
- package/security/04-antipatterns/security-coding-antipatterns.md +580 -0
- package/security/05-cases/case-log4shell-incident.md +537 -0
- package/security/05-cases/case-major-breaches.md +468 -0
- package/security/06-glossary/security-glossary.md +212 -0
- package/security/compliance-automation.md +993 -0
- package/security/container-security.md +680 -0
- package/security/devsecops-complete.md +426 -0
- package/security/sast-dast-sca.md +775 -0
- package/security/secrets-management.md +594 -0
- package/security/security-architecture-deep-dive.md +37 -0
- package/security/threat-modeling-stride-playbook.md +40 -0
- package/seed-templates/auth-system.md +59 -0
- package/seed-templates/blog-content.md +94 -0
- package/seed-templates/dashboard.md +89 -0
- package/seed-templates/docs-site.md +73 -0
- package/seed-templates/e-commerce.md +50 -0
- package/seed-templates/saas-landing.md +92 -0
- package/seed-templates/settings-page.md +51 -0
- package/testing/01-standards/test-strategy-and-layering.md +83 -0
- package/testing/01-standards/testing-strategy-complete.md +422 -0
- package/testing/01-standards/unit-testing-best-practices.md +118 -0
- package/testing/02-playbooks/e2e-testing-playbook.md +988 -0
- package/testing/02-playbooks/testing-strategy-playbook.md +126 -0
- package/testing/03-checklists/test-strategy-checklist.md +208 -0
- package/testing/04-antipatterns/testing-antipatterns.md +718 -0
- package/testing/05-cases/case-testing-transformation.md +300 -0
- package/testing/06-glossary/testing-glossary.md +110 -0
- package/testing/risk-based-test-matrix.md +36 -0
- package/testing/testing-strategy-deep-dive.md +37 -0
|
@@ -0,0 +1,388 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: design-review-playbook
|
|
3
|
+
title: 设计评审作战手册 (Design Review Playbook)
|
|
4
|
+
domain: design
|
|
5
|
+
category: 02-playbooks
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [design, issue, playbook, review, 严重程度, 列表, 前置条件, 搜索结果页缺少空状态设计]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 设计评审作战手册 (Design Review Playbook)
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
本手册定义了设计评审的完整流程,涵盖评审准备、六大评审维度(一致性、可用性、无障碍、响应式、性能、品牌)、评审模板、反馈格式和跟踪机制。目标是在设计交付开发前拦截问题,减少返工成本。
|
|
16
|
+
|
|
17
|
+
## 前置条件
|
|
18
|
+
|
|
19
|
+
### 必须满足
|
|
20
|
+
|
|
21
|
+
- [ ] 设计稿已在 Figma / Sketch 中完成至少 High-Fidelity 程度
|
|
22
|
+
- [ ] 设计稿覆盖所有核心用户流程(Happy Path + Edge Cases)
|
|
23
|
+
- [ ] 已定义 Design System / Token 基础(颜色、字体、间距)
|
|
24
|
+
- [ ] PRD 已确认,需求无歧义
|
|
25
|
+
- [ ] 已指定评审参与者(设计师、前端开发、PM、QA)
|
|
26
|
+
|
|
27
|
+
### 建议满足
|
|
28
|
+
|
|
29
|
+
- [ ] 有可点击的交互原型(Figma Prototype)
|
|
30
|
+
- [ ] 已标注关键的微交互动画
|
|
31
|
+
- [ ] 有竞品分析作为评审参考
|
|
32
|
+
- [ ] 移动端与桌面端设计稿齐备
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 步骤一:评审准备
|
|
37
|
+
|
|
38
|
+
### 1.1 评审发起者(设计师)准备清单
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
评审前 48 小时
|
|
42
|
+
├── 1. 整理设计稿链接,确保权限可访问
|
|
43
|
+
├── 2. 编写设计说明文档
|
|
44
|
+
│ ├── 设计目标与用户场景
|
|
45
|
+
│ ├── 关键设计决策及理由
|
|
46
|
+
│ ├── 与前版设计的差异对比
|
|
47
|
+
│ └── 已知的取舍和限制
|
|
48
|
+
├── 3. 准备评审材料
|
|
49
|
+
│ ├── 用户流程图(User Flow)
|
|
50
|
+
│ ├── 关键页面标注(间距 / 字号 / 颜色 Token)
|
|
51
|
+
│ ├── 交互状态说明(Default / Hover / Active / Disabled / Error / Loading / Empty)
|
|
52
|
+
│ └── 响应式断点设计(Mobile / Tablet / Desktop)
|
|
53
|
+
├── 4. 发送评审邀请
|
|
54
|
+
│ ├── 附上设计稿链接
|
|
55
|
+
│ ├── 附上设计说明文档
|
|
56
|
+
│ ├── 明确评审范围(全局评审 / 局部评审)
|
|
57
|
+
│ └── 建议评审关注点
|
|
58
|
+
└── 5. 预约评审会议(45-60 分钟)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 1.2 评审参与者准备清单
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
评审前 24 小时
|
|
65
|
+
├── 1. 通读设计说明文档
|
|
66
|
+
├── 2. 浏览设计稿,标记初步反馈(Figma Comment)
|
|
67
|
+
├── 3. 对照 PRD 检查需求覆盖度
|
|
68
|
+
├── 4. 从自身角色视角准备问题
|
|
69
|
+
│ ├── 前端:实现可行性、组件复用性、性能影响
|
|
70
|
+
│ ├── PM:需求满足度、业务逻辑完整性
|
|
71
|
+
│ ├── QA:边界状态覆盖、可测试性
|
|
72
|
+
│ └── 设计:一致性、可用性、美观度
|
|
73
|
+
└── 5. 记录发现的问题(按严重程度分类)
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 步骤二:六大评审维度
|
|
79
|
+
|
|
80
|
+
### 2.1 一致性(Consistency)
|
|
81
|
+
|
|
82
|
+
评审设计稿与 Design System 的一致性。
|
|
83
|
+
|
|
84
|
+
| 检查项 | 判定标准 | 严重程度 |
|
|
85
|
+
|--------|---------|:-------:|
|
|
86
|
+
| 颜色使用 Token | 所有颜色引用 Design Token,无硬编码 HEX 值 | HIGH |
|
|
87
|
+
| 字体层级 | 标题/正文/辅助文字符合 Typography Scale 定义 | HIGH |
|
|
88
|
+
| 间距系统 | 间距使用 4px / 8px 基准网格 | MEDIUM |
|
|
89
|
+
| 组件复用 | 使用 Design System 中已有组件,不重复造轮子 | HIGH |
|
|
90
|
+
| 图标风格 | 图标风格统一(线性/填充/粗细/圆角) | MEDIUM |
|
|
91
|
+
| 圆角一致 | 相同层级的卡片/按钮圆角值一致 | LOW |
|
|
92
|
+
| 阴影层级 | 阴影使用预定义的 Elevation Token | LOW |
|
|
93
|
+
| 交互模式 | 相同功能的交互方式一致(如删除确认方式) | HIGH |
|
|
94
|
+
|
|
95
|
+
```markdown
|
|
96
|
+
# 一致性检查示例
|
|
97
|
+
|
|
98
|
+
## 问题:颜色硬编码
|
|
99
|
+
- 位置:首页 Banner 标题
|
|
100
|
+
- 当前:#1A73E8(硬编码)
|
|
101
|
+
- 应该:使用 Token `color-primary-600`
|
|
102
|
+
- 严重程度:HIGH
|
|
103
|
+
- 原因:品牌色调整时此处不会自动更新
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 2.2 可用性(Usability)
|
|
107
|
+
|
|
108
|
+
评审设计是否易用、直觉、高效。
|
|
109
|
+
|
|
110
|
+
| 检查项 | 判定标准 | 严重程度 |
|
|
111
|
+
|--------|---------|:-------:|
|
|
112
|
+
| 操作反馈 | 每个操作有明确的成功/失败/加载反馈 | HIGH |
|
|
113
|
+
| 错误提示 | 错误信息具体、可操作(非"发生错误") | HIGH |
|
|
114
|
+
| 空状态 | 列表/搜索空状态有引导文案和操作入口 | MEDIUM |
|
|
115
|
+
| 加载状态 | 长操作有 Loading / Skeleton 提示 | HIGH |
|
|
116
|
+
| 撤销机制 | 破坏性操作有确认弹窗或撤销能力 | HIGH |
|
|
117
|
+
| 表单验证 | 实时校验 + 行内错误提示,非提交后弹窗 | MEDIUM |
|
|
118
|
+
| 导航可预测 | 用户能清楚知道自己在哪、能去哪、怎么回来 | HIGH |
|
|
119
|
+
| 信息层级 | 页面信息主次分明,核心操作突出 | MEDIUM |
|
|
120
|
+
| 手势操作 | 移动端的滑动/长按等手势有视觉暗示 | LOW |
|
|
121
|
+
| 文案清晰 | 按钮和标签文案明确,避免"确定"等模糊词 | MEDIUM |
|
|
122
|
+
|
|
123
|
+
```markdown
|
|
124
|
+
# 可用性检查示例
|
|
125
|
+
|
|
126
|
+
## 问题:删除操作无确认
|
|
127
|
+
- 位置:文章管理 > 删除按钮
|
|
128
|
+
- 当前:点击后直接删除
|
|
129
|
+
- 建议:添加确认弹窗 "确认删除《文章标题》?此操作不可撤销。"
|
|
130
|
+
- 严重程度:HIGH
|
|
131
|
+
- 原因:误触风险高,数据不可恢复
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### 2.3 无障碍(Accessibility / A11y)
|
|
135
|
+
|
|
136
|
+
评审设计是否符合 WCAG 2.1 AA 标准。
|
|
137
|
+
|
|
138
|
+
| 检查项 | 判定标准 | 严重程度 |
|
|
139
|
+
|--------|---------|:-------:|
|
|
140
|
+
| 颜色对比度 | 正文 >= 4.5:1,大文字 >= 3:1 (WCAG AA) | HIGH |
|
|
141
|
+
| 不仅靠颜色传达信息 | 状态除颜色外有图标/文字辅助区分 | HIGH |
|
|
142
|
+
| 焦点可见 | Tab 导航时焦点环清晰可见 | HIGH |
|
|
143
|
+
| 触摸目标 | 移动端可点击区域 >= 44x44px | MEDIUM |
|
|
144
|
+
| 文字可缩放 | 字号使用相对单位(rem),200% 缩放不破版 | MEDIUM |
|
|
145
|
+
| 表单标签 | 每个表单字段有可见的 Label | HIGH |
|
|
146
|
+
| 图片替代文字 | 功能性图片有 alt 描述 | MEDIUM |
|
|
147
|
+
| 键盘可操作 | 所有功能可通过键盘完成 | HIGH |
|
|
148
|
+
| 动画减弱 | 支持 prefers-reduced-motion 媒体查询 | LOW |
|
|
149
|
+
| 语义结构 | 标题层级有序(h1 > h2 > h3),不跳级 | MEDIUM |
|
|
150
|
+
|
|
151
|
+
```markdown
|
|
152
|
+
# 无障碍检查示例
|
|
153
|
+
|
|
154
|
+
## 问题:按钮颜色对比度不足
|
|
155
|
+
- 位置:登录页 > 次要按钮
|
|
156
|
+
- 当前:文字 #999999 + 背景 #F5F5F5,对比度 2.8:1
|
|
157
|
+
- 建议:文字改为 #666666,对比度 5.7:1
|
|
158
|
+
- 严重程度:HIGH
|
|
159
|
+
- 标准:WCAG 2.1 AA 要求正文对比度 >= 4.5:1
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### 2.4 响应式(Responsive Design)
|
|
163
|
+
|
|
164
|
+
评审设计在不同屏幕尺寸下的表现。
|
|
165
|
+
|
|
166
|
+
| 检查项 | 判定标准 | 严重程度 |
|
|
167
|
+
|--------|---------|:-------:|
|
|
168
|
+
| 断点定义 | 覆盖 Mobile (375px+) / Tablet (768px+) / Desktop (1280px+) | HIGH |
|
|
169
|
+
| 布局切换 | 每个断点的布局策略明确(栅格列数、侧边栏折叠) | HIGH |
|
|
170
|
+
| 导航适配 | 移动端有 Hamburger Menu / Bottom Nav 方案 | HIGH |
|
|
171
|
+
| 图片适配 | 大图在移动端缩放或裁切方案明确 | MEDIUM |
|
|
172
|
+
| 表格适配 | 宽表格在移动端的处理方案(横滑/折叠/卡片化) | MEDIUM |
|
|
173
|
+
| 触摸优化 | 移动端按钮间距足够,避免误触 | MEDIUM |
|
|
174
|
+
| 文字截断 | 长文本的截断策略(省略号/折行/展开) | LOW |
|
|
175
|
+
| 弹窗适配 | 弹窗在移动端改为全屏 Sheet 或 Bottom Sheet | MEDIUM |
|
|
176
|
+
|
|
177
|
+
```markdown
|
|
178
|
+
# 响应式检查示例
|
|
179
|
+
|
|
180
|
+
## 问题:数据表格缺少移动端方案
|
|
181
|
+
- 位置:订单管理 > 订单列表
|
|
182
|
+
- 当前:桌面端 8 列表格,移动端未设计
|
|
183
|
+
- 建议方案 A:仅显示关键 3 列,点击展开详情
|
|
184
|
+
- 建议方案 B:移动端切换为卡片布局
|
|
185
|
+
- 严重程度:HIGH
|
|
186
|
+
- 原因:50%+ 用户通过移动端访问
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### 2.5 性能(Performance)
|
|
190
|
+
|
|
191
|
+
评审设计对前端性能的影响。
|
|
192
|
+
|
|
193
|
+
| 检查项 | 判定标准 | 严重程度 |
|
|
194
|
+
|--------|---------|:-------:|
|
|
195
|
+
| 图片格式和大小 | 使用 WebP/AVIF,Hero 图 < 200KB,图标使用 SVG | MEDIUM |
|
|
196
|
+
| 字体加载 | 自定义字体 <= 2 个家族,有 fallback 字体 | MEDIUM |
|
|
197
|
+
| 动画复杂度 | 动画仅使用 transform/opacity(GPU 加速属性) | MEDIUM |
|
|
198
|
+
| 首屏内容 | 首屏在 1 秒内有意义的内容(不能全是骨架屏) | HIGH |
|
|
199
|
+
| 列表加载 | 长列表使用虚拟滚动或分页,非全量渲染 | HIGH |
|
|
200
|
+
| 图片懒加载 | 首屏外的图片使用懒加载 | MEDIUM |
|
|
201
|
+
| 组件按需 | 非首屏的重组件(图表/编辑器)支持懒加载 | MEDIUM |
|
|
202
|
+
| 交互动画 | 动画时长 200-400ms,不阻塞用户操作 | LOW |
|
|
203
|
+
|
|
204
|
+
### 2.6 品牌(Brand Alignment)
|
|
205
|
+
|
|
206
|
+
评审设计与品牌调性的一致性。
|
|
207
|
+
|
|
208
|
+
| 检查项 | 判定标准 | 严重程度 |
|
|
209
|
+
|--------|---------|:-------:|
|
|
210
|
+
| 品牌色使用 | 主色/辅色使用品牌规范中的颜色 | HIGH |
|
|
211
|
+
| Logo 使用 | Logo 尺寸/间距/背景符合品牌规范 | HIGH |
|
|
212
|
+
| 语气 (Tone) | 文案语气与品牌定位一致(专业/友好/活泼) | MEDIUM |
|
|
213
|
+
| 图片风格 | 图片/插画风格统一,与品牌调性匹配 | MEDIUM |
|
|
214
|
+
| 差异化 | 设计有品牌辨识度,非通用模板 | MEDIUM |
|
|
215
|
+
| 情感化 | 关键交互有品牌独有的微交互/动画 | LOW |
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
## 步骤三:评审会议流程
|
|
220
|
+
|
|
221
|
+
### 3.1 会议时间线(45 分钟)
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
[0-5 min] 设计师介绍背景和设计目标
|
|
225
|
+
[5-10 min] Walk-through 核心用户流程
|
|
226
|
+
[10-35 min] 逐维度评审(按优先级排序)
|
|
227
|
+
- 一致性 (5 min)
|
|
228
|
+
- 可用性 (10 min)
|
|
229
|
+
- 无障碍 (5 min)
|
|
230
|
+
- 响应式 (5 min)
|
|
231
|
+
[35-40 min] 讨论关键争议点,达成共识
|
|
232
|
+
[40-45 min] 总结 Action Items,指定负责人和截止时间
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### 3.2 评审纪律
|
|
236
|
+
|
|
237
|
+
1. **评审的是设计,不是设计师** -- 所有反馈针对作品,非个人
|
|
238
|
+
2. **给出具体建议,而非模糊感受** -- "这个按钮对比度不够" 优于 "感觉不太对"
|
|
239
|
+
3. **区分主观偏好与客观问题** -- 主观偏好不作为 blocker
|
|
240
|
+
4. **当场不能达成共识的,记录后线下讨论** -- 不耗时间在单个争议上
|
|
241
|
+
5. **每个 Issue 必须有明确的严重程度和建议方案**
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## 步骤四:反馈格式
|
|
246
|
+
|
|
247
|
+
### 4.1 标准 Issue 格式
|
|
248
|
+
|
|
249
|
+
```markdown
|
|
250
|
+
## [严重程度] 简短标题
|
|
251
|
+
|
|
252
|
+
- **位置**:页面名 > 区域/组件
|
|
253
|
+
- **问题**:描述当前设计的具体问题
|
|
254
|
+
- **依据**:引用设计原则 / WCAG 标准 / Design System 规范
|
|
255
|
+
- **建议**:提出具体的改进方案(附截图/标注)
|
|
256
|
+
- **影响**:如果不修复,对用户/业务的具体影响
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### 4.2 严重程度定义
|
|
260
|
+
|
|
261
|
+
| 级别 | 标识 | 定义 | 处理要求 |
|
|
262
|
+
|------|------|------|---------|
|
|
263
|
+
| P0 | BLOCKER | 功能不可用或严重违反合规要求 | 必须修复后才能进入开发 |
|
|
264
|
+
| P1 | HIGH | 影响主流程的可用性或一致性问题 | 必须在当前迭代内修复 |
|
|
265
|
+
| P2 | MEDIUM | 影响体验但不阻塞功能的问题 | 下个迭代修复 |
|
|
266
|
+
| P3 | LOW | 美观度、微交互等优化建议 | 排入 Backlog |
|
|
267
|
+
|
|
268
|
+
### 4.3 反馈示例(完整)
|
|
269
|
+
|
|
270
|
+
```markdown
|
|
271
|
+
## [P1] 搜索结果页缺少空状态设计
|
|
272
|
+
|
|
273
|
+
- **位置**:搜索结果页 > 列表区域
|
|
274
|
+
- **问题**:搜索无结果时,页面显示空白,用户不知道发生了什么
|
|
275
|
+
- **依据**:可用性原则 -- 系统状态可见性(Nielsen #1)
|
|
276
|
+
- **建议**:
|
|
277
|
+
1. 显示插画 + "未找到相关结果" 文案
|
|
278
|
+
2. 提供搜索建议:"试试更换关键词" / "浏览热门分类"
|
|
279
|
+
3. 提供快捷操作入口:"清除筛选条件" / "返回首页"
|
|
280
|
+
- **影响**:用户搜索无果后流失率预计增加 15-20%
|
|
281
|
+
|
|
282
|
+
## [P0] 表单提交按钮在移动端被键盘遮挡
|
|
283
|
+
|
|
284
|
+
- **位置**:注册页 > 表单底部
|
|
285
|
+
- **问题**:移动端弹出虚拟键盘后,提交按钮被完全遮挡,用户需要收起键盘才能点击
|
|
286
|
+
- **依据**:可用性原则 -- 移动端输入体验最佳实践
|
|
287
|
+
- **建议**:
|
|
288
|
+
1. 提交按钮固定在键盘上方(Sticky Bottom)
|
|
289
|
+
2. 或者在最后一个输入框的键盘 Return 键触发提交
|
|
290
|
+
- **影响**:阻塞注册主流程,预计影响 30%+ 移动端注册转化
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## 步骤五:评审结果与跟踪
|
|
296
|
+
|
|
297
|
+
### 5.1 评审结论
|
|
298
|
+
|
|
299
|
+
| 结论 | 定义 | 后续动作 |
|
|
300
|
+
|------|------|---------|
|
|
301
|
+
| APPROVED | 无 P0/P1 问题,可直接进入开发 | 设计 Handoff |
|
|
302
|
+
| APPROVED WITH CONDITIONS | 有 P1 问题但不阻塞开发启动 | 设计师修复 P1 后异步确认 |
|
|
303
|
+
| REVISION REQUIRED | 有 P0 问题或大量 P1 问题 | 设计师修改后重新评审 |
|
|
304
|
+
| REJECTED | 设计方向有根本问题 | 需要重新设计,安排新的设计冲刺 |
|
|
305
|
+
|
|
306
|
+
### 5.2 Issue 跟踪模板
|
|
307
|
+
|
|
308
|
+
```markdown
|
|
309
|
+
# Design Review: [功能名] - [日期]
|
|
310
|
+
|
|
311
|
+
## 评审信息
|
|
312
|
+
- 设计稿:[Figma 链接]
|
|
313
|
+
- 参与者:[姓名列表]
|
|
314
|
+
- 评审结论:APPROVED WITH CONDITIONS
|
|
315
|
+
|
|
316
|
+
## Issue 列表
|
|
317
|
+
|
|
318
|
+
| # | 严重程度 | 标题 | 负责人 | 截止日期 | 状态 |
|
|
319
|
+
|---|:-------:|------|--------|---------|------|
|
|
320
|
+
| 1 | P0 | 表单按钮被键盘遮挡 | @Alice | 06-20 | DONE |
|
|
321
|
+
| 2 | P1 | 搜索空状态缺失 | @Alice | 06-22 | IN PROGRESS |
|
|
322
|
+
| 3 | P1 | 颜色对比度不足 (3处) | @Alice | 06-22 | TODO |
|
|
323
|
+
| 4 | P2 | 表格移动端适配 | @Alice | 07-01 | BACKLOG |
|
|
324
|
+
| 5 | P3 | 微交互动画优化 | @Alice | TBD | BACKLOG |
|
|
325
|
+
|
|
326
|
+
## 跟进会议
|
|
327
|
+
- 复核日期:06-23
|
|
328
|
+
- P0/P1 Issue 全部关闭后可以开始开发
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### 5.3 设计交付 (Design Handoff) 清单
|
|
332
|
+
|
|
333
|
+
评审通过后,设计师需提供以下交付物给开发团队:
|
|
334
|
+
|
|
335
|
+
```
|
|
336
|
+
设计交付物
|
|
337
|
+
├── 1. 标注完整的设计稿(Figma Dev Mode / Zeplin)
|
|
338
|
+
│ ├── 所有间距标注
|
|
339
|
+
│ ├── 所有颜色 Token 标注
|
|
340
|
+
│ ├── 所有字号/行高标注
|
|
341
|
+
│ └── 组件与 Design System 的映射关系
|
|
342
|
+
├── 2. 交互说明文档
|
|
343
|
+
│ ├── 状态机图(状态之间的转换条件)
|
|
344
|
+
│ ├── 动画/过渡效果说明(时长 / 缓动 / 属性)
|
|
345
|
+
│ ├── 手势操作说明(移动端)
|
|
346
|
+
│ └── 键盘快捷键说明(桌面端)
|
|
347
|
+
├── 3. 设计资源
|
|
348
|
+
│ ├── 切图(SVG 图标、PNG/WebP 图片)
|
|
349
|
+
│ ├── 自定义字体文件
|
|
350
|
+
│ └── Lottie 动画文件(如有)
|
|
351
|
+
├── 4. 响应式说明
|
|
352
|
+
│ ├── 各断点的布局变化
|
|
353
|
+
│ ├── 组件的响应式行为
|
|
354
|
+
│ └── 最小/最大宽度限制
|
|
355
|
+
└── 5. 边界情况说明
|
|
356
|
+
├── 超长文本处理
|
|
357
|
+
├── 极端数据(0条 / 1条 / 1000条)
|
|
358
|
+
├── 慢网络 / 离线状态
|
|
359
|
+
└── 权限差异(管理员 vs 普通用户)
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
---
|
|
363
|
+
|
|
364
|
+
## 评审维度权重(按场景调整)
|
|
365
|
+
|
|
366
|
+
| 维度 | To C 产品 | To B 产品 | 内部工具 |
|
|
367
|
+
|------|:--------:|:--------:|:-------:|
|
|
368
|
+
| 一致性 | 25% | 30% | 20% |
|
|
369
|
+
| 可用性 | 30% | 25% | 35% |
|
|
370
|
+
| 无障碍 | 15% | 10% | 5% |
|
|
371
|
+
| 响应式 | 15% | 15% | 10% |
|
|
372
|
+
| 性能 | 10% | 10% | 20% |
|
|
373
|
+
| 品牌 | 5% | 10% | 10% |
|
|
374
|
+
|
|
375
|
+
---
|
|
376
|
+
|
|
377
|
+
## Agent Checklist
|
|
378
|
+
|
|
379
|
+
- [ ] 设计稿已达到 High-Fidelity 程度,核心流程完整
|
|
380
|
+
- [ ] Design System Token(颜色/字体/间距)已定义并在稿中使用
|
|
381
|
+
- [ ] 六大维度逐项评审:一致性/可用性/无障碍/响应式/性能/品牌
|
|
382
|
+
- [ ] 颜色对比度通过 WCAG AA 标准(正文 >= 4.5:1)
|
|
383
|
+
- [ ] 所有组件覆盖完整状态(Default/Hover/Active/Disabled/Error/Loading/Empty)
|
|
384
|
+
- [ ] 响应式设计覆盖 Mobile / Tablet / Desktop 三个断点
|
|
385
|
+
- [ ] 空状态、错误状态、加载状态均有设计方案
|
|
386
|
+
- [ ] 所有 Issue 按 P0-P3 分级,P0/P1 有明确负责人和截止日期
|
|
387
|
+
- [ ] 评审结论明确(Approved / Revision Required / Rejected)
|
|
388
|
+
- [ ] 设计交付物(标注/交互说明/资源/边界情况)准备齐全
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: design-review-checklist
|
|
3
|
+
title: Design Review Checklist
|
|
4
|
+
domain: design
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [agent, checklist, compliance, consistency, design, feedback, review, 概述]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# Design Review Checklist
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
设计评审是确保产品设计质量的关键环节。本检查清单覆盖视觉一致性、无障碍性、响应式适配、品牌规范、动效表现和交互反馈六大维度,适用于 UI 设计稿评审、前端实现走查和上线前最终确认。每条检查项标注优先级(P0 必须 / P1 应该 / P2 建议),团队可根据项目阶段灵活裁剪。
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 一、视觉一致性(Visual Consistency)
|
|
20
|
+
|
|
21
|
+
### 颜色系统
|
|
22
|
+
|
|
23
|
+
- [ ] **[P0]** 所有颜色引用 Design Token,无硬编码 HEX/RGB 值
|
|
24
|
+
- [ ] **[P0]** 主色/辅色/中性色使用正确的语义色阶(primary-500, neutral-100 等)
|
|
25
|
+
- [ ] **[P0]** 语义颜色正确使用:success=绿色、warning=橙色、error=红色、info=蓝色
|
|
26
|
+
- [ ] **[P1]** 暗色模式下颜色对比度满足 WCAG AA(4.5:1 正文,3:1 大字)
|
|
27
|
+
- [ ] **[P1]** 品牌色在不同背景下可读性测试通过
|
|
28
|
+
- [ ] **[P2]** 颜色数量控制在设计系统定义范围内,无多余颜色
|
|
29
|
+
|
|
30
|
+
### 排版系统
|
|
31
|
+
|
|
32
|
+
- [ ] **[P0]** 字体族(font-family)与品牌规范一致
|
|
33
|
+
- [ ] **[P0]** 标题层级使用正确的 Text Style(H1-H6)
|
|
34
|
+
- [ ] **[P0]** 正文字号不小于 14px(移动端不小于 16px)
|
|
35
|
+
- [ ] **[P1]** 行高(line-height)遵循设计系统:标题 1.2-1.3,正文 1.5-1.7
|
|
36
|
+
- [ ] **[P1]** 字重梯度合理:Regular(400)、Medium(500)、Semibold(600)、Bold(700)
|
|
37
|
+
- [ ] **[P1]** 段落最大宽度不超过 75 个字符(中文约 35 个汉字)
|
|
38
|
+
- [ ] **[P2]** 中英文混排时字体回退链正确
|
|
39
|
+
|
|
40
|
+
### 间距与网格
|
|
41
|
+
|
|
42
|
+
- [ ] **[P0]** 间距使用 4px/8px 基准网格
|
|
43
|
+
- [ ] **[P0]** 组件内部间距统一(padding 引用 Token)
|
|
44
|
+
- [ ] **[P0]** 组件之间间距统一(margin/gap 引用 Token)
|
|
45
|
+
- [ ] **[P1]** 页面整体使用网格系统(12 列或自定义)
|
|
46
|
+
- [ ] **[P1]** 内容区域左右边距与设计系统一致
|
|
47
|
+
- [ ] **[P2]** 视觉重心平衡,留白合理
|
|
48
|
+
|
|
49
|
+
### 图标与图片
|
|
50
|
+
|
|
51
|
+
- [ ] **[P0]** 图标风格统一(线性/填充/双色不混用)
|
|
52
|
+
- [ ] **[P0]** 图标尺寸成系统:16px / 20px / 24px / 32px
|
|
53
|
+
- [ ] **[P1]** 图片比例一致(卡片内图片统一为 16:9 或 4:3)
|
|
54
|
+
- [ ] **[P1]** 占位图/缺省图/加载图设计到位
|
|
55
|
+
- [ ] **[P2]** 图片压缩和格式优化(WebP 优先)
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 二、无障碍性(Accessibility)
|
|
60
|
+
|
|
61
|
+
### 感知性
|
|
62
|
+
|
|
63
|
+
- [ ] **[P0]** 文本颜色与背景对比度 >= 4.5:1(WCAG AA)
|
|
64
|
+
- [ ] **[P0]** 非文本元素(图标、按钮)对比度 >= 3:1
|
|
65
|
+
- [ ] **[P0]** 信息传递不仅依赖颜色(辅助图标或文本标识)
|
|
66
|
+
- [ ] **[P1]** 图片包含有意义的 alt 文本
|
|
67
|
+
- [ ] **[P1]** 表单字段有可见的 label(非仅 placeholder)
|
|
68
|
+
- [ ] **[P2]** 视频/音频内容提供字幕或文本替代
|
|
69
|
+
|
|
70
|
+
### 可操作性
|
|
71
|
+
|
|
72
|
+
- [ ] **[P0]** 可点击元素最小触控区域 44x44px(移动端)
|
|
73
|
+
- [ ] **[P0]** 键盘可达:所有交互元素支持 Tab 导航
|
|
74
|
+
- [ ] **[P0]** 焦点状态可见且清晰(focus ring)
|
|
75
|
+
- [ ] **[P1]** 焦点顺序与视觉顺序一致
|
|
76
|
+
- [ ] **[P1]** 无键盘陷阱(Modal 除外,但 Modal 需支持 Esc 关闭)
|
|
77
|
+
- [ ] **[P1]** 拖拽操作提供键盘替代方案
|
|
78
|
+
- [ ] **[P2]** 动画可通过 prefers-reduced-motion 关闭
|
|
79
|
+
|
|
80
|
+
### 可理解性
|
|
81
|
+
|
|
82
|
+
- [ ] **[P0]** 错误信息明确指出问题和修复方法
|
|
83
|
+
- [ ] **[P0]** 表单验证在提交前提供实时反馈
|
|
84
|
+
- [ ] **[P1]** 页面语言正确设置(lang 属性)
|
|
85
|
+
- [ ] **[P1]** 链接文本描述目标而非泛泛的"点击这里"
|
|
86
|
+
- [ ] **[P2]** 复杂操作提供帮助文本或引导
|
|
87
|
+
|
|
88
|
+
### 健壮性
|
|
89
|
+
|
|
90
|
+
- [ ] **[P0]** 语义化 HTML:heading 层级正确,表单使用 fieldset/legend
|
|
91
|
+
- [ ] **[P0]** ARIA 属性正确使用(aria-label, aria-expanded, role 等)
|
|
92
|
+
- [ ] **[P1]** 屏幕阅读器测试通过(VoiceOver / NVDA)
|
|
93
|
+
- [ ] **[P2]** 支持浏览器缩放至 200% 仍可用
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 三、响应式适配(Responsive Design)
|
|
98
|
+
|
|
99
|
+
### 断点系统
|
|
100
|
+
|
|
101
|
+
- [ ] **[P0]** 定义的断点覆盖主流设备:Mobile / Tablet / Desktop / Wide
|
|
102
|
+
- [ ] **[P0]** 断点值与 CSS 框架和设计稿一致
|
|
103
|
+
- [ ] **[P1]** 断点之间的过渡平滑,无布局跳变
|
|
104
|
+
- [ ] **[P1]** 容器查询用于组件级响应式(如适用)
|
|
105
|
+
|
|
106
|
+
### 布局适配
|
|
107
|
+
|
|
108
|
+
- [ ] **[P0]** 移动端优先设计,内容不被截断或溢出
|
|
109
|
+
- [ ] **[P0]** 导航在移动端转为汉堡菜单或 Bottom Tab
|
|
110
|
+
- [ ] **[P0]** 表格在小屏幕有滚动或卡片化方案
|
|
111
|
+
- [ ] **[P1]** 侧边栏在移动端可收起或转为全屏
|
|
112
|
+
- [ ] **[P1]** 图片使用 srcset 提供不同分辨率版本
|
|
113
|
+
- [ ] **[P2]** 超宽屏(>1920px)有最大内容宽度限制
|
|
114
|
+
|
|
115
|
+
### 文本适配
|
|
116
|
+
|
|
117
|
+
- [ ] **[P0]** 长文本正确截断(ellipsis 或 line-clamp)
|
|
118
|
+
- [ ] **[P0]** 多语言场景下文本溢出处理
|
|
119
|
+
- [ ] **[P1]** 字号在移动端适当缩小(fluid typography)
|
|
120
|
+
- [ ] **[P2]** 表单 label 在窄屏时从左侧切换为顶部
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## 四、品牌规范(Brand Compliance)
|
|
125
|
+
|
|
126
|
+
### 视觉标识
|
|
127
|
+
|
|
128
|
+
- [ ] **[P0]** Logo 使用正确版本(全彩/单色/反白),安全区域充足
|
|
129
|
+
- [ ] **[P0]** 品牌主色使用正确,无色差
|
|
130
|
+
- [ ] **[P1]** 品牌字体正确加载,回退字体合理
|
|
131
|
+
- [ ] **[P1]** 图片风格与品牌调性一致(摄影/插画/3D)
|
|
132
|
+
- [ ] **[P2]** 品牌声音(Voice & Tone)在文案中一致
|
|
133
|
+
|
|
134
|
+
### 风格一致性
|
|
135
|
+
|
|
136
|
+
- [ ] **[P0]** 按钮/输入框/卡片风格在全站统一
|
|
137
|
+
- [ ] **[P0]** 圆角策略统一(全圆角/小圆角/直角不混用)
|
|
138
|
+
- [ ] **[P1]** 阴影层级统一(elevation system)
|
|
139
|
+
- [ ] **[P1]** 分隔线/边框使用一致
|
|
140
|
+
- [ ] **[P2]** 空状态插画风格与品牌一致
|
|
141
|
+
|
|
142
|
+
### 反 AI 模板感
|
|
143
|
+
|
|
144
|
+
- [ ] **[P0]** 无默认紫色渐变背景
|
|
145
|
+
- [ ] **[P0]** 无 emoji 图标替代专业图标
|
|
146
|
+
- [ ] **[P0]** 无默认系统字体堆砌的模板感
|
|
147
|
+
- [ ] **[P1]** 有自定义设计元素而非纯 UI Kit 拼搭
|
|
148
|
+
- [ ] **[P1]** Hero 区域有真实内容而非泛泛口号
|
|
149
|
+
- [ ] **[P2]** 微交互有品牌特色而非通用动效
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 五、动效设计(Motion Design)
|
|
154
|
+
|
|
155
|
+
### 基础规范
|
|
156
|
+
|
|
157
|
+
- [ ] **[P0]** 动效时长合理:微交互 100-200ms,过渡 200-400ms,复杂动画 400-600ms
|
|
158
|
+
- [ ] **[P0]** 缓动函数统一定义:ease-out 进入、ease-in 退出
|
|
159
|
+
- [ ] **[P1]** 页面切换有过渡效果(非瞬切)
|
|
160
|
+
- [ ] **[P1]** 列表项入场有交错动画(stagger)
|
|
161
|
+
- [ ] **[P2]** 滚动驱动的动画有明确触发点
|
|
162
|
+
|
|
163
|
+
### 性能约束
|
|
164
|
+
|
|
165
|
+
- [ ] **[P0]** 动画仅使用 transform 和 opacity(GPU 加速)
|
|
166
|
+
- [ ] **[P0]** 无布局抖动(Layout Shift)动画
|
|
167
|
+
- [ ] **[P1]** 动画帧率 >= 60fps
|
|
168
|
+
- [ ] **[P1]** 首屏加载无阻塞动画
|
|
169
|
+
- [ ] **[P2]** Lottie/Rive 动画文件大小 < 50KB
|
|
170
|
+
|
|
171
|
+
### 有意义的动效
|
|
172
|
+
|
|
173
|
+
- [ ] **[P0]** 动效传达层级关系(展开/收起、进入/退出)
|
|
174
|
+
- [ ] **[P1]** 状态变化有过渡(颜色、尺寸、位置)
|
|
175
|
+
- [ ] **[P1]** 加载状态有骨架屏或进度指示
|
|
176
|
+
- [ ] **[P2]** 空状态有引导动画
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## 六、交互反馈(Interaction Feedback)
|
|
181
|
+
|
|
182
|
+
### 即时反馈
|
|
183
|
+
|
|
184
|
+
- [ ] **[P0]** 按钮点击有视觉反馈(active state)
|
|
185
|
+
- [ ] **[P0]** 表单提交有 Loading 状态和结果反馈
|
|
186
|
+
- [ ] **[P0]** 操作成功/失败有 Toast 或 Snackbar 通知
|
|
187
|
+
- [ ] **[P1]** 输入框聚焦有边框高亮
|
|
188
|
+
- [ ] **[P1]** 链接悬停有下划线或颜色变化
|
|
189
|
+
|
|
190
|
+
### 防错设计
|
|
191
|
+
|
|
192
|
+
- [ ] **[P0]** 危险操作(删除、支付)有二次确认
|
|
193
|
+
- [ ] **[P0]** 表单有实时校验而非仅提交后校验
|
|
194
|
+
- [ ] **[P1]** 不可逆操作有撤销机制
|
|
195
|
+
- [ ] **[P1]** 离开未保存页面有确认提示
|
|
196
|
+
- [ ] **[P2]** 自动保存草稿
|
|
197
|
+
|
|
198
|
+
### 系统状态
|
|
199
|
+
|
|
200
|
+
- [ ] **[P0]** 加载中有 Loading 指示器(Spinner / Skeleton)
|
|
201
|
+
- [ ] **[P0]** 空数据有 Empty State 说明和引导操作
|
|
202
|
+
- [ ] **[P0]** 网络错误有友好提示和重试按钮
|
|
203
|
+
- [ ] **[P1]** 长列表有分页或无限滚动指示
|
|
204
|
+
- [ ] **[P1]** 后台任务有进度条或完成通知
|
|
205
|
+
- [ ] **[P2]** 实时数据有更新指示器
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## 评审流程
|
|
210
|
+
|
|
211
|
+
### 评审时机
|
|
212
|
+
|
|
213
|
+
1. **设计评审**:设计稿完成后、开发前
|
|
214
|
+
2. **实现走查**:前端实现后、合并前
|
|
215
|
+
3. **上线确认**:Staging 环境、正式上线前
|
|
216
|
+
|
|
217
|
+
### 评审参与者
|
|
218
|
+
|
|
219
|
+
| 角色 | 职责 |
|
|
220
|
+
|------|------|
|
|
221
|
+
| 设计师 | 主导评审,检查还原度 |
|
|
222
|
+
| 前端开发 | 说明技术约束,确认可行性 |
|
|
223
|
+
| PM | 确认功能完整性和业务逻辑 |
|
|
224
|
+
| QA | 补充边界用例和兼容性 |
|
|
225
|
+
|
|
226
|
+
### 问题分级处理
|
|
227
|
+
|
|
228
|
+
- **P0 Blocker**:必须在当前迭代修复,阻止上线
|
|
229
|
+
- **P1 Major**:当前迭代修复,不阻止灰度但阻止全量
|
|
230
|
+
- **P2 Minor**:排入下个迭代的优化 Backlog
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Agent Checklist
|
|
235
|
+
|
|
236
|
+
以下为 AI Agent 在执行设计评审时的检查要点:
|
|
237
|
+
|
|
238
|
+
- [ ] 使用 Design Token 验证颜色/字体/间距一致性
|
|
239
|
+
- [ ] 通过对比度工具检查无障碍合规性(axe / Lighthouse)
|
|
240
|
+
- [ ] 在 Mobile / Tablet / Desktop 三个视口验证响应式
|
|
241
|
+
- [ ] 确认品牌元素(Logo/主色/字体)使用正确
|
|
242
|
+
- [ ] 检查动效性能(仅 transform/opacity,无 Layout Shift)
|
|
243
|
+
- [ ] 验证所有交互元素有完整反馈状态
|
|
244
|
+
- [ ] 确认无 AI 模板感(无紫色渐变/emoji 图标/默认字体)
|
|
245
|
+
- [ ] P0 问题全部修复后方可通过评审
|
|
246
|
+
- [ ] 评审结果记录并归档至项目文档
|