@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,157 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: data-migration-checklist
|
|
3
|
+
title: 数据迁移检查清单 (Data Migration Checklist)
|
|
4
|
+
domain: development
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [checklist, data, development, migration, 人员与沟通, 参考, 回滚方案, 对业务的影响评估]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 数据迁移检查清单 (Data Migration Checklist)
|
|
12
|
+
|
|
13
|
+
> 适用场景:数据库 Schema 变更、数据库引擎迁移、数据中心迁移、数据格式转换、大规模数据回填。
|
|
14
|
+
> 通过标准:所有 MUST 项全部通过方可执行生产迁移;SHOULD 项未通过需迁移负责人签字确认。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. 迁移规划
|
|
19
|
+
|
|
20
|
+
### 1.1 范围与目标
|
|
21
|
+
|
|
22
|
+
- [ ] **迁移范围已明确** — 涉及的数据库 / 表 / 字段 / 记录范围已列出,有明确的包含和排除列表。
|
|
23
|
+
- [ ] **迁移目标已量化** — 预期迁移的数据量(行数 / 存储大小)、迁移完成时间已估算。
|
|
24
|
+
- [ ] **迁移类型已确定** — 在线迁移(零停机)/ 停机迁移 / 双写渐进迁移,方案已选定并论证。
|
|
25
|
+
- [ ] **迁移依赖已梳理** — 上下游服务、定时任务、数据消费方的影响已评估。
|
|
26
|
+
- [ ] **成功标准已定义** — 迁移完成的判定条件已量化(如数据一致率 >= 99.99%,性能不退化)。
|
|
27
|
+
|
|
28
|
+
### 1.2 时间窗口
|
|
29
|
+
|
|
30
|
+
- [ ] **迁移时间窗口已确定** — 选择业务低峰期,预留足够的执行 + 验证 + 回滚时间。
|
|
31
|
+
- [ ] **时间里程碑已拆分** — 准备阶段、执行阶段、验证阶段、切换阶段的时间节点已标记。
|
|
32
|
+
- [ ] **超时策略已定义** — 迁移超过预期时间 150% 时的决策流程(继续 / 暂停 / 回滚)已确定。
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 2. 迁移前准备
|
|
37
|
+
|
|
38
|
+
### 2.1 数据分析
|
|
39
|
+
|
|
40
|
+
- [ ] **源数据质量已评估** — 空值、异常值、重复数据、编码问题已统计并处理。
|
|
41
|
+
- [ ] **数据分布已分析** — 大表行数、索引大小、热点分布已确认,用于估算迁移耗时。
|
|
42
|
+
- [ ] **Schema 差异已映射** — 源和目标的 Schema 差异已列出,字段类型转换规则已定义。
|
|
43
|
+
- [ ] **外键与约束已梳理** — 外键依赖关系已理清,迁移顺序按依赖拓扑排序。
|
|
44
|
+
- [ ] **触发器 / 存储过程已评估** — 迁移过程中触发器是否需要临时禁用已确认。
|
|
45
|
+
|
|
46
|
+
### 2.2 环境准备
|
|
47
|
+
|
|
48
|
+
- [ ] **目标环境已就绪** — 目标数据库实例已创建,配置(字符集 / 排序规则 / 参数组)已对齐。
|
|
49
|
+
- [ ] **网络连通性已验证** — 源和目标数据库之间的网络延迟和带宽满足迁移需求。
|
|
50
|
+
- [ ] **存储空间已确认** — 目标存储空间 >= 源数据大小的 2x(预留临时表和日志空间)。
|
|
51
|
+
- [ ] **权限已配置** — 迁移账号具有源端 SELECT 和目标端 INSERT / UPDATE / DDL 权限。
|
|
52
|
+
|
|
53
|
+
### 2.3 脚本与工具
|
|
54
|
+
|
|
55
|
+
- [ ] **迁移脚本已编写** — 迁移脚本(SQL / ETL / 自定义程序)已完成,代码已 review。
|
|
56
|
+
- [ ] **脚本幂等性已保证** — 迁移脚本可安全重复执行,不产生重复数据或错误。
|
|
57
|
+
- [ ] **分批策略已实施** — 大表迁移按主键 / 时间范围分批执行,单批 <= 10000 行,避免长事务。
|
|
58
|
+
- [ ] **进度记录机制已实施** — 迁移进度可实时查看(已迁移行数 / 百分比 / 预计剩余时间)。
|
|
59
|
+
- [ ] **断点续传已支持** — 迁移中断后可从断点恢复,不需要从头开始。
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 3. 数据校验
|
|
64
|
+
|
|
65
|
+
### 3.1 迁移前校验
|
|
66
|
+
|
|
67
|
+
- [ ] **源数据快照已保存** — 迁移前的关键统计数据已记录(总行数 / 校验和 / 关键字段汇总值)。
|
|
68
|
+
- [ ] **抽样数据已导出** — 随机抽取 >= 1000 条记录用于迁移后逐行比对。
|
|
69
|
+
- [ ] **业务规则校验已定义** — 关键业务规则(如余额非负、状态机合法、关联关系完整)的校验查询已编写。
|
|
70
|
+
|
|
71
|
+
### 3.2 迁移后校验
|
|
72
|
+
|
|
73
|
+
- [ ] **行数一致性校验** — 源和目标的各表行数一致(允许偏差范围已定义)。
|
|
74
|
+
- [ ] **数据完整性校验** — 主键唯一性、外键完整性、非空约束均通过。
|
|
75
|
+
- [ ] **字段值校验** — 抽样数据逐字段比对通过,关键汇总值(SUM / COUNT / MAX / MIN)一致。
|
|
76
|
+
- [ ] **业务规则校验** — 迁移后数据满足所有预定义的业务规则。
|
|
77
|
+
- [ ] **索引与约束校验** — 目标表的索引、唯一约束、检查约束已正确创建。
|
|
78
|
+
- [ ] **编码与精度校验** — 中文 / 特殊字符未乱码,数值精度未丢失。
|
|
79
|
+
|
|
80
|
+
### 3.3 性能校验
|
|
81
|
+
|
|
82
|
+
- [ ] **查询性能对比** — 核心查询在目标库上的执行计划和耗时与源库一致或更优。
|
|
83
|
+
- [ ] **索引命中率正常** — 关键查询使用了预期的索引,无全表扫描。
|
|
84
|
+
- [ ] **应用性能验证** — 应用连接目标库后,核心接口延迟在可接受范围内。
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 4. 双写与切换(在线迁移专用)
|
|
89
|
+
|
|
90
|
+
- [ ] **双写逻辑已实现** — 写操作同时写入源和目标,或通过 CDC(Change Data Capture)实时同步增量。
|
|
91
|
+
- [ ] **双写一致性已验证** — 双写期间源和目标的数据差异 <= 可接受延迟(如 < 5s)。
|
|
92
|
+
- [ ] **读切换策略已定义** — 灰度切换读流量(如先切查询 -> 再切写入),每步有验证点。
|
|
93
|
+
- [ ] **写切换策略已定义** — 写流量切换窗口最小化,切换时的在途请求处理方案已确认。
|
|
94
|
+
- [ ] **切换回退机制** — 切换后发现问题可快速回退到源库,回退操作 <= 5 分钟。
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 5. 回滚方案
|
|
99
|
+
|
|
100
|
+
- [ ] **回滚脚本已编写** — 数据回滚脚本已完成,可将目标数据恢复到迁移前状态。
|
|
101
|
+
- [ ] **回滚触发条件已定义** — 明确什么情况下触发回滚(如数据不一致率 > 0.01%,应用错误率 > 5%)。
|
|
102
|
+
- [ ] **回滚时间已评估** — 回滚操作预计耗时已估算,在可接受范围内。
|
|
103
|
+
- [ ] **回滚已演练** — 在预发布环境执行过完整的迁移 + 回滚流程。
|
|
104
|
+
- [ ] **回滚后业务影响已评估** — 回滚后的数据损失范围(迁移后新增的数据如何处理)已有方案。
|
|
105
|
+
- [ ] **备份已创建** — 迁移前的数据库全量备份已完成,备份可用性已验证。
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## 6. 对业务的影响评估
|
|
110
|
+
|
|
111
|
+
- [ ] **业务方已知晓** — 迁移时间 / 影响范围 / 预期停机(如有)已通知业务方。
|
|
112
|
+
- [ ] **定时任务已暂停** — 迁移期间相关的定时任务 / Cron Job 已暂停,迁移后恢复。
|
|
113
|
+
- [ ] **消息消费已暂停**(如需要)— 迁移期间相关消息队列消费者已暂停,积压量在可控范围。
|
|
114
|
+
- [ ] **缓存失效策略已定义** — 迁移后缓存中的旧数据清理方案已确定(全量清除 / 逐步过期)。
|
|
115
|
+
- [ ] **下游通知已发送** — 数据消费方(报表 / 分析 / 同步任务)已知悉迁移计划。
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## 7. 人员与沟通
|
|
120
|
+
|
|
121
|
+
- [ ] **迁移负责人已指定** — 有明确的迁移协调人,对迁移过程全程负责。
|
|
122
|
+
- [ ] **DBA 支持已确认** — DBA 在迁移窗口内可提供支持。
|
|
123
|
+
- [ ] **值班安排已确认** — 迁移后 >= 4 小时有工程师值守观察。
|
|
124
|
+
- [ ] **升级路径已明确** — 迁移异常时的升级联系人和决策链已确认。
|
|
125
|
+
- [ ] **沟通渠道已建立** — 迁移过程的实时沟通群组 / 频道已创建。
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## 8. 迁移后收尾
|
|
130
|
+
|
|
131
|
+
- [ ] **源库处理方案已确定** — 迁移完成后源库保留时间已定义(建议 >= 7 天只读保留)。
|
|
132
|
+
- [ ] **监控已切换** — 监控和告警已指向目标库,源库监控降级为备用。
|
|
133
|
+
- [ ] **连接串已全部切换** — 所有应用 / 脚本 / 定时任务的数据库连接已指向目标。
|
|
134
|
+
- [ ] **迁移文档已归档** — 迁移方案、执行日志、校验结果、回滚记录已存档。
|
|
135
|
+
- [ ] **事后复盘已排期** — 迁移完成后一周内安排复盘,总结经验和改进点。
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 参考
|
|
140
|
+
|
|
141
|
+
- AWS Database Migration Service Best Practices — https://docs.aws.amazon.com/dms/latest/userguide/CHAP_BestPractices.html
|
|
142
|
+
- Flyway / Liquibase Migration Best Practices
|
|
143
|
+
- Martin Kleppmann: Designing Data-Intensive Applications, Chapter 4
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## Agent Checklist
|
|
148
|
+
|
|
149
|
+
供 AI Agent 在执行或监督数据迁移时使用的自检项:
|
|
150
|
+
|
|
151
|
+
- [ ] 已确认迁移脚本在预发布环境完整执行通过。
|
|
152
|
+
- [ ] 已核对源和目标的 Schema 差异映射无遗漏。
|
|
153
|
+
- [ ] 已验证数据校验覆盖行数 / 完整性 / 业务规则三个维度。
|
|
154
|
+
- [ ] 已确认回滚方案可实际执行(非纸面方案)。
|
|
155
|
+
- [ ] 已验证迁移后应用性能无退化。
|
|
156
|
+
- [ ] 已确认所有定时任务和消息消费者已正确暂停 / 恢复。
|
|
157
|
+
- [ ] 迁移执行日志和校验报告已存档至 `output/` 目录。
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: oncall-handover-checklist
|
|
3
|
+
title: 值班交接检查清单 (On-Call Handover Checklist)
|
|
4
|
+
domain: development
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [checklist, development, handover, oncall, 交接确认, 升级路径与联系人, 变更与发布, 已知风险与临时方案]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 值班交接检查清单 (On-Call Handover Checklist)
|
|
12
|
+
|
|
13
|
+
> 适用场景:值班轮换交接、跨团队值班交接、重大事件期间的临时交接、假期前交接。
|
|
14
|
+
> 通过标准:所有 MUST 项在交接会议中完成确认,交接记录双方签字认可。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. 当前系统状态
|
|
19
|
+
|
|
20
|
+
### 1.1 告警与事故
|
|
21
|
+
|
|
22
|
+
- [ ] **活跃告警已同步** — 当前所有未恢复的告警已逐条说明,包含触发时间、影响范围、当前处理状态。
|
|
23
|
+
- [ ] **进行中的事故已交接** — 正在处理的 P0/P1 事故的时间线、当前进展、下一步行动已说明。
|
|
24
|
+
- [ ] **近期已恢复的告警已说明** — 过去 24 小时内恢复的告警已说明,标注是否有复发风险。
|
|
25
|
+
- [ ] **静默 / 抑制的告警已说明** — 当前被静默的告警及其原因、预期恢复时间已交代。
|
|
26
|
+
- [ ] **误报告警已标注** — 已知的误报告警已说明,避免接班人花时间排查。
|
|
27
|
+
|
|
28
|
+
### 1.2 系统健康度
|
|
29
|
+
|
|
30
|
+
- [ ] **核心服务状态** — 各核心服务的健康状态已确认(正常 / 降级 / 部分不可用)。
|
|
31
|
+
- [ ] **资源使用趋势** — CPU / 内存 / 磁盘 / 连接数的使用趋势已说明,标注是否有接近阈值的风险。
|
|
32
|
+
- [ ] **依赖服务状态** — 第三方服务和上下游服务的当前状态已确认。
|
|
33
|
+
- [ ] **SLI / SLO 消耗情况** — 当前 Error Budget 消耗百分比已说明,是否处于风险区间。
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 2. 已知风险与临时方案
|
|
38
|
+
|
|
39
|
+
- [ ] **已知风险清单** — 当前存在但尚未修复的风险项已列出,包含影响范围和优先级。
|
|
40
|
+
- [ ] **临时绕行方案** — 正在使用的临时修复 / 绕行方案已说明,标注方案的有效期和限制条件。
|
|
41
|
+
- [ ] **技术债务风险** — 可能在值班期间触发问题的技术债务已标注(如快满的磁盘、即将过期的证书)。
|
|
42
|
+
- [ ] **定时任务注意事项** — 值班期间将运行的重要定时任务(如结算 / 对账 / 备份)已说明。
|
|
43
|
+
- [ ] **即将过期的资源** — 域名 / 证书 / License / API Key 等在值班期间可能过期的资源已标注。
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 3. 变更与发布
|
|
48
|
+
|
|
49
|
+
- [ ] **近期变更已同步** — 过去 48 小时内的生产变更已说明,包含变更内容、影响范围、负责人。
|
|
50
|
+
- [ ] **计划中的变更** — 值班期间计划执行的变更已列出,包含时间窗口、执行人、回滚方案。
|
|
51
|
+
- [ ] **灰度发布状态** — 正在进行的灰度 / 金丝雀发布的当前比例和观察指标已说明。
|
|
52
|
+
- [ ] **变更冻结期** — 是否处于变更冻结期(如大促前)已确认,冻结期规则已说明。
|
|
53
|
+
- [ ] **Feature Flag 状态** — 正在灰度中的 Feature Flag 状态已说明,包含启停条件。
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 4. 运维工具与入口
|
|
58
|
+
|
|
59
|
+
### 4.1 监控面板
|
|
60
|
+
|
|
61
|
+
- [ ] **核心监控 Dashboard 入口** — Grafana / CloudWatch / Datadog 等核心面板的 URL 已共享。
|
|
62
|
+
- [ ] **业务监控面板入口** — 业务关键指标(GMV / 订单量 / 转化率等)面板 URL 已共享。
|
|
63
|
+
- [ ] **基础设施面板入口** — 集群资源 / 数据库 / 缓存 / 队列的监控面板 URL 已共享。
|
|
64
|
+
|
|
65
|
+
### 4.2 操作工具
|
|
66
|
+
|
|
67
|
+
- [ ] **告警管理平台入口** — PagerDuty / OpsGenie / 自建告警平台的登录方式和操作权限已确认。
|
|
68
|
+
- [ ] **日志查询平台入口** — ELK / Loki / CloudWatch Logs 的查询入口和常用查询语句已共享。
|
|
69
|
+
- [ ] **CI/CD 平台入口** — Jenkins / GitHub Actions / ArgoCD 等部署平台的访问方式已确认。
|
|
70
|
+
- [ ] **数据库管理工具** — 数据库连接方式(跳板机 / 管理平台)和只读 / 读写权限已确认。
|
|
71
|
+
|
|
72
|
+
### 4.3 文档入口
|
|
73
|
+
|
|
74
|
+
- [ ] **Runbook 入口已确认** — 常见故障处理手册的最新版本位置已确认。
|
|
75
|
+
- [ ] **架构文档入口** — 系统架构图、服务依赖图的位置已确认。
|
|
76
|
+
- [ ] **应急预案入口** — 重大故障应急预案的位置已确认。
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 5. 升级路径与联系人
|
|
81
|
+
|
|
82
|
+
- [ ] **升级联系人可达** — 一级升级人(技术 Lead)、二级升级人(技术总监)、三级升级人(CTO)的联系方式已确认且可达。
|
|
83
|
+
- [ ] **DBA 支持联系方式** — DBA 值班人员的联系方式和响应时间承诺已确认。
|
|
84
|
+
- [ ] **安全团队联系方式** — 安全事件的上报联系人和沟通渠道已确认。
|
|
85
|
+
- [ ] **业务方联系人** — 需要业务决策时的对接人联系方式已确认。
|
|
86
|
+
- [ ] **第三方支持联系方式** — 云厂商 / CDN / 支付渠道等第三方的技术支持联系方式和 SLA 已确认。
|
|
87
|
+
- [ ] **升级触发条件已明确** — P0 事件 5 分钟升级、P1 事件 15 分钟升级等规则已复述确认。
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 6. 未完成事项
|
|
92
|
+
|
|
93
|
+
- [ ] **待修复项清单** — 上一班次遗留的待修复项已列出,包含优先级和预期完成时间。
|
|
94
|
+
- [ ] **待观察项清单** — 需要持续观察的指标或行为已列出,包含观察频率和判定标准。
|
|
95
|
+
- [ ] **待跟进的工单** — 已创建但未关闭的事故工单 / 问题工单的状态已同步。
|
|
96
|
+
- [ ] **待回复的沟通** — 来自业务方 / 用户 / 上下游的待回复沟通已说明。
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 7. 特殊情况说明
|
|
101
|
+
|
|
102
|
+
- [ ] **业务高峰期预警** — 值班期间是否有大促 / 活动 / 流量高峰已告知,峰值预估已说明。
|
|
103
|
+
- [ ] **计划内维护** — 值班期间的计划内维护(如数据库维护窗口 / 网络调整)已标注。
|
|
104
|
+
- [ ] **跨时区协调** — 需要跨时区沟通的事项已说明,对方团队的工作时间已标注。
|
|
105
|
+
- [ ] **合规审计事项** — 值班期间是否有审计访问或合规检查已告知。
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## 8. 交接确认
|
|
110
|
+
|
|
111
|
+
- [ ] **交接时间已记录** — 交接发生的日期和时间已记录。
|
|
112
|
+
- [ ] **交接双方已确认** — 交班人和接班人姓名已记录,双方均确认交接内容完整。
|
|
113
|
+
- [ ] **值班日历已更新** — 值班排班表中的当前值班人已更新。
|
|
114
|
+
- [ ] **告警通知已切换** — PagerDuty / OpsGenie 等告警通知的接收人已切换到接班人。
|
|
115
|
+
- [ ] **IM 群组已更新** — 值班 IM 群组中的值班人标识已更新。
|
|
116
|
+
- [ ] **VPN / 跳板机已测试** — 接班人的远程访问权限已验证可用。
|
|
117
|
+
- [ ] **交接记录已存档** — 本次交接记录已保存到团队知识库或值班日志中。
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 交接记录模板
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
## 值班交接记录
|
|
125
|
+
|
|
126
|
+
- 交接时间: YYYY-MM-DD HH:MM
|
|
127
|
+
- 交班人: [姓名]
|
|
128
|
+
- 接班人: [姓名]
|
|
129
|
+
- 值班周期: YYYY-MM-DD ~ YYYY-MM-DD
|
|
130
|
+
|
|
131
|
+
### 当前系统状态
|
|
132
|
+
- [ ] 全部正常 / [ ] 存在异常(详见下方说明)
|
|
133
|
+
|
|
134
|
+
### 活跃告警
|
|
135
|
+
| 告警名称 | 触发时间 | 影响范围 | 当前状态 |
|
|
136
|
+
|----------|---------|---------|---------|
|
|
137
|
+
| | | | |
|
|
138
|
+
|
|
139
|
+
### 已知风险
|
|
140
|
+
| 风险描述 | 优先级 | 临时方案 | 预期修复时间 |
|
|
141
|
+
|---------|--------|---------|------------|
|
|
142
|
+
| | | | |
|
|
143
|
+
|
|
144
|
+
### 待跟进事项
|
|
145
|
+
| 事项 | 优先级 | 负责人 | 备注 |
|
|
146
|
+
|-----|--------|-------|------|
|
|
147
|
+
| | | | |
|
|
148
|
+
|
|
149
|
+
### 交班人签字: ___________
|
|
150
|
+
### 接班人签字: ___________
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## 参考
|
|
156
|
+
|
|
157
|
+
- Google SRE: Being On-Call — https://sre.google/sre-book/being-on-call/
|
|
158
|
+
- PagerDuty Incident Response Guide — https://response.pagerduty.com/
|
|
159
|
+
- Increment: On-Call — https://increment.com/on-call/
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Agent Checklist
|
|
164
|
+
|
|
165
|
+
供 AI Agent 在协助值班交接时使用的自检项:
|
|
166
|
+
|
|
167
|
+
- [ ] 已收集当前所有活跃告警和进行中事故的状态。
|
|
168
|
+
- [ ] 已核对已知风险和临时绕行方案的完整性。
|
|
169
|
+
- [ ] 已确认所有升级联系人的可达性。
|
|
170
|
+
- [ ] 已验证监控面板和运维工具的访问链接有效。
|
|
171
|
+
- [ ] 已确认交接双方对所有待跟进事项达成一致理解。
|
|
172
|
+
- [ ] 已生成交接记录并存档至团队知识库。
|
|
173
|
+
- [ ] 已提醒接班人检查值班期间的特殊事项(高峰期 / 维护窗口)。
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: pr-checklist
|
|
3
|
+
title: PR 检查清单 (Pull Request Checklist)
|
|
4
|
+
domain: development
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [checklist, development, 代码质量, 兼容性, 变更范围与描述, 安全, 性能, 文档]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# PR 检查清单 (Pull Request Checklist)
|
|
12
|
+
|
|
13
|
+
> 适用场景:代码评审、合并请求审核、自动化 CI 门禁配合使用。
|
|
14
|
+
> 通过标准:所有 MUST 项通过方可合并;SHOULD 项未通过需在 PR 描述中说明理由。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. 变更范围与描述
|
|
19
|
+
|
|
20
|
+
- [ ] **PR 标题清晰且符合规范** — 使用 Conventional Commits 格式(feat / fix / refactor / docs / test / chore),标题 <= 72 字符。
|
|
21
|
+
- [ ] **变更目的单一且明确** — 一个 PR 只解决一个问题或实现一个功能,不混合无关变更。
|
|
22
|
+
- [ ] **PR 描述完整** — 包含变更背景、实现方案概述、影响范围、测试方式,关联 Issue / Ticket 编号。
|
|
23
|
+
- [ ] **Breaking Change 已标注** — 如有不兼容变更,在 PR 描述和 commit message 中明确标注 `BREAKING CHANGE`。
|
|
24
|
+
- [ ] **变更规模合理** — 新增 / 修改代码 <= 400 行(不含自动生成代码),超大 PR 应拆分。
|
|
25
|
+
- [ ] **截图 / 录屏已附加**(如涉及 UI)— 变更前后对比截图已附加,覆盖关键状态。
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 2. 代码质量
|
|
30
|
+
|
|
31
|
+
### 2.1 可读性
|
|
32
|
+
|
|
33
|
+
- [ ] **命名清晰有意义** — 变量 / 函数 / 类 / 模块命名准确表达意图,无 `tmp` / `data` / `handler2` 等模糊名称。
|
|
34
|
+
- [ ] **函数职责单一** — 每个函数只做一件事,长度 <= 50 行(不含空行和注释),超长函数已拆分。
|
|
35
|
+
- [ ] **无重复代码** — 不引入 copy-paste 代码块,公共逻辑已提取为共享函数或模块。
|
|
36
|
+
- [ ] **注释说明 Why 而非 What** — 注释解释业务背景和设计决策,不重复描述代码逻辑。
|
|
37
|
+
- [ ] **魔术数字已消除** — 数值字面量提取为命名常量,含义一目了然。
|
|
38
|
+
|
|
39
|
+
### 2.2 设计
|
|
40
|
+
|
|
41
|
+
- [ ] **符合项目架构规范** — 新代码放在正确的模块 / 层级,遵循已有的分层与依赖方向。
|
|
42
|
+
- [ ] **接口设计合理** — 公开接口参数最小化,返回值类型明确,错误处理一致。
|
|
43
|
+
- [ ] **无过度设计** — 不引入当前不需要的抽象层、不提前优化,遵循 YAGNI 原则。
|
|
44
|
+
- [ ] **向后兼容** — API / 数据格式变更向后兼容,或有明确的迁移路径和版本计划。
|
|
45
|
+
|
|
46
|
+
### 2.3 代码规范
|
|
47
|
+
|
|
48
|
+
- [ ] **Lint 检查通过** — Ruff / ESLint / Prettier 等格式化与规范检查零错误。
|
|
49
|
+
- [ ] **类型检查通过** — MyPy / TypeScript 类型检查无新增错误。
|
|
50
|
+
- [ ] **无 TODO/FIXME/HACK 残留** — 临时代码已清理,或关联了对应的 Issue 进行后续跟踪。
|
|
51
|
+
- [ ] **import 排序正确** — 导入按标准库 / 三方库 / 项目内部排序,无未使用的导入。
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 3. 测试
|
|
56
|
+
|
|
57
|
+
### 3.1 测试覆盖
|
|
58
|
+
|
|
59
|
+
- [ ] **新增代码有对应测试** — 业务逻辑新增 / 修改的代码有单元测试覆盖,覆盖率不低于既有基线。
|
|
60
|
+
- [ ] **边界条件已覆盖** — 空值、零值、最大值、异常输入、并发场景的测试用例已编写。
|
|
61
|
+
- [ ] **错误路径已测试** — 异常抛出、错误码返回、降级逻辑均有测试用例验证。
|
|
62
|
+
- [ ] **回归测试已通过** — 既有测试套件全部通过,无因本次变更导致的测试失败。
|
|
63
|
+
|
|
64
|
+
### 3.2 测试质量
|
|
65
|
+
|
|
66
|
+
- [ ] **测试独立可重复** — 测试不依赖执行顺序或外部状态,可单独运行且结果稳定。
|
|
67
|
+
- [ ] **断言具体明确** — 不使用 `assertTrue(result)` 式模糊断言,校验具体字段和值。
|
|
68
|
+
- [ ] **Mock 范围合理** — 仅 Mock 外部依赖(HTTP / DB / 第三方),不 Mock 被测试对象的内部方法。
|
|
69
|
+
- [ ] **测试命名描述行为** — 测试函数名描述被测行为和预期结果,如 `test_login_fails_with_invalid_password`。
|
|
70
|
+
|
|
71
|
+
### 3.3 集成与端到端
|
|
72
|
+
|
|
73
|
+
- [ ] **集成测试已补充**(如涉及跨模块交互)— 模块间交互的关键路径有集成测试覆盖。
|
|
74
|
+
- [ ] **E2E 测试已更新**(如涉及用户流程变更)— 核心用户流程的 E2E 测试已同步更新。
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 4. 文档
|
|
79
|
+
|
|
80
|
+
- [ ] **代码注释已更新** — 修改的函数 / 类的 docstring 与实际行为一致。
|
|
81
|
+
- [ ] **API 文档已同步** — 接口变更同步更新 OpenAPI / Swagger / GraphQL Schema 文档。
|
|
82
|
+
- [ ] **README 已更新**(如涉及使用方式变更)— 安装步骤、配置项、使用示例已同步更新。
|
|
83
|
+
- [ ] **CHANGELOG 已更新** — 用户可感知的变更已记录在 CHANGELOG 中。
|
|
84
|
+
- [ ] **架构决策已记录**(如涉及设计变更)— ADR(Architecture Decision Record)已创建或更新。
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 5. 安全
|
|
89
|
+
|
|
90
|
+
- [ ] **无敏感信息提交** — 代码中无硬编码的密钥、Token、密码、内部 URL。
|
|
91
|
+
- [ ] **用户输入已校验** — 新增的外部输入已做白名单校验或参数化处理。
|
|
92
|
+
- [ ] **权限检查已覆盖** — 新增的接口 / 资源访问有对应的认证和授权校验。
|
|
93
|
+
- [ ] **SQL 查询参数化** — 新增 / 修改的数据库查询使用参数化查询,无字符串拼接。
|
|
94
|
+
- [ ] **依赖安全** — 新增依赖无已知 Critical / High 漏洞(npm audit / pip-audit 通过)。
|
|
95
|
+
- [ ] **日志不含敏感数据** — 新增日志语句不输出用户密码、Token、PII 等敏感信息。
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## 6. 性能
|
|
100
|
+
|
|
101
|
+
- [ ] **无 N+1 查询** — 数据库访问无循环内单条查询的模式,使用批量查询或预加载。
|
|
102
|
+
- [ ] **无不必要的全表扫描** — 新增查询已 EXPLAIN 分析,必要字段已建索引。
|
|
103
|
+
- [ ] **大数据量处理已分页/流式** — 返回列表数据有分页,大文件处理使用流式读取。
|
|
104
|
+
- [ ] **缓存策略合理** — 频繁访问的不变数据已缓存,缓存键与失效策略已定义。
|
|
105
|
+
- [ ] **无内存泄漏风险** — 事件监听器已正确清理,大对象引用在使用后释放。
|
|
106
|
+
- [ ] **异步操作已正确处理** — Promise / async-await 无未捕获的异常,无 fire-and-forget 的关键操作。
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 7. 兼容性
|
|
111
|
+
|
|
112
|
+
- [ ] **API 版本兼容** — 接口变更不影响现有客户端,或有版本号隔离。
|
|
113
|
+
- [ ] **数据库 Schema 兼容** — DDL 变更可前向兼容(先加后删,不改类型),migration 可回滚。
|
|
114
|
+
- [ ] **配置变更兼容** — 新增配置有默认值,删除配置有迁移路径。
|
|
115
|
+
- [ ] **浏览器 / 运行时兼容**(如前端变更)— 在目标浏览器 / Node.js 版本上测试通过。
|
|
116
|
+
- [ ] **国际化兼容**(如涉及文案)— 新增文案已抽取为 i18n 资源,不硬编码中文 / 英文。
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## 8. 运维影响
|
|
121
|
+
|
|
122
|
+
- [ ] **回滚方案已确认** — 本次变更可通过 revert commit 或功能开关快速回滚。
|
|
123
|
+
- [ ] **Feature Flag 已配置**(如涉及灰度)— 新功能可通过 Feature Flag 控制开关,默认关闭。
|
|
124
|
+
- [ ] **监控指标已添加** — 新增功能的关键路径有延迟 / 错误率 / 调用量指标。
|
|
125
|
+
- [ ] **告警规则已配置** — 新增指标的异常阈值已配置对应告警。
|
|
126
|
+
- [ ] **日志可追踪** — 关键业务操作有结构化日志,包含 traceId 和业务上下文。
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## PR 合并前最终确认
|
|
131
|
+
|
|
132
|
+
- [ ] CI 流水线全部通过(lint + type check + test + security scan)。
|
|
133
|
+
- [ ] 至少 1 位 reviewer 已 Approve。
|
|
134
|
+
- [ ] 所有 review comment 已 resolve。
|
|
135
|
+
- [ ] 分支已 rebase 到最新 main,无冲突。
|
|
136
|
+
- [ ] PR 描述中的 checklist 已全部勾选或注明豁免理由。
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## 参考
|
|
141
|
+
|
|
142
|
+
- Conventional Commits — https://www.conventionalcommits.org/
|
|
143
|
+
- Google Engineering Practices: Code Review — https://google.github.io/eng-practices/review/
|
|
144
|
+
- Thoughtbot Code Review Guide — https://github.com/thoughtbot/guides/tree/main/code-review
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Agent Checklist
|
|
149
|
+
|
|
150
|
+
供 AI Agent 在创建或审核 PR 时使用的自检项:
|
|
151
|
+
|
|
152
|
+
- [ ] 已检查 PR 标题符合 Conventional Commits 格式。
|
|
153
|
+
- [ ] 已核对变更文件列表,确认无意外文件被包含(如 .env / lock 文件 / 构建产物)。
|
|
154
|
+
- [ ] 已逐文件 review 代码差异,非仅检查 CI 是否通过。
|
|
155
|
+
- [ ] 已验证新增测试实际覆盖了变更代码的核心路径。
|
|
156
|
+
- [ ] 已检查是否有未处理的 review comment。
|
|
157
|
+
- [ ] 已确认变更不引入安全风险(密钥泄露 / 注入 / 越权)。
|
|
158
|
+
- [ ] 审核结果已记录,包含通过项和待修复项清单。
|