@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,166 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: component-quality-checklist
|
|
3
|
+
title: 组件质量检查清单
|
|
4
|
+
domain: frontend
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [a11y, checklist, component, frontend, props, quality, 响应式设计, 性能优化]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 组件质量检查清单
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
本清单用于在组件开发完成后、合入主干前进行系统化质量审查。涵盖 Props 验证、样式隔离、无障碍、响应式、性能和测试覆盖六个维度,确保每个组件达到商业级交付标准。
|
|
16
|
+
|
|
17
|
+
适用场景:React / Vue / Svelte 等主流框架的 UI 组件库开发及业务组件交付。
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 1. Props 验证
|
|
22
|
+
|
|
23
|
+
- [ ] 所有 Props 均已声明类型(TypeScript interface 或 PropTypes)
|
|
24
|
+
- [ ] 必填 Props 与可选 Props 区分明确,可选 Props 设置合理默认值
|
|
25
|
+
- [ ] 枚举类型 Props 使用联合类型(union type)而非 `string`
|
|
26
|
+
- [ ] 回调函数 Props 命名以 `on` 开头(如 `onClick`、`onChange`)
|
|
27
|
+
- [ ] 子组件 Props 不透传 `any` 类型
|
|
28
|
+
- [ ] 复杂对象 Props 有完整的嵌套类型定义
|
|
29
|
+
- [ ] Props 变更有向后兼容策略(deprecated 标注 + 迁移文档)
|
|
30
|
+
- [ ] 使用 `children` 或 `render props` 时类型约束明确
|
|
31
|
+
- [ ] Props 数量不超过 10 个;超过时考虑拆分组件或使用组合模式
|
|
32
|
+
- [ ] 布尔型 Props 默认值为 `false`,命名为肯定形式(如 `disabled` 而非 `notEnabled`)
|
|
33
|
+
|
|
34
|
+
## 2. 样式隔离
|
|
35
|
+
|
|
36
|
+
- [ ] 组件样式不泄漏到外部(使用 CSS Modules / Scoped CSS / CSS-in-JS)
|
|
37
|
+
- [ ] 不使用全局选择器(如 `div`、`p`、`h1`)
|
|
38
|
+
- [ ] 不使用 `!important`(特殊情况需注释说明原因)
|
|
39
|
+
- [ ] 类名命名有组件前缀或使用自动哈希(避免命名冲突)
|
|
40
|
+
- [ ] 主题变量通过 CSS 自定义属性(CSS Variables)或 Design Token 注入
|
|
41
|
+
- [ ] 样式不依赖 DOM 层级结构(避免 `.parent > .child > .target` 深层嵌套)
|
|
42
|
+
- [ ] 暗色模式 / 多主题切换已验证
|
|
43
|
+
- [ ] z-index 使用项目统一的层级管理常量,不随意指定数值
|
|
44
|
+
- [ ] 过渡动画使用 `transform` / `opacity`,避免触发布局重排
|
|
45
|
+
- [ ] 组件支持通过 `className` 或 `style` Props 进行外部样式覆盖
|
|
46
|
+
|
|
47
|
+
## 3. 无障碍(Accessibility / a11y)
|
|
48
|
+
|
|
49
|
+
- [ ] 交互元素有明确的语义化标签(`<button>`、`<a>`、`<input>` 等)
|
|
50
|
+
- [ ] 所有图片有 `alt` 属性;装饰性图片使用 `alt=""`
|
|
51
|
+
- [ ] 表单控件关联 `<label>`(通过 `htmlFor` 或嵌套)
|
|
52
|
+
- [ ] 自定义控件设置正确的 ARIA role(`role="dialog"`、`role="tablist"` 等)
|
|
53
|
+
- [ ] 焦点管理正确:模态框打开时焦点移入,关闭时焦点回到触发元素
|
|
54
|
+
- [ ] 键盘可完整操作:Tab 导航、Enter/Space 激活、Escape 关闭
|
|
55
|
+
- [ ] 颜色对比度满足 WCAG 2.1 AA 标准(正文 ≥ 4.5:1,大文本 ≥ 3:1)
|
|
56
|
+
- [ ] 动态内容变更使用 `aria-live` 通知屏幕阅读器
|
|
57
|
+
- [ ] 禁用状态使用 `aria-disabled` 而非仅视觉变灰
|
|
58
|
+
- [ ] 通过 axe-core 或 Lighthouse 无障碍扫描无严重错误
|
|
59
|
+
|
|
60
|
+
## 4. 响应式设计
|
|
61
|
+
|
|
62
|
+
- [ ] 断点使用项目统一定义(如 sm/md/lg/xl),不硬编码像素值
|
|
63
|
+
- [ ] 移动端优先(mobile-first)编写媒体查询
|
|
64
|
+
- [ ] 触摸区域最小 44x44px(符合 Apple HIG / Material Design)
|
|
65
|
+
- [ ] 文字不使用固定像素大小,使用 rem/em 相对单位
|
|
66
|
+
- [ ] 长文本有截断策略(ellipsis / 展开收起 / tooltip)
|
|
67
|
+
- [ ] 表格在小屏幕有降级方案(卡片化 / 横向滚动 / 隐藏次要列)
|
|
68
|
+
- [ ] 图片使用 `srcset` 或响应式图片方案,避免大图加载浪费带宽
|
|
69
|
+
- [ ] 弹窗 / 下拉菜单在小屏幕适配正确(不溢出视口)
|
|
70
|
+
- [ ] 横屏模式下布局不破裂
|
|
71
|
+
- [ ] 在 320px ~ 2560px 宽度范围内手动验证过渲染效果
|
|
72
|
+
|
|
73
|
+
## 5. 性能优化
|
|
74
|
+
|
|
75
|
+
- [ ] 大列表使用虚拟滚动(react-window / vue-virtual-scroller)
|
|
76
|
+
- [ ] 避免在 render 中创建新对象 / 新函数(使用 useMemo / useCallback)
|
|
77
|
+
- [ ] 图片使用懒加载(`loading="lazy"` 或 Intersection Observer)
|
|
78
|
+
- [ ] 组件按需加载(React.lazy / dynamic import)
|
|
79
|
+
- [ ] 避免不必要的重渲染(React.memo / shouldComponentUpdate / computed)
|
|
80
|
+
- [ ] 事件处理器有防抖 / 节流(搜索输入、滚动监听、窗口 resize)
|
|
81
|
+
- [ ] SVG 图标使用 sprite 或内联,不逐个请求
|
|
82
|
+
- [ ] 动画帧率保持 60fps,避免主线程阻塞
|
|
83
|
+
- [ ] 组件卸载时清理定时器、事件监听器、取消未完成请求
|
|
84
|
+
- [ ] Bundle 分析确认组件不引入过大的第三方依赖
|
|
85
|
+
|
|
86
|
+
## 6. 测试覆盖
|
|
87
|
+
|
|
88
|
+
- [ ] 单元测试覆盖所有 Props 组合的核心渲染路径
|
|
89
|
+
- [ ] 交互行为测试(点击、输入、焦点切换)使用 Testing Library
|
|
90
|
+
- [ ] 快照测试(Snapshot)仅用于稳定组件,频繁变更组件不使用
|
|
91
|
+
- [ ] 边界条件测试:空数据、超长文本、特殊字符、极大数值
|
|
92
|
+
- [ ] 异步行为测试:加载状态、错误状态、超时处理
|
|
93
|
+
- [ ] 可访问性测试(jest-axe / @axe-core/react)
|
|
94
|
+
- [ ] 视觉回归测试(Chromatic / Percy / Playwright screenshot)
|
|
95
|
+
- [ ] 测试覆盖率 ≥ 80%(行覆盖 + 分支覆盖)
|
|
96
|
+
- [ ] 测试用例有清晰的 describe/it 描述,不使用 test1/test2 命名
|
|
97
|
+
- [ ] CI 中测试通过才允许合并
|
|
98
|
+
|
|
99
|
+
## 7. 代码规范与文档
|
|
100
|
+
|
|
101
|
+
- [ ] 组件有 JSDoc / TSDoc 注释说明用途和使用示例
|
|
102
|
+
- [ ] Storybook 或同类工具中有完整 Story(包含各状态展示)
|
|
103
|
+
- [ ] 导出类型定义供外部消费
|
|
104
|
+
- [ ] 组件目录结构统一(index.ts + Component.tsx + Component.test.tsx + Component.module.css)
|
|
105
|
+
- [ ] 命名规范:组件 PascalCase,文件名与组件名一致
|
|
106
|
+
- [ ] 无 console.log / debugger 残留
|
|
107
|
+
- [ ] 无注释掉的代码块
|
|
108
|
+
- [ ] ESLint / Stylelint 无警告
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 评审流程
|
|
113
|
+
|
|
114
|
+
| 阶段 | 检查重点 | 工具 |
|
|
115
|
+
|------|---------|------|
|
|
116
|
+
| 开发自查 | Props 验证 + 样式隔离 + 代码规范 | ESLint, TypeScript |
|
|
117
|
+
| 同行评审 | 无障碍 + 响应式 + 性能 | axe-core, Lighthouse |
|
|
118
|
+
| QA 验收 | 全维度回归 | Playwright, Chromatic |
|
|
119
|
+
| 发布前 | 测试覆盖率 + Bundle 大小 | Jest, webpack-bundle-analyzer |
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## 组件复杂度评估
|
|
124
|
+
|
|
125
|
+
在决定组件是否需要拆分时,参考以下指标:
|
|
126
|
+
|
|
127
|
+
| 指标 | 健康值 | 需要关注 | 必须拆分 |
|
|
128
|
+
|------|--------|---------|---------|
|
|
129
|
+
| Props 数量 | ≤ 5 | 6-10 | > 10 |
|
|
130
|
+
| 组件行数 | ≤ 150 | 150-300 | > 300 |
|
|
131
|
+
| 嵌套层级 | ≤ 3 | 4-5 | > 5 |
|
|
132
|
+
| useState 数量 | ≤ 3 | 4-5 | > 5 |
|
|
133
|
+
| useEffect 数量 | ≤ 2 | 3 | > 3 |
|
|
134
|
+
| 条件渲染分支 | ≤ 3 | 4-5 | > 5 |
|
|
135
|
+
|
|
136
|
+
拆分原则:
|
|
137
|
+
- **单一职责**:一个组件只做一件事
|
|
138
|
+
- **容器与展示分离**:数据获取逻辑放在容器组件,UI 渲染放在展示组件
|
|
139
|
+
- **组合优于继承**:通过 children / render props 组合,而非创建深层继承链
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## 常见不合格项 Top 5
|
|
144
|
+
|
|
145
|
+
1. **Props 类型为 `any`** - 丧失类型安全,重构时无法发现调用错误
|
|
146
|
+
2. **全局样式污染** - 组件在不同页面表现不一致
|
|
147
|
+
3. **缺少键盘操作支持** - 自定义下拉框/弹窗无法用键盘关闭
|
|
148
|
+
4. **大列表不使用虚拟滚动** - 数据超过 500 条时页面卡顿
|
|
149
|
+
5. **组件卸载不清理副作用** - 导致内存泄漏和控制台报错
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## Agent Checklist
|
|
154
|
+
|
|
155
|
+
以下为 AI Agent 在审查组件时必须逐项验证的硬约束:
|
|
156
|
+
|
|
157
|
+
- [ ] 运行 `tsc --noEmit` 确认无类型错误
|
|
158
|
+
- [ ] 运行 `npx eslint --ext .tsx,.ts <component-path>` 确认无 lint 错误
|
|
159
|
+
- [ ] 运行 `npx jest --coverage <component-test-path>` 确认覆盖率 ≥ 80%
|
|
160
|
+
- [ ] 运行 Lighthouse Accessibility 审计得分 ≥ 90
|
|
161
|
+
- [ ] 检查组件在 375px(iPhone SE)和 1920px(桌面)两个宽度下的渲染
|
|
162
|
+
- [ ] 确认组件 bundle 大小不超过 50KB(gzip 后)
|
|
163
|
+
- [ ] 确认 Storybook Story 存在且可正常渲染
|
|
164
|
+
- [ ] 确认组件无 `// TODO`、`// FIXME`、`// HACK` 遗留标记
|
|
165
|
+
- [ ] 若组件为新增,确认已在组件索引文件中导出
|
|
166
|
+
- [ ] 生成审查报告并附在 PR 评论中
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: frontend-launch-checklist
|
|
3
|
+
title: 前端上线检查清单 (Frontend Launch Checklist)
|
|
4
|
+
domain: frontend
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [accessibility, checklist, engine, frontend, launch, optimization, performance, search]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 前端上线检查清单 (Frontend Launch Checklist)
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
本检查清单覆盖前端应用从开发完成到生产上线的全部验证项,确保性能、SEO、安全、无障碍、兼容性和监控六大维度全部就绪。每次上线前必须逐项确认,未通过的关键项(标记 [CRITICAL])必须修复后才能继续。
|
|
16
|
+
|
|
17
|
+
## 使用说明
|
|
18
|
+
|
|
19
|
+
- **[CRITICAL]** 标记项为强制必过门禁,任一未通过则阻断上线
|
|
20
|
+
- **[HIGH]** 标记项为高度建议项,需要负责人签字确认风险后方可跳过
|
|
21
|
+
- **[MEDIUM]** 标记项为一般建议项,可带风险上线但需在 7 天内补齐
|
|
22
|
+
- 每项需由**执行人签字**和**审核人确认**,记录**确认时间**
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 一、性能 (Performance)
|
|
27
|
+
|
|
28
|
+
### 1.1 Lighthouse 评分
|
|
29
|
+
|
|
30
|
+
- [ ] **[CRITICAL]** Lighthouse Performance 得分 ≥ 90(移动端)
|
|
31
|
+
- [ ] **[CRITICAL]** Lighthouse Performance 得分 ≥ 90(桌面端)
|
|
32
|
+
- [ ] **[HIGH]** Lighthouse Accessibility 得分 ≥ 90
|
|
33
|
+
- [ ] **[HIGH]** Lighthouse Best Practices 得分 ≥ 90
|
|
34
|
+
- [ ] **[HIGH]** Lighthouse SEO 得分 ≥ 90
|
|
35
|
+
- [ ] **[MEDIUM]** 已使用 Lighthouse CI 在 Pipeline 中自动化检测
|
|
36
|
+
|
|
37
|
+
### 1.2 Core Web Vitals
|
|
38
|
+
|
|
39
|
+
- [ ] **[CRITICAL]** LCP (Largest Contentful Paint) < 2.5s
|
|
40
|
+
- [ ] **[CRITICAL]** INP (Interaction to Next Paint) < 200ms
|
|
41
|
+
- [ ] **[CRITICAL]** CLS (Cumulative Layout Shift) < 0.1
|
|
42
|
+
- [ ] **[HIGH]** FCP (First Contentful Paint) < 1.8s
|
|
43
|
+
- [ ] **[HIGH]** TTFB (Time to First Byte) < 800ms
|
|
44
|
+
- [ ] **[MEDIUM]** 已在 RUM (Real User Monitoring) 中持续监控 Core Web Vitals
|
|
45
|
+
|
|
46
|
+
### 1.3 Bundle Size
|
|
47
|
+
|
|
48
|
+
- [ ] **[CRITICAL]** 主包 (main bundle) gzip 后 < 200KB
|
|
49
|
+
- [ ] **[HIGH]** 首屏 JS 总量 gzip 后 < 300KB
|
|
50
|
+
- [ ] **[HIGH]** 已配置代码分割 (Code Splitting),路由级别懒加载
|
|
51
|
+
- [ ] **[HIGH]** 已使用 Tree Shaking 移除未使用的代码
|
|
52
|
+
- [ ] **[MEDIUM]** 已使用 Bundle Analyzer 检查大型依赖(如 lodash 全量导入、moment.js)
|
|
53
|
+
- [ ] **[MEDIUM]** 第三方脚本(Analytics、广告、客服)使用 `async` 或 `defer` 加载
|
|
54
|
+
- [ ] **[MEDIUM]** 已评估并移除不必要的 polyfill
|
|
55
|
+
|
|
56
|
+
### 1.4 图片优化
|
|
57
|
+
|
|
58
|
+
- [ ] **[CRITICAL]** 所有图片使用现代格式(WebP / AVIF),提供 fallback
|
|
59
|
+
- [ ] **[HIGH]** 图片根据显示尺寸提供多种分辨率(`srcset` + `sizes`)
|
|
60
|
+
- [ ] **[HIGH]** 首屏以下图片使用懒加载 (`loading="lazy"`)
|
|
61
|
+
- [ ] **[HIGH]** 首屏图片设置了 `fetchpriority="high"`
|
|
62
|
+
- [ ] **[HIGH]** 所有图片设置了明确的 `width` 和 `height` 属性(防止 CLS)
|
|
63
|
+
- [ ] **[MEDIUM]** SVG 图标使用 SVG Sprite 或内联方式,而非单独 HTTP 请求
|
|
64
|
+
- [ ] **[MEDIUM]** 大图片已通过 CDN 进行动态裁剪和压缩
|
|
65
|
+
|
|
66
|
+
### 1.5 缓存策略
|
|
67
|
+
|
|
68
|
+
- [ ] **[CRITICAL]** 静态资源使用内容哈希文件名(`app.a1b2c3.js`)
|
|
69
|
+
- [ ] **[CRITICAL]** 静态资源设置长期缓存头 (`Cache-Control: max-age=31536000, immutable`)
|
|
70
|
+
- [ ] **[HIGH]** HTML 文件设置短缓存或不缓存 (`Cache-Control: no-cache`)
|
|
71
|
+
- [ ] **[HIGH]** Service Worker 缓存策略已正确配置(如有使用 PWA)
|
|
72
|
+
- [ ] **[HIGH]** CDN 缓存已配置并验证命中率
|
|
73
|
+
- [ ] **[MEDIUM]** API 响应根据业务场景设置合理的缓存策略
|
|
74
|
+
- [ ] **[MEDIUM]** 已配置 CDN 缓存清除(purge)机制,确保紧急更新可快速生效
|
|
75
|
+
|
|
76
|
+
### 1.6 字体优化
|
|
77
|
+
|
|
78
|
+
- [ ] **[HIGH]** 自定义字体使用 `font-display: swap` 或 `optional` 防止 FOIT
|
|
79
|
+
- [ ] **[HIGH]** 字体文件使用 WOFF2 格式
|
|
80
|
+
- [ ] **[HIGH]** 字体文件已子集化(subsetted),仅包含所需字符集
|
|
81
|
+
- [ ] **[MEDIUM]** 关键字体使用 `<link rel="preload">` 预加载
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## 二、SEO (Search Engine Optimization)
|
|
86
|
+
|
|
87
|
+
### 2.1 Meta 标签
|
|
88
|
+
|
|
89
|
+
- [ ] **[CRITICAL]** 每个页面都有唯一的 `<title>`(60 字符以内)
|
|
90
|
+
- [ ] **[CRITICAL]** 每个页面都有唯一的 `<meta name="description">`(160 字符以内)
|
|
91
|
+
- [ ] **[HIGH]** 页面语言已设置 (`<html lang="zh-CN">`)
|
|
92
|
+
- [ ] **[HIGH]** 视口已正确配置 (`<meta name="viewport" content="width=device-width, initial-scale=1">`)
|
|
93
|
+
- [ ] **[MEDIUM]** Canonical URL 已设置(`<link rel="canonical">`)
|
|
94
|
+
- [ ] **[MEDIUM]** 多语言页面已配置 `hreflang` 标签
|
|
95
|
+
|
|
96
|
+
### 2.2 Open Graph & Social
|
|
97
|
+
|
|
98
|
+
- [ ] **[HIGH]** Open Graph 标签已配置(`og:title`、`og:description`、`og:image`、`og:url`)
|
|
99
|
+
- [ ] **[HIGH]** `og:image` 尺寸至少 1200×630 px
|
|
100
|
+
- [ ] **[HIGH]** Twitter Card 标签已配置(`twitter:card`、`twitter:title`、`twitter:image`)
|
|
101
|
+
- [ ] **[MEDIUM]** 已使用社交媒体分享调试工具验证预览效果
|
|
102
|
+
- [ ] **[MEDIUM]** 配置了 `og:type`(article / website / product)
|
|
103
|
+
|
|
104
|
+
### 2.3 Sitemap & Robots
|
|
105
|
+
|
|
106
|
+
- [ ] **[CRITICAL]** `robots.txt` 已配置且允许搜索引擎爬取
|
|
107
|
+
- [ ] **[CRITICAL]** 生产环境确认没有 `noindex` / `nofollow` 遗留标签
|
|
108
|
+
- [ ] **[HIGH]** `sitemap.xml` 已生成并提交至 Google Search Console
|
|
109
|
+
- [ ] **[HIGH]** Sitemap 包含所有公开页面的 URL 和 `lastmod` 日期
|
|
110
|
+
- [ ] **[MEDIUM]** 404 页面已自定义,提供有用的导航链接
|
|
111
|
+
- [ ] **[MEDIUM]** 已配置结构化数据(JSON-LD)提升搜索结果展示效果
|
|
112
|
+
|
|
113
|
+
### 2.4 URL 与路由
|
|
114
|
+
|
|
115
|
+
- [ ] **[HIGH]** URL 使用语义化路径(`/products/shoes` 而非 `/p?id=123`)
|
|
116
|
+
- [ ] **[HIGH]** SPA 已配置服务端渲染(SSR)或预渲染(Prerendering)
|
|
117
|
+
- [ ] **[HIGH]** 旧 URL 已配置 301 重定向到新 URL
|
|
118
|
+
- [ ] **[MEDIUM]** URL 使用小写字母和连字符(`-`)而非下划线(`_`)
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
## 三、安全 (Security)
|
|
123
|
+
|
|
124
|
+
### 3.1 CSP (Content Security Policy)
|
|
125
|
+
|
|
126
|
+
- [ ] **[CRITICAL]** 已配置 Content-Security-Policy 响应头
|
|
127
|
+
- [ ] **[CRITICAL]** CSP 禁止 `unsafe-inline` 和 `unsafe-eval`(或使用 nonce/hash 替代)
|
|
128
|
+
- [ ] **[HIGH]** CSP 限定了 `script-src`、`style-src`、`img-src`、`connect-src` 的域名白名单
|
|
129
|
+
- [ ] **[HIGH]** CSP 配置了 `report-uri` / `report-to` 用于收集违规报告
|
|
130
|
+
- [ ] **[MEDIUM]** 已在 Report-Only 模式下测试 CSP 规则,确认无误后启用强制模式
|
|
131
|
+
|
|
132
|
+
### 3.2 XSS 防护
|
|
133
|
+
|
|
134
|
+
- [ ] **[CRITICAL]** 所有用户输入在渲染时已正确转义
|
|
135
|
+
- [ ] **[CRITICAL]** 禁止使用 `dangerouslySetInnerHTML`(React)/ `v-html`(Vue)渲染用户内容
|
|
136
|
+
- [ ] **[HIGH]** 已配置 `X-Content-Type-Options: nosniff`
|
|
137
|
+
- [ ] **[HIGH]** 已配置 `X-Frame-Options: DENY` 或 CSP `frame-ancestors 'none'`
|
|
138
|
+
- [ ] **[HIGH]** Cookie 设置了 `HttpOnly`、`Secure`、`SameSite=Strict/Lax`
|
|
139
|
+
|
|
140
|
+
### 3.3 CORS (Cross-Origin Resource Sharing)
|
|
141
|
+
|
|
142
|
+
- [ ] **[CRITICAL]** CORS 白名单仅包含必要的域名,禁止 `Access-Control-Allow-Origin: *`(需认证的 API)
|
|
143
|
+
- [ ] **[HIGH]** `Access-Control-Allow-Methods` 仅包含必要的 HTTP 方法
|
|
144
|
+
- [ ] **[HIGH]** `Access-Control-Allow-Headers` 仅包含必要的请求头
|
|
145
|
+
- [ ] **[MEDIUM]** 预检请求(OPTIONS)已正确缓存 (`Access-Control-Max-Age`)
|
|
146
|
+
|
|
147
|
+
### 3.4 其他安全
|
|
148
|
+
|
|
149
|
+
- [ ] **[CRITICAL]** 全站强制 HTTPS,HTTP 请求 301 重定向到 HTTPS
|
|
150
|
+
- [ ] **[CRITICAL]** 已配置 `Strict-Transport-Security` (HSTS) 头
|
|
151
|
+
- [ ] **[HIGH]** 敏感数据(Token、密码)不存储在 `localStorage`,使用 `httpOnly Cookie`
|
|
152
|
+
- [ ] **[HIGH]** 表单提交已实现 CSRF 防护
|
|
153
|
+
- [ ] **[HIGH]** 依赖包无已知高危漏洞(`npm audit` / `snyk test` 通过)
|
|
154
|
+
- [ ] **[MEDIUM]** Subresource Integrity (SRI) 已配置(CDN 引入的第三方脚本)
|
|
155
|
+
- [ ] **[MEDIUM]** 已配置 `Referrer-Policy: strict-origin-when-cross-origin`
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## 四、无障碍 (Accessibility)
|
|
160
|
+
|
|
161
|
+
### 4.1 WCAG 合规
|
|
162
|
+
|
|
163
|
+
- [ ] **[CRITICAL]** WCAG 2.1 AA 级合规(或满足业务要求的合规等级)
|
|
164
|
+
- [ ] **[HIGH]** 已使用自动化工具扫描(axe-core、Lighthouse Accessibility)
|
|
165
|
+
- [ ] **[HIGH]** 颜色对比度满足 WCAG 要求(正文 ≥ 4.5:1,大文本 ≥ 3:1)
|
|
166
|
+
- [ ] **[MEDIUM]** 已进行真人无障碍测试(邀请视障/运动障碍用户参与)
|
|
167
|
+
|
|
168
|
+
### 4.2 键盘导航
|
|
169
|
+
|
|
170
|
+
- [ ] **[CRITICAL]** 所有交互元素可通过 Tab 键访问
|
|
171
|
+
- [ ] **[CRITICAL]** 焦点指示器(focus indicator)清晰可见且未被 CSS 隐藏
|
|
172
|
+
- [ ] **[HIGH]** Tab 顺序符合逻辑阅读顺序
|
|
173
|
+
- [ ] **[HIGH]** 模态框/弹窗实现了焦点陷阱(focus trap)
|
|
174
|
+
- [ ] **[HIGH]** 提供了跳过导航链接(Skip to main content)
|
|
175
|
+
- [ ] **[MEDIUM]** 自定义组件(下拉菜单、Tab 面板等)实现了键盘操作模式
|
|
176
|
+
|
|
177
|
+
### 4.3 屏幕阅读器
|
|
178
|
+
|
|
179
|
+
- [ ] **[CRITICAL]** 所有图片有 `alt` 文本(装饰性图片使用 `alt=""`)
|
|
180
|
+
- [ ] **[CRITICAL]** 表单输入有关联的 `<label>` 元素
|
|
181
|
+
- [ ] **[HIGH]** 使用语义化 HTML 标签(`<nav>`、`<main>`、`<article>`、`<aside>`)
|
|
182
|
+
- [ ] **[HIGH]** ARIA 属性使用正确(`aria-label`、`aria-describedby`、`role`)
|
|
183
|
+
- [ ] **[HIGH]** 动态内容更新使用 `aria-live` 通知屏幕阅读器
|
|
184
|
+
- [ ] **[MEDIUM]** 已使用 NVDA / VoiceOver / TalkBack 实际测试核心流程
|
|
185
|
+
- [ ] **[MEDIUM]** 页面标题层级正确(h1 → h2 → h3,不跳级)
|
|
186
|
+
|
|
187
|
+
### 4.4 其他无障碍
|
|
188
|
+
|
|
189
|
+
- [ ] **[HIGH]** 不仅依赖颜色传达信息(如错误不仅用红色,还有图标/文字)
|
|
190
|
+
- [ ] **[HIGH]** 动画提供了 `prefers-reduced-motion` 适配
|
|
191
|
+
- [ ] **[MEDIUM]** 自动播放的媒体提供了暂停/停止控制
|
|
192
|
+
- [ ] **[MEDIUM]** 文本可放大至 200% 而不丢失功能
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## 五、兼容性 (Compatibility)
|
|
197
|
+
|
|
198
|
+
### 5.1 浏览器兼容
|
|
199
|
+
|
|
200
|
+
- [ ] **[CRITICAL]** Chrome 最新两个版本测试通过
|
|
201
|
+
- [ ] **[CRITICAL]** Safari 最新两个版本测试通过(含 iOS Safari)
|
|
202
|
+
- [ ] **[CRITICAL]** Firefox 最新两个版本测试通过
|
|
203
|
+
- [ ] **[HIGH]** Edge 最新两个版本测试通过
|
|
204
|
+
- [ ] **[HIGH]** `browserslist` 配置与目标用户浏览器分布匹配
|
|
205
|
+
- [ ] **[MEDIUM]** 已处理 CSS 前缀(通过 Autoprefixer 自动添加)
|
|
206
|
+
- [ ] **[MEDIUM]** 不支持的浏览器显示友好提示而非白屏
|
|
207
|
+
|
|
208
|
+
### 5.2 响应式适配
|
|
209
|
+
|
|
210
|
+
- [ ] **[CRITICAL]** 移动端(375px)布局正常且可操作
|
|
211
|
+
- [ ] **[CRITICAL]** 平板端(768px)布局正常
|
|
212
|
+
- [ ] **[CRITICAL]** 桌面端(1440px)布局正常
|
|
213
|
+
- [ ] **[HIGH]** 超宽屏(1920px+)内容不过度拉伸
|
|
214
|
+
- [ ] **[HIGH]** 触摸目标尺寸 ≥ 44×44 px(移动端)
|
|
215
|
+
- [ ] **[HIGH]** 横竖屏切换不破坏布局
|
|
216
|
+
- [ ] **[MEDIUM]** 打印样式已配置(如有打印需求)
|
|
217
|
+
|
|
218
|
+
### 5.3 国际化(如适用)
|
|
219
|
+
|
|
220
|
+
- [ ] **[HIGH]** 文本使用 i18n 框架管理,无硬编码文案
|
|
221
|
+
- [ ] **[HIGH]** 支持 RTL(Right-to-Left)布局(如目标市场包含阿拉伯语/希伯来语)
|
|
222
|
+
- [ ] **[MEDIUM]** 日期、数字、货币格式已本地化
|
|
223
|
+
- [ ] **[MEDIUM]** 长文本不会撑破布局(德语/俄语等文本通常比英语长 30-40%)
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## 六、监控 (Monitoring)
|
|
228
|
+
|
|
229
|
+
### 6.1 错误追踪
|
|
230
|
+
|
|
231
|
+
- [ ] **[CRITICAL]** 前端错误追踪已接入(Sentry / Datadog / Bugsnag)
|
|
232
|
+
- [ ] **[CRITICAL]** 未捕获的异常(unhandledrejection / onerror)已全局捕获并上报
|
|
233
|
+
- [ ] **[HIGH]** 错误上报包含用户上下文(浏览器、OS、页面 URL、用户 ID)
|
|
234
|
+
- [ ] **[HIGH]** Source Map 已上传到错误追踪平台(生产环境不暴露 Source Map 文件)
|
|
235
|
+
- [ ] **[HIGH]** 关键业务流程(登录、支付、下单)设置了错误率告警
|
|
236
|
+
- [ ] **[MEDIUM]** 已配置错误采样率(高流量场景避免上报量爆炸)
|
|
237
|
+
|
|
238
|
+
### 6.2 性能监控
|
|
239
|
+
|
|
240
|
+
- [ ] **[HIGH]** Real User Monitoring (RUM) 已接入
|
|
241
|
+
- [ ] **[HIGH]** Core Web Vitals 持续监控并设置告警阈值
|
|
242
|
+
- [ ] **[HIGH]** 关键页面加载时间已建立基线(baseline)
|
|
243
|
+
- [ ] **[MEDIUM]** 长任务(Long Tasks > 50ms)监控已启用
|
|
244
|
+
- [ ] **[MEDIUM]** 资源加载失败(CSS/JS/图片 404)监控已启用
|
|
245
|
+
|
|
246
|
+
### 6.3 用户分析
|
|
247
|
+
|
|
248
|
+
- [ ] **[HIGH]** Analytics 工具已接入(GA4 / Plausible / Mixpanel)
|
|
249
|
+
- [ ] **[HIGH]** 关键事件追踪已配置(注册、登录、购买、核心功能使用)
|
|
250
|
+
- [ ] **[HIGH]** 隐私合规已确认(GDPR Cookie Consent / CCPA)
|
|
251
|
+
- [ ] **[MEDIUM]** UTM 参数追踪已配置
|
|
252
|
+
- [ ] **[MEDIUM]** 漏斗分析已建立(从着陆到转化的完整路径)
|
|
253
|
+
|
|
254
|
+
### 6.4 可用性监控
|
|
255
|
+
|
|
256
|
+
- [ ] **[CRITICAL]** 外部拨测(Synthetic Monitoring)已配置,覆盖核心页面
|
|
257
|
+
- [ ] **[HIGH]** CDN 可用性和命中率监控已配置
|
|
258
|
+
- [ ] **[HIGH]** API 健康检查接口存在且被监控
|
|
259
|
+
- [ ] **[MEDIUM]** DNS 解析监控已配置
|
|
260
|
+
- [ ] **[MEDIUM]** TLS 证书过期监控已配置(提前 30 天告警)
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
## 七、上线前最终确认
|
|
265
|
+
|
|
266
|
+
### 7.1 环境配置
|
|
267
|
+
|
|
268
|
+
- [ ] **[CRITICAL]** 生产环境环境变量已正确配置(API URL、Feature Flag 等)
|
|
269
|
+
- [ ] **[CRITICAL]** 生产构建已使用 `production` 模式(无 debug 日志、无 source map 暴露)
|
|
270
|
+
- [ ] **[CRITICAL]** console.log / debugger 语句已清理
|
|
271
|
+
- [ ] **[HIGH]** 环境变量中无硬编码的密钥/Token
|
|
272
|
+
|
|
273
|
+
### 7.2 回滚准备
|
|
274
|
+
|
|
275
|
+
- [ ] **[CRITICAL]** 回滚方案已文档化且经过测试
|
|
276
|
+
- [ ] **[HIGH]** 上一个稳定版本的制品仍可用
|
|
277
|
+
- [ ] **[HIGH]** 数据库变更(如有)支持回滚
|
|
278
|
+
- [ ] **[MEDIUM]** 已确认回滚后的用户体验(缓存、Service Worker 清理)
|
|
279
|
+
|
|
280
|
+
### 7.3 沟通与协调
|
|
281
|
+
|
|
282
|
+
- [ ] **[HIGH]** 上线时间已通知相关团队(后端、QA、客服、产品)
|
|
283
|
+
- [ ] **[HIGH]** 上线后观察计划已制定(谁在哪个时间段观察哪些指标)
|
|
284
|
+
- [ ] **[MEDIUM]** 用户公告/更新日志已准备(如有面向用户的重大变更)
|
|
285
|
+
|
|
286
|
+
---
|
|
287
|
+
|
|
288
|
+
## Agent Checklist
|
|
289
|
+
|
|
290
|
+
- [ ] 覆盖全部六大维度:性能、SEO、安全、无障碍、兼容性、监控
|
|
291
|
+
- [ ] 性能部分包含 Lighthouse 评分、Core Web Vitals、Bundle Size、图片优化、缓存策略
|
|
292
|
+
- [ ] SEO 部分包含 Meta 标签、Open Graph、Sitemap、robots.txt
|
|
293
|
+
- [ ] 安全部分包含 CSP、XSS 防护、CORS 配置
|
|
294
|
+
- [ ] 无障碍部分包含 WCAG、键盘导航、屏幕阅读器支持
|
|
295
|
+
- [ ] 兼容性部分包含浏览器兼容和响应式适配
|
|
296
|
+
- [ ] 监控部分包含错误追踪、性能监控、用户分析
|
|
297
|
+
- [ ] 使用 [CRITICAL] / [HIGH] / [MEDIUM] 分级标记
|
|
298
|
+
- [ ] 检查项具备可操作性,包含具体阈值和工具建议
|
|
299
|
+
- [ ] 文件超过 200 行
|