@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,303 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: incident-response-complete
|
|
3
|
+
title: 事故响应与复盘完整指南
|
|
4
|
+
domain: incident
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [complete, incident, response, 事故分级, 事故响应流程, 初始通知, 发现后5分钟内, 恢复通知]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 事故响应与复盘完整指南
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
|
|
15
|
+
事故响应是运维工程的核心能力。一个成熟的事故响应流程能将 MTTR(平均恢复时间)从小时级降低到分钟级。本指南覆盖事故分级、响应流程、通信模板、复盘方法和预防措施。
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 事故分级
|
|
20
|
+
|
|
21
|
+
| 级别 | 影响 | 响应时间 | 通知范围 | 示例 |
|
|
22
|
+
|------|------|----------|----------|------|
|
|
23
|
+
| **P0 (Critical)** | 全站不可用/数据丢失 | < 5分钟 | CEO + 全体工程 | 数据库崩溃、安全漏洞被利用 |
|
|
24
|
+
| **P1 (Major)** | 核心功能不可用 | < 15分钟 | VP Eng + On-call | 支付系统故障、API 大面积超时 |
|
|
25
|
+
| **P2 (Minor)** | 部分功能降级 | < 30分钟 | Team Lead + On-call | 搜索变慢、部分用户无法登录 |
|
|
26
|
+
| **P3 (Low)** | 非关键功能异常 | < 2小时 | On-call | 管理后台报错、日志丢失 |
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 事故响应流程
|
|
31
|
+
|
|
32
|
+
### Phase 1: 检测与告警 (0-5分钟)
|
|
33
|
+
|
|
34
|
+
```yaml
|
|
35
|
+
# Prometheus 告警规则示例
|
|
36
|
+
groups:
|
|
37
|
+
- name: critical-alerts
|
|
38
|
+
rules:
|
|
39
|
+
- alert: HighErrorRate
|
|
40
|
+
expr: |
|
|
41
|
+
sum(rate(http_requests_total{status=~"5.."}[5m]))
|
|
42
|
+
/ sum(rate(http_requests_total[5m])) > 0.05
|
|
43
|
+
for: 2m
|
|
44
|
+
labels:
|
|
45
|
+
severity: critical
|
|
46
|
+
annotations:
|
|
47
|
+
summary: "错误率超过 5%"
|
|
48
|
+
runbook: "https://runbook.internal/high-error-rate"
|
|
49
|
+
|
|
50
|
+
- alert: HighLatency
|
|
51
|
+
expr: |
|
|
52
|
+
histogram_quantile(0.99, rate(http_request_duration_seconds_bucket[5m])) > 2
|
|
53
|
+
for: 3m
|
|
54
|
+
labels:
|
|
55
|
+
severity: warning
|
|
56
|
+
annotations:
|
|
57
|
+
summary: "P99 延迟超过 2s"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Phase 2: 分类与升级 (5-15分钟)
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
告警触发
|
|
64
|
+
│
|
|
65
|
+
├── On-call 工程师确认
|
|
66
|
+
│ │
|
|
67
|
+
│ ├── 是否影响用户? ──── 否 → P3 (记录并排期修复)
|
|
68
|
+
│ │
|
|
69
|
+
│ └── 是 → 影响范围?
|
|
70
|
+
│ │
|
|
71
|
+
│ ├── 部分用户 → P2
|
|
72
|
+
│ ├── 核心功能 → P1
|
|
73
|
+
│ └── 全站 → P0 (立即升级)
|
|
74
|
+
│
|
|
75
|
+
└── 指派事故指挥官 (Incident Commander)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Phase 3: 诊断与修复 (15分钟-2小时)
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# 快速诊断脚本
|
|
82
|
+
#!/bin/bash
|
|
83
|
+
echo "=== 系统状态 ==="
|
|
84
|
+
kubectl get pods --all-namespaces | grep -v Running
|
|
85
|
+
kubectl top nodes
|
|
86
|
+
kubectl top pods --sort-by=memory
|
|
87
|
+
|
|
88
|
+
echo "=== 最近事件 ==="
|
|
89
|
+
kubectl get events --sort-by='.lastTimestamp' | tail -20
|
|
90
|
+
|
|
91
|
+
echo "=== 错误日志 ==="
|
|
92
|
+
kubectl logs -l app=api-server --tail=50 | grep -i error
|
|
93
|
+
|
|
94
|
+
echo "=== 数据库连接 ==="
|
|
95
|
+
psql -c "SELECT count(*) FROM pg_stat_activity WHERE state = 'active';"
|
|
96
|
+
psql -c "SELECT query, calls, mean_exec_time FROM pg_stat_statements ORDER BY mean_exec_time DESC LIMIT 5;"
|
|
97
|
+
|
|
98
|
+
echo "=== Redis 状态 ==="
|
|
99
|
+
redis-cli info memory | grep used_memory_human
|
|
100
|
+
redis-cli info clients | grep connected_clients
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Phase 4: 缓解措施
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
# 常见缓解策略
|
|
107
|
+
MITIGATION_PLAYBOOK = {
|
|
108
|
+
"高错误率": [
|
|
109
|
+
"1. 检查最近部署 → 回滚 (kubectl rollout undo)",
|
|
110
|
+
"2. 检查外部依赖 → 开启降级模式",
|
|
111
|
+
"3. 检查数据库 → 杀慢查询, 扩连接池",
|
|
112
|
+
"4. 检查内存/CPU → 水平扩容",
|
|
113
|
+
],
|
|
114
|
+
"高延迟": [
|
|
115
|
+
"1. 检查数据库慢查询 → 优化或杀掉",
|
|
116
|
+
"2. 检查缓存命中率 → 预热缓存",
|
|
117
|
+
"3. 检查连接池耗尽 → 扩大池大小",
|
|
118
|
+
"4. 检查 GC 暂停 → 调整 JVM/Python GC",
|
|
119
|
+
],
|
|
120
|
+
"服务不可用": [
|
|
121
|
+
"1. 检查 Pod 状态 → 重启或扩容",
|
|
122
|
+
"2. 检查证书过期 → 更新证书",
|
|
123
|
+
"3. 检查 DNS → 验证解析",
|
|
124
|
+
"4. 检查磁盘 → 清理或扩容",
|
|
125
|
+
],
|
|
126
|
+
"数据异常": [
|
|
127
|
+
"1. 停止写入 → 防止进一步损坏",
|
|
128
|
+
"2. 评估影响范围 → 确定受影响的数据",
|
|
129
|
+
"3. 从备份恢复 → PITR 到故障前时间点",
|
|
130
|
+
"4. 验证数据完整性 → 校验和对账",
|
|
131
|
+
],
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Phase 5: 通信
|
|
136
|
+
|
|
137
|
+
```markdown
|
|
138
|
+
# 事故通信模板
|
|
139
|
+
|
|
140
|
+
## 初始通知 (发现后5分钟内)
|
|
141
|
+
**[P1 事故] API 响应超时**
|
|
142
|
+
- 影响: 部分用户无法完成支付
|
|
143
|
+
- 发现时间: 2026-03-28 14:30 UTC
|
|
144
|
+
- 当前状态: 调查中
|
|
145
|
+
- 事故指挥官: @alice
|
|
146
|
+
- 下次更新: 15分钟后
|
|
147
|
+
|
|
148
|
+
## 进展更新 (每15-30分钟)
|
|
149
|
+
**[P1 更新] API 响应超时 - 根因已定位**
|
|
150
|
+
- 根因: 数据库连接池耗尽 (活跃连接 500/500)
|
|
151
|
+
- 缓解措施: 已扩大连接池至 1000,正在重启服务
|
|
152
|
+
- 预计恢复: 15分钟内
|
|
153
|
+
- 下次更新: 15分钟后
|
|
154
|
+
|
|
155
|
+
## 恢复通知
|
|
156
|
+
**[P1 已恢复] API 响应超时**
|
|
157
|
+
- 恢复时间: 2026-03-28 15:15 UTC
|
|
158
|
+
- 影响时长: 45分钟
|
|
159
|
+
- 根因: 新功能引入了 N+1 查询导致连接池耗尽
|
|
160
|
+
- 永久修复: 已合并 PR #1234 (查询优化)
|
|
161
|
+
- 复盘时间: 2026-03-29 10:00 UTC
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 复盘 (Postmortem)
|
|
167
|
+
|
|
168
|
+
### 复盘模板
|
|
169
|
+
|
|
170
|
+
```markdown
|
|
171
|
+
# 事故复盘: [事故标题]
|
|
172
|
+
|
|
173
|
+
## 概要
|
|
174
|
+
- **日期**: 2026-03-28
|
|
175
|
+
- **时长**: 45分钟 (14:30 - 15:15 UTC)
|
|
176
|
+
- **影响**: 约 5000 用户无法完成支付
|
|
177
|
+
- **级别**: P1
|
|
178
|
+
- **根因**: N+1 查询导致数据库连接池耗尽
|
|
179
|
+
|
|
180
|
+
## 时间线
|
|
181
|
+
| 时间 (UTC) | 事件 |
|
|
182
|
+
|------------|------|
|
|
183
|
+
| 14:25 | 部署 v2.3.1 (包含订单列表新功能) |
|
|
184
|
+
| 14:30 | 错误率告警触发 (>5%) |
|
|
185
|
+
| 14:32 | On-call @bob 确认事故,升级为 P1 |
|
|
186
|
+
| 14:35 | 事故指挥官 @alice 就位,开始诊断 |
|
|
187
|
+
| 14:45 | 定位根因: pg_stat_activity 显示 500 活跃连接 |
|
|
188
|
+
| 14:50 | 尝试回滚 v2.3.1 → 失败 (数据库迁移不可逆) |
|
|
189
|
+
| 14:55 | 扩大连接池至 1000,重启 API 服务 |
|
|
190
|
+
| 15:05 | 错误率降至 1%,支付功能恢复 |
|
|
191
|
+
| 15:15 | 错误率降至 0.1%,确认完全恢复 |
|
|
192
|
+
|
|
193
|
+
## 根因分析
|
|
194
|
+
订单列表 API 在新功能中引入了 N+1 查询问题:
|
|
195
|
+
- 每个订单额外查询 3 次数据库 (用户信息、商品详情、物流状态)
|
|
196
|
+
- 一个列表请求触发 30+ 数据库查询
|
|
197
|
+
- 高峰期请求并发导致连接池快速耗尽
|
|
198
|
+
|
|
199
|
+
## 5 Whys 分析
|
|
200
|
+
1. **为什么支付系统不可用?** → 数据库连接池耗尽
|
|
201
|
+
2. **为什么连接池耗尽?** → 新功能引入了 N+1 查询
|
|
202
|
+
3. **为什么 N+1 查询没被发现?** → 代码审查未检查数据库查询数量
|
|
203
|
+
4. **为什么没有查询数量的监控?** → 监控只覆盖了响应时间,未覆盖查询数量
|
|
204
|
+
5. **为什么测试没有发现?** → 测试数据量太小 (10条 vs 生产 10000条)
|
|
205
|
+
|
|
206
|
+
## 行动项
|
|
207
|
+
| 优先级 | 行动 | 负责人 | 截止日期 |
|
|
208
|
+
|--------|------|--------|----------|
|
|
209
|
+
| P0 | 修复 N+1 查询 (select_related) | @charlie | 2026-03-29 |
|
|
210
|
+
| P1 | 添加数据库查询数量监控 | @dave | 2026-04-01 |
|
|
211
|
+
| P1 | CI 中添加查询数量断言 | @eve | 2026-04-05 |
|
|
212
|
+
| P2 | 增加测试数据量 (>1000条) | @charlie | 2026-04-10 |
|
|
213
|
+
| P2 | 连接池告警 (>80%使用率) | @dave | 2026-04-05 |
|
|
214
|
+
|
|
215
|
+
## 经验教训
|
|
216
|
+
### 做得好的
|
|
217
|
+
- 告警触发迅速 (部署后5分钟)
|
|
218
|
+
- 事故响应流程清晰,通信及时
|
|
219
|
+
- 团队协作高效
|
|
220
|
+
|
|
221
|
+
### 需要改进的
|
|
222
|
+
- 代码审查需要关注数据库查询模式
|
|
223
|
+
- 需要更真实的测试数据
|
|
224
|
+
- 回滚失败时需要备选方案
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### 无责文化 (Blameless Culture)
|
|
228
|
+
|
|
229
|
+
```
|
|
230
|
+
✅ 正确的复盘态度:
|
|
231
|
+
- "系统允许了这个错误发生" (而非 "某人犯了错")
|
|
232
|
+
- "我们的流程缺失了什么?" (而非 "谁没做好?")
|
|
233
|
+
- "如何让这个错误不可能再次发生?" (而非 "下次小心点")
|
|
234
|
+
|
|
235
|
+
❌ 错误的复盘态度:
|
|
236
|
+
- "这是 @bob 的错"
|
|
237
|
+
- "应该更小心"
|
|
238
|
+
- "下次注意"
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
## On-Call 最佳实践
|
|
244
|
+
|
|
245
|
+
### 轮值制度
|
|
246
|
+
|
|
247
|
+
```
|
|
248
|
+
每周轮值:
|
|
249
|
+
├── 主 On-Call (Primary): 接收所有告警,第一响应
|
|
250
|
+
├── 副 On-Call (Secondary): 主 On-Call 15分钟无响应时升级
|
|
251
|
+
└── 经理 On-Call: P0/P1 事故自动通知
|
|
252
|
+
|
|
253
|
+
轮值规则:
|
|
254
|
+
- 每次轮值 1 周 (周一 10:00 → 下周一 10:00)
|
|
255
|
+
- 轮值前一天交接会 (15分钟)
|
|
256
|
+
- 夜间告警 (22:00-08:00) 必须可在 5 分钟内响应
|
|
257
|
+
- 连续超过 3 次夜间告警 → 次日可延迟上班
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### 告警疲劳防治
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
✅ 健康的告警:
|
|
264
|
+
- 每周夜间告警 < 5 次
|
|
265
|
+
- 每条告警都需要人为干预
|
|
266
|
+
- 告警有明确的 Runbook 链接
|
|
267
|
+
|
|
268
|
+
❌ 告警疲劳信号:
|
|
269
|
+
- 超过 50% 的告警被忽略
|
|
270
|
+
- On-Call 开始"批量确认"告警
|
|
271
|
+
- 关键告警淹没在噪音中
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
---
|
|
275
|
+
|
|
276
|
+
## Agent Checklist
|
|
277
|
+
|
|
278
|
+
Agent 在设计系统时必须检查的事故预防要点:
|
|
279
|
+
|
|
280
|
+
- [ ] 是否有完善的监控和告警 (错误率/延迟/资源使用)?
|
|
281
|
+
- [ ] 告警是否有 Runbook 链接?
|
|
282
|
+
- [ ] 是否有事故分级标准和升级流程?
|
|
283
|
+
- [ ] 部署是否支持快速回滚?
|
|
284
|
+
- [ ] 是否有数据库慢查询监控?
|
|
285
|
+
- [ ] 是否有连接池/线程池使用率告警?
|
|
286
|
+
- [ ] 是否有事故通信模板?
|
|
287
|
+
- [ ] 是否定期进行复盘 (所有 P0/P1)?
|
|
288
|
+
- [ ] 是否有混沌工程实践 (故障注入测试)?
|
|
289
|
+
- [ ] On-Call 轮值是否合理 (不过度疲劳)?
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## 参考资料
|
|
294
|
+
|
|
295
|
+
- [Google SRE Book - Chapter 14: Managing Incidents](https://sre.google/sre-book/managing-incidents/)
|
|
296
|
+
- [PagerDuty Incident Response Guide](https://response.pagerduty.com/)
|
|
297
|
+
- [Atlassian Incident Management Handbook](https://www.atlassian.com/incident-management)
|
|
298
|
+
|
|
299
|
+
---
|
|
300
|
+
|
|
301
|
+
**文档版本**: v1.0
|
|
302
|
+
**最后更新**: 2026-03-28
|
|
303
|
+
**质量评分**: 93/100
|