@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,215 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: ai-project-checklist
|
|
3
|
+
title: AI 项目检查清单 (AI Project Checklist)
|
|
4
|
+
domain: ai
|
|
5
|
+
category: 03-checklists
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [ai, checklist, data, evaluation, model, preparation, project, selection]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# AI 项目检查清单 (AI Project Checklist)
|
|
12
|
+
|
|
13
|
+
> 适用场景:AI/ML 项目全生命周期质量把控,涵盖数据准备、模型选择、评估验证、部署运维、安全合规五大阶段。
|
|
14
|
+
> 通过标准:所有 MUST 项必须通过方可进入下一阶段;SHOULD 项未通过需在评审文档中说明理由和补偿措施。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. 数据准备 (Data Preparation)
|
|
19
|
+
|
|
20
|
+
### 1.1 数据质量
|
|
21
|
+
|
|
22
|
+
- [ ] **数据来源已审计(MUST)** — 所有训练/评估数据的来源已记录,包括采集方式、时间范围、授权协议。
|
|
23
|
+
- [ ] **数据量级评估完成** — 已评估数据量是否满足模型训练需求,小样本场景已标注并准备数据增强方案。
|
|
24
|
+
- [ ] **缺失值处理策略已定义** — 缺失率统计完成,>5% 缺失的字段有明确处理方案(删除/插值/标记)。
|
|
25
|
+
- [ ] **异常值检测已完成** — 通过 IQR / Z-Score / 可视化等方式识别异常值,处理策略已记录。
|
|
26
|
+
- [ ] **数据分布已分析** — 训练集/验证集/测试集的分布一致性已检查,无显著偏移。
|
|
27
|
+
- [ ] **类别不平衡已评估** — 分类任务中各类别样本比例已统计,>10:1 不平衡已准备过采样/欠采样/加权方案。
|
|
28
|
+
- [ ] **数据版本化已建立(MUST)** — 数据集使用 DVC / LakeFS / Delta Lake 等工具版本化管理。
|
|
29
|
+
- [ ] **数据 Schema 已固定** — 字段名、类型、取值范围已文档化,变更需走审批流程。
|
|
30
|
+
|
|
31
|
+
### 1.2 数据标注
|
|
32
|
+
|
|
33
|
+
- [ ] **标注规范已制定(MUST)** — 标注指南文档已编写,包含正例/反例/边界案例示例。
|
|
34
|
+
- [ ] **标注一致性已验证** — 多标注员 Kappa / Fleiss' Kappa >= 0.8,不一致案例已仲裁。
|
|
35
|
+
- [ ] **标注质量抽检已完成** — 至少 10% 样本经高级标注员复审,错误率 < 5%。
|
|
36
|
+
- [ ] **主动学习流程已建立** — 低置信度样本优先标注,标注预算利用率已优化。
|
|
37
|
+
- [ ] **标注工具已选型** — Label Studio / Prodigy / CVAT / Doccano 等工具已部署,工作流已调通。
|
|
38
|
+
|
|
39
|
+
### 1.3 数据隐私与合规
|
|
40
|
+
|
|
41
|
+
- [ ] **PII 识别与脱敏已完成(MUST)** — 姓名/身份证/手机号/地址等 PII 已检测并脱敏或匿名化。
|
|
42
|
+
- [ ] **数据使用授权已获取(MUST)** — 已获得数据所有方的明确授权,授权范围覆盖训练/评估/线上推理。
|
|
43
|
+
- [ ] **GDPR / 个保法合规检查** — 数据存储、跨境传输、用户删除权、最小化收集已满足。
|
|
44
|
+
- [ ] **数据保留策略已定义** — 训练数据、中间产物、日志的保留期限和销毁流程已确定。
|
|
45
|
+
- [ ] **模型训练数据可追溯** — 任意输出可溯源到训练数据子集,满足审计要求。
|
|
46
|
+
- [ ] **合成数据使用已标注** — 如使用合成/增强数据,比例和生成方式已在文档中说明。
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 2. 模型选择与训练 (Model Selection & Training)
|
|
51
|
+
|
|
52
|
+
### 2.1 模型选型
|
|
53
|
+
|
|
54
|
+
- [ ] **问题类型已明确定义(MUST)** — 分类/回归/生成/检索/排序,评估指标与问题类型匹配。
|
|
55
|
+
- [ ] **Baseline 已建立(MUST)** — 简单方案(规则/TF-IDF + LR/启发式)的指标已记录,作为对比基线。
|
|
56
|
+
- [ ] **LLM vs 传统 ML 决策已记录** — 选择理由包括数据量、延迟要求、成本预算、可解释性需求。
|
|
57
|
+
- [ ] **模型许可证已检查** — 开源模型的 License(Apache-2.0 / MIT / LLAMA / RAIL)与商业用途兼容。
|
|
58
|
+
- [ ] **微调 vs Prompt Engineering 决策已评估** — 评估维度包括任务复杂度、数据量、推理成本、迭代速度。
|
|
59
|
+
- [ ] **模型规模与资源匹配** — 模型参数量与可用 GPU 内存匹配,推理延迟满足 SLA。
|
|
60
|
+
|
|
61
|
+
### 2.2 训练过程
|
|
62
|
+
|
|
63
|
+
- [ ] **超参数搜索策略已定义** — Grid / Random / Bayesian / Optuna 搜索空间和预算已确定。
|
|
64
|
+
- [ ] **训练可复现性已保证(MUST)** — 随机种子固定,依赖版本锁定,训练脚本版本化。
|
|
65
|
+
- [ ] **过拟合监控已设置** — 训练集/验证集 Loss 曲线实时追踪,Early Stopping 已配置。
|
|
66
|
+
- [ ] **梯度异常监控已配置** — 梯度爆炸/消失检测,NaN/Inf Loss 自动中断训练。
|
|
67
|
+
- [ ] **Checkpoint 策略已定义** — 每 N 步或每 Epoch 保存,最佳模型自动保留,磁盘配额已设置。
|
|
68
|
+
- [ ] **分布式训练配置已验证** — 多卡/多机训练的通信开销已评估,吞吐量线性度 > 0.7。
|
|
69
|
+
- [ ] **实验记录已归档** — MLflow / W&B / TensorBoard 实验追踪已配置,关键指标自动记录。
|
|
70
|
+
|
|
71
|
+
### 2.3 微调 (Fine-tuning)
|
|
72
|
+
|
|
73
|
+
- [ ] **微调策略已选择** — Full Fine-tune / LoRA / QLoRA / Adapter / Prefix Tuning,选择理由已记录。
|
|
74
|
+
- [ ] **学习率与 Warmup 已调优** — 微调学习率通常为预训练的 1/10 ~ 1/100,Warmup 比例 5-10%。
|
|
75
|
+
- [ ] **灾难性遗忘已评估** — 微调后在原始任务上的表现衰退幅度已测量,< 5% 为可接受。
|
|
76
|
+
- [ ] **数据混合比例已确定** — 新任务数据与通用数据的混合比例已实验验证。
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 3. 评估与验证 (Evaluation & Validation)
|
|
81
|
+
|
|
82
|
+
### 3.1 离线评估
|
|
83
|
+
|
|
84
|
+
- [ ] **评估指标已定义(MUST)** — 主指标和辅助指标明确,与业务目标直接关联。
|
|
85
|
+
- [ ] **测试集独立性已保证(MUST)** — 测试集从未参与训练或超参调优,无数据泄漏。
|
|
86
|
+
- [ ] **分层评估已完成** — 按用户群体/场景/难度等维度分层报告指标,非仅全局均值。
|
|
87
|
+
- [ ] **置信区间已计算** — Bootstrap / Cross-Validation 提供指标的置信区间,非单一点估计。
|
|
88
|
+
- [ ] **对比实验已完成** — 与 Baseline 和前版模型对比,差异具有统计显著性(p < 0.05)。
|
|
89
|
+
|
|
90
|
+
### 3.2 基准测试 (Benchmarking)
|
|
91
|
+
|
|
92
|
+
- [ ] **标准 Benchmark 已跑通** — 使用领域公认的 Benchmark 数据集(如 MMLU / HumanEval / SQuAD)。
|
|
93
|
+
- [ ] **Benchmark 版本已锁定** — Benchmark 数据集和评估脚本版本已记录,确保可比性。
|
|
94
|
+
- [ ] **Leaderboard 对比已记录** — 与同类模型在同一 Benchmark 上的表现对比已文档化。
|
|
95
|
+
- [ ] **自建评估集已构建** — 面向业务场景的评估集已构建,样本量 >= 500。
|
|
96
|
+
|
|
97
|
+
### 3.3 人工评估
|
|
98
|
+
|
|
99
|
+
- [ ] **人工评估流程已定义** — 评估维度(相关性/准确性/流畅性/安全性)、评分标准(1-5 分)已明确。
|
|
100
|
+
- [ ] **评估员已培训** — 评估员已阅读评估指南并完成校准测试。
|
|
101
|
+
- [ ] **评估员间一致性已检查** — Cohen's Kappa >= 0.6,不一致案例已讨论并达成共识。
|
|
102
|
+
- [ ] **盲评已执行** — 评估员不知道哪个回答来自哪个模型,避免偏见。
|
|
103
|
+
|
|
104
|
+
### 3.4 A/B 测试
|
|
105
|
+
|
|
106
|
+
- [ ] **A/B 测试方案已设计** — 实验组/对照组划分策略、样本量计算、运行时长已确定。
|
|
107
|
+
- [ ] **核心指标已定义** — 主指标(如 CTR / 转化率 / 满意度)和护栏指标(如延迟 / 错误率)已明确。
|
|
108
|
+
- [ ] **流量分配机制已实现** — 用户级/请求级分流,哈希一致性保证同一用户始终进入同一组。
|
|
109
|
+
- [ ] **统计显著性门槛已设定** — p-value < 0.05,最小可检测效应(MDE)已计算。
|
|
110
|
+
- [ ] **灰度放量计划已制定** — 1% -> 5% -> 20% -> 50% -> 100% 的放量节奏和回滚条件已明确。
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## 4. 部署与运维 (Deployment & Operations)
|
|
115
|
+
|
|
116
|
+
### 4.1 推理优化
|
|
117
|
+
|
|
118
|
+
- [ ] **模型量化已评估** — INT8 / FP16 / GPTQ / AWQ 量化后精度损失 < 1%,延迟降低已量化。
|
|
119
|
+
- [ ] **推理框架已选型** — vLLM / TGI / TensorRT / ONNX Runtime / Triton 选型理由已记录。
|
|
120
|
+
- [ ] **Batch 推理已配置** — 动态 Batching 参数(max_batch_size / max_wait_time)已调优。
|
|
121
|
+
- [ ] **KV Cache 策略已优化** — PagedAttention / 连续 Batching 已配置,GPU 内存利用率 > 80%。
|
|
122
|
+
- [ ] **模型预热已完成** — 首次推理延迟已通过 Warm-up 请求消除。
|
|
123
|
+
- [ ] **推理成本已估算** — 单次推理成本已计算($/1K tokens 或 $/request),月度预算已审批。
|
|
124
|
+
|
|
125
|
+
### 4.2 服务部署
|
|
126
|
+
|
|
127
|
+
- [ ] **容器镜像已构建(MUST)** — Dockerfile 已编写,镜像体积已优化(多阶段构建),安全扫描已通过。
|
|
128
|
+
- [ ] **健康检查已配置(MUST)** — Liveness / Readiness / Startup Probe 已设置,超时阈值合理。
|
|
129
|
+
- [ ] **自动扩缩容已配置** — HPA 基于 GPU 利用率 / 队列深度 / 请求延迟自动扩缩。
|
|
130
|
+
- [ ] **资源限制已设置** — CPU / Memory / GPU 的 Request 和 Limit 已配置,无无限资源占用风险。
|
|
131
|
+
- [ ] **蓝绿 / 金丝雀部署已配置** — 新模型版本通过渐进式发布验证,异常自动回滚。
|
|
132
|
+
- [ ] **模型版本管理已建立** — 模型文件与代码版本绑定,任意线上版本可追溯和回滚。
|
|
133
|
+
|
|
134
|
+
### 4.3 监控与告警
|
|
135
|
+
|
|
136
|
+
- [ ] **推理延迟监控已配置(MUST)** — P50 / P95 / P99 延迟实时追踪,超出 SLA 自动告警。
|
|
137
|
+
- [ ] **模型质量监控已配置(MUST)** — 在线评估指标(如 BLEU / 人工评分 / 用户反馈)持续追踪。
|
|
138
|
+
- [ ] **数据漂移检测已部署** — 输入特征分布与训练分布对比,PSI / KL 散度超阈值告警。
|
|
139
|
+
- [ ] **Token 使用量监控已配置** — 输入/输出 Token 数统计,异常长请求自动截断。
|
|
140
|
+
- [ ] **错误率监控已配置** — 模型推理错误(OOM / Timeout / 异常输出)分类统计。
|
|
141
|
+
- [ ] **成本仪表盘已建立** — GPU 小时 / API 调用次数 / 存储成本实时可视化。
|
|
142
|
+
|
|
143
|
+
### 4.4 回滚与应急
|
|
144
|
+
|
|
145
|
+
- [ ] **回滚流程已定义(MUST)** — 一键回滚到前一稳定版本,回滚时间 < 5 分钟。
|
|
146
|
+
- [ ] **降级方案已准备** — 模型不可用时降级到规则引擎/缓存结果/小模型。
|
|
147
|
+
- [ ] **熔断机制已配置** — 连续错误超过阈值自动熔断,恢复探测已设置。
|
|
148
|
+
- [ ] **应急预案已演练** — 模型宕机、GPU 不足、数据中毒等场景已进行应急演练。
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## 5. 安全与合规 (Security & Compliance)
|
|
153
|
+
|
|
154
|
+
### 5.1 Prompt 安全
|
|
155
|
+
|
|
156
|
+
- [ ] **Prompt 注入防护已实现(MUST)** — 输入清洗、角色锁定、指令隔离等多层防护已部署。
|
|
157
|
+
- [ ] **System Prompt 防泄漏** — 拒绝输出系统指令的防护已测试,红队测试已通过。
|
|
158
|
+
- [ ] **越狱防护已部署** — 常见越狱 Prompt 库已测试,拦截率 > 95%。
|
|
159
|
+
- [ ] **输出过滤已配置** — 有害内容(暴力/色情/歧视/个人信息)输出过滤器已启用。
|
|
160
|
+
- [ ] **多轮对话上下文安全** — 跨轮次注入攻击已测试,上下文隔离已验证。
|
|
161
|
+
|
|
162
|
+
### 5.2 数据安全
|
|
163
|
+
|
|
164
|
+
- [ ] **训练数据不可逆提取(MUST)** — 模型无法通过 Prompt 逐字复述训练数据。
|
|
165
|
+
- [ ] **推理日志脱敏** — 用户输入和模型输出日志已脱敏,PII 自动替换。
|
|
166
|
+
- [ ] **API Key / Token 安全** — 密钥轮换策略已定义,泄漏检测已配置。
|
|
167
|
+
- [ ] **数据传输加密** — 推理请求全链路 TLS 1.2+ 加密,内部通信 mTLS。
|
|
168
|
+
- [ ] **访问控制已配置** — 模型 API 的 RBAC 已实现,审计日志已启用。
|
|
169
|
+
|
|
170
|
+
### 5.3 偏见与公平性
|
|
171
|
+
|
|
172
|
+
- [ ] **偏见评估已完成(MUST)** — 性别/种族/年龄/地域等维度的偏见测试已执行。
|
|
173
|
+
- [ ] **公平性指标已定义** — Demographic Parity / Equal Opportunity / Calibration 已选择并量化。
|
|
174
|
+
- [ ] **偏见缓解措施已实施** — 数据平衡/对抗训练/输出校准等至少一种措施已部署。
|
|
175
|
+
- [ ] **偏见监控已上线** — 生产环境中持续监控模型输出的公平性指标。
|
|
176
|
+
- [ ] **模型卡 (Model Card) 已编写** — 包含预期用途、已知局限、偏见评估结果、推荐使用范围。
|
|
177
|
+
|
|
178
|
+
### 5.4 合规与治理
|
|
179
|
+
|
|
180
|
+
- [ ] **AI 治理框架已对齐** — 符合 EU AI Act / NIST AI RMF / 国内《生成式 AI 管理办法》。
|
|
181
|
+
- [ ] **可解释性方案已实现** — SHAP / LIME / Attention 可视化 / Chain-of-Thought 至少一种可用。
|
|
182
|
+
- [ ] **人类监督机制已建立** — 高风险决策需人工复核,自动化决策有申诉通道。
|
|
183
|
+
- [ ] **变更审计日志完整** — 模型变更、数据变更、配置变更全记录,保留 >= 1 年。
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## 6. 成本与效率 (Cost & Efficiency)
|
|
188
|
+
|
|
189
|
+
- [ ] **训练成本已核算** — GPU 小时数、云资源费用、人力成本已统计,ROI 已评估。
|
|
190
|
+
- [ ] **推理成本已预算** — 单次推理成本和月度总预算已获审批,成本超限有告警。
|
|
191
|
+
- [ ] **资源利用率已优化** — GPU 利用率 > 70%,无长期闲置的训练/推理资源。
|
|
192
|
+
- [ ] **Spot / 竞价实例已评估** — 训练任务是否可用 Spot 实例降低成本已验证。
|
|
193
|
+
- [ ] **模型瘦身已评估** — 量化/蒸馏/剪枝能否在可接受精度损失下降低推理成本。
|
|
194
|
+
- [ ] **缓存策略已实现** — 高频相同请求的推理结果已缓存,避免重复计算。
|
|
195
|
+
- [ ] **成本归因已建立** — 各业务线/团队的 AI 资源消耗可独立统计和归因。
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## 7. 文档与知识管理 (Documentation & Knowledge)
|
|
200
|
+
|
|
201
|
+
- [ ] **模型卡已编写(MUST)** — 包含模型用途、训练数据、性能指标、已知局限、伦理考量。
|
|
202
|
+
- [ ] **API 文档已完善** — 推理 API 的输入/输出格式、错误码、速率限制已文档化。
|
|
203
|
+
- [ ] **运维手册已编写** — 常见故障的 Runbook、扩缩容操作、日志查看方法已归档。
|
|
204
|
+
- [ ] **实验记录已归档** — 所有实验的假设、方法、结果、结论已记录在实验追踪系统中。
|
|
205
|
+
- [ ] **决策记录已保存** — 模型选型、架构选择、技术取舍的 ADR 已编写。
|
|
206
|
+
- [ ] **培训材料已准备** — 新成员 Onboarding 所需的技术文档和操作指南已就绪。
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
## Agent Checklist
|
|
211
|
+
|
|
212
|
+
- [ ] 阅读本检查清单后确认覆盖所有 MUST 项
|
|
213
|
+
- [ ] 根据项目实际情况裁剪 SHOULD 项,裁剪理由已记录
|
|
214
|
+
- [ ] 每阶段完成后更新检查清单状态,未通过项有明确的补偿时间表
|
|
215
|
+
- [ ] 检查清单评审结果已纳入质量门禁判定
|