@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,791 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: project-templates-collection
|
|
3
|
+
title: Project Templates Collection - Comprehensive Lifecycle Templates
|
|
4
|
+
domain: development
|
|
5
|
+
category: 15-lifecycle-templates
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [architecture, catalog, collection, design, development, handoff, project, requirement]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# Project Templates Collection - Comprehensive Lifecycle Templates
|
|
12
|
+
|
|
13
|
+
> Consolidated collection of all lifecycle stage templates: requirement, design handoff, architecture ADR, implementation PR, testing report, security compliance, release change, operations runbook, postmortem, and lifecycle review board. Each template is ready-to-use with structured sections and guidance notes.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Template Catalog
|
|
18
|
+
|
|
19
|
+
| ID | Template | Lifecycle Stage | Purpose |
|
|
20
|
+
|----|----------|----------------|---------|
|
|
21
|
+
| T-01 | Requirement Template | Requirement Discovery | Capture business goals, user scenarios, acceptance criteria, and risks |
|
|
22
|
+
| T-02 | Design Handoff Template | Product & Design | Ensure complete design-to-engineering transfer |
|
|
23
|
+
| T-03 | Architecture ADR Template | Architecture Decision | Record architecture decisions with context and trade-offs |
|
|
24
|
+
| T-04 | Implementation PR Template | Implementation Execution | Standardize pull request content for quality review |
|
|
25
|
+
| T-05 | Testing Report Template | Testing & Verification | Document test coverage, results, and release recommendation |
|
|
26
|
+
| T-06 | Security Compliance Template | Security & Compliance | Record security assessment and compliance status |
|
|
27
|
+
| T-07 | Release Change Template | Release & Change Management | Document release plan, rollout strategy, and verification |
|
|
28
|
+
| T-08 | Operations Runbook Template | Operations & Observability | Provide operational reference for production services |
|
|
29
|
+
| T-09 | Postmortem Template | Incident Learning | Structure incident review and improvement actions |
|
|
30
|
+
| T-10 | Lifecycle Review Board Template | Cross-Stage Governance | Track overall project progress across all lifecycle stages |
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## T-01: Requirement Template
|
|
35
|
+
|
|
36
|
+
### Document Header
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
Project: [Project Name]
|
|
40
|
+
Version: [Document Version]
|
|
41
|
+
Author: [Author Name]
|
|
42
|
+
Date: [YYYY-MM-DD]
|
|
43
|
+
Status: [Draft | Review | Approved]
|
|
44
|
+
Stakeholders: [List of stakeholders]
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 1. Business Objective
|
|
48
|
+
|
|
49
|
+
**Primary Goal**
|
|
50
|
+
- Describe the business outcome this requirement serves.
|
|
51
|
+
- Include measurable target: [Metric] from [Current] to [Target] by [Date].
|
|
52
|
+
|
|
53
|
+
**Business Context**
|
|
54
|
+
- Why now? What market condition, user feedback, or strategic priority drives this?
|
|
55
|
+
- What is the cost of not doing this?
|
|
56
|
+
|
|
57
|
+
**Success Metrics**
|
|
58
|
+
| Metric | Current Baseline | Target | Measurement Method |
|
|
59
|
+
|--------|-----------------|--------|-------------------|
|
|
60
|
+
| [e.g., Conversion Rate] | [e.g., 3.2%] | [e.g., 5.0%] | [e.g., Analytics funnel] |
|
|
61
|
+
|
|
62
|
+
**Business Boundary**
|
|
63
|
+
- What is explicitly out of scope?
|
|
64
|
+
- What constraints exist (budget, timeline, technical, legal)?
|
|
65
|
+
|
|
66
|
+
### 2. User Scenarios
|
|
67
|
+
|
|
68
|
+
**Target Users**
|
|
69
|
+
| User Role | Description | Primary Goal | Frequency |
|
|
70
|
+
|-----------|-------------|-------------|-----------|
|
|
71
|
+
| [e.g., Admin] | [Description] | [Goal] | [Daily/Weekly] |
|
|
72
|
+
|
|
73
|
+
**Primary Path (Happy Path)**
|
|
74
|
+
```
|
|
75
|
+
Trigger: [What initiates the flow]
|
|
76
|
+
Step 1: [User action] -> [System response]
|
|
77
|
+
Step 2: [User action] -> [System response]
|
|
78
|
+
...
|
|
79
|
+
Outcome: [Expected end state]
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Alternative Paths**
|
|
83
|
+
- Path A: [Description of alternative flow and when it applies]
|
|
84
|
+
- Path B: [Description of alternative flow and when it applies]
|
|
85
|
+
|
|
86
|
+
**Exception Paths**
|
|
87
|
+
- Exception 1: [Error condition] -> [Expected system behavior] -> [User recovery path]
|
|
88
|
+
- Exception 2: [Error condition] -> [Expected system behavior] -> [User recovery path]
|
|
89
|
+
|
|
90
|
+
### 3. Acceptance Criteria
|
|
91
|
+
|
|
92
|
+
| ID | Scenario | Given | When | Then | Priority |
|
|
93
|
+
|----|----------|-------|------|------|----------|
|
|
94
|
+
| AC-01 | [Scenario name] | [Precondition] | [Action] | [Expected result] | MUST |
|
|
95
|
+
| AC-02 | [Scenario name] | [Precondition] | [Action] | [Expected result] | MUST |
|
|
96
|
+
| AC-03 | [Scenario name] | [Precondition] | [Action] | [Expected result] | SHOULD |
|
|
97
|
+
|
|
98
|
+
**Non-Functional Acceptance Criteria**
|
|
99
|
+
| Category | Requirement | Threshold | Measurement |
|
|
100
|
+
|----------|-------------|-----------|-------------|
|
|
101
|
+
| Performance | Page load time | < 2s P95 | Lighthouse / RUM |
|
|
102
|
+
| Availability | Uptime | 99.9% | Monitoring system |
|
|
103
|
+
| Accessibility | WCAG compliance | Level AA | axe-core scan |
|
|
104
|
+
| Security | Vulnerability scan | Zero critical/high | SAST/DAST |
|
|
105
|
+
|
|
106
|
+
### 4. Risk Register
|
|
107
|
+
|
|
108
|
+
| ID | Risk | Likelihood | Impact | Mitigation | Owner | Review Date |
|
|
109
|
+
|----|------|-----------|--------|------------|-------|-------------|
|
|
110
|
+
| R-01 | [Risk description] | [H/M/L] | [H/M/L] | [Mitigation plan] | [Name] | [Date] |
|
|
111
|
+
|
|
112
|
+
**Dependencies**
|
|
113
|
+
| Dependency | Type | Owner | Status | Risk if Delayed |
|
|
114
|
+
|-----------|------|-------|--------|----------------|
|
|
115
|
+
| [External API] | External | [Team] | [Confirmed] | [Impact description] |
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## T-02: Design Handoff Template
|
|
120
|
+
|
|
121
|
+
### Document Header
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
Feature: [Feature Name]
|
|
125
|
+
Designer: [Designer Name]
|
|
126
|
+
Engineer: [Assigned Engineer]
|
|
127
|
+
Date: [YYYY-MM-DD]
|
|
128
|
+
Design File: [Link to Figma/Sketch/etc.]
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### 1. Interaction Scope
|
|
132
|
+
|
|
133
|
+
**Page / Screen List**
|
|
134
|
+
| Page | New / Modified | Complexity | Notes |
|
|
135
|
+
|------|---------------|------------|-------|
|
|
136
|
+
| [Page name] | [New] | [High/Med/Low] | [Special considerations] |
|
|
137
|
+
|
|
138
|
+
**State Coverage Matrix**
|
|
139
|
+
| Page / Component | Default | Hover | Focus | Active | Disabled | Loading | Error | Empty | Success |
|
|
140
|
+
|-----------------|---------|-------|-------|--------|----------|---------|-------|-------|---------|
|
|
141
|
+
| [Component A] | Y | Y | Y | Y | Y | Y | Y | N/A | Y |
|
|
142
|
+
|
|
143
|
+
**Flow Diagram Reference**
|
|
144
|
+
- Primary flow: [Link or description]
|
|
145
|
+
- Exception flows: [Link or description]
|
|
146
|
+
|
|
147
|
+
### 2. Visual Specification
|
|
148
|
+
|
|
149
|
+
**Component & Token Mapping**
|
|
150
|
+
| Component | Token Reference | Custom Styling | Notes |
|
|
151
|
+
|-----------|----------------|---------------|-------|
|
|
152
|
+
| [Button CTA] | `button-primary` | None | Standard token |
|
|
153
|
+
| [Status Badge] | `badge-success` | Custom radius | See design note |
|
|
154
|
+
|
|
155
|
+
**Responsive Breakpoints**
|
|
156
|
+
| Breakpoint | Width | Layout Change |
|
|
157
|
+
|-----------|-------|---------------|
|
|
158
|
+
| Desktop | >= 1280px | Full layout |
|
|
159
|
+
| Tablet | 768-1279px | Collapsed sidebar |
|
|
160
|
+
| Mobile | < 768px | Single column, bottom nav |
|
|
161
|
+
|
|
162
|
+
**Animation / Motion**
|
|
163
|
+
| Interaction | Animation | Duration | Easing |
|
|
164
|
+
|-------------|-----------|----------|--------|
|
|
165
|
+
| [Modal open] | [Fade + scale] | [200ms] | [ease-out] |
|
|
166
|
+
|
|
167
|
+
### 3. Engineering Alignment
|
|
168
|
+
|
|
169
|
+
**Analytics Event Plan**
|
|
170
|
+
| Event Name | Trigger | Properties | Priority |
|
|
171
|
+
|-----------|---------|------------|----------|
|
|
172
|
+
| [feature_viewed] | [Page load] | [page_id, user_role] | [MUST] |
|
|
173
|
+
|
|
174
|
+
**Permission Rules**
|
|
175
|
+
| Element | Visibility Condition | Behavior When Hidden |
|
|
176
|
+
|---------|---------------------|---------------------|
|
|
177
|
+
| [Admin panel] | [role == admin] | [Not rendered] |
|
|
178
|
+
|
|
179
|
+
**Handoff Acceptance Criteria**
|
|
180
|
+
- [ ] All states implemented per state coverage matrix.
|
|
181
|
+
- [ ] Responsive behavior verified at all breakpoints.
|
|
182
|
+
- [ ] Token usage verified (no hardcoded values).
|
|
183
|
+
- [ ] Analytics events firing correctly.
|
|
184
|
+
- [ ] Accessibility: keyboard navigation and screen reader verified.
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## T-03: Architecture ADR Template
|
|
189
|
+
|
|
190
|
+
### Document Header
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
ADR-[Number]: [Decision Title]
|
|
194
|
+
Date: [YYYY-MM-DD]
|
|
195
|
+
Status: [Proposed | Accepted | Superseded | Deprecated]
|
|
196
|
+
Deciders: [List of decision makers]
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### 1. Decision Context
|
|
200
|
+
|
|
201
|
+
**Problem Statement**
|
|
202
|
+
- What problem are we trying to solve?
|
|
203
|
+
- What are the current pain points or limitations?
|
|
204
|
+
|
|
205
|
+
**Constraints**
|
|
206
|
+
- Technical: [Technology constraints, compatibility requirements]
|
|
207
|
+
- Business: [Budget, timeline, team skill constraints]
|
|
208
|
+
- Compliance: [Regulatory or security constraints]
|
|
209
|
+
|
|
210
|
+
**Assumptions**
|
|
211
|
+
- [Assumption 1 and its basis]
|
|
212
|
+
- [Assumption 2 and its basis]
|
|
213
|
+
|
|
214
|
+
### 2. Options Considered
|
|
215
|
+
|
|
216
|
+
**Option A: [Name]**
|
|
217
|
+
| Dimension | Assessment |
|
|
218
|
+
|-----------|-----------|
|
|
219
|
+
| Description | [How it works] |
|
|
220
|
+
| Pros | [Advantages] |
|
|
221
|
+
| Cons | [Disadvantages] |
|
|
222
|
+
| Cost | [Implementation and operational cost] |
|
|
223
|
+
| Risk | [Key risks] |
|
|
224
|
+
| Timeline | [Estimated implementation time] |
|
|
225
|
+
|
|
226
|
+
**Option B: [Name]**
|
|
227
|
+
| Dimension | Assessment |
|
|
228
|
+
|-----------|-----------|
|
|
229
|
+
| Description | [How it works] |
|
|
230
|
+
| Pros | [Advantages] |
|
|
231
|
+
| Cons | [Disadvantages] |
|
|
232
|
+
| Cost | [Implementation and operational cost] |
|
|
233
|
+
| Risk | [Key risks] |
|
|
234
|
+
| Timeline | [Estimated implementation time] |
|
|
235
|
+
|
|
236
|
+
**Comparison Matrix**
|
|
237
|
+
| Criteria | Weight | Option A | Option B |
|
|
238
|
+
|----------|--------|----------|----------|
|
|
239
|
+
| [Scalability] | [30%] | [Score] | [Score] |
|
|
240
|
+
| [Maintainability] | [25%] | [Score] | [Score] |
|
|
241
|
+
| [Performance] | [20%] | [Score] | [Score] |
|
|
242
|
+
| [Cost] | [15%] | [Score] | [Score] |
|
|
243
|
+
| [Time to implement] | [10%] | [Score] | [Score] |
|
|
244
|
+
| **Weighted Total** | **100%** | **[Total]** | **[Total]** |
|
|
245
|
+
|
|
246
|
+
### 3. Decision
|
|
247
|
+
|
|
248
|
+
**Chosen Option**: [Option Name]
|
|
249
|
+
|
|
250
|
+
**Rationale**: [1-3 sentences explaining why this option was selected]
|
|
251
|
+
|
|
252
|
+
**Trade-offs Accepted**: [What we are giving up and why it is acceptable]
|
|
253
|
+
|
|
254
|
+
### 4. Consequences
|
|
255
|
+
|
|
256
|
+
**Positive**
|
|
257
|
+
- [Expected benefit 1]
|
|
258
|
+
- [Expected benefit 2]
|
|
259
|
+
|
|
260
|
+
**Negative**
|
|
261
|
+
- [Known limitation 1 and how we will manage it]
|
|
262
|
+
- [Known limitation 2 and how we will manage it]
|
|
263
|
+
|
|
264
|
+
### 5. Risk & Rollback
|
|
265
|
+
|
|
266
|
+
**Risk Assessment**
|
|
267
|
+
| Risk | Likelihood | Impact | Mitigation |
|
|
268
|
+
|------|-----------|--------|------------|
|
|
269
|
+
| [Risk 1] | [H/M/L] | [H/M/L] | [Mitigation plan] |
|
|
270
|
+
|
|
271
|
+
**Rollback Plan**
|
|
272
|
+
- Trigger condition: [When would we consider reverting this decision?]
|
|
273
|
+
- Rollback steps: [Step-by-step procedure]
|
|
274
|
+
- Estimated rollback time: [Duration]
|
|
275
|
+
- Data migration (if applicable): [Strategy]
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## T-04: Implementation PR Template
|
|
280
|
+
|
|
281
|
+
### PR Header
|
|
282
|
+
|
|
283
|
+
```
|
|
284
|
+
Title: [Short description of the change]
|
|
285
|
+
Ticket: [Link to requirement/task]
|
|
286
|
+
Type: [Feature | Bugfix | Refactor | Hotfix | Chore]
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### 1. Change Overview
|
|
290
|
+
|
|
291
|
+
**What Changed**
|
|
292
|
+
- [Summary of the change in 2-3 sentences]
|
|
293
|
+
- Affected modules: [List of modules / packages / services]
|
|
294
|
+
|
|
295
|
+
**Why**
|
|
296
|
+
- [Business or technical motivation]
|
|
297
|
+
- [Link to requirement or ADR if applicable]
|
|
298
|
+
|
|
299
|
+
### 2. Quality Evidence
|
|
300
|
+
|
|
301
|
+
**Test Results**
|
|
302
|
+
| Test Type | Status | Coverage | Notes |
|
|
303
|
+
|-----------|--------|----------|-------|
|
|
304
|
+
| Unit tests | [Pass/Fail] | [Coverage %] | [New tests added] |
|
|
305
|
+
| Integration tests | [Pass/Fail] | [N/A or Coverage %] | [Notes] |
|
|
306
|
+
| Manual testing | [Pass/Fail] | [N/A] | [What was tested manually] |
|
|
307
|
+
|
|
308
|
+
**Screenshots / Recordings** (for UI changes)
|
|
309
|
+
| State | Before | After |
|
|
310
|
+
|-------|--------|-------|
|
|
311
|
+
| [Default] | [Screenshot] | [Screenshot] |
|
|
312
|
+
| [Error] | [Screenshot] | [Screenshot] |
|
|
313
|
+
|
|
314
|
+
**Static Analysis**
|
|
315
|
+
- Lint: [Pass/Fail]
|
|
316
|
+
- Type check: [Pass/Fail]
|
|
317
|
+
- Security scan: [Pass/Fail]
|
|
318
|
+
|
|
319
|
+
### 3. Risk Assessment
|
|
320
|
+
|
|
321
|
+
**What Could Go Wrong**
|
|
322
|
+
| Risk | Likelihood | Mitigation |
|
|
323
|
+
|------|-----------|------------|
|
|
324
|
+
| [Risk description] | [H/M/L] | [How it was mitigated or tested] |
|
|
325
|
+
|
|
326
|
+
**Deployment Considerations**
|
|
327
|
+
- Database migration required: [Yes/No]
|
|
328
|
+
- Feature flag: [Flag name or N/A]
|
|
329
|
+
- Backwards compatible: [Yes/No]
|
|
330
|
+
|
|
331
|
+
### 4. Rollback Plan
|
|
332
|
+
|
|
333
|
+
**If this change needs to be reverted:**
|
|
334
|
+
1. [Step 1: e.g., Revert commit or flip feature flag]
|
|
335
|
+
2. [Step 2: e.g., Run migration rollback]
|
|
336
|
+
3. [Step 3: e.g., Verify service health]
|
|
337
|
+
- Estimated rollback time: [Duration]
|
|
338
|
+
|
|
339
|
+
### 5. Reviewer Checklist
|
|
340
|
+
|
|
341
|
+
- [ ] Code follows project style guide and passes lint.
|
|
342
|
+
- [ ] Tests cover the changed logic (happy path + failure path).
|
|
343
|
+
- [ ] PR description is complete (ticket link, change summary, test evidence, risk, rollback).
|
|
344
|
+
- [ ] No hardcoded secrets, credentials, or PII in the code.
|
|
345
|
+
- [ ] Database changes are backwards compatible or migration is documented.
|
|
346
|
+
|
|
347
|
+
---
|
|
348
|
+
|
|
349
|
+
## T-05: Testing Report Template
|
|
350
|
+
|
|
351
|
+
### Report Header
|
|
352
|
+
|
|
353
|
+
```
|
|
354
|
+
Project: [Project Name]
|
|
355
|
+
Release: [Version]
|
|
356
|
+
Test Period: [Start Date] - [End Date]
|
|
357
|
+
Author: [QA Lead Name]
|
|
358
|
+
Status: [In Progress | Complete]
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
### 1. Test Coverage
|
|
362
|
+
|
|
363
|
+
**Functional Test Cases**
|
|
364
|
+
| Module | Total Cases | Passed | Failed | Blocked | Skip | Pass Rate |
|
|
365
|
+
|--------|------------|--------|--------|---------|------|-----------|
|
|
366
|
+
| [Module A] | [N] | [N] | [N] | [N] | [N] | [%] |
|
|
367
|
+
| **Total** | **[N]** | **[N]** | **[N]** | **[N]** | **[N]** | **[%]** |
|
|
368
|
+
|
|
369
|
+
**Regression Test Cases**
|
|
370
|
+
| Suite | Total | Passed | Failed | Pass Rate |
|
|
371
|
+
|-------|-------|--------|--------|-----------|
|
|
372
|
+
| [Core flows] | [N] | [N] | [N] | [%] |
|
|
373
|
+
| **Total** | **[N]** | **[N]** | **[N]** | **[%]** |
|
|
374
|
+
|
|
375
|
+
**Performance Test Cases**
|
|
376
|
+
| Scenario | Metric | Target | Actual | Status |
|
|
377
|
+
|----------|--------|--------|--------|--------|
|
|
378
|
+
| [API response] | P95 latency | < 200ms | [Xms] | [Pass/Fail] |
|
|
379
|
+
| [Page load] | LCP | < 2.5s | [Xs] | [Pass/Fail] |
|
|
380
|
+
|
|
381
|
+
### 2. Defect Summary
|
|
382
|
+
|
|
383
|
+
| Severity | Open | Fixed | Verified | Won't Fix | Total |
|
|
384
|
+
|----------|------|-------|----------|-----------|-------|
|
|
385
|
+
| P0 (Blocker) | [N] | [N] | [N] | [N] | [N] |
|
|
386
|
+
| P1 (Critical) | [N] | [N] | [N] | [N] | [N] |
|
|
387
|
+
| P2 (Major) | [N] | [N] | [N] | [N] | [N] |
|
|
388
|
+
| P3 (Minor) | [N] | [N] | [N] | [N] | [N] |
|
|
389
|
+
|
|
390
|
+
**Open Blockers** (if any)
|
|
391
|
+
| ID | Description | Owner | ETA |
|
|
392
|
+
|----|-------------|-------|-----|
|
|
393
|
+
| [Bug ID] | [Description] | [Name] | [Date] |
|
|
394
|
+
|
|
395
|
+
### 3. Risk Assessment
|
|
396
|
+
|
|
397
|
+
| Risk | Impact | Probability | Mitigation |
|
|
398
|
+
|------|--------|------------|------------|
|
|
399
|
+
| [Identified risk] | [H/M/L] | [H/M/L] | [Mitigation plan] |
|
|
400
|
+
|
|
401
|
+
### 4. Release Recommendation
|
|
402
|
+
|
|
403
|
+
- [ ] **GO**: All criteria met, recommend release.
|
|
404
|
+
- [ ] **CONDITIONAL GO**: Release with known issues and tracking items listed below.
|
|
405
|
+
- [ ] **NO GO**: Blocking issues prevent release.
|
|
406
|
+
|
|
407
|
+
**Conditions (if conditional)**
|
|
408
|
+
| Condition | Owner | Deadline | Tracking |
|
|
409
|
+
|-----------|-------|----------|----------|
|
|
410
|
+
| [Condition] | [Name] | [Date] | [Ticket link] |
|
|
411
|
+
|
|
412
|
+
---
|
|
413
|
+
|
|
414
|
+
## T-06: Security & Compliance Template
|
|
415
|
+
|
|
416
|
+
### Assessment Header
|
|
417
|
+
|
|
418
|
+
```
|
|
419
|
+
Project: [Project Name]
|
|
420
|
+
Version: [Version]
|
|
421
|
+
Assessor: [Security Engineer Name]
|
|
422
|
+
Date: [YYYY-MM-DD]
|
|
423
|
+
Scope: [What was assessed]
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### 1. Risk Surface
|
|
427
|
+
|
|
428
|
+
**Data Security**
|
|
429
|
+
| Data Category | Classification | Protection Measure | Status |
|
|
430
|
+
|--------------|---------------|-------------------|--------|
|
|
431
|
+
| [User PII] | [Confidential] | [AES-256 at rest, TLS 1.3 in transit] | [Verified] |
|
|
432
|
+
| [Payment data] | [Restricted] | [Tokenization + HSM] | [Verified] |
|
|
433
|
+
|
|
434
|
+
**Permission & Audit**
|
|
435
|
+
| Check | Status | Evidence |
|
|
436
|
+
|-------|--------|---------|
|
|
437
|
+
| Least-privilege enforcement | [Pass/Fail] | [Permission audit report link] |
|
|
438
|
+
| Audit log completeness | [Pass/Fail] | [Log sample verification link] |
|
|
439
|
+
| Admin action logging | [Pass/Fail] | [Audit trail verification link] |
|
|
440
|
+
|
|
441
|
+
**Supply Chain Risk**
|
|
442
|
+
| Check | Status | Evidence |
|
|
443
|
+
|-------|--------|---------|
|
|
444
|
+
| Dependency vulnerability scan | [Pass/Fail] | [Trivy/npm audit report link] |
|
|
445
|
+
| License compliance | [Pass/Fail] | [License scan report link] |
|
|
446
|
+
| Container image scan | [Pass/Fail] | [Image scan report link] |
|
|
447
|
+
|
|
448
|
+
### 2. Vulnerability Findings
|
|
449
|
+
|
|
450
|
+
| ID | Severity | Description | CVSS | Status | Remediation | Owner | Deadline |
|
|
451
|
+
|----|----------|-------------|------|--------|-------------|-------|----------|
|
|
452
|
+
| [V-01] | [Critical] | [Description] | [9.1] | [Fixed] | [Fix details] | [Name] | [Date] |
|
|
453
|
+
|
|
454
|
+
### 3. Compliance Mapping
|
|
455
|
+
|
|
456
|
+
| Regulation | Requirement | Technical Control | Evidence | Status |
|
|
457
|
+
|-----------|-------------|------------------|---------|--------|
|
|
458
|
+
| [GDPR Art.25] | [Data protection by design] | [Encryption, access control] | [Config docs] | [Compliant] |
|
|
459
|
+
|
|
460
|
+
### 4. Sign-Off
|
|
461
|
+
|
|
462
|
+
| Role | Name | Decision | Date |
|
|
463
|
+
|------|------|----------|------|
|
|
464
|
+
| Security Lead | [Name] | [Approve/Reject] | [Date] |
|
|
465
|
+
| Compliance Officer | [Name] | [Approve/Reject] | [Date] |
|
|
466
|
+
|
|
467
|
+
---
|
|
468
|
+
|
|
469
|
+
## T-07: Release Change Template
|
|
470
|
+
|
|
471
|
+
### Change Header
|
|
472
|
+
|
|
473
|
+
```
|
|
474
|
+
Change ID: [CHG-XXXX]
|
|
475
|
+
Version: [Release version]
|
|
476
|
+
Release Window: [YYYY-MM-DD HH:MM - HH:MM TZ]
|
|
477
|
+
Change Owner: [Name]
|
|
478
|
+
Status: [Planned | Approved | In Progress | Completed | Rolled Back]
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### 1. Change Information
|
|
482
|
+
|
|
483
|
+
**Scope**
|
|
484
|
+
- What is being released: [Feature / fix / infrastructure change description]
|
|
485
|
+
- Affected systems: [List of systems / services]
|
|
486
|
+
- Affected users: [User segments, estimated count]
|
|
487
|
+
|
|
488
|
+
**Impact Assessment**
|
|
489
|
+
| Dimension | Impact | Notes |
|
|
490
|
+
|-----------|--------|-------|
|
|
491
|
+
| Service availability | [None / Partial / Full downtime] | [Duration if applicable] |
|
|
492
|
+
| Data migration | [None / Online / Offline] | [Strategy] |
|
|
493
|
+
| API compatibility | [Backward compatible / Breaking] | [Migration guide if breaking] |
|
|
494
|
+
|
|
495
|
+
### 2. Rollout Strategy
|
|
496
|
+
|
|
497
|
+
**Rollout Plan**
|
|
498
|
+
| Stage | Traffic % | Duration | Criteria to Proceed |
|
|
499
|
+
|-------|----------|----------|-------------------|
|
|
500
|
+
| Canary | 1% | 1 hour | Error rate < 0.1%, latency stable |
|
|
501
|
+
| Early | 10% | 4 hours | Core metrics stable |
|
|
502
|
+
| Partial | 50% | 24 hours | No regressions detected |
|
|
503
|
+
| Full | 100% | - | All criteria met |
|
|
504
|
+
|
|
505
|
+
**Rollback Conditions**
|
|
506
|
+
- Trigger: [What condition triggers a rollback]
|
|
507
|
+
- Procedure: [Step-by-step rollback process]
|
|
508
|
+
- Estimated rollback time: [Duration]
|
|
509
|
+
- Data reconciliation: [Required / Not required]
|
|
510
|
+
|
|
511
|
+
### 3. Post-Release Verification
|
|
512
|
+
|
|
513
|
+
| Check | Method | Expected | Actual | Status |
|
|
514
|
+
|-------|--------|----------|--------|--------|
|
|
515
|
+
| Core API health | Health endpoint | 200 OK | [Result] | [Pass/Fail] |
|
|
516
|
+
| Error rate | Monitoring dashboard | < 0.1% | [Result] | [Pass/Fail] |
|
|
517
|
+
| Latency P95 | Monitoring dashboard | < [X]ms | [Result] | [Pass/Fail] |
|
|
518
|
+
| Business metric | Analytics | Within 5% of baseline | [Result] | [Pass/Fail] |
|
|
519
|
+
|
|
520
|
+
**Observation Period**: 48 hours with enhanced monitoring.
|
|
521
|
+
|
|
522
|
+
---
|
|
523
|
+
|
|
524
|
+
## T-08: Operations Runbook Template
|
|
525
|
+
|
|
526
|
+
### Service Header
|
|
527
|
+
|
|
528
|
+
```
|
|
529
|
+
Service: [Service Name]
|
|
530
|
+
Team: [Owning Team]
|
|
531
|
+
On-Call: [Rotation link / schedule]
|
|
532
|
+
Last Updated: [YYYY-MM-DD]
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
### 1. Service Overview
|
|
536
|
+
|
|
537
|
+
**Purpose**: [What this service does in 1-2 sentences]
|
|
538
|
+
|
|
539
|
+
**Key SLOs**
|
|
540
|
+
| SLI | SLO Target | Current | Dashboard Link |
|
|
541
|
+
|-----|-----------|---------|---------------|
|
|
542
|
+
| Availability | [99.95%] | [Current %] | [Link] |
|
|
543
|
+
| Latency P99 | [< 500ms] | [Current] | [Link] |
|
|
544
|
+
| Error rate | [< 0.1%] | [Current] | [Link] |
|
|
545
|
+
|
|
546
|
+
**Dependencies**
|
|
547
|
+
| Service | Type | Impact if Down | Fallback |
|
|
548
|
+
|---------|------|---------------|----------|
|
|
549
|
+
| [Database] | [Critical] | [Service unavailable] | [Read replica / cache] |
|
|
550
|
+
| [Auth service] | [Critical] | [Cannot authenticate] | [Cached tokens for X min] |
|
|
551
|
+
| [Notification] | [Non-critical] | [Notifications delayed] | [Queue and retry] |
|
|
552
|
+
|
|
553
|
+
### 2. Health Check
|
|
554
|
+
|
|
555
|
+
**Endpoints**
|
|
556
|
+
| Endpoint | Expected Response | Interval |
|
|
557
|
+
|----------|------------------|----------|
|
|
558
|
+
| `/health` | `200 {"status": "ok"}` | 30s |
|
|
559
|
+
| `/ready` | `200 {"ready": true}` | 30s |
|
|
560
|
+
|
|
561
|
+
**Manual Verification**
|
|
562
|
+
```bash
|
|
563
|
+
# Quick health check
|
|
564
|
+
curl -s https://[service-url]/health | jq .
|
|
565
|
+
|
|
566
|
+
# Dependency check
|
|
567
|
+
curl -s https://[service-url]/health/dependencies | jq .
|
|
568
|
+
```
|
|
569
|
+
|
|
570
|
+
### 3. Alert Response Procedures
|
|
571
|
+
|
|
572
|
+
**High Error Rate (> 1%)**
|
|
573
|
+
1. Check error logs: `[log query or command]`
|
|
574
|
+
2. Identify affected endpoints: `[dashboard or query]`
|
|
575
|
+
3. Check recent deployments: `[deployment history command]`
|
|
576
|
+
4. If caused by recent deploy: rollback using `[rollback command]`
|
|
577
|
+
5. If infrastructure issue: check `[infrastructure dashboard]`
|
|
578
|
+
6. Escalate to [Team/Person] if unresolved within 15 minutes.
|
|
579
|
+
|
|
580
|
+
**High Latency (P99 > [threshold])**
|
|
581
|
+
1. Check resource utilization: `[dashboard link]`
|
|
582
|
+
2. Check database connection pool: `[monitoring link]`
|
|
583
|
+
3. Check downstream service latency: `[trace dashboard]`
|
|
584
|
+
4. If resource exhaustion: scale up using `[scaling command]`
|
|
585
|
+
5. If database bottleneck: check slow query log.
|
|
586
|
+
6. Escalate to [Team/Person] if unresolved within 15 minutes.
|
|
587
|
+
|
|
588
|
+
**Service Unavailable**
|
|
589
|
+
1. Check pod / instance status: `[kubectl/command]`
|
|
590
|
+
2. Check recent events: `[event log command]`
|
|
591
|
+
3. Attempt restart: `[restart command]`
|
|
592
|
+
4. If restart fails: check node / host health.
|
|
593
|
+
5. Escalate immediately to [Team/Person].
|
|
594
|
+
|
|
595
|
+
### 4. Scaling Procedures
|
|
596
|
+
|
|
597
|
+
**Horizontal Scale-Up**
|
|
598
|
+
```bash
|
|
599
|
+
# Manual scaling
|
|
600
|
+
[scaling command, e.g., kubectl scale deployment ...]
|
|
601
|
+
|
|
602
|
+
# Verify
|
|
603
|
+
[verification command]
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
**Auto-Scaling Configuration**
|
|
607
|
+
| Metric | Scale-Up Threshold | Scale-Down Threshold | Min / Max Replicas |
|
|
608
|
+
|--------|-------------------|---------------------|-------------------|
|
|
609
|
+
| CPU | > 70% | < 30% | [2 / 10] |
|
|
610
|
+
| Memory | > 80% | < 40% | [2 / 10] |
|
|
611
|
+
|
|
612
|
+
### 5. Recovery Procedures
|
|
613
|
+
|
|
614
|
+
**Database Recovery**
|
|
615
|
+
1. Identify the failure point: `[diagnostic command]`
|
|
616
|
+
2. Check backup status: `[backup check command]`
|
|
617
|
+
3. Restore from backup: `[restore command]`
|
|
618
|
+
4. Verify data integrity: `[verification command]`
|
|
619
|
+
5. Update SLO dashboard with incident impact.
|
|
620
|
+
|
|
621
|
+
**Restart Procedure**
|
|
622
|
+
1. Graceful restart: `[graceful restart command]`
|
|
623
|
+
2. Wait for health check to pass: `[health check command]`
|
|
624
|
+
3. Verify traffic is flowing: `[traffic verification]`
|
|
625
|
+
4. Monitor for 15 minutes post-restart.
|
|
626
|
+
|
|
627
|
+
---
|
|
628
|
+
|
|
629
|
+
## T-09: Postmortem Template
|
|
630
|
+
|
|
631
|
+
### Incident Header
|
|
632
|
+
|
|
633
|
+
```
|
|
634
|
+
Incident ID: [INC-XXXX]
|
|
635
|
+
Severity: [P0 | P1 | P2]
|
|
636
|
+
Date: [YYYY-MM-DD]
|
|
637
|
+
Duration: [Start time - End time (total duration)]
|
|
638
|
+
Author: [Postmortem author]
|
|
639
|
+
Reviewers: [List of reviewers]
|
|
640
|
+
Status: [Draft | Reviewed | Final]
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
### 1. Executive Summary
|
|
644
|
+
|
|
645
|
+
[2-3 sentences: what happened, how many users were affected, how long it lasted, and how it was resolved.]
|
|
646
|
+
|
|
647
|
+
### 2. Impact Assessment
|
|
648
|
+
|
|
649
|
+
| Dimension | Detail |
|
|
650
|
+
|-----------|--------|
|
|
651
|
+
| Users affected | [Number and segment] |
|
|
652
|
+
| Duration | [Total time from detection to resolution] |
|
|
653
|
+
| Revenue impact | [Estimated or N/A] |
|
|
654
|
+
| SLA breach | [Yes/No, which SLA] |
|
|
655
|
+
| Data impact | [Any data loss or corruption] |
|
|
656
|
+
|
|
657
|
+
### 3. Timeline
|
|
658
|
+
|
|
659
|
+
| Time (UTC) | Event |
|
|
660
|
+
|-----------|-------|
|
|
661
|
+
| [HH:MM] | [First anomaly detected by...] |
|
|
662
|
+
| [HH:MM] | [Alert fired / user report received] |
|
|
663
|
+
| [HH:MM] | [First responder engaged] |
|
|
664
|
+
| [HH:MM] | [Root cause identified] |
|
|
665
|
+
| [HH:MM] | [Mitigation applied] |
|
|
666
|
+
| [HH:MM] | [Service restored] |
|
|
667
|
+
| [HH:MM] | [All-clear confirmed] |
|
|
668
|
+
|
|
669
|
+
**Detection**
|
|
670
|
+
- How was the incident detected? [Alert / User report / Monitoring]
|
|
671
|
+
- Time from incident start to detection: [Duration]
|
|
672
|
+
|
|
673
|
+
**Communication**
|
|
674
|
+
- Internal notification sent at: [Time]
|
|
675
|
+
- External communication (if applicable) sent at: [Time]
|
|
676
|
+
- Communication quality: [Adequate / Needs improvement]
|
|
677
|
+
|
|
678
|
+
### 4. Root Cause Analysis
|
|
679
|
+
|
|
680
|
+
**Direct Cause**
|
|
681
|
+
[The specific technical failure that caused the incident]
|
|
682
|
+
|
|
683
|
+
**Contributing Causes**
|
|
684
|
+
- [Factor 1: e.g., Missing monitoring for the affected component]
|
|
685
|
+
- [Factor 2: e.g., Deployment without sufficient canary period]
|
|
686
|
+
|
|
687
|
+
**Systemic Cause**
|
|
688
|
+
[The organizational or process gap that allowed the contributing causes to exist]
|
|
689
|
+
|
|
690
|
+
**5 Whys Analysis**
|
|
691
|
+
1. Why did [symptom]? Because [direct cause].
|
|
692
|
+
2. Why did [direct cause]? Because [contributing cause 1].
|
|
693
|
+
3. Why did [contributing cause 1]? Because [contributing cause 2].
|
|
694
|
+
4. Why did [contributing cause 2]? Because [systemic cause].
|
|
695
|
+
5. Why did [systemic cause]? Because [root organizational gap].
|
|
696
|
+
|
|
697
|
+
### 5. Action Items
|
|
698
|
+
|
|
699
|
+
**Immediate Fixes (1-3 days)**
|
|
700
|
+
| Action | Owner | Deadline | Status | Ticket |
|
|
701
|
+
|--------|-------|----------|--------|--------|
|
|
702
|
+
| [Fix description] | [Name] | [Date] | [Open/Done] | [Link] |
|
|
703
|
+
|
|
704
|
+
**Short-Term Prevention (1-2 weeks)**
|
|
705
|
+
| Action | Owner | Deadline | Status | Ticket |
|
|
706
|
+
|--------|-------|----------|--------|--------|
|
|
707
|
+
| [Prevention action] | [Name] | [Date] | [Open/Done] | [Link] |
|
|
708
|
+
|
|
709
|
+
**Long-Term Prevention (1-3 months)**
|
|
710
|
+
| Action | Owner | Deadline | Status | Ticket |
|
|
711
|
+
|--------|-------|----------|--------|--------|
|
|
712
|
+
| [Structural improvement] | [Name] | [Date] | [Open/Done] | [Link] |
|
|
713
|
+
|
|
714
|
+
### 6. Lessons Learned
|
|
715
|
+
|
|
716
|
+
**What Went Well**
|
|
717
|
+
- [e.g., Alert fired within 2 minutes of anomaly]
|
|
718
|
+
- [e.g., Rollback procedure executed smoothly]
|
|
719
|
+
|
|
720
|
+
**What Went Poorly**
|
|
721
|
+
- [e.g., Root cause identification took 45 minutes due to missing traces]
|
|
722
|
+
- [e.g., External communication was delayed]
|
|
723
|
+
|
|
724
|
+
**Knowledge Base Updates**
|
|
725
|
+
- [ ] New checklist item added to [checklist name].
|
|
726
|
+
- [ ] New anti-pattern documented in [knowledge area].
|
|
727
|
+
- [ ] Runbook updated for [service name].
|
|
728
|
+
|
|
729
|
+
---
|
|
730
|
+
|
|
731
|
+
## T-10: Lifecycle Review Board Template
|
|
732
|
+
|
|
733
|
+
### Review Header
|
|
734
|
+
|
|
735
|
+
```
|
|
736
|
+
Project: [Project Name]
|
|
737
|
+
Review Date: [YYYY-MM-DD]
|
|
738
|
+
Reviewer: [Review Board Chair]
|
|
739
|
+
Participants: [List of participants]
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
### 1. Stage Status Dashboard
|
|
743
|
+
|
|
744
|
+
| Stage | Status | Gate Owner | Gate Pass Date | Blockers |
|
|
745
|
+
|-------|--------|-----------|----------------|----------|
|
|
746
|
+
| Requirement | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
747
|
+
| Design | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
748
|
+
| Architecture | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
749
|
+
| Implementation | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
750
|
+
| Testing | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
751
|
+
| Security | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
752
|
+
| Release | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
753
|
+
| Operations | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
754
|
+
| Postmortem | [Not Started / In Progress / Passed / Blocked] | [Name] | [Date or -] | [Description or None] |
|
|
755
|
+
|
|
756
|
+
### 2. Blockers & Decisions
|
|
757
|
+
|
|
758
|
+
**Active Blockers**
|
|
759
|
+
| ID | Blocker | Affected Stage | Owner | Deadline | Escalation |
|
|
760
|
+
|----|---------|---------------|-------|----------|-----------|
|
|
761
|
+
| B-01 | [Description] | [Stage] | [Name] | [Date] | [Escalation action if deadline missed] |
|
|
762
|
+
|
|
763
|
+
**Decisions Required**
|
|
764
|
+
| ID | Decision | Context | Options | Recommended | Decider | Deadline |
|
|
765
|
+
|----|----------|---------|---------|-------------|---------|----------|
|
|
766
|
+
| D-01 | [Decision needed] | [Why] | [A, B, C] | [Recommendation] | [Name] | [Date] |
|
|
767
|
+
|
|
768
|
+
### 3. Risk Register Update
|
|
769
|
+
|
|
770
|
+
| ID | Risk | Stage | Status | Mitigation Progress |
|
|
771
|
+
|----|------|-------|--------|-------------------|
|
|
772
|
+
| R-01 | [Risk from requirement stage] | [Stage] | [Active/Mitigated/Closed] | [Progress notes] |
|
|
773
|
+
|
|
774
|
+
### 4. Next Review
|
|
775
|
+
|
|
776
|
+
- Next review date: [YYYY-MM-DD]
|
|
777
|
+
- Focus areas: [Stages or topics to review]
|
|
778
|
+
- Required participants: [Names]
|
|
779
|
+
|
|
780
|
+
---
|
|
781
|
+
|
|
782
|
+
## Agent Checklist
|
|
783
|
+
|
|
784
|
+
- [ ] Select the appropriate template for the current lifecycle stage.
|
|
785
|
+
- [ ] Fill in all sections -- do not leave placeholder text in production documents.
|
|
786
|
+
- [ ] Ensure every action item has an owner and deadline.
|
|
787
|
+
- [ ] Link documents to upstream artifacts (requirement links to PRD, PR links to requirement, etc.).
|
|
788
|
+
- [ ] Archive completed templates as project artifacts.
|
|
789
|
+
- [ ] Review template catalog when starting a new lifecycle stage to ensure no template is missed.
|
|
790
|
+
- [ ] Update the lifecycle review board template at each stage transition.
|
|
791
|
+
- [ ] Use the postmortem template within 5 business days of any P0/P1 incident.
|