@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,297 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: architecture-decision-checklist
|
|
3
|
+
title: 架构决策检查清单
|
|
4
|
+
domain: architecture
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [architecture, checklist, decision, 可扩展性, 可用性, 可观测性, 安全, 成本]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 架构决策检查清单
|
|
12
|
+
|
|
13
|
+
> 适用场景:新系统设计、重大技术选型、架构评审会议、ADR 编写前的全面评估。
|
|
14
|
+
> 使用方式:逐项核查,标记完成状态,未通过项必须附带理由或待办。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. 需求分析
|
|
19
|
+
|
|
20
|
+
### 1.1 功能需求
|
|
21
|
+
|
|
22
|
+
- [ ] 核心业务场景已梳理并按优先级排序(P0/P1/P2)
|
|
23
|
+
- [ ] 用户角色与权限模型已定义
|
|
24
|
+
- [ ] 关键业务流程已绘制流程图或时序图
|
|
25
|
+
- [ ] 数据实体与关系已建模(ER 图或领域模型)
|
|
26
|
+
- [ ] 接口边界已明确(对外 API、对内服务间调用)
|
|
27
|
+
- [ ] 离线/批处理需求已识别
|
|
28
|
+
- [ ] 多租户需求已评估(是否需要、隔离级别)
|
|
29
|
+
- [ ] 国际化/本地化需求已确认(语言、时区、货币)
|
|
30
|
+
|
|
31
|
+
### 1.2 非功能需求
|
|
32
|
+
|
|
33
|
+
- [ ] 性能目标已量化(QPS、响应时间 P50/P95/P99)
|
|
34
|
+
- [ ] 可用性目标已量化(SLA 百分比,如 99.9%、99.99%)
|
|
35
|
+
- [ ] 数据一致性要求已明确(强一致/最终一致)
|
|
36
|
+
- [ ] 数据量预估已完成(初始量、增长率、峰值)
|
|
37
|
+
- [ ] 并发用户数预估已完成(日常/峰值)
|
|
38
|
+
- [ ] 数据保留策略已定义(热/温/冷数据周期)
|
|
39
|
+
- [ ] 合规要求已识别(GDPR、等保、行业法规)
|
|
40
|
+
- [ ] 灾备等级已确定(RPO/RTO 目标值)
|
|
41
|
+
|
|
42
|
+
### 1.3 约束条件
|
|
43
|
+
|
|
44
|
+
- [ ] 现有技术栈约束已列出
|
|
45
|
+
- [ ] 团队技术能力已评估(熟悉的语言/框架/工具)
|
|
46
|
+
- [ ] 预算约束已明确(基础设施、许可证、第三方服务)
|
|
47
|
+
- [ ] 上线时间约束已确认
|
|
48
|
+
- [ ] 合规与审计约束已确认
|
|
49
|
+
- [ ] 组织架构约束已考虑(团队规模、协作模式)
|
|
50
|
+
- [ ] 遗留系统集成约束已识别
|
|
51
|
+
- [ ] 供应商锁定风险已评估
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 2. 技术选型
|
|
56
|
+
|
|
57
|
+
### 2.1 编程语言与运行时
|
|
58
|
+
|
|
59
|
+
- [ ] 候选语言已列出并对比(性能/生态/招聘难度)
|
|
60
|
+
- [ ] 语言版本与 LTS 策略已确认
|
|
61
|
+
- [ ] 运行时环境已确定(JVM/Node/Python/Go 等)
|
|
62
|
+
- [ ] 跨语言通信方案已确定(gRPC/REST/消息队列)
|
|
63
|
+
- [ ] 构建工具链已选定
|
|
64
|
+
|
|
65
|
+
### 2.2 框架与库
|
|
66
|
+
|
|
67
|
+
- [ ] Web 框架已选定并评估(成熟度/社区/性能)
|
|
68
|
+
- [ ] ORM / 数据访问层方案已确定
|
|
69
|
+
- [ ] 依赖管理策略已制定(版本锁定/安全扫描)
|
|
70
|
+
- [ ] 框架升级路径已评估(大版本兼容性)
|
|
71
|
+
- [ ] 开源许可证合规已检查
|
|
72
|
+
|
|
73
|
+
### 2.3 数据库
|
|
74
|
+
|
|
75
|
+
- [ ] 主数据库类型已选定(关系型/文档/键值/图/时序)
|
|
76
|
+
- [ ] 读写分离方案已评估
|
|
77
|
+
- [ ] 分库分表策略已评估(是否需要、分片键选择)
|
|
78
|
+
- [ ] 数据库版本与部署模式已确定(自建/托管/Serverless)
|
|
79
|
+
- [ ] 数据迁移方案已规划
|
|
80
|
+
- [ ] 备份与恢复策略已制定
|
|
81
|
+
- [ ] 索引设计原则已确定
|
|
82
|
+
|
|
83
|
+
### 2.4 消息队列
|
|
84
|
+
|
|
85
|
+
- [ ] 是否需要消息队列已评估
|
|
86
|
+
- [ ] 消息队列产品已选定(Kafka/RabbitMQ/RocketMQ/Pulsar/NATS)
|
|
87
|
+
- [ ] 消息投递语义已确定(at-least-once/at-most-once/exactly-once)
|
|
88
|
+
- [ ] 消息顺序性要求已评估
|
|
89
|
+
- [ ] 死信队列/重试策略已设计
|
|
90
|
+
- [ ] 消息积压监控方案已规划
|
|
91
|
+
- [ ] 消息 schema 管理方案已确定
|
|
92
|
+
|
|
93
|
+
### 2.5 缓存
|
|
94
|
+
|
|
95
|
+
- [ ] 缓存层级已设计(本地缓存/分布式缓存/CDN)
|
|
96
|
+
- [ ] 缓存产品已选定(Redis/Memcached/本地 LRU)
|
|
97
|
+
- [ ] 缓存策略已确定(Cache-Aside/Read-Through/Write-Behind)
|
|
98
|
+
- [ ] 缓存失效策略已设计(TTL/事件驱动/版本号)
|
|
99
|
+
- [ ] 缓存穿透/击穿/雪崩防护已设计
|
|
100
|
+
- [ ] 缓存一致性方案已确定
|
|
101
|
+
- [ ] 缓存容量预估已完成
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 3. 可扩展性
|
|
106
|
+
|
|
107
|
+
### 3.1 水平扩展
|
|
108
|
+
|
|
109
|
+
- [ ] 无状态服务设计已确认(Session 外置)
|
|
110
|
+
- [ ] 服务发现机制已确定
|
|
111
|
+
- [ ] 负载均衡策略已选定(轮询/权重/一致性哈希)
|
|
112
|
+
- [ ] 自动扩缩容规则已设计(CPU/内存/QPS 阈值)
|
|
113
|
+
- [ ] 数据库连接池在扩展时的行为已验证
|
|
114
|
+
- [ ] 有状态组件的水平扩展方案已明确
|
|
115
|
+
|
|
116
|
+
### 3.2 垂直扩展
|
|
117
|
+
|
|
118
|
+
- [ ] 单节点性能瓶颈已预估
|
|
119
|
+
- [ ] 资源规格上限已了解(云厂商实例上限)
|
|
120
|
+
- [ ] 垂直扩展成本曲线已评估
|
|
121
|
+
- [ ] 垂直扩展时的停机影响已评估
|
|
122
|
+
|
|
123
|
+
### 3.3 数据分片
|
|
124
|
+
|
|
125
|
+
- [ ] 分片策略已确定(范围/哈希/混合)
|
|
126
|
+
- [ ] 分片键选择已论证(数据分布均匀性、查询模式)
|
|
127
|
+
- [ ] 跨分片查询方案已设计
|
|
128
|
+
- [ ] 分片扩容方案已规划(在线扩容/停机迁移)
|
|
129
|
+
- [ ] 全局唯一 ID 生成方案已确定
|
|
130
|
+
- [ ] 跨分片事务处理方案已设计
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## 4. 可用性
|
|
135
|
+
|
|
136
|
+
### 4.1 SLA 定义
|
|
137
|
+
|
|
138
|
+
- [ ] 整体 SLA 目标已定义(如 99.95%)
|
|
139
|
+
- [ ] 各子系统 SLA 已分解
|
|
140
|
+
- [ ] SLA 计算方式已明确(时间窗口/排除维护窗口)
|
|
141
|
+
- [ ] SLA 违约的响应流程已建立
|
|
142
|
+
- [ ] 依赖方 SLA 已确认并纳入计算
|
|
143
|
+
|
|
144
|
+
### 4.2 冗余设计
|
|
145
|
+
|
|
146
|
+
- [ ] 服务实例冗余数量已确定(最少 2 副本)
|
|
147
|
+
- [ ] 数据库主从/多副本已配置
|
|
148
|
+
- [ ] 缓存集群冗余已设计
|
|
149
|
+
- [ ] 消息队列集群冗余已设计
|
|
150
|
+
- [ ] 跨可用区部署已评估
|
|
151
|
+
- [ ] 跨区域部署已评估(多活/灾备)
|
|
152
|
+
|
|
153
|
+
### 4.3 故障转移
|
|
154
|
+
|
|
155
|
+
- [ ] 健康检查机制已设计(存活/就绪探针)
|
|
156
|
+
- [ ] 自动故障转移策略已配置
|
|
157
|
+
- [ ] 手动切换流程已文档化
|
|
158
|
+
- [ ] 数据库 Failover 方案已验证
|
|
159
|
+
- [ ] DNS 切换方案已规划(TTL 设置)
|
|
160
|
+
- [ ] 故障演练计划已制定
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## 5. 安全
|
|
165
|
+
|
|
166
|
+
### 5.1 认证与授权
|
|
167
|
+
|
|
168
|
+
- [ ] 认证方案已确定(OAuth2/OIDC/SAML/JWT/Session)
|
|
169
|
+
- [ ] Token 生命周期管理已设计(签发/刷新/撤销)
|
|
170
|
+
- [ ] 权限模型已设计(RBAC/ABAC/ACL)
|
|
171
|
+
- [ ] API 鉴权方案已确定
|
|
172
|
+
- [ ] 服务间认证已设计(mTLS/Service Token)
|
|
173
|
+
- [ ] 多因素认证需求已评估
|
|
174
|
+
|
|
175
|
+
### 5.2 数据加密
|
|
176
|
+
|
|
177
|
+
- [ ] 传输加密已确认(TLS 1.2+)
|
|
178
|
+
- [ ] 静态数据加密方案已确定(磁盘加密/字段加密)
|
|
179
|
+
- [ ] 敏感数据识别与分类已完成
|
|
180
|
+
- [ ] 密钥管理方案已确定(KMS/Vault)
|
|
181
|
+
- [ ] 密钥轮换策略已设计
|
|
182
|
+
- [ ] 证书管理与自动续期已规划
|
|
183
|
+
|
|
184
|
+
### 5.3 审计与合规
|
|
185
|
+
|
|
186
|
+
- [ ] 审计日志范围已定义(操作类型/数据变更)
|
|
187
|
+
- [ ] 审计日志存储与保留策略已确定
|
|
188
|
+
- [ ] 审计日志防篡改方案已设计
|
|
189
|
+
- [ ] 合规扫描已纳入 CI/CD
|
|
190
|
+
- [ ] 渗透测试计划已制定
|
|
191
|
+
- [ ] 安全事件响应流程已建立
|
|
192
|
+
- [ ] 数据脱敏规则已定义(日志/测试环境)
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## 6. 可观测性
|
|
197
|
+
|
|
198
|
+
### 6.1 指标(Metrics)
|
|
199
|
+
|
|
200
|
+
- [ ] 业务指标已定义(订单量/转化率/活跃用户)
|
|
201
|
+
- [ ] 系统指标已定义(CPU/内存/磁盘/网络)
|
|
202
|
+
- [ ] 应用指标已定义(请求量/延迟/错误率 — RED 方法)
|
|
203
|
+
- [ ] 指标采集方案已选定(Prometheus/Datadog/CloudWatch)
|
|
204
|
+
- [ ] 仪表盘已规划(总览/服务级/基础设施级)
|
|
205
|
+
- [ ] 告警规则已定义(阈值/持续时间/通知渠道)
|
|
206
|
+
- [ ] SLI/SLO 指标已与 SLA 对齐
|
|
207
|
+
|
|
208
|
+
### 6.2 日志(Logging)
|
|
209
|
+
|
|
210
|
+
- [ ] 日志格式已统一(结构化 JSON)
|
|
211
|
+
- [ ] 日志级别使用规范已制定
|
|
212
|
+
- [ ] 日志采集方案已选定(ELK/Loki/CloudWatch Logs)
|
|
213
|
+
- [ ] 日志存储与保留策略已确定
|
|
214
|
+
- [ ] 敏感信息脱敏已在日志层实现
|
|
215
|
+
- [ ] 请求 ID / 关联 ID 已贯穿全链路
|
|
216
|
+
|
|
217
|
+
### 6.3 追踪(Tracing)
|
|
218
|
+
|
|
219
|
+
- [ ] 分布式追踪方案已选定(Jaeger/Zipkin/OpenTelemetry)
|
|
220
|
+
- [ ] Trace ID 传播机制已确认(HTTP Header/消息 Header)
|
|
221
|
+
- [ ] 采样策略已确定(全量/概率/自适应)
|
|
222
|
+
- [ ] 追踪数据保留周期已定义
|
|
223
|
+
- [ ] 关键路径已标注 Span 名称和属性
|
|
224
|
+
- [ ] 追踪与日志/指标的关联已打通
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
## 7. 成本
|
|
229
|
+
|
|
230
|
+
### 7.1 基础设施成本
|
|
231
|
+
|
|
232
|
+
- [ ] 计算资源预估已完成(实例类型/数量/预留/按需)
|
|
233
|
+
- [ ] 存储成本预估已完成(块存储/对象存储/数据库存储)
|
|
234
|
+
- [ ] 网络成本预估已完成(跨区域流量/CDN/API 网关调用)
|
|
235
|
+
- [ ] 托管服务费用已列出(数据库/缓存/消息队列/搜索)
|
|
236
|
+
- [ ] 许可证费用已列出(商业软件/SaaS)
|
|
237
|
+
- [ ] 成本优化策略已制定(预留实例/Spot/Savings Plan)
|
|
238
|
+
|
|
239
|
+
### 7.2 运维成本
|
|
240
|
+
|
|
241
|
+
- [ ] 监控/告警平台费用已评估
|
|
242
|
+
- [ ] 日志存储费用已评估
|
|
243
|
+
- [ ] CI/CD 平台费用已评估
|
|
244
|
+
- [ ] 安全工具费用已评估(WAF/SAST/DAST)
|
|
245
|
+
- [ ] 运维自动化程度已评估
|
|
246
|
+
|
|
247
|
+
### 7.3 人力成本
|
|
248
|
+
|
|
249
|
+
- [ ] 开发团队规模已评估
|
|
250
|
+
- [ ] 运维团队规模已评估
|
|
251
|
+
- [ ] 技术栈学习成本已评估
|
|
252
|
+
- [ ] 招聘难度已评估(稀缺技术/市场供给)
|
|
253
|
+
- [ ] 外部顾问/培训费用已评估
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## 8. 文档
|
|
258
|
+
|
|
259
|
+
### 8.1 架构决策记录(ADR)
|
|
260
|
+
|
|
261
|
+
- [ ] ADR 模板已选定(标题/状态/上下文/决策/后果)
|
|
262
|
+
- [ ] 每项重大技术选型已编写 ADR
|
|
263
|
+
- [ ] ADR 存储位置已确定(代码仓库/Wiki)
|
|
264
|
+
- [ ] ADR 审批流程已建立
|
|
265
|
+
- [ ] 历史 ADR 已归档且可检索
|
|
266
|
+
|
|
267
|
+
### 8.2 架构图
|
|
268
|
+
|
|
269
|
+
- [ ] 系统上下文图已绘制(C4 Level 1)
|
|
270
|
+
- [ ] 容器图已绘制(C4 Level 2)
|
|
271
|
+
- [ ] 组件图已绘制(C4 Level 3,关键模块)
|
|
272
|
+
- [ ] 部署图已绘制(基础设施拓扑)
|
|
273
|
+
- [ ] 数据流图已绘制(关键业务流程)
|
|
274
|
+
- [ ] 架构图使用代码化工具(Mermaid/PlantUML/Structurizr)
|
|
275
|
+
- [ ] 架构图版本与代码同步更新
|
|
276
|
+
|
|
277
|
+
### 8.3 接口文档
|
|
278
|
+
|
|
279
|
+
- [ ] API 文档格式已统一(OpenAPI 3.0 / AsyncAPI)
|
|
280
|
+
- [ ] API 文档自动生成已集成到 CI
|
|
281
|
+
- [ ] 服务间接口契约已定义
|
|
282
|
+
- [ ] 接口变更流程已建立(版本控制/向后兼容)
|
|
283
|
+
- [ ] 接口示例与错误码已完善
|
|
284
|
+
- [ ] SDK / 客户端库生成方案已评估
|
|
285
|
+
|
|
286
|
+
---
|
|
287
|
+
|
|
288
|
+
## Agent Checklist
|
|
289
|
+
|
|
290
|
+
- [ ] 架构决策前已完成本清单中所有 P0 项的评估
|
|
291
|
+
- [ ] 未通过的检查项已附带原因说明或待办计划
|
|
292
|
+
- [ ] 清单结果已同步至 ADR 或架构评审纪要
|
|
293
|
+
- [ ] 涉及的非功能需求已转化为可量化的 SLI/SLO
|
|
294
|
+
- [ ] 技术选型对比矩阵已存档
|
|
295
|
+
- [ ] 成本预估已获得相关方确认
|
|
296
|
+
- [ ] 安全与合规项已通过安全团队评审
|
|
297
|
+
- [ ] 所有架构图已更新至最新版本
|