@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,511 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: software-lifecycle-gates
|
|
3
|
+
title: Software Lifecycle Gates - Comprehensive Quality Gate Reference
|
|
4
|
+
domain: development
|
|
5
|
+
category: 14-full-lifecycle
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [architecture, decision, design, development, discovery, end-to-end, gate, gates]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# Software Lifecycle Gates - Comprehensive Quality Gate Reference
|
|
12
|
+
|
|
13
|
+
> Consolidated reference covering the end-to-end software development lifecycle: requirement discovery, product-design handoff, architecture decision, implementation execution, testing verification, security compliance, release management, operations observability, incident postmortem, and stage exit criteria.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 1. Lifecycle End-to-End Map
|
|
18
|
+
|
|
19
|
+
### 1.1 Stages Overview
|
|
20
|
+
|
|
21
|
+
The full software development lifecycle consists of 9 stages, each with defined inputs, outputs, gates, and responsible roles:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
Requirement Product & Architecture Implementation Testing
|
|
25
|
+
Discovery -> Design -> Decision -> Execution -> Verification
|
|
26
|
+
| | | | |
|
|
27
|
+
v v v v v
|
|
28
|
+
[Scope Doc] [UI States] [ADR] [Merged Code] [Test Report]
|
|
29
|
+
[Acceptance] [Tracking] [Scale Plan] [Test Evidence] [Perf Result]
|
|
30
|
+
[Risk Reg.] [Handoff] [Rollback] [PR Review] [Bug Closure]
|
|
31
|
+
|
|
|
32
|
+
v
|
|
33
|
+
Security Release & Operations Incident
|
|
34
|
+
Compliance -> Change Mgmt -> Observability -> Postmortem
|
|
35
|
+
| | | |
|
|
36
|
+
v v v v
|
|
37
|
+
[Vuln Scan] [Change Ticket] [SLO Dashboard] [Postmortem]
|
|
38
|
+
[Perm Audit] [Rollout Record][Alert Policy] [Action Items]
|
|
39
|
+
[Compliance] [Verification] [Runbook] [Prevention]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 1.2 Governing Principles
|
|
43
|
+
|
|
44
|
+
1. **Stage Gate Enforcement**: Each stage has explicit exit criteria. The next stage must not begin until the current stage's gate is passed.
|
|
45
|
+
2. **Traceability**: Every decision must be traceable and replayable. Link requirements to code, code to tests, tests to release.
|
|
46
|
+
3. **Responsibility Assignment**: Every stage has a designated owner. Ownership must be documented and acknowledged.
|
|
47
|
+
4. **Continuous Feedback**: Later stages feed improvements back to earlier stages (postmortem -> requirement standards, operations -> architecture).
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## 2. Stage 1: Requirement Discovery
|
|
52
|
+
|
|
53
|
+
### 2.1 Inputs
|
|
54
|
+
|
|
55
|
+
- Business objectives with measurable targets (revenue, efficiency, compliance, etc.).
|
|
56
|
+
- Constraint conditions (budget, timeline, team capacity, technology stack).
|
|
57
|
+
- Target users and their primary contexts.
|
|
58
|
+
- Key success metrics and how they will be measured.
|
|
59
|
+
|
|
60
|
+
### 2.2 Process
|
|
61
|
+
|
|
62
|
+
**Step 1: User Task Decomposition**
|
|
63
|
+
- Identify the primary user roles and their goals.
|
|
64
|
+
- Map each goal to a task flow: trigger -> steps -> outcome.
|
|
65
|
+
- Identify the critical path (the shortest flow to core value).
|
|
66
|
+
- Document alternative paths and edge cases.
|
|
67
|
+
|
|
68
|
+
**Step 2: Non-Functional Requirement Identification**
|
|
69
|
+
- Performance: response time budgets, throughput targets, concurrency limits.
|
|
70
|
+
- Reliability: availability target (e.g., 99.9%), RTO, RPO.
|
|
71
|
+
- Security: data classification, authentication requirements, compliance regulations.
|
|
72
|
+
- Scalability: expected growth trajectory and scaling strategy.
|
|
73
|
+
- Accessibility: WCAG compliance level, supported assistive technologies.
|
|
74
|
+
|
|
75
|
+
**Step 3: Acceptance Criteria Definition**
|
|
76
|
+
- Each requirement must have testable acceptance criteria using Given-When-Then or equivalent format.
|
|
77
|
+
- Acceptance criteria must cover both happy path and failure paths.
|
|
78
|
+
- Non-functional requirements must have measurable thresholds.
|
|
79
|
+
|
|
80
|
+
**Step 4: Risk Identification**
|
|
81
|
+
- Technical risks: unfamiliar technology, integration complexity, performance uncertainty.
|
|
82
|
+
- Business risks: market timing, regulatory changes, dependency on third parties.
|
|
83
|
+
- Each risk must have: likelihood, impact, mitigation plan, and owner.
|
|
84
|
+
|
|
85
|
+
### 2.3 Outputs
|
|
86
|
+
|
|
87
|
+
| Output | Description | Quality Standard |
|
|
88
|
+
|--------|-------------|-----------------|
|
|
89
|
+
| Scope Document | Business goals, user roles, task flows, boundaries | Reviewed by PM, Tech Lead, and stakeholder |
|
|
90
|
+
| Acceptance Criteria | Testable conditions for every requirement | Mapped 1:1 to requirement items |
|
|
91
|
+
| Risk Register | Identified risks with mitigation plans | Each risk has owner and review date |
|
|
92
|
+
|
|
93
|
+
### 2.4 Exit Criteria
|
|
94
|
+
|
|
95
|
+
- [ ] Scope document reviewed and signed off by all stakeholders.
|
|
96
|
+
- [ ] All requirements have testable acceptance criteria.
|
|
97
|
+
- [ ] Risk register contains all identified risks with mitigation plans.
|
|
98
|
+
- [ ] Non-functional requirements have measurable thresholds.
|
|
99
|
+
- [ ] Dependencies on external teams or systems are documented and acknowledged.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## 3. Stage 2: Product & Design Handoff
|
|
104
|
+
|
|
105
|
+
### 3.1 Handoff Checklist
|
|
106
|
+
|
|
107
|
+
The design-to-engineering handoff must include all of the following:
|
|
108
|
+
|
|
109
|
+
**Interaction Completeness**
|
|
110
|
+
- [ ] User flow diagrams cover all primary and exception paths.
|
|
111
|
+
- [ ] Edge cases documented: empty state, error state, loading state, permission-denied state.
|
|
112
|
+
- [ ] State transitions defined with trigger conditions.
|
|
113
|
+
- [ ] Responsive behavior specified for all target breakpoints.
|
|
114
|
+
|
|
115
|
+
**Visual Completeness**
|
|
116
|
+
- [ ] Visual designs cover all states: default, hover, focus, active, disabled, error, empty, loading, success.
|
|
117
|
+
- [ ] Dark mode / theme variants included if applicable.
|
|
118
|
+
- [ ] Component-to-token mapping documented (which token drives which visual property).
|
|
119
|
+
|
|
120
|
+
**Content & Tracking**
|
|
121
|
+
- [ ] All UI copy finalized and reviewed.
|
|
122
|
+
- [ ] Analytics event plan defined (event name, properties, trigger condition).
|
|
123
|
+
- [ ] Permission rules documented (who sees what, conditional visibility).
|
|
124
|
+
|
|
125
|
+
**Engineering Alignment**
|
|
126
|
+
- [ ] Component reuse identified (which existing components to use, which to create).
|
|
127
|
+
- [ ] Token references verified (all visual values trace to design tokens).
|
|
128
|
+
- [ ] Design acceptance criteria defined and testable.
|
|
129
|
+
- [ ] Change impact assessment completed (which pages / flows are affected).
|
|
130
|
+
- [ ] Version / release strategy confirmed.
|
|
131
|
+
|
|
132
|
+
### 3.2 Handoff Quality Standard
|
|
133
|
+
|
|
134
|
+
- No design file should be "handed off" without a 30-minute walkthrough with the implementing engineer.
|
|
135
|
+
- Engineer must confirm understanding by restating the critical path and key edge cases.
|
|
136
|
+
- Open questions must be logged and resolved within 24 hours.
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## 4. Stage 3: Architecture Decision Gate
|
|
141
|
+
|
|
142
|
+
### 4.1 Mandatory Review Items
|
|
143
|
+
|
|
144
|
+
Every architecture decision must address these four dimensions:
|
|
145
|
+
|
|
146
|
+
**Scalability & Performance**
|
|
147
|
+
- What is the expected load in 6 months? 12 months?
|
|
148
|
+
- What is the scaling strategy (horizontal, vertical, sharding)?
|
|
149
|
+
- What are the performance budgets (latency P50/P95/P99, throughput)?
|
|
150
|
+
- Where are the bottleneck risks and what are the mitigations?
|
|
151
|
+
|
|
152
|
+
**Availability & Disaster Recovery**
|
|
153
|
+
- What is the availability target and corresponding error budget?
|
|
154
|
+
- What is the disaster recovery strategy (active-active, active-passive, cold standby)?
|
|
155
|
+
- What are the RTO and RPO targets?
|
|
156
|
+
- How is data replicated and what is the consistency model?
|
|
157
|
+
|
|
158
|
+
**Security & Access Control**
|
|
159
|
+
- What is the authentication mechanism?
|
|
160
|
+
- What is the authorization model (RBAC, ABAC, policy-based)?
|
|
161
|
+
- How are secrets managed?
|
|
162
|
+
- What data needs encryption at rest and in transit?
|
|
163
|
+
|
|
164
|
+
**Observability & Alerting**
|
|
165
|
+
- What metrics, logs, and traces are collected?
|
|
166
|
+
- What are the key SLIs and SLOs?
|
|
167
|
+
- What is the alerting hierarchy (P0 -> immediate page, P1 -> 15 min, P2 -> next business day)?
|
|
168
|
+
- What dashboards are required?
|
|
169
|
+
|
|
170
|
+
### 4.2 Decision Artifacts
|
|
171
|
+
|
|
172
|
+
Every architecture decision must produce:
|
|
173
|
+
|
|
174
|
+
| Artifact | Content | Retention |
|
|
175
|
+
|----------|---------|-----------|
|
|
176
|
+
| ADR (Architecture Decision Record) | Context, options considered, decision rationale, consequences | Permanent (version controlled) |
|
|
177
|
+
| Trade-off Analysis | Comparison matrix with weighted criteria | Attached to ADR |
|
|
178
|
+
| Rollback / Migration Plan | Steps to revert or migrate if the decision proves wrong | Attached to ADR |
|
|
179
|
+
| Dependency Map | Upstream and downstream system dependencies | Updated per release |
|
|
180
|
+
|
|
181
|
+
### 4.3 Exit Criteria
|
|
182
|
+
|
|
183
|
+
- [ ] ADR written, reviewed by architecture review board, and merged.
|
|
184
|
+
- [ ] Scalability plan documented with growth projections.
|
|
185
|
+
- [ ] Rollback plan documented and feasible.
|
|
186
|
+
- [ ] Security model reviewed by security team.
|
|
187
|
+
- [ ] Observability plan reviewed by operations team.
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## 5. Stage 4: Implementation Execution
|
|
192
|
+
|
|
193
|
+
### 5.1 Execution Rules
|
|
194
|
+
|
|
195
|
+
**Task Management**
|
|
196
|
+
- Tasks must be decomposed to 1-3 day units, each with a clear definition of done.
|
|
197
|
+
- Branch strategy must be documented and traceable (branch name maps to task/ticket ID).
|
|
198
|
+
- Work-in-progress (WIP) limits must be enforced (max 2 active tasks per developer).
|
|
199
|
+
|
|
200
|
+
**Code Quality**
|
|
201
|
+
- All production code must be covered by automated tests before merge.
|
|
202
|
+
- Main branch code must always be in a shippable state.
|
|
203
|
+
- Static analysis (lint, type check) must pass before PR review.
|
|
204
|
+
|
|
205
|
+
**Pull Request Standards**
|
|
206
|
+
- Every PR must include:
|
|
207
|
+
- Link to the requirement / task.
|
|
208
|
+
- Summary of what changed and why.
|
|
209
|
+
- Test evidence (screenshots, test output, or coverage report).
|
|
210
|
+
- Risk assessment (what could go wrong, what was tested).
|
|
211
|
+
- Rollback instructions if the change needs to be reverted.
|
|
212
|
+
|
|
213
|
+
### 5.2 Quality Actions
|
|
214
|
+
|
|
215
|
+
| Action | Timing | Gate |
|
|
216
|
+
|--------|--------|------|
|
|
217
|
+
| Static analysis (lint + type check) | Pre-commit / CI | Must pass |
|
|
218
|
+
| Unit tests | Pre-commit / CI | Must pass, coverage >= threshold |
|
|
219
|
+
| Integration tests | CI | Must pass for affected modules |
|
|
220
|
+
| Code review | Before merge | At least 1 approval from qualified reviewer |
|
|
221
|
+
| Regression test | Before release | All regression suites pass |
|
|
222
|
+
| Security scan | CI | No critical / high vulnerabilities |
|
|
223
|
+
|
|
224
|
+
### 5.3 Critical Logic Requirements
|
|
225
|
+
|
|
226
|
+
- Business-critical logic (payment, authorization, data mutation) must have:
|
|
227
|
+
- Dedicated regression test cases covering success, failure, and edge paths.
|
|
228
|
+
- Explicit error handling with recovery or compensation.
|
|
229
|
+
- Audit logging for all state changes.
|
|
230
|
+
- Code review by a senior engineer or domain expert.
|
|
231
|
+
|
|
232
|
+
### 5.4 Exit Criteria
|
|
233
|
+
|
|
234
|
+
- [ ] All task code merged to main branch.
|
|
235
|
+
- [ ] All automated tests pass (unit, integration, regression).
|
|
236
|
+
- [ ] PR reviews completed with all comments resolved.
|
|
237
|
+
- [ ] Static analysis and security scan pass.
|
|
238
|
+
- [ ] Test evidence archived as build artifacts.
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## 6. Stage 5: Testing & Verification Gate
|
|
243
|
+
|
|
244
|
+
### 6.1 Coverage Scope
|
|
245
|
+
|
|
246
|
+
Testing must cover five dimensions:
|
|
247
|
+
|
|
248
|
+
| Dimension | Focus | Minimum Requirement |
|
|
249
|
+
|-----------|-------|-------------------|
|
|
250
|
+
| Functional | Feature correctness per acceptance criteria | All acceptance criteria have corresponding test cases |
|
|
251
|
+
| Regression | No existing functionality broken | Full regression suite pass |
|
|
252
|
+
| Performance | Meets latency, throughput, and resource budgets | Load test at 2x expected peak |
|
|
253
|
+
| Security | No exploitable vulnerabilities | DAST/SAST scan pass, penetration test for critical flows |
|
|
254
|
+
| Compatibility | Works on target platforms / browsers / devices | Matrix verification for top 80% user agents |
|
|
255
|
+
|
|
256
|
+
### 6.2 Test Path Coverage
|
|
257
|
+
|
|
258
|
+
- Every critical user flow must have test cases covering:
|
|
259
|
+
- Success path (happy path).
|
|
260
|
+
- Failure path (invalid input, network error, timeout).
|
|
261
|
+
- Edge path (boundary values, concurrent access, resource exhaustion).
|
|
262
|
+
|
|
263
|
+
### 6.3 Exit Criteria
|
|
264
|
+
|
|
265
|
+
- [ ] Zero blocking (P0) defects open.
|
|
266
|
+
- [ ] High-risk test cases: 100% pass rate.
|
|
267
|
+
- [ ] Smoke test suite: 100% pass.
|
|
268
|
+
- [ ] Regression test suite: 100% pass.
|
|
269
|
+
- [ ] Performance test results within budget.
|
|
270
|
+
- [ ] Staged verification (if applicable): canary / gray release verification pass.
|
|
271
|
+
- [ ] Test report generated and archived.
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
## 7. Stage 6: Security & Compliance Gate
|
|
276
|
+
|
|
277
|
+
### 7.1 Mandatory Checks
|
|
278
|
+
|
|
279
|
+
| Check Area | Requirement | Evidence |
|
|
280
|
+
|-----------|-------------|---------|
|
|
281
|
+
| Data Classification | All data fields classified (public, internal, confidential, restricted) | Classification matrix document |
|
|
282
|
+
| Data Protection | Confidential/restricted data encrypted at rest and in transit | Encryption configuration verification |
|
|
283
|
+
| Masking / Tokenization | PII masked in logs, test environments, and non-production displays | Log sampling verification |
|
|
284
|
+
| Permission Model | Least-privilege principle enforced; no excessive permissions | Permission audit report |
|
|
285
|
+
| Audit Logging | All state-changing operations logged with immutable trail | Audit log completeness check |
|
|
286
|
+
| Dependency Security | No known critical/high CVEs in production dependencies | Dependency scan report (Trivy, npm audit, etc.) |
|
|
287
|
+
| Compliance Mapping | Applicable regulations mapped to technical controls | Compliance matrix with evidence links |
|
|
288
|
+
|
|
289
|
+
### 7.2 Exit Criteria
|
|
290
|
+
|
|
291
|
+
- [ ] Zero critical (CVSS >= 9.0) vulnerabilities.
|
|
292
|
+
- [ ] Zero high (CVSS >= 7.0) vulnerabilities without approved mitigation plan.
|
|
293
|
+
- [ ] All mitigation plans have owner and deadline (max 30 days for high).
|
|
294
|
+
- [ ] Permission audit completed and signed off.
|
|
295
|
+
- [ ] Compliance mapping reviewed by legal / compliance team.
|
|
296
|
+
- [ ] Security scan report archived as release artifact.
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
## 8. Stage 7: Release & Change Management
|
|
301
|
+
|
|
302
|
+
### 8.1 Release Strategy
|
|
303
|
+
|
|
304
|
+
**Principles**
|
|
305
|
+
- Small batches, frequent releases, with gradual rollout.
|
|
306
|
+
- Every release must have a rollback plan that can execute in < 15 minutes.
|
|
307
|
+
- Critical feature flags must support instant kill-switch.
|
|
308
|
+
|
|
309
|
+
**Rollout Pattern**
|
|
310
|
+
1. Canary: 1-2% of traffic for initial validation (minimum 1 hour).
|
|
311
|
+
2. Early adopter: 5-10% for broader signal (minimum 4 hours).
|
|
312
|
+
3. Partial: 25-50% for confidence building (minimum 24 hours).
|
|
313
|
+
4. Full: 100% with enhanced monitoring for 48 hours.
|
|
314
|
+
|
|
315
|
+
### 8.2 Change Control
|
|
316
|
+
|
|
317
|
+
- Every production change must have a change ticket containing:
|
|
318
|
+
- Change description and business justification.
|
|
319
|
+
- Impact assessment (systems, users, data).
|
|
320
|
+
- Rollback procedure with step-by-step instructions.
|
|
321
|
+
- Approval from change manager and tech lead.
|
|
322
|
+
- Release windows must have:
|
|
323
|
+
- On-call engineer assigned.
|
|
324
|
+
- Emergency communication channel established.
|
|
325
|
+
- Escalation path documented.
|
|
326
|
+
|
|
327
|
+
### 8.3 Post-Release Verification
|
|
328
|
+
|
|
329
|
+
- Within 30 minutes of full rollout:
|
|
330
|
+
- [ ] Core business metrics stable (within +/- 5% of baseline).
|
|
331
|
+
- [ ] Error rates within normal bounds.
|
|
332
|
+
- [ ] No new alerts triggered.
|
|
333
|
+
- [ ] Latency P95/P99 within budget.
|
|
334
|
+
- Enhanced monitoring period: 48 hours with lowered alert thresholds.
|
|
335
|
+
|
|
336
|
+
### 8.4 Exit Criteria
|
|
337
|
+
|
|
338
|
+
- [ ] Change ticket approved and linked to release.
|
|
339
|
+
- [ ] Staged rollout completed per pattern.
|
|
340
|
+
- [ ] Post-release verification passed.
|
|
341
|
+
- [ ] Rollback plan verified (tested in staging or documented from previous rollback).
|
|
342
|
+
- [ ] Release record archived with rollout timeline and verification results.
|
|
343
|
+
|
|
344
|
+
---
|
|
345
|
+
|
|
346
|
+
## 9. Stage 8: Operations & Observability
|
|
347
|
+
|
|
348
|
+
### 9.1 Observability Stack
|
|
349
|
+
|
|
350
|
+
Three pillars of observability must be implemented:
|
|
351
|
+
|
|
352
|
+
| Pillar | Purpose | Implementation |
|
|
353
|
+
|--------|---------|---------------|
|
|
354
|
+
| Metrics | Quantitative measurement of system health | Prometheus / CloudWatch / Datadog with SLI definitions |
|
|
355
|
+
| Logs | Detailed event records for debugging | Structured JSON logs with correlation IDs, shipped to central log system |
|
|
356
|
+
| Traces | Request flow across services | Distributed tracing (OpenTelemetry / Jaeger / X-Ray) |
|
|
357
|
+
|
|
358
|
+
### 9.2 SLO & Error Budget
|
|
359
|
+
|
|
360
|
+
- Define SLOs for each critical service:
|
|
361
|
+
- Availability: e.g., 99.95% measured over 30-day rolling window.
|
|
362
|
+
- Latency: e.g., P99 < 500ms for API endpoints.
|
|
363
|
+
- Error rate: e.g., < 0.1% 5xx responses.
|
|
364
|
+
- Error budget = 100% - SLO target. When error budget is exhausted:
|
|
365
|
+
- Freeze non-critical deployments.
|
|
366
|
+
- Prioritize reliability work until budget recovers.
|
|
367
|
+
|
|
368
|
+
### 9.3 Alerting Strategy
|
|
369
|
+
|
|
370
|
+
| Severity | Response Time | Channel | Example |
|
|
371
|
+
|----------|--------------|---------|---------|
|
|
372
|
+
| P0 - Critical | Immediate (< 5 min) | Phone + PagerDuty | Service down, data loss, security breach |
|
|
373
|
+
| P1 - High | < 15 min | Slack + PagerDuty | Degraded performance, elevated error rate |
|
|
374
|
+
| P2 - Medium | < 4 hours | Slack alert channel | Non-critical feature failure, approaching capacity |
|
|
375
|
+
| P3 - Low | Next business day | Email / ticket | Cosmetic issue, minor log anomaly |
|
|
376
|
+
|
|
377
|
+
Rules:
|
|
378
|
+
- Alert on symptoms (user-facing impact), not causes.
|
|
379
|
+
- Every alert must have a runbook link.
|
|
380
|
+
- Alert fatigue review: monthly audit of alert volume and signal-to-noise ratio.
|
|
381
|
+
|
|
382
|
+
### 9.4 Runbook Standards
|
|
383
|
+
|
|
384
|
+
Every production service must have a runbook containing:
|
|
385
|
+
- Service overview: purpose, dependencies, SLOs.
|
|
386
|
+
- Health check endpoints and expected responses.
|
|
387
|
+
- Common failure modes and resolution steps.
|
|
388
|
+
- Scaling procedures (manual and automated).
|
|
389
|
+
- Restart / recovery procedures.
|
|
390
|
+
- Contact list and escalation path.
|
|
391
|
+
|
|
392
|
+
### 9.5 Post-Change Observation
|
|
393
|
+
|
|
394
|
+
- After any production change, enhanced observation for 24 hours:
|
|
395
|
+
- Lower alert thresholds by 20%.
|
|
396
|
+
- Monitor new-code-path metrics specifically.
|
|
397
|
+
- On-call engineer must acknowledge the change and confirm observation setup.
|
|
398
|
+
|
|
399
|
+
### 9.6 Exit Criteria
|
|
400
|
+
|
|
401
|
+
- [ ] SLO dashboard operational for all critical services.
|
|
402
|
+
- [ ] Alert policies configured and tested.
|
|
403
|
+
- [ ] Runbooks documented for all production services.
|
|
404
|
+
- [ ] On-call rotation established and acknowledged.
|
|
405
|
+
- [ ] Log and trace retention meets compliance requirements.
|
|
406
|
+
|
|
407
|
+
---
|
|
408
|
+
|
|
409
|
+
## 10. Stage 9: Incident Postmortem & Learning Loop
|
|
410
|
+
|
|
411
|
+
### 10.1 Postmortem Structure
|
|
412
|
+
|
|
413
|
+
Every significant incident (P0 or P1) must produce a postmortem within 5 business days:
|
|
414
|
+
|
|
415
|
+
**Section 1: Event Timeline**
|
|
416
|
+
- Detection time and method (alert, user report, monitoring).
|
|
417
|
+
- First response time and responder.
|
|
418
|
+
- Key decision points during incident.
|
|
419
|
+
- Resolution time and method.
|
|
420
|
+
- Communication timeline (internal and external).
|
|
421
|
+
|
|
422
|
+
**Section 2: Impact Assessment**
|
|
423
|
+
- User impact: number of affected users, duration, severity.
|
|
424
|
+
- Business impact: revenue loss, SLA breach, reputation damage.
|
|
425
|
+
- Data impact: any data loss or corruption.
|
|
426
|
+
|
|
427
|
+
**Section 3: Root Cause Chain**
|
|
428
|
+
- Direct cause: the specific failure that triggered the incident.
|
|
429
|
+
- Contributing causes: conditions that allowed the direct cause to have impact.
|
|
430
|
+
- Systemic cause: organizational or process gaps that created the contributing conditions.
|
|
431
|
+
|
|
432
|
+
### 10.2 Action Items
|
|
433
|
+
|
|
434
|
+
Every postmortem must produce categorized action items:
|
|
435
|
+
|
|
436
|
+
| Category | Timeline | Example |
|
|
437
|
+
|----------|----------|---------|
|
|
438
|
+
| Immediate Fix | 1-3 days | Patch the specific bug, restore data |
|
|
439
|
+
| Short-term Prevention | 1-2 weeks | Add monitoring, improve alert, add test case |
|
|
440
|
+
| Long-term Prevention | 1-3 months | Architecture improvement, process change, training |
|
|
441
|
+
|
|
442
|
+
Rules:
|
|
443
|
+
- Every action item has an owner and a deadline.
|
|
444
|
+
- Prevention items should be fed back into standards or gate rules (e.g., a new checklist item, a new anti-pattern entry).
|
|
445
|
+
- Action items are tracked in the issue system and reviewed weekly until closed.
|
|
446
|
+
|
|
447
|
+
### 10.3 Learning Loop
|
|
448
|
+
|
|
449
|
+
- Monthly: review incident trends (frequency, severity, category, MTTR).
|
|
450
|
+
- Quarterly: aggregate learnings into knowledge base updates.
|
|
451
|
+
- Annually: review systemic patterns and invest in structural improvements.
|
|
452
|
+
- Blameless culture: focus on systems and processes, not individuals.
|
|
453
|
+
|
|
454
|
+
### 10.4 Exit Criteria
|
|
455
|
+
|
|
456
|
+
- [ ] Postmortem document completed within 5 business days.
|
|
457
|
+
- [ ] All action items logged with owner and deadline.
|
|
458
|
+
- [ ] Prevention items mapped to standards, gates, or checklists.
|
|
459
|
+
- [ ] Monthly trend review conducted.
|
|
460
|
+
- [ ] Quarterly knowledge base update completed.
|
|
461
|
+
|
|
462
|
+
---
|
|
463
|
+
|
|
464
|
+
## 11. Stage Exit Criteria Summary (YAML Reference)
|
|
465
|
+
|
|
466
|
+
```yaml
|
|
467
|
+
stage_exit_criteria:
|
|
468
|
+
requirement:
|
|
469
|
+
required_outputs: [scope_doc, acceptance_criteria, risk_register]
|
|
470
|
+
gate_owner: Product Manager
|
|
471
|
+
design:
|
|
472
|
+
required_outputs: [user_flow, ui_states, tracking_plan]
|
|
473
|
+
gate_owner: Design Lead
|
|
474
|
+
architecture:
|
|
475
|
+
required_outputs: [adr, scalability_plan, rollback_plan]
|
|
476
|
+
gate_owner: Tech Lead / Architect
|
|
477
|
+
implementation:
|
|
478
|
+
required_outputs: [merged_code, test_evidence, pr_review]
|
|
479
|
+
gate_owner: Tech Lead
|
|
480
|
+
testing:
|
|
481
|
+
required_outputs: [regression_report, performance_result, bug_closure]
|
|
482
|
+
gate_owner: QA Lead
|
|
483
|
+
security:
|
|
484
|
+
required_outputs: [vulnerability_scan, permission_audit, compliance_check]
|
|
485
|
+
gate_owner: Security Engineer
|
|
486
|
+
release:
|
|
487
|
+
required_outputs: [change_ticket, rollout_record, verification_result]
|
|
488
|
+
gate_owner: Release Manager
|
|
489
|
+
operations:
|
|
490
|
+
required_outputs: [slo_dashboard, alert_policy, runbook]
|
|
491
|
+
gate_owner: SRE / DevOps Lead
|
|
492
|
+
incident_learning:
|
|
493
|
+
required_outputs: [postmortem, action_items, prevention_updates]
|
|
494
|
+
gate_owner: Incident Commander
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
---
|
|
498
|
+
|
|
499
|
+
## Agent Checklist
|
|
500
|
+
|
|
501
|
+
- [ ] Verify current lifecycle stage and confirm all prior stage exit criteria are met.
|
|
502
|
+
- [ ] For requirement stage: confirm scope doc, acceptance criteria, and risk register exist.
|
|
503
|
+
- [ ] For design handoff: walk through the handoff checklist with the implementing engineer.
|
|
504
|
+
- [ ] For architecture: verify ADR exists with scalability plan, rollback plan, and security review.
|
|
505
|
+
- [ ] For implementation: verify PR standards (link, summary, test evidence, risk, rollback).
|
|
506
|
+
- [ ] For testing: verify zero blocking defects and 100% high-risk test pass rate.
|
|
507
|
+
- [ ] For security: verify zero critical vulnerabilities and compliance mapping complete.
|
|
508
|
+
- [ ] For release: verify change ticket, staged rollout, and post-release verification.
|
|
509
|
+
- [ ] For operations: verify SLO dashboard, alert policies, and runbooks are in place.
|
|
510
|
+
- [ ] For postmortem: verify action items are logged, owned, and tracked to closure.
|
|
511
|
+
- [ ] Cross-reference stage exit criteria YAML when validating gate passage.
|