@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,557 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: governance-capabilities
|
|
3
|
+
title: UmaDev 治理能力全景图
|
|
4
|
+
domain: 00-governance
|
|
5
|
+
category: governance-capabilities.md
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [00-governance, capabilities, engine, governance, knowledge, rule, tracker, validation]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# UmaDev 治理能力全景图
|
|
12
|
+
|
|
13
|
+
> 版本: 2.1.6+ | 最后更新: 2026-03-28
|
|
14
|
+
|
|
15
|
+
## 1. 概述
|
|
16
|
+
|
|
17
|
+
UmaDev 的核心定位是 **AI Coding 治理层** —— 它不拥有模型端点,而是在 AI 编码宿主(Claude Code、Cursor、Windsurf 等)之上提供标准化的工程流水线协议、质量门禁和交付审计。
|
|
18
|
+
|
|
19
|
+
2.1.6 版本引入了 5 项治理能力增强,将治理从"阶段性检查"升级为"全链路可编程治理":
|
|
20
|
+
|
|
21
|
+
| 能力 | 模块 | 核心价值 |
|
|
22
|
+
|------|------|----------|
|
|
23
|
+
| Validation Rule Engine | `umadev/reviewers/validation_rules.py` | 可编程质量规则,YAML 定义,pipeline 任意阶段插拔 |
|
|
24
|
+
| Knowledge Tracker | `umadev/knowledge_tracker.py` | 知识引用透明化,覆盖率可量化 |
|
|
25
|
+
| Prompt Templates | `umadev/creators/prompt_templates.py` | Prompt 版本化管理,可追溯可回滚 |
|
|
26
|
+
| ADR Generator | `umadev/creators/adr_generator.py` | 架构决策自动记录,技术选型有据可查 |
|
|
27
|
+
| Pipeline Metrics | `umadev/metrics/pipeline_metrics.py` | DORA + Rework Rate,效能可度量 |
|
|
28
|
+
|
|
29
|
+
统一由 **Pipeline Governance** (`umadev/orchestrator/governance.py`) 集成管理。
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 2. 设计理念
|
|
34
|
+
|
|
35
|
+
### 2.1 可编程优于硬编码
|
|
36
|
+
|
|
37
|
+
所有治理规则通过 YAML 或 Markdown 文件定义,而非代码内嵌。这意味着:
|
|
38
|
+
- 项目团队可以在不修改 UmaDev 源码的情况下调整治理策略
|
|
39
|
+
- 规则变更可以通过 Git 追踪和 Code Review
|
|
40
|
+
- 不同项目可以有不同的治理配置
|
|
41
|
+
|
|
42
|
+
### 2.2 透明优于黑盒
|
|
43
|
+
|
|
44
|
+
每项治理能力都会生成可读的报告和审计记录:
|
|
45
|
+
- 验证规则执行结果有详细的通过/失败说明
|
|
46
|
+
- 知识引用有完整的引用链路
|
|
47
|
+
- 度量数据可导出为 JSON 供外部系统消费
|
|
48
|
+
|
|
49
|
+
### 2.3 渐进式采纳
|
|
50
|
+
|
|
51
|
+
所有治理能力默认启用但不阻断,团队可以逐步提高要求:
|
|
52
|
+
- 先观察(报告模式)
|
|
53
|
+
- 再告警(warning 模式)
|
|
54
|
+
- 最后强制(fail 模式)
|
|
55
|
+
|
|
56
|
+
### 2.4 与 Pipeline 深度集成
|
|
57
|
+
|
|
58
|
+
治理能力不是独立的工具集,而是嵌入 pipeline 的每个阶段:
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
discovery ──> intelligence ──> drafting ──> redteam ──> qa ──> delivery ──> deployment
|
|
62
|
+
│ │ │ │ │ │ │
|
|
63
|
+
▼ ▼ ▼ ▼ ▼ ▼ ▼
|
|
64
|
+
知识追踪 知识追踪+ 验证规则 验证规则 质量门禁 度量收集 度量报告
|
|
65
|
+
Prompt模板 ADR生成 红队规则 验证规则 ADR归档 最终审计
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## 3. Validation Rule Engine — 验证规则引擎
|
|
71
|
+
|
|
72
|
+
### 3.1 概述
|
|
73
|
+
|
|
74
|
+
验证规则引擎允许通过 YAML 文件定义质量检查规则,并在 pipeline 的指定阶段自动执行。内置 14 条默认规则,覆盖文档质量、代码规范、安全基线和架构合规。
|
|
75
|
+
|
|
76
|
+
### 3.2 内置规则分类
|
|
77
|
+
|
|
78
|
+
| 类别 | 规则数 | 示例 |
|
|
79
|
+
|------|--------|------|
|
|
80
|
+
| 文档质量 | 4 | PRD 必须包含用户故事、架构文档必须有组件图 |
|
|
81
|
+
| 代码规范 | 3 | 函数复杂度上限、测试覆盖率下限、导入排序 |
|
|
82
|
+
| 安全基线 | 4 | 无硬编码密钥、依赖漏洞扫描、OWASP Top 10 检查 |
|
|
83
|
+
| 架构合规 | 3 | 分层依赖方向、API 契约一致性、数据库迁移脚本存在 |
|
|
84
|
+
|
|
85
|
+
### 3.3 自定义规则编写指南
|
|
86
|
+
|
|
87
|
+
自定义规则文件位置: `.umadev/rules/custom_rules.yaml`
|
|
88
|
+
|
|
89
|
+
#### 规则结构
|
|
90
|
+
|
|
91
|
+
```yaml
|
|
92
|
+
rules:
|
|
93
|
+
- id: custom-001
|
|
94
|
+
name: "API 响应时间限制"
|
|
95
|
+
description: "所有 API 端点响应时间必须低于 500ms"
|
|
96
|
+
severity: error # error | warning | info
|
|
97
|
+
phase: qa # 执行阶段: discovery | drafting | redteam | qa | delivery
|
|
98
|
+
category: performance
|
|
99
|
+
condition:
|
|
100
|
+
type: metric_threshold
|
|
101
|
+
metric: api_response_time_p95
|
|
102
|
+
operator: lt
|
|
103
|
+
value: 500
|
|
104
|
+
message: "API P95 响应时间 {{actual}}ms 超过阈值 500ms"
|
|
105
|
+
|
|
106
|
+
- id: custom-002
|
|
107
|
+
name: "必须包含 CHANGELOG"
|
|
108
|
+
description: "交付包必须包含 CHANGELOG.md"
|
|
109
|
+
severity: warning
|
|
110
|
+
phase: delivery
|
|
111
|
+
category: documentation
|
|
112
|
+
condition:
|
|
113
|
+
type: file_exists
|
|
114
|
+
path: CHANGELOG.md
|
|
115
|
+
message: "交付包缺少 CHANGELOG.md 文件"
|
|
116
|
+
|
|
117
|
+
- id: custom-003
|
|
118
|
+
name: "禁止使用 eval()"
|
|
119
|
+
description: "代码中不得包含 eval() 调用"
|
|
120
|
+
severity: error
|
|
121
|
+
phase: redteam
|
|
122
|
+
category: security
|
|
123
|
+
condition:
|
|
124
|
+
type: pattern_absent
|
|
125
|
+
glob: "**/*.py"
|
|
126
|
+
pattern: "eval\\("
|
|
127
|
+
message: "检测到 eval() 调用: {{file}}:{{line}}"
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
#### 条件类型 (condition.type)
|
|
131
|
+
|
|
132
|
+
| 类型 | 说明 | 必填参数 |
|
|
133
|
+
|------|------|----------|
|
|
134
|
+
| `file_exists` | 检查文件是否存在 | `path` |
|
|
135
|
+
| `file_absent` | 检查文件不存在 | `path` |
|
|
136
|
+
| `pattern_present` | 检查文件内容包含正则 | `glob`, `pattern` |
|
|
137
|
+
| `pattern_absent` | 检查文件内容不包含正则 | `glob`, `pattern` |
|
|
138
|
+
| `metric_threshold` | 检查度量值 | `metric`, `operator`, `value` |
|
|
139
|
+
| `dependency_check` | 检查依赖版本 | `package`, `version_constraint` |
|
|
140
|
+
| `custom_script` | 执行自定义脚本 | `script`, `expected_exit_code` |
|
|
141
|
+
|
|
142
|
+
#### 跳过规则
|
|
143
|
+
|
|
144
|
+
在 `umadev.yaml` 中配置:
|
|
145
|
+
|
|
146
|
+
```yaml
|
|
147
|
+
validation_rules:
|
|
148
|
+
skip_rules:
|
|
149
|
+
- custom-001 # 按 ID 跳过
|
|
150
|
+
- "doc-*" # 按通配符跳过
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## 4. Knowledge Tracker — 知识引用追踪
|
|
156
|
+
|
|
157
|
+
### 4.1 概述
|
|
158
|
+
|
|
159
|
+
Knowledge Tracker 记录 pipeline 运行过程中引用了哪些知识文件,生成引用报告和覆盖率分析。这解决了"AI 到底参考了哪些资料"的透明性问题。
|
|
160
|
+
|
|
161
|
+
### 4.2 追踪范围
|
|
162
|
+
|
|
163
|
+
- `knowledge/` 目录下的所有文件
|
|
164
|
+
- `output/knowledge-cache/*-knowledge-bundle.json` 缓存文件
|
|
165
|
+
- Pipeline 各阶段的知识读取操作
|
|
166
|
+
|
|
167
|
+
### 4.3 引用报告结构
|
|
168
|
+
|
|
169
|
+
```json
|
|
170
|
+
{
|
|
171
|
+
"run_id": "20260328-143022",
|
|
172
|
+
"total_knowledge_files": 142,
|
|
173
|
+
"referenced_files": 37,
|
|
174
|
+
"coverage": 0.26,
|
|
175
|
+
"by_domain": {
|
|
176
|
+
"security": { "total": 18, "referenced": 12, "coverage": 0.67 },
|
|
177
|
+
"architecture": { "total": 15, "referenced": 8, "coverage": 0.53 },
|
|
178
|
+
"frontend": { "total": 22, "referenced": 5, "coverage": 0.23 }
|
|
179
|
+
},
|
|
180
|
+
"unreferenced_critical": [
|
|
181
|
+
"knowledge/security/01-standards/owasp-top10.md",
|
|
182
|
+
"knowledge/architecture/04-antipatterns/monolith-trap.md"
|
|
183
|
+
],
|
|
184
|
+
"reference_chain": [
|
|
185
|
+
{
|
|
186
|
+
"phase": "intelligence",
|
|
187
|
+
"file": "knowledge/security/01-standards/web-security-complete.md",
|
|
188
|
+
"sections_used": ["Authentication", "CSRF Protection"],
|
|
189
|
+
"downstream_artifacts": ["output/proj-architecture.md"]
|
|
190
|
+
}
|
|
191
|
+
]
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### 4.4 使用方法
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
# 生成知识引用报告
|
|
199
|
+
umadev governance knowledge-report
|
|
200
|
+
|
|
201
|
+
# 查看覆盖率摘要
|
|
202
|
+
umadev governance knowledge-report --summary
|
|
203
|
+
|
|
204
|
+
# 检查是否达到最低覆盖率
|
|
205
|
+
umadev governance knowledge-report --check --min-coverage 0.6
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### 4.5 最佳实践
|
|
209
|
+
|
|
210
|
+
1. **在 CI 中集成覆盖率检查**: 确保关键领域(安全、架构)的知识覆盖率不低于 60%
|
|
211
|
+
2. **定期审查未引用文件**: 未引用的知识文件可能已过时,需要更新或归档
|
|
212
|
+
3. **利用引用链路做根因分析**: 当交付质量出问题时,追溯知识引用链路可以发现是否遗漏了关键输入
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
## 5. Prompt Templates — Prompt 模板版本管理
|
|
217
|
+
|
|
218
|
+
### 5.1 概述
|
|
219
|
+
|
|
220
|
+
Pipeline 各阶段使用的 Prompt 模板存储为版本化的 Markdown 文件,位于 `umadev/templates/` 目录。这使得 Prompt 变更可追踪、可回滚、可 A/B 测试。
|
|
221
|
+
|
|
222
|
+
### 5.2 目录结构
|
|
223
|
+
|
|
224
|
+
```
|
|
225
|
+
umadev/templates/
|
|
226
|
+
├── discovery/
|
|
227
|
+
│ ├── requirement_analysis.v1.md
|
|
228
|
+
│ └── requirement_analysis.v2.md
|
|
229
|
+
├── intelligence/
|
|
230
|
+
│ ├── research_prompt.v1.md
|
|
231
|
+
│ └── knowledge_synthesis.v1.md
|
|
232
|
+
├── drafting/
|
|
233
|
+
│ ├── prd_generation.v1.md
|
|
234
|
+
│ ├── architecture_generation.v1.md
|
|
235
|
+
│ └── uiux_generation.v1.md
|
|
236
|
+
├── redteam/
|
|
237
|
+
│ ├── security_review.v1.md
|
|
238
|
+
│ └── performance_review.v1.md
|
|
239
|
+
└── qa/
|
|
240
|
+
├── quality_gate.v1.md
|
|
241
|
+
└── code_review.v1.md
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### 5.3 模板格式
|
|
245
|
+
|
|
246
|
+
```markdown
|
|
247
|
+
---
|
|
248
|
+
id: prd_generation
|
|
249
|
+
version: 2
|
|
250
|
+
created: 2026-03-15
|
|
251
|
+
author: umadev
|
|
252
|
+
variables:
|
|
253
|
+
- name: project_name
|
|
254
|
+
required: true
|
|
255
|
+
- name: research_summary
|
|
256
|
+
required: true
|
|
257
|
+
- name: knowledge_constraints
|
|
258
|
+
required: false
|
|
259
|
+
default: "无特殊约束"
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
# PRD Generation Prompt
|
|
263
|
+
|
|
264
|
+
你正在为 {{project_name}} 生成产品需求文档。
|
|
265
|
+
|
|
266
|
+
## 背景信息
|
|
267
|
+
|
|
268
|
+
{{research_summary}}
|
|
269
|
+
|
|
270
|
+
## 约束条件
|
|
271
|
+
|
|
272
|
+
{{knowledge_constraints}}
|
|
273
|
+
|
|
274
|
+
## 输出要求
|
|
275
|
+
|
|
276
|
+
...
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### 5.4 版本策略
|
|
280
|
+
|
|
281
|
+
| 策略 | 说明 | 适用场景 |
|
|
282
|
+
|------|------|----------|
|
|
283
|
+
| `semver` | 语义化版本 (v1, v2, v3) | 默认,适合大多数项目 |
|
|
284
|
+
| `date` | 日期版本 (20260328) | 频繁迭代的团队 |
|
|
285
|
+
| `hash` | Git commit hash | 需要精确追溯的场景 |
|
|
286
|
+
|
|
287
|
+
### 5.5 最佳实践
|
|
288
|
+
|
|
289
|
+
1. **不要删除旧版本模板**: 保留历史版本用于对比和回滚
|
|
290
|
+
2. **在模板 frontmatter 中记录变更原因**: 便于团队理解每次改动的动机
|
|
291
|
+
3. **先在非关键阶段测试新模板**: 例如先在 discovery 阶段测试,稳定后再推广到 drafting
|
|
292
|
+
4. **利用 variables 抽取可变部分**: 避免为不同项目复制整个模板
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## 6. ADR Generator — 架构决策记录
|
|
297
|
+
|
|
298
|
+
### 6.1 概述
|
|
299
|
+
|
|
300
|
+
ADR (Architecture Decision Record) 是记录重要架构决策的轻量级文档。UmaDev 的 ADR Generator 从架构配置(`umadev.yaml` 和 `output/*-architecture.md`)中自动提取技术选型,生成标准化的 ADR 文档。
|
|
301
|
+
|
|
302
|
+
### 6.2 自动提取的决策类型
|
|
303
|
+
|
|
304
|
+
| 决策类型 | 数据来源 | 示例 |
|
|
305
|
+
|----------|----------|------|
|
|
306
|
+
| 前端框架选择 | `umadev.yaml: frontend` | ADR-001: 使用 React 作为前端框架 |
|
|
307
|
+
| 后端框架选择 | `umadev.yaml: backend` | ADR-002: 使用 Node.js + Express |
|
|
308
|
+
| 数据库选择 | `umadev.yaml: database` | ADR-003: 使用 PostgreSQL |
|
|
309
|
+
| 部署平台 | `umadev.yaml: platform` | ADR-004: 选择 Web 平台部署 |
|
|
310
|
+
| 架构模式 | `output/*-architecture.md` | ADR-005: 采用前后端分离架构 |
|
|
311
|
+
| 安全方案 | Red-team 报告 | ADR-006: 实施 OWASP Top 10 防护 |
|
|
312
|
+
|
|
313
|
+
### 6.3 ADR 格式 (MADR)
|
|
314
|
+
|
|
315
|
+
```markdown
|
|
316
|
+
# ADR-001: 使用 React 作为前端框架
|
|
317
|
+
|
|
318
|
+
## 状态
|
|
319
|
+
|
|
320
|
+
已接受 (Accepted)
|
|
321
|
+
|
|
322
|
+
## 背景
|
|
323
|
+
|
|
324
|
+
项目需要构建交互式 Web 前端,需要选择前端框架。
|
|
325
|
+
团队对 React 生态有丰富经验。
|
|
326
|
+
|
|
327
|
+
## 决策
|
|
328
|
+
|
|
329
|
+
使用 React 18+ 配合 Vite 构建工具。
|
|
330
|
+
|
|
331
|
+
## 理由
|
|
332
|
+
|
|
333
|
+
- 团队熟悉度高,降低学习成本
|
|
334
|
+
- 生态成熟,组件库丰富
|
|
335
|
+
- Vite 提供快速的开发体验
|
|
336
|
+
- TypeScript 支持完善
|
|
337
|
+
|
|
338
|
+
## 后果
|
|
339
|
+
|
|
340
|
+
- 正面: 开发效率高,招聘容易
|
|
341
|
+
- 负面: 包体积较大,需要关注性能优化
|
|
342
|
+
- 风险: React 大版本升级可能带来迁移成本
|
|
343
|
+
|
|
344
|
+
## 相关 ADR
|
|
345
|
+
|
|
346
|
+
- ADR-005: 前后端分离架构
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### 6.4 使用方法
|
|
350
|
+
|
|
351
|
+
```bash
|
|
352
|
+
# 从当前项目配置生成所有 ADR
|
|
353
|
+
umadev governance adr generate
|
|
354
|
+
|
|
355
|
+
# 只生成指定类别
|
|
356
|
+
umadev governance adr generate --category frontend,database
|
|
357
|
+
|
|
358
|
+
# 列出已生成的 ADR
|
|
359
|
+
umadev governance adr list
|
|
360
|
+
|
|
361
|
+
# 导出为单一文档
|
|
362
|
+
umadev governance adr export --format markdown
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
### 6.5 使用场景
|
|
366
|
+
|
|
367
|
+
1. **新项目启动时**: 自动为技术选型生成 ADR,建立决策追溯基线
|
|
368
|
+
2. **架构变更时**: 在修改 `umadev.yaml` 或架构文档后重新生成,记录演进历史
|
|
369
|
+
3. **交付审计时**: ADR 作为交付证据包的一部分,证明技术决策经过了评估
|
|
370
|
+
4. **团队 onboarding**: 新成员通过 ADR 快速了解项目的技术决策和背后的考量
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
## 7. Pipeline Metrics — 交付效能度量
|
|
375
|
+
|
|
376
|
+
### 7.1 概述
|
|
377
|
+
|
|
378
|
+
Pipeline Metrics 追踪交付效能指标,包括 DORA 四项指标和 Rework Rate。数据存储在本地,可导出供外部 BI 系统消费。
|
|
379
|
+
|
|
380
|
+
### 7.2 度量指标
|
|
381
|
+
|
|
382
|
+
#### DORA 四项指标
|
|
383
|
+
|
|
384
|
+
| 指标 | 说明 | 数据来源 |
|
|
385
|
+
|------|------|----------|
|
|
386
|
+
| Deployment Frequency | 部署频率 | pipeline delivery 阶段完成次数 |
|
|
387
|
+
| Lead Time for Changes | 变更前置时间 | 从 discovery 到 delivery 的耗时 |
|
|
388
|
+
| Change Failure Rate | 变更失败率 | quality gate 未通过的比例 |
|
|
389
|
+
| Time to Restore | 恢复时间 | 从失败到下次成功的耗时 |
|
|
390
|
+
|
|
391
|
+
#### 扩展指标
|
|
392
|
+
|
|
393
|
+
| 指标 | 说明 |
|
|
394
|
+
|------|------|
|
|
395
|
+
| Rework Rate | 返工率 — 需要重新执行的阶段占比 |
|
|
396
|
+
| Knowledge Coverage | 知识覆盖率 — 来自 Knowledge Tracker |
|
|
397
|
+
| Rule Pass Rate | 规则通过率 — 来自 Validation Rule Engine |
|
|
398
|
+
| Gate Score Trend | 质量门禁分数趋势 |
|
|
399
|
+
|
|
400
|
+
### 7.3 数据存储
|
|
401
|
+
|
|
402
|
+
度量数据以 JSON 格式存储在 `output/metrics/` 目录:
|
|
403
|
+
|
|
404
|
+
```
|
|
405
|
+
output/metrics/
|
|
406
|
+
├── pipeline-runs.jsonl # 每次 pipeline 运行记录 (JSON Lines)
|
|
407
|
+
├── dora-summary.json # DORA 指标汇总
|
|
408
|
+
└── weekly-report.json # 周报数据
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
### 7.4 使用方法
|
|
412
|
+
|
|
413
|
+
```bash
|
|
414
|
+
# 显示当前项目的效能指标
|
|
415
|
+
umadev governance metrics show
|
|
416
|
+
|
|
417
|
+
# 显示最近 30 天的趋势
|
|
418
|
+
umadev governance metrics show --period 30d
|
|
419
|
+
|
|
420
|
+
# 导出为 JSON
|
|
421
|
+
umadev governance metrics export --output metrics-export.json
|
|
422
|
+
|
|
423
|
+
# 生成周报
|
|
424
|
+
umadev governance metrics weekly-report
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### 7.5 指标解读
|
|
428
|
+
|
|
429
|
+
| 等级 | Deployment Frequency | Lead Time | Change Failure Rate | Time to Restore |
|
|
430
|
+
|------|---------------------|-----------|---------------------|-----------------|
|
|
431
|
+
| Elite | 按需 (每天多次) | < 1 天 | < 5% | < 1 小时 |
|
|
432
|
+
| High | 每天至每周 | 1 天 - 1 周 | 5% - 10% | < 1 天 |
|
|
433
|
+
| Medium | 每周至每月 | 1 周 - 1 月 | 10% - 20% | 1 天 - 1 周 |
|
|
434
|
+
| Low | 每月以上 | > 1 月 | > 20% | > 1 周 |
|
|
435
|
+
|
|
436
|
+
---
|
|
437
|
+
|
|
438
|
+
## 8. Pipeline Governance 集成层
|
|
439
|
+
|
|
440
|
+
### 8.1 概述
|
|
441
|
+
|
|
442
|
+
`umadev/orchestrator/governance.py` 是治理集成层,负责:
|
|
443
|
+
- 在 pipeline 各阶段自动调用对应的治理能力
|
|
444
|
+
- 汇总所有治理结果生成统一报告
|
|
445
|
+
- 根据配置决定是否阻断 pipeline
|
|
446
|
+
|
|
447
|
+
### 8.2 阶段与治理能力映射
|
|
448
|
+
|
|
449
|
+
```yaml
|
|
450
|
+
governance_hooks:
|
|
451
|
+
discovery:
|
|
452
|
+
- knowledge_tracker.start_tracking
|
|
453
|
+
intelligence:
|
|
454
|
+
- knowledge_tracker.record_references
|
|
455
|
+
- prompt_templates.load_template
|
|
456
|
+
drafting:
|
|
457
|
+
- validation_rules.check("drafting")
|
|
458
|
+
- prompt_templates.load_template
|
|
459
|
+
- adr_generator.extract_decisions
|
|
460
|
+
redteam:
|
|
461
|
+
- validation_rules.check("redteam")
|
|
462
|
+
qa:
|
|
463
|
+
- validation_rules.check("qa")
|
|
464
|
+
- pipeline_metrics.record_gate_score
|
|
465
|
+
delivery:
|
|
466
|
+
- validation_rules.check("delivery")
|
|
467
|
+
- knowledge_tracker.generate_report
|
|
468
|
+
- adr_generator.finalize
|
|
469
|
+
- pipeline_metrics.record_completion
|
|
470
|
+
deployment:
|
|
471
|
+
- pipeline_metrics.record_deployment
|
|
472
|
+
- pipeline_metrics.generate_summary
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### 8.3 统一治理报告
|
|
476
|
+
|
|
477
|
+
pipeline 完成后,governance 层生成统一报告 (`output/governance-report.json`):
|
|
478
|
+
|
|
479
|
+
```json
|
|
480
|
+
{
|
|
481
|
+
"run_id": "20260328-143022",
|
|
482
|
+
"overall_status": "passed",
|
|
483
|
+
"validation_rules": {
|
|
484
|
+
"total": 17,
|
|
485
|
+
"passed": 15,
|
|
486
|
+
"warnings": 2,
|
|
487
|
+
"errors": 0
|
|
488
|
+
},
|
|
489
|
+
"knowledge_coverage": 0.72,
|
|
490
|
+
"adr_count": 6,
|
|
491
|
+
"pipeline_duration_minutes": 45,
|
|
492
|
+
"quality_gate_score": 92,
|
|
493
|
+
"rework_count": 1
|
|
494
|
+
}
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
---
|
|
498
|
+
|
|
499
|
+
## 9. Agent Checklist
|
|
500
|
+
|
|
501
|
+
以下清单供 AI Agent(Claude Code、Cursor 等)在执行 UmaDev pipeline 时参考:
|
|
502
|
+
|
|
503
|
+
### 9.1 Pipeline 启动前
|
|
504
|
+
|
|
505
|
+
- [ ] 确认 `umadev.yaml` 中治理配置已正确设置
|
|
506
|
+
- [ ] 确认 `.umadev/rules/custom_rules.yaml` 存在(如有自定义规则)
|
|
507
|
+
- [ ] 确认 `knowledge/` 目录内容为最新版本
|
|
508
|
+
- [ ] 确认 `umadev/templates/` 中模板版本正确
|
|
509
|
+
|
|
510
|
+
### 9.2 各阶段检查
|
|
511
|
+
|
|
512
|
+
- [ ] **discovery**: Knowledge Tracker 已启动追踪
|
|
513
|
+
- [ ] **intelligence**: 知识引用已记录,Prompt 模板已加载
|
|
514
|
+
- [ ] **drafting**: 验证规则已执行,ADR 决策已提取
|
|
515
|
+
- [ ] **redteam**: 安全类验证规则已执行
|
|
516
|
+
- [ ] **qa**: 质量门禁分数已记录,所有 error 级规则已通过
|
|
517
|
+
- [ ] **delivery**: 知识引用报告已生成,ADR 已归档,度量已记录
|
|
518
|
+
- [ ] **deployment**: 部署度量已记录,统一治理报告已生成
|
|
519
|
+
|
|
520
|
+
### 9.3 交付前确认
|
|
521
|
+
|
|
522
|
+
- [ ] 统一治理报告 (`output/governance-report.json`) 状态为 passed
|
|
523
|
+
- [ ] 知识覆盖率达到配置阈值(默认 0.6)
|
|
524
|
+
- [ ] 所有 error 级验证规则通过
|
|
525
|
+
- [ ] ADR 文档已包含在交付证据包中
|
|
526
|
+
- [ ] DORA 指标已更新
|
|
527
|
+
|
|
528
|
+
### 9.4 常见问题排查
|
|
529
|
+
|
|
530
|
+
| 问题 | 检查项 | 解决方案 |
|
|
531
|
+
|------|--------|----------|
|
|
532
|
+
| 验证规则未执行 | `validation_rules.enabled` | 检查 `umadev.yaml` 配置 |
|
|
533
|
+
| 知识覆盖率为 0 | Knowledge Tracker 启动 | 确认 `knowledge/` 目录非空 |
|
|
534
|
+
| ADR 生成为空 | 架构配置 | 确认 `umadev.yaml` 有 frontend/backend/database 配置 |
|
|
535
|
+
| 度量数据缺失 | metrics 目录权限 | 确认 `output/metrics/` 目录可写 |
|
|
536
|
+
| 自定义规则不生效 | YAML 语法 | 使用 `umadev governance rules validate` 检查 |
|
|
537
|
+
|
|
538
|
+
### 9.5 治理能力启用矩阵
|
|
539
|
+
|
|
540
|
+
| 治理能力 | 默认状态 | 推荐级别 | 企业级别 |
|
|
541
|
+
|----------|----------|----------|----------|
|
|
542
|
+
| Validation Rules | 启用 (warning) | 启用 (error) | 启用 (error + fail_on_warning) |
|
|
543
|
+
| Knowledge Tracker | 启用 | 启用 + 覆盖率检查 | 启用 + min_coverage: 0.8 |
|
|
544
|
+
| Prompt Templates | 启用 | 启用 + semver | 启用 + 审批流程 |
|
|
545
|
+
| ADR Generator | 启用 | 启用 | 启用 + 强制归档 |
|
|
546
|
+
| Pipeline Metrics | 启用 | 启用 + 周报 | 启用 + 外部 BI 集成 |
|
|
547
|
+
|
|
548
|
+
---
|
|
549
|
+
|
|
550
|
+
## 10. 参考资料
|
|
551
|
+
|
|
552
|
+
- [DORA Metrics](https://dora.dev/) — DevOps Research and Assessment
|
|
553
|
+
- [MADR](https://adr.github.io/madr/) — Markdown Architectural Decision Records
|
|
554
|
+
- [OWASP Top 10](https://owasp.org/www-project-top-ten/) — Web 应用安全风险
|
|
555
|
+
- UmaDev 源码: `umadev/orchestrator/governance.py`
|
|
556
|
+
- UmaDev 配置: `umadev.yaml`
|
|
557
|
+
- UmaDev 自定义规则示例: `.umadev/rules/custom_rules.yaml`
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: knowledge-map
|
|
3
|
+
title: knowledge-map
|
|
4
|
+
domain: 00-governance
|
|
5
|
+
category: knowledge-map.md
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [00-governance, knowledge, map]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# 开发:Excellent(11964948@qq.com)
|
|
12
|
+
|
|
13
|
+
## 知识库地图(全环节)
|
|
14
|
+
|
|
15
|
+
### 1. 目标
|
|
16
|
+
- 建立可持续演进的项目知识系统,减少“只靠人记忆”带来的交付风险。
|
|
17
|
+
- 让需求增强、文档生成、评审与上线决策都能引用统一知识源。
|
|
18
|
+
|
|
19
|
+
### 2. 生命周期映射
|
|
20
|
+
- 战略与机会:`product/`
|
|
21
|
+
- 设计与体验:`design/`
|
|
22
|
+
- 架构与实现:`architecture/`、`development/`
|
|
23
|
+
- 质量与安全:`testing/`、`security/`
|
|
24
|
+
- 交付与运维:`cicd/`、`operations/`
|
|
25
|
+
- 数据与增长:`data/`
|
|
26
|
+
- 事故与复盘:`incident/`
|
|
27
|
+
- AI与自动化:`ai/`
|
|
28
|
+
|
|
29
|
+
### 3. 强关联关系
|
|
30
|
+
- `product` 决定 `architecture` 的边界与非功能指标。
|
|
31
|
+
- `architecture` 约束 `development` 的实现模式。
|
|
32
|
+
- `testing` 与 `security` 共同定义 `cicd` 的门禁。
|
|
33
|
+
- `operations` 的监控与事故数据反哺 `product` 与 `architecture`。
|
|
34
|
+
- `ai` 的安全与评测要求同时受 `security/testing/operations` 约束。
|
|
35
|
+
|
|
36
|
+
### 4. 版本与审查
|
|
37
|
+
- P0条目:月度审查。
|
|
38
|
+
- P1条目:季度审查。
|
|
39
|
+
- P2条目:半年度审查。
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: maintenance-policy
|
|
3
|
+
title: 知识库维护政策
|
|
4
|
+
domain: 00-governance
|
|
5
|
+
category: 01-standards
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [00-governance, maintenance, policy, lifecycle, quality]
|
|
8
|
+
quality_score: 88
|
|
9
|
+
last_updated: 2026-06-16
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# 知识库维护政策
|
|
13
|
+
|
|
14
|
+
## 所有权与责任矩阵
|
|
15
|
+
|
|
16
|
+
| 角色 | 职责 | 频率 |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| **知识库所有者** (platform-team) | 审批新增/删除域,维护 00-governance/ 规范 | 季度 |
|
|
19
|
+
| **域维护者** (per-domain) | 审批域内文件变更,保证质量分 ≥ 70 | 双周 |
|
|
20
|
+
| **贡献者** (any agent/user) | 提交新文件或修订,附完整 front-matter | 随时 |
|
|
21
|
+
|
|
22
|
+
## 文件生命周期
|
|
23
|
+
|
|
24
|
+
### 新增
|
|
25
|
+
1. 文件必须包含完整 front-matter(`id`, `title`, `domain`, `tags`, `quality_score`, `difficulty`)。
|
|
26
|
+
2. 文件字数 ≥ 200 词(CJK 按 1.5× 折算);低于阈值的标记 `status: draft`。
|
|
27
|
+
3. 新增域需经知识库所有者审批,且初始至少 3 个文件。
|
|
28
|
+
4. `quality_score` 初值 = 70,贡献者可自行调整。
|
|
29
|
+
|
|
30
|
+
### 修订
|
|
31
|
+
1. 修订后必须更新 `last_updated` 日期。
|
|
32
|
+
2. 内容变更超过 30% 时 `version` 字段 +1。
|
|
33
|
+
3. 修订不得删除已有 H2 章节(只能标记 deprecated)。
|
|
34
|
+
|
|
35
|
+
### 归档与删除
|
|
36
|
+
1. 连续 2 个季度无修订且无检索命中的文件 → 标记 `status: archived`。
|
|
37
|
+
2. 归档文件移入 `<domain>/99-archived/` 子目录,不参与默认检索。
|
|
38
|
+
3. 仅知识库所有者可执行物理删除,需在变更记录中写明原因。
|
|
39
|
+
|
|
40
|
+
## 质量门禁
|
|
41
|
+
|
|
42
|
+
- 每个文件的 `quality_score` 必须 ≥ 50;低于 50 的文件不进入 BM25 索引。
|
|
43
|
+
- 每季度全库扫描:`quality_score < 60` 的文件通知域维护者复审。
|
|
44
|
+
- front-matter 完整性检查:`tags` 非空、`domain` 与路径一致、`quality_score` 为整数。
|
|
45
|
+
|
|
46
|
+
## 检索权重规则
|
|
47
|
+
|
|
48
|
+
- `quality_score` 作为 BM25 分数的弱加权:`score × (1 + quality/200)`。
|
|
49
|
+
- `difficulty = advanced` 的文件在同分时优先(企业级场景更需深度知识)。
|
|
50
|
+
- `.umadev/learned/` 下的经验文件 `quality_score` 固定为 80(项目专属高价值)。
|
|
51
|
+
|
|
52
|
+
## 失效治理
|
|
53
|
+
|
|
54
|
+
- 每周检测失效链接并替换或移除。
|
|
55
|
+
- 每月清理重复条目与过期策略。
|
|
56
|
+
- 每季度做知识结构重组,保持检索可读性。
|
|
57
|
+
- 索引缓存(`bm25.bin` / `vectors.bin`)通过 content-hash 自动失效,无需手动清除。
|
|
58
|
+
|
|
59
|
+
## front-matter 兼容性
|
|
60
|
+
|
|
61
|
+
- schema 变更必须向后兼容(新字段 `#[serde(default)]`)。
|
|
62
|
+
- 旧格式文件(无 `quality_score`)通过 `cargo run --example backfill-frontmatter -- --fix` 补齐。
|
|
63
|
+
- 三种 front-matter 历史格式(legacy/numbered/complete)均被 chunker 兼容解析。
|
|
64
|
+
|
|
65
|
+
## 升级流程
|
|
66
|
+
|
|
67
|
+
1. 在 `docs/plans/` 创建升级方案文档。
|
|
68
|
+
2. 知识库所有者审批。
|
|
69
|
+
3. 执行变更(新增/修订/归档)。
|
|
70
|
+
4. 运行 `cargo test -p umadev-knowledge` 验证索引构建。
|
|
71
|
+
5. 更新 `docs/ARCHITECTURE.md` 如有结构性变更。
|
|
72
|
+
|
|
73
|
+
## 变更记录
|
|
74
|
+
|
|
75
|
+
每次更新追加"变更摘要",说明原因、影响范围、回归检查结果。变更记录写入
|
|
76
|
+
`00-governance/changelog.md`(按需创建)。
|