@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,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: miniprogram-uniapp-ai-mistakes
|
|
3
|
+
title: 小程序 / uniapp · AI 高频错误避坑卡(错 -> 对)
|
|
4
|
+
domain: miniprogram
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [小程序, miniprogram, 微信, uniapp, uni-app, 踩坑, AI高频错误, setData, 合法域名, 条件编译, rpx, 生命周期, 商业级]
|
|
8
|
+
quality_score: 95
|
|
9
|
+
last_updated: 2026-06-20
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 小程序 / uniapp · AI 高频错误避坑卡
|
|
13
|
+
|
|
14
|
+
> AI 写小程序/uniapp 最容易把 **web 那套** 直接搬过来,但小程序是**双线程、无 DOM、域名白名单、体积受限**的环境。下面是实测高频错误的「错 -> 对」清单,写代码前逐条自检。配套参考见 `miniprogram-standard.md` 与 `cross-platform/01-standards/cross-platform-frameworks.md`。
|
|
15
|
+
|
|
16
|
+
## 一、微信小程序(原生)
|
|
17
|
+
|
|
18
|
+
1. **用 web API**:`document` / `window` / `localStorage` / `fetch` / `cookie`
|
|
19
|
+
-> 小程序逻辑层无 DOM/BOM。存储用 `wx.setStorageSync`/`wx.getStorageSync`,请求用 `wx.request`,没有 fetch/axios(axios 需适配器)。
|
|
20
|
+
2. **`wx.request` 直接打域名**:真机报「不在以下 request 合法域名列表中」
|
|
21
|
+
-> 域名必须在小程序管理后台「开发设置 -> 服务器域名」白名单,且只能 **https**。开发期可勾「不校验合法域名」,上线必须配。
|
|
22
|
+
3. **直接改 `this.data`**:`this.data.x = v` 视图不刷新
|
|
23
|
+
-> 必须 `this.setData({ x: v })`。`setData` 是逻辑层->视图层唯一通道且**跨线程序列化**:别在循环/高频里调用,别一次塞大对象,局部更新用路径 `this.setData({ 'list[0].done': true })`。
|
|
24
|
+
4. **px + HTML/CSS 任意选择器**
|
|
25
|
+
-> WXML/WXSS:尺寸用 **`rpx`**(`750rpx` = 屏宽);选择器受限(**无 `*` 通配、后代选择器有限、不支持级联**),组件样式默认隔离。
|
|
26
|
+
5. **套 React/Vue 生命周期**:`componentDidMount` / `created`
|
|
27
|
+
-> Page 用 `onLoad`(带参) / `onShow` / `onReady`;Component 用 `attached` / `ready`;页面通信用 `onLoad` 的 query + 全局 `getApp()`/`eventChannel`。
|
|
28
|
+
6. **tabBar 页用 `wx.navigateTo`**:跳不过去
|
|
29
|
+
-> tabBar 页只能 `wx.switchTab`;普通页 `wx.navigateTo`(保留栈,**最多 10 层**),重定向 `wx.redirectTo`,返回 `wx.navigateBack`。
|
|
30
|
+
7. **`wx.getUserInfo` 拿头像昵称**:已废弃/拿不到
|
|
31
|
+
-> 用 `wx.getUserProfile`(**必须用户点击事件里触发**,不能进页面自动调)。登录用 `wx.login` 拿 `code`,**后端**用 code 换 openid/session_key,别在前端解。
|
|
32
|
+
8. **直接 `npm install` 引包就用**
|
|
33
|
+
-> 需「工具 -> 构建 npm」生成 `miniprogram_npm`;主包 **<= 2MB**,超了用**分包**(`subPackages`)+ 分包预下载。
|
|
34
|
+
9. **支付/手机号等能力不看资质**
|
|
35
|
+
-> `wx.requestPayment`、手机号快速验证等需对应**类目/资质**,且支付需后端下单签名,AI 常漏后端这步。
|
|
36
|
+
|
|
37
|
+
## 二、uniapp(跨端:H5 + 各家小程序 + App)
|
|
38
|
+
|
|
39
|
+
1. **写平台专属/web 代码不做条件编译**:一处改动多端炸
|
|
40
|
+
-> 平台差异用**条件编译**隔离:`#ifdef MP-WEIXIN … #endif`、`#ifdef H5`、`#ifdef APP-PLUS`、`#ifndef H5`。
|
|
41
|
+
2. **用 `wx.*` / `window` / `document`**:换端即失效
|
|
42
|
+
-> 跨端统一用 **`uni.*`**(`uni.request` / `uni.navigateTo` / `uni.setStorageSync`)。DOM/BOM 在小程序与 App 端不存在。
|
|
43
|
+
3. **用 vue-router / `<router-link>`**
|
|
44
|
+
-> 路由在 **`pages.json`** 声明(含 `tabBar`);跳转 `uni.navigateTo` / `uni.switchTab`,不是 vue-router。
|
|
45
|
+
4. **复杂 template 表达式 / 渲染函数**
|
|
46
|
+
-> 小程序端模板编译受限:逻辑放 `computed`/`methods`,少在模板里写复杂表达式;慎用 `render()`/JSX。
|
|
47
|
+
5. **appid、平台 key 硬编码进代码**
|
|
48
|
+
-> 各平台配置进 **`manifest.json`**(每端独立 appid / SDK key)。
|
|
49
|
+
6. **`mounted` 里拿节点尺寸**:小程序端拿不到
|
|
50
|
+
-> 用 `uni.createSelectorQuery().in(this)`;`mounted` 在小程序端时机不可靠,DOM 思路在此不成立。
|
|
51
|
+
7. **直接用浏览器专属库**(依赖 `document` 的图表/富文本)
|
|
52
|
+
-> 选支持多端的库或按端条件编译;`rpx` 做自适应单位。
|
|
53
|
+
|
|
54
|
+
## 三、写完自检(小程序/uniapp 通用)
|
|
55
|
+
- [ ] 没有用 `document`/`window`/`fetch`/`localStorage`(改 `wx.*`/`uni.*`)
|
|
56
|
+
- [ ] 所有请求域名已规划进合法域名白名单、全 https
|
|
57
|
+
- [ ] 状态更新走 `setData`/响应式,无直接赋值;无高频/大对象 setData
|
|
58
|
+
- [ ] 尺寸用 `rpx`;选择器在小程序约束内
|
|
59
|
+
- [ ] tabBar 用 switchTab;导航不超 10 层
|
|
60
|
+
- [ ] 登录走 `wx.login` + 后端换 openid;敏感能力看资质、签名在后端
|
|
61
|
+
- [ ] uniapp 平台差异已条件编译;路由在 pages.json;平台配置在 manifest.json
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: miniprogram-custom-navbar-capsule
|
|
3
|
+
title: 小程序自定义导航栏 · 顶部适配与右上角胶囊(设计规范 · 必读)
|
|
4
|
+
domain: miniprogram
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [小程序, miniprogram, 微信, uniapp, 自定义导航栏, navigationStyle, custom, 胶囊, 顶部适配, 状态栏, statusBarHeight, getMenuButtonBoundingClientRect, 安全区, 商业级]
|
|
8
|
+
quality_score: 96
|
|
9
|
+
last_updated: 2026-06-20
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 小程序自定义导航栏 · 顶部适配与右上角胶囊
|
|
13
|
+
|
|
14
|
+
> **AI 写小程序自定义导航栏最高频的错误**:用了 `navigationStyle: "custom"` 自己画顶栏,却**没做顶部适配**——内容顶到状态栏下面、标题被状态栏盖住,或者把按钮放到了**右上角胶囊(微信常驻的那个药丸形按钮,含「更多」和「关闭」)底下点不到**。胶囊不可隐藏、位置随机型而变,必须**动态测量、给它让位**。本规范给出正确做法。
|
|
15
|
+
|
|
16
|
+
## 1. 什么时候要自己适配
|
|
17
|
+
- 页面或全局配置 `navigationStyle: "custom"` 后,**整个顶部区域归你画**,微信只保留**右上角胶囊**。
|
|
18
|
+
- 此时必须自己处理:**状态栏高度** + **导航栏高度** + **与胶囊垂直对齐** + **右侧给胶囊留空**。
|
|
19
|
+
- 不用 custom(默认导航栏)时不需要这套——但商业小程序为了品牌/沉浸式 banner 常用 custom。
|
|
20
|
+
|
|
21
|
+
## 2. 两个必测量值(绝不能写死)
|
|
22
|
+
不同机型(iOS/Android)、不同微信版本,状态栏高度和胶囊位置**都不一样**,必须运行时取:
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
// 状态栏高度
|
|
26
|
+
const { statusBarHeight, safeArea } = wx.getWindowInfo(); // 新 API;旧版用 wx.getSystemInfoSync()
|
|
27
|
+
// 右上角胶囊的位置与尺寸(相对屏幕左上角,单位 px)
|
|
28
|
+
const cap = wx.getMenuButtonBoundingClientRect();
|
|
29
|
+
// cap = { top, right, bottom, left, width, height }
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 3. 正确的高度与对齐公式
|
|
33
|
+
导航栏内容应与胶囊**垂直居中对齐**,整条导航栏高度按胶囊推算:
|
|
34
|
+
|
|
35
|
+
```js
|
|
36
|
+
// 胶囊上边距状态栏的间隙(上下对称),推出导航栏内容区高度
|
|
37
|
+
const gap = cap.top - statusBarHeight; // 胶囊到状态栏的间距
|
|
38
|
+
const navBarHeight = cap.height + gap * 2; // 导航栏内容区高度(与胶囊上下等距)
|
|
39
|
+
const navTotalHeight = statusBarHeight + navBarHeight; // 顶栏总高(含状态栏)
|
|
40
|
+
|
|
41
|
+
this.setData({
|
|
42
|
+
statusBarHeight, // 顶部用它做 padding-top,避开状态栏
|
|
43
|
+
navBarHeight, // 导航栏内容区高度
|
|
44
|
+
navTotalHeight, // 占位高度,给页面内容做 margin-top
|
|
45
|
+
capsuleRight: cap.right, // 右侧需要让出的宽度参考
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
WXSS(用 px,因为测量值是 px,别混 rpx):
|
|
50
|
+
```css
|
|
51
|
+
.custom-nav { position: fixed; top: 0; left: 0; right: 0; z-index: 999; }
|
|
52
|
+
.custom-nav .status-bar { height: {{statusBarHeight}}px; } /* 状态栏占位 */
|
|
53
|
+
.custom-nav .bar { height: {{navBarHeight}}px; display: flex; align-items: center; }
|
|
54
|
+
/* 标题/返回键放左侧;右侧到胶囊之间留空,绝不在胶囊下放可点元素 */
|
|
55
|
+
.page-body { margin-top: {{navTotalHeight}}px; } /* 内容避开固定顶栏 */
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 4. 硬性规则(自检)
|
|
59
|
+
- [ ] 顶栏内容**从状态栏下方**开始(`padding-top: statusBarHeight`),标题不被状态栏盖。
|
|
60
|
+
- [ ] 导航栏高度/标题位置**与胶囊垂直居中对齐**(用公式,别写死 44px / 88rpx)。
|
|
61
|
+
- [ ] **右上角胶囊区域不放任何可点控件**;自定义按钮放左侧或胶囊左边,给胶囊让出宽度。
|
|
62
|
+
- [ ] 顶栏 `position: fixed`,页面内容 `margin-top: navTotalHeight` 避免被遮。
|
|
63
|
+
- [ ] 测量值是 **px**,导航栏这块用 px,不要和 rpx 混算。
|
|
64
|
+
- [ ] 底部同样做**安全区**适配:`safeArea` / `env(safe-area-inset-bottom)`(iPhone 底部小黑条)。
|
|
65
|
+
- [ ] 返回逻辑自理:custom 后没有系统返回键,首页判断 `getCurrentPages().length` 决定显示返回箭头还是首页图标。
|
|
66
|
+
|
|
67
|
+
## 5. uniapp 写法
|
|
68
|
+
- 取值:`uni.getMenuButtonBoundingClientRect()` + `uni.getWindowInfo()`(或 `uni.getSystemInfoSync()`),公式同上。
|
|
69
|
+
- uniapp 提供 CSS 变量 `--status-bar-height` 可直接用:`padding-top: var(--status-bar-height);`。
|
|
70
|
+
- 平台差异用条件编译:H5/App 没有胶囊,`#ifdef MP-WEIXIN` 才做胶囊对齐。
|
|
71
|
+
- 也可在 `pages.json` 单页设 `"navigationStyle": "custom"`。
|
|
72
|
+
|
|
73
|
+
## 6. 常见错法(别这么写)
|
|
74
|
+
- 写死 `navBarHeight = 44`(只在部分 iPhone 对,安卓/异形屏全错)。
|
|
75
|
+
- 用 `rpx` 套测量出来的 px 值(量纲错)。
|
|
76
|
+
- 自定义胶囊样按钮盖在真胶囊上(点不到/重叠)。
|
|
77
|
+
- 忘了页面内容 `margin-top`,首屏内容被固定顶栏吃掉一截。
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: miniprogram-design
|
|
3
|
+
title: 微信小程序设计规范(官方设计指南 + WeUI)
|
|
4
|
+
domain: miniprogram
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [小程序, 微信, 设计规范, 设计指南, weui, 交互, 视觉, 导航, 友好高效一致, 知情权, 商业级]
|
|
8
|
+
quality_score: 93
|
|
9
|
+
last_updated: 2026-06-19
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 微信小程序设计规范(官方设计指南 + WeUI)
|
|
13
|
+
|
|
14
|
+
> 微信官方有明确的小程序设计指南。遵循它做出**友好、高效、一致**、符合微信生态习惯的体验;用 WeUI 对齐官方视觉。
|
|
15
|
+
|
|
16
|
+
## 1. 核心理念(官方设计指南)
|
|
17
|
+
|
|
18
|
+
- 建立在**充分尊重用户知情权与操作权**的基础上:清楚告知在做什么、要什么权限、用户可控可退。
|
|
19
|
+
- 在微信生态内追求**友好、高效、一致**的体验——符合用户在微信里的既有习惯,降低学习成本。
|
|
20
|
+
- **即用即走**:聚焦核心任务,轻量、快、不强留;首屏直达价值。
|
|
21
|
+
|
|
22
|
+
## 2. 视觉与组件(用 WeUI)
|
|
23
|
+
|
|
24
|
+
- 用微信官方 **WeUI**(官方设计团队为小程序量身设计的组件库 / weui-wxss + WeUI 扩展组件 / Vant Weapp 等)保证视觉与微信原生一致。
|
|
25
|
+
- 遵循微信视觉规范:克制配色、标准间距、清晰层级;主色不滥用;不要做得"很不微信"。
|
|
26
|
+
- 图标用图标库(不用 emoji 当功能图标);尺寸用 **rpx** 适配不同屏宽。
|
|
27
|
+
|
|
28
|
+
## 3. 导航与布局
|
|
29
|
+
|
|
30
|
+
- 顶层用 **TabBar**(底部,2–5 个);页面内层级用导航栏返回。
|
|
31
|
+
- 遵循微信导航与手势习惯(右滑返回);不要自造反直觉导航。
|
|
32
|
+
- 关键操作位置符合习惯;表单/列表/卡片遵循 WeUI 规范。
|
|
33
|
+
|
|
34
|
+
## 4. 交互与体验
|
|
35
|
+
|
|
36
|
+
- 每个操作有反馈(loading / toast / 按钮态);**加载/空/错误三态**都要做。
|
|
37
|
+
- 首屏骨架屏/loading;下拉刷新、触底加载;秒开(缓存 + 数据预取)。
|
|
38
|
+
- 授权时机合理:在用户理解为什么需要时才申请(如点"获取位置"才请求),尊重拒绝并降级。
|
|
39
|
+
|
|
40
|
+
## 5. 合规(设计层面)
|
|
41
|
+
|
|
42
|
+
- 隐私协议、用户授权弹窗符合微信与法规要求;明确数据用途。
|
|
43
|
+
- 遵守微信**审核与运营规范**(类目资质、内容、诱导分享限制等),避免设计出违规交互。
|
|
44
|
+
|
|
45
|
+
## 6. 反模式(出现即不合格 / "不像微信")
|
|
46
|
+
|
|
47
|
+
- 不用 WeUI/微信视觉,做成 web 或他端风格,体验割裂。
|
|
48
|
+
- 自造反直觉导航/手势;TabBar 超 5 个或层级混乱。
|
|
49
|
+
- 不做三态/反馈/骨架屏;不尊重知情权,进来就索权/强留。
|
|
50
|
+
- emoji 当图标;不用 rpx 适配导致小屏错位。
|
|
51
|
+
|
|
52
|
+
## 7. 最低交付 checklist
|
|
53
|
+
|
|
54
|
+
- [ ] 尊重知情权/操作权;友好高效一致、即用即走、首屏直达。
|
|
55
|
+
- [ ] 用 WeUI/微信视觉规范;克制配色 + 清晰层级 + rpx 适配;图标库无 emoji。
|
|
56
|
+
- [ ] TabBar(≤5)+导航返回符合微信习惯。
|
|
57
|
+
- [ ] 三态 + 反馈 + 骨架屏 + 秒开;授权合理时机 + 降级。
|
|
58
|
+
- [ ] 隐私协议/授权合规 + 遵守审核运营规范。
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
**参考(官方)**:微信小程序设计指南 (developers.weixin.qq.com/miniprogram/design/)、WeUI 组件库、rpx 适配、微信审核规范。
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: miniprogram-standard
|
|
3
|
+
title: 小程序开发标准(微信/支付宝/uni-app · 商业级)
|
|
4
|
+
domain: miniprogram
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [小程序, miniprogram, 微信, 支付宝, 双线程, setData, 分包, 性能, 生命周期, 组件, uni-app, taro, 审核, 商业级]
|
|
8
|
+
quality_score: 94
|
|
9
|
+
last_updated: 2026-06-19
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 小程序开发标准(微信/支付宝/抖音/uni-app · 商业级)
|
|
13
|
+
|
|
14
|
+
> 小程序是国内重要的商业触点(即用即走、依附超级 App 流量)。它的**双线程架构**与体积/性能约束决定了写法和 web 很不一样。本标准给出商业级小程序规范。
|
|
15
|
+
|
|
16
|
+
## 1. 双线程架构(理解它才能写好)
|
|
17
|
+
|
|
18
|
+
- 小程序分**逻辑层(JS 引擎)** 与 **视图层(WebView/渲染)**,两层通过 Native 桥**异步通信**(`evaluateJavascript`)。
|
|
19
|
+
- **`setData` 是逻辑层→视图层的唯一数据通道,也是性能瓶颈**:每次 setData 都跨线程序列化传输。优化 setData 是小程序性能的核心。
|
|
20
|
+
- 视图层不能直接操作 DOM/拿不到 JS 对象;交互事件从视图层异步回传逻辑层。
|
|
21
|
+
|
|
22
|
+
## 2. setData 性能(最关键)
|
|
23
|
+
|
|
24
|
+
- **只传变化的最小数据**:用数据路径 `this.setData({{'list[2].name': v}})`,不要整对象 setData。
|
|
25
|
+
- **合并/节流 setData**:避免在循环/高频事件(scroll/input)里频繁调用;合并成一次。
|
|
26
|
+
- **与渲染无关的数据不要放 `data`**(放普通变量/`this`),data 越大 setData 越慢。
|
|
27
|
+
- 避免一次 setData 传超大数组/长列表全量;长列表用分页 + 虚拟列表(recycle-view)。
|
|
28
|
+
|
|
29
|
+
## 3. 包体积与分包
|
|
30
|
+
|
|
31
|
+
- 主包有体积上限(微信主包 2MB,整体含分包 ≤ 20MB),**必须分包**:
|
|
32
|
+
- 主包只放 启动页/TabBar 页/公共组件;其余功能拆 **分包**。
|
|
33
|
+
- **分包预下载**(`preloadRule`)提升进入分包页的速度。
|
|
34
|
+
- **独立分包**用于可脱离主包独立运行的活动页。
|
|
35
|
+
- 资源:图片用 CDN、压缩、懒加载;避免大图打进包。
|
|
36
|
+
|
|
37
|
+
## 4. 工程结构与组件化
|
|
38
|
+
|
|
39
|
+
- 按 feature/页面组织;公共逻辑抽工具/`behavior`(微信)/mixin;UI 抽**自定义组件**复用。
|
|
40
|
+
- 数据请求统一封装(request 拦截、鉴权、错误处理、loading),不在页面里散落 `wx.request`。
|
|
41
|
+
- 状态跨页共享用全局 store(如 mobx-miniprogram / 全局对象 / 本地缓存),别滥用全局。
|
|
42
|
+
- 用 TypeScript + 规范的目录;用官方/成熟 UI 库(WeUI/Vant Weapp)对齐设计规范。
|
|
43
|
+
|
|
44
|
+
## 5. 生命周期与体验
|
|
45
|
+
|
|
46
|
+
- 正确用页面/组件/App 生命周期(`onLoad/onShow/onReady/onHide/onUnload`;组件 `attached/detached`);onLoad 取参数、onShow 刷新。
|
|
47
|
+
- 首屏:骨架屏/loading;下拉刷新、触底加载、空态/错误态都要做。
|
|
48
|
+
- 分包加载、跳转有反馈;合理使用缓存(`Storage`)做秒开。
|
|
49
|
+
|
|
50
|
+
## 6. 平台能力与合规
|
|
51
|
+
|
|
52
|
+
- 登录用平台标准流程(微信 `wx.login` → code 换 openid/session,**在后端换**,不在前端暴露 secret);用户信息/手机号按最新合规接口获取(需用户授权)。
|
|
53
|
+
- 支付用平台支付(微信支付/支付宝),金额/订单后端为准 + 幂等(见支付标准)。
|
|
54
|
+
- 权限/隐私:调用敏感接口(定位/相机/通讯录)需 scope 授权 + 用途说明 + 隐私协议;遵守平台**审核规范**(类目资质、内容合规),否则审核拒绝。
|
|
55
|
+
- 域名必须 HTTPS 且在后台配置白名单(request/上传/下载/socket 合法域名)。
|
|
56
|
+
|
|
57
|
+
## 7. uni-app / Taro 跨端(一套多端)
|
|
58
|
+
|
|
59
|
+
- 要同时覆盖 多家小程序 + App + H5,用 **uni-app / Taro** 一套代码多端编译,省重复开发。
|
|
60
|
+
- 跨端注意:差量更新、条件编译处理平台差异、不要用某端独有 API 不做兼容、样式用 rpx 适配。
|
|
61
|
+
- uni-app 底层自动差量数据更新,仍要遵守"少 setData/data 精简"的原则。
|
|
62
|
+
|
|
63
|
+
## 8. 反模式(出现即不合格)
|
|
64
|
+
|
|
65
|
+
- 整对象/超大数据 setData;高频事件里频繁 setData;渲染无关数据塞 data。
|
|
66
|
+
- 不分包导致主包超限/启动慢;大图打进包。
|
|
67
|
+
- 页面里散落 `wx.request` 无统一封装;前端暴露 appsecret。
|
|
68
|
+
- 不处理空态/错误/弱网;登录/支付不走后端校验、无幂等。
|
|
69
|
+
- 调敏感接口不授权说明、不配合规域名白名单、忽略审核规范。
|
|
70
|
+
|
|
71
|
+
## 9. 最低交付 checklist
|
|
72
|
+
|
|
73
|
+
- [ ] setData 只传最小变化、路径更新、合并节流;渲染无关数据不入 data;长列表分页/虚拟。
|
|
74
|
+
- [ ] 分包(主包仅必要) + 预下载 + 图片 CDN/压缩/懒加载,主包<上限。
|
|
75
|
+
- [ ] 统一请求封装 + 自定义组件复用 + 合理全局状态 + TS + UI 库对齐设计。
|
|
76
|
+
- [ ] 生命周期正确 + 首屏骨架/loading + 三态 + 缓存秒开。
|
|
77
|
+
- [ ] 登录/支付后端校验+幂等;敏感接口授权说明+隐私协议+合规域名+过审核。
|
|
78
|
+
- [ ] 多端用 uni-app/Taro 条件编译 + rpx 适配。
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
**参考**:微信小程序官方性能优化/分包文档、setData 最佳实践、uni-app/Taro 跨端、平台审核规范、WeUI/Vant Weapp 设计。
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: android-material-design
|
|
3
|
+
title: Android 设计规范(Material Design 3 · 官方)
|
|
4
|
+
domain: mobile
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [android, 设计规范, material-design, material3, m3, 色彩角色, type-scale, elevation, motion, dynamic-color, 自适应, 商业级]
|
|
8
|
+
quality_score: 95
|
|
9
|
+
last_updated: 2026-06-19
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Android 设计规范(Material Design 3 · 官方)
|
|
13
|
+
|
|
14
|
+
> 纯 Claude/Codex 写 Android UI 常不遵循 Material、像套了个 iOS 或 web 壳。本标准是 Google 官方 **Material Design 3 (M3)** 的落地要点——做出**像 Android 原生**的界面。
|
|
15
|
+
|
|
16
|
+
## 1. 色彩系统(M3 Color Roles)
|
|
17
|
+
|
|
18
|
+
- 用 M3 的**语义色角色**而非硬编码 hex:`primary`(主要按钮/激活态)、`secondary`(次要)、`tertiary`(对比强调),及其 `on-*`(其上文字)、`surface`/`background`/`error` 等。
|
|
19
|
+
- 从一个**种子色(seed)** 生成完整 tonal palette;支持 **Dynamic Color**(Material You:跟随用户壁纸取色,Android 12+)。
|
|
20
|
+
- 必须支持深色主题(M3 的 dark scheme),文字/容器对比达标。
|
|
21
|
+
|
|
22
|
+
## 2. 排版(Type Scale)
|
|
23
|
+
|
|
24
|
+
- 用 M3 **type scale**:`Display / Headline / Title / Body / Label`,各有 Large/Medium/Small;用角色而非写死字号。
|
|
25
|
+
- 默认字体 Roboto(中文思源黑体/系统中文),清晰层级。
|
|
26
|
+
|
|
27
|
+
## 3. 形状与高度(Shape & Elevation)
|
|
28
|
+
|
|
29
|
+
- 用 M3 **shape scale**(圆角等级:none/xs/s/m/l/xl,对应不同组件)。
|
|
30
|
+
- **Elevation**:用 z 轴高度 + tonal surface(M3 用表面色调变化表达层级,弱化阴影)传达层次;同类组件高度一致。
|
|
31
|
+
|
|
32
|
+
## 4. 动效(Motion)
|
|
33
|
+
|
|
34
|
+
- 用 M3 动效(标准缓动曲线、容器变换 container transform、共享轴 shared axis)引导用户、表达层级关系,**有意义不炫技**;尊重 reduce motion。
|
|
35
|
+
|
|
36
|
+
## 5. 组件(用 M3 组件库)
|
|
37
|
+
|
|
38
|
+
- 用 Material Components(Jetpack Compose Material3 / Views MDC):`Button`(filled/tonal/outlined/text/elevated)、`TopAppBar`、`NavigationBar`(底部)/`NavigationRail`/`NavigationDrawer`、`FAB`、`Card`、`TextField`(outlined/filled)、`Chip`、`Snackbar`、`BottomSheet`、`Dialog` 等。
|
|
39
|
+
- 图标用 **Material Symbols**,不要用 emoji 当功能图标。
|
|
40
|
+
- **FAB** 用于页面主操作(Android 特有,别照搬到 iOS)。
|
|
41
|
+
|
|
42
|
+
## 6. 导航范式(Android 特有)
|
|
43
|
+
|
|
44
|
+
- 顶层切换用 **Navigation Bar**(底部,3–5 项) / 大屏用 Navigation Rail / Drawer。
|
|
45
|
+
- **顶部 App Bar** 承载标题与操作;**系统返回**(手势/返回键)必须正确处理(与 iOS 左上返回不同)。
|
|
46
|
+
- 大屏/平板/折叠屏用**自适应布局**(窗口尺寸类 compact/medium/expanded,列表-详情等 canonical layouts)。
|
|
47
|
+
|
|
48
|
+
## 7. 布局与适配
|
|
49
|
+
|
|
50
|
+
- 8dp 栅格基线;触控目标 **≥48×48dp**。
|
|
51
|
+
- 边到边(edge-to-edge) + 处理系统栏 insets;适配深色、字体缩放、不同密度(dpi)。
|
|
52
|
+
- 自适应不同屏幕尺寸/折叠态,不写死宽度。
|
|
53
|
+
|
|
54
|
+
## 8. 反模式(出现即不合格 / "不像 Android")
|
|
55
|
+
|
|
56
|
+
- 不用 M3 色角色/type scale,硬编码颜色字号;不支持深色/Dynamic Color。
|
|
57
|
+
- 套 iOS 范式(顶部 tab、iOS 返回)忽略系统返回;把 FAB 乱用或缺主操作入口。
|
|
58
|
+
- 不适配大屏/折叠屏;忽略系统栏 insets;触控目标过小。
|
|
59
|
+
- emoji 当图标;自绘非 Material 控件且无无障碍。
|
|
60
|
+
|
|
61
|
+
## 9. 最低交付 checklist
|
|
62
|
+
|
|
63
|
+
- [ ] M3 色角色(seed→palette)+Dynamic Color+深色;type scale;shape/elevation 体系。
|
|
64
|
+
- [ ] 用 Material3 组件 + Material Symbols 图标(无 emoji);FAB 用于主操作。
|
|
65
|
+
- [ ] 底部 Navigation Bar/Rail/Drawer + 顶部 App Bar + 正确系统返回。
|
|
66
|
+
- [ ] 8dp 栅格 + ≥48dp 触控 + edge-to-edge insets + 自适应大屏/折叠屏/密度/字体缩放。
|
|
67
|
+
- [ ] M3 有意义动效 + 三态 + 无障碍(TalkBack/对比度/reduce motion)。
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
**参考(官方)**:Material Design 3 (m3.material.io)、Material 3 in Compose、Dynamic Color/Material You、Material Symbols、自适应布局(window size classes)。
|