@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.
Files changed (418) hide show
  1. package/00-governance/governance-capabilities.md +557 -0
  2. package/00-governance/knowledge-map.md +39 -0
  3. package/00-governance/maintenance-policy.md +76 -0
  4. package/00-governance/review-checklist.md +81 -0
  5. package/README.md +13 -0
  6. package/ai/01-standards/agent-development-complete.md +691 -0
  7. package/ai/01-standards/llm-application-complete.md +488 -0
  8. package/ai/01-standards/mlops-complete.md +798 -0
  9. package/ai/01-standards/prompt-engineering-complete.md +646 -0
  10. package/ai/01-standards/rag-architecture-complete.md +649 -0
  11. package/ai/02-playbooks/llm-evaluation-playbook.md +847 -0
  12. package/ai/03-checklists/ai-project-checklist.md +215 -0
  13. package/ai/04-antipatterns/ai-antipatterns.md +661 -0
  14. package/ai/05-cases/case-rag-production.md +147 -0
  15. package/ai/06-glossary/ai-glossary.md +162 -0
  16. package/ai/agent-evaluation-benchmark.md +53 -0
  17. package/ai/ai-agent-memory-context-management.md +41 -0
  18. package/ai/ai-cost-capacity-optimization-playbook.md +42 -0
  19. package/ai/ai-data-security-and-compliance-playbook.md +37 -0
  20. package/ai/ai-domain-index-and-checklist.md +40 -0
  21. package/ai/ai-governance-maturity-model.md +50 -0
  22. package/ai/ai-model-selection-and-routing-strategy.md +47 -0
  23. package/ai/ai-observability-and-oncall-runbook.md +52 -0
  24. package/ai/ai-rag-engineering-playbook.md +42 -0
  25. package/ai/ai-red-team-and-safety-evaluation.md +42 -0
  26. package/ai/ai-release-readiness-and-rollback-gate.md +42 -0
  27. package/ai/llm-agent-engineering-deep-dive.md +57 -0
  28. package/ai/prompt-and-tool-guardrails.md +52 -0
  29. package/api/01-standards/enterprise-api-standards.md +198 -0
  30. package/api/01-standards/rest-api-design-guide.md +63 -0
  31. package/api/02-playbooks/api-pagination-playbook.md +93 -0
  32. package/api/02-playbooks/graphql-production-playbook.md +176 -0
  33. package/api/03-checklists/api-review-checklist.md +55 -0
  34. package/api/04-antipatterns/api-antipatterns.md +112 -0
  35. package/architecture/01-standards/api-gateway-patterns.md +496 -0
  36. package/architecture/01-standards/cloud-native-patterns.md +644 -0
  37. package/architecture/01-standards/distributed-systems-patterns.md +591 -0
  38. package/architecture/01-standards/event-driven-architecture.md +595 -0
  39. package/architecture/01-standards/microservices-patterns-complete.md +968 -0
  40. package/architecture/01-standards/microservices-patterns.md +495 -0
  41. package/architecture/01-standards/system-design-interview.md +664 -0
  42. package/architecture/02-playbooks/microservices-patterns-playbook.md +137 -0
  43. package/architecture/02-playbooks/migration-playbook.md +780 -0
  44. package/architecture/02-playbooks/system-design-playbook.md +779 -0
  45. package/architecture/03-checklists/architecture-decision-checklist.md +297 -0
  46. package/architecture/04-antipatterns/architecture-antipatterns.md +417 -0
  47. package/architecture/05-cases/case-netflix-microservices.md +413 -0
  48. package/architecture/06-glossary/architecture-glossary.md +164 -0
  49. package/architecture/adr-template-and-examples.md +38 -0
  50. package/architecture/api-gateway-deep-dive.md +1291 -0
  51. package/architecture/configuration-management.md +1162 -0
  52. package/architecture/distributed-transactions.md +1220 -0
  53. package/architecture/microservices-complete.md +735 -0
  54. package/architecture/resilience-and-disaster-patterns.md +37 -0
  55. package/architecture/service-governance.md +1198 -0
  56. package/architecture/system-architecture-deep-dive.md +37 -0
  57. package/backend/01-standards/analytics-and-growth.md +65 -0
  58. package/backend/01-standards/api-and-error-conventions.md +120 -0
  59. package/backend/01-standards/application-layering-and-packaging.md +160 -0
  60. package/backend/01-standards/auth-implementation.md +104 -0
  61. package/backend/01-standards/backend-framework-idioms.md +74 -0
  62. package/backend/01-standards/background-jobs-and-async.md +66 -0
  63. package/backend/01-standards/caching-strategies-complete.md +390 -0
  64. package/backend/01-standards/config-and-observability.md +77 -0
  65. package/backend/01-standards/data-modeling-and-persistence.md +94 -0
  66. package/backend/01-standards/django-complete.md +1765 -0
  67. package/backend/01-standards/email-and-notifications.md +64 -0
  68. package/backend/01-standards/fastapi-complete.md +925 -0
  69. package/backend/01-standards/file-upload-and-storage.md +66 -0
  70. package/backend/01-standards/graphql-api-complete.md +416 -0
  71. package/backend/01-standards/llm-application-standard.md +78 -0
  72. package/backend/01-standards/message-queue-patterns.md +379 -0
  73. package/backend/01-standards/microservices-and-distributed.md +78 -0
  74. package/backend/01-standards/nestjs-complete.md +2167 -0
  75. package/backend/01-standards/payment-integration.md +80 -0
  76. package/backend/01-standards/rate-limiting-complete.md +451 -0
  77. package/backend/01-standards/realtime-and-websocket.md +65 -0
  78. package/backend/01-standards/search-and-filtering.md +64 -0
  79. package/backend/01-standards/spring-boot-complete.md +445 -0
  80. package/backend/02-playbooks/api-design-playbook.md +718 -0
  81. package/backend/02-playbooks/email-send-playbook.md +130 -0
  82. package/backend/02-playbooks/file-upload-s3-playbook.md +153 -0
  83. package/backend/02-playbooks/typescript-enterprise-playbook.md +133 -0
  84. package/backend/02-playbooks/websocket-realtime-playbook.md +154 -0
  85. package/backend/03-checklists/api-launch-checklist.md +189 -0
  86. package/backend/04-antipatterns/backend-antipatterns.md +1051 -0
  87. package/blockchain/01-standards/blockchain-basics.md +557 -0
  88. package/blockchain/01-standards/smart-contract-development.md +1315 -0
  89. package/cicd/01-standards/deployment-and-delivery-standard.md +96 -0
  90. package/cicd/01-standards/github-actions-complete.md +473 -0
  91. package/cicd/01-standards/release-and-store-submission.md +75 -0
  92. package/cicd/02-playbooks/cicd-pipeline-playbook.md +144 -0
  93. package/cicd/02-playbooks/release-management-playbook.md +605 -0
  94. package/cicd/03-checklists/pipeline-security-checklist.md +168 -0
  95. package/cicd/04-antipatterns/cicd-antipatterns.md +589 -0
  96. package/cicd/05-cases/case-deployment-automation.md +221 -0
  97. package/cicd/05-cases/case-gitops-transformation.md +212 -0
  98. package/cicd/06-glossary/cicd-glossary.md +114 -0
  99. package/cicd/cicd-blueprint-deep-dive.md +38 -0
  100. package/cicd/release-readiness-gate.md +37 -0
  101. package/cloud-native/01-standards/container-security.md +741 -0
  102. package/cloud-native/01-standards/kubernetes-complete.md +812 -0
  103. package/cloud-native/02-playbooks/api-gateway-playbook.md +155 -0
  104. package/cloud-native/02-playbooks/gitops-with-argocd.md +760 -0
  105. package/cloud-native/02-playbooks/k8s-troubleshooting-playbook.md +1942 -0
  106. package/cloud-native/02-playbooks/message-queue-playbook.md +129 -0
  107. package/cloud-native/02-playbooks/multicloud-governance.md +726 -0
  108. package/cloud-native/02-playbooks/serverless-patterns.md +788 -0
  109. package/cloud-native/02-playbooks/service-mesh-playbook.md +612 -0
  110. package/cloud-native/02-playbooks/terraform-iac-playbook.md +143 -0
  111. package/cloud-native/03-checklists/container-security-checklist.md +431 -0
  112. package/cloud-native/03-checklists/k8s-production-readiness-checklist.md +460 -0
  113. package/cloud-native/04-antipatterns/container-antipatterns.md +660 -0
  114. package/cloud-native/04-antipatterns/k8s-antipatterns.md +743 -0
  115. package/cloud-native/05-cases/case-k8s-migration.md +478 -0
  116. package/cloud-native/05-cases/case-k8s-scaling.md +642 -0
  117. package/cloud-native/05-cases/case-k8s-security-incident.md +397 -0
  118. package/cloud-native/06-glossary/cloud-native-glossary.md +337 -0
  119. package/cross-platform/01-standards/cross-platform-frameworks.md +83 -0
  120. package/cross-platform/01-standards/platform-selection-and-architecture.md +77 -0
  121. package/data/01-standards/elasticsearch-complete.md +2098 -0
  122. package/data/01-standards/postgresql-complete.md +1613 -0
  123. package/data/01-standards/redis-complete.md +1527 -0
  124. package/data/02-playbooks/database-optimization-playbook.md +403 -0
  125. package/data/02-playbooks/elasticsearch-production-playbook.md +132 -0
  126. package/data/03-checklists/database-launch-checklist.md +187 -0
  127. package/data/04-antipatterns/database-antipatterns.md +873 -0
  128. package/data/05-cases/case-database-migration.md +310 -0
  129. package/data/06-glossary/database-glossary.md +440 -0
  130. package/data/data-governance-and-modeling-deep-dive.md +39 -0
  131. package/data-engineering/01-standards/airflow-complete.md +523 -0
  132. package/data-engineering/01-standards/kafka-complete.md +1521 -0
  133. package/data-engineering/02-playbooks/spark-etl-playbook.md +496 -0
  134. package/data-engineering/03-checklists/pipeline-launch-checklist.md +194 -0
  135. package/data-engineering/04-antipatterns/data-pipeline-antipatterns.md +684 -0
  136. package/data-engineering/05-cases/case-real-time-pipeline.md +355 -0
  137. package/data-engineering/06-glossary/data-engineering-glossary.md +429 -0
  138. package/database/01-standards/database-schema-standards.md +147 -0
  139. package/database/02-playbooks/postgresql-optimization-quick.md +52 -0
  140. package/database/02-playbooks/postgresql-performance-optimization.md +58 -0
  141. package/database/02-playbooks/postgresql-production-playbook.md +146 -0
  142. package/database/02-playbooks/redis-caching-playbook.md +117 -0
  143. package/database/03-checklists/database-review-checklist.md +50 -0
  144. package/database/04-antipatterns/database-antipatterns.md +112 -0
  145. package/design/01-standards/ui-design-system-complete.md +423 -0
  146. package/design/02-playbooks/design-handoff-playbook.md +254 -0
  147. package/design/02-playbooks/design-review-playbook.md +388 -0
  148. package/design/03-checklists/design-review-checklist.md +246 -0
  149. package/design/04-antipatterns/design-antipatterns.md +378 -0
  150. package/design/05-cases/case-design-system-adoption.md +328 -0
  151. package/design/06-glossary/design-glossary.md +329 -0
  152. package/design/ui-full-lifecycle-cross-platform-playbook.md +571 -0
  153. package/design/ux-system-deep-dive.md +38 -0
  154. package/design-systems/00-craft-rules.md +71 -0
  155. package/design-systems/aesthetic-families.md +43 -0
  156. package/design-systems/anti-ai-slop.md +162 -0
  157. package/design-systems/bold-geometric.md +120 -0
  158. package/design-systems/brutalist-bold.md +103 -0
  159. package/design-systems/editorial-clean.md +109 -0
  160. package/design-systems/glass-aurora.md +108 -0
  161. package/design-systems/modern-minimal.md +145 -0
  162. package/design-systems/premium-luxury.md +106 -0
  163. package/design-systems/product-type-design-map.md +48 -0
  164. package/design-systems/soft-warm.md +123 -0
  165. package/design-systems/tech-utility.md +113 -0
  166. package/desktop/01-standards/desktop-app-standard.md +72 -0
  167. package/desktop/01-standards/desktop-design.md +71 -0
  168. package/development/00-governance/document-template.md +41 -0
  169. package/development/01-standards/api-versioning-strategies.md +432 -0
  170. package/development/01-standards/authentication-patterns-complete.md +479 -0
  171. package/development/01-standards/css-architecture-complete.md +550 -0
  172. package/development/01-standards/database-migration-strategies.md +484 -0
  173. package/development/01-standards/elasticsearch-complete.md +347 -0
  174. package/development/01-standards/git-complete.md +371 -0
  175. package/development/01-standards/golang-complete.md +1565 -0
  176. package/development/01-standards/graphql-complete.md +298 -0
  177. package/development/01-standards/javascript-bundlers-complete.md +469 -0
  178. package/development/01-standards/javascript-typescript-complete.md +528 -0
  179. package/development/01-standards/jest-complete.md +275 -0
  180. package/development/01-standards/linux-complete.md +234 -0
  181. package/development/01-standards/logging-observability-complete.md +526 -0
  182. package/development/01-standards/microservices-communication.md +502 -0
  183. package/development/01-standards/mongodb-complete.md +406 -0
  184. package/development/01-standards/oauth2-complete.md +285 -0
  185. package/development/01-standards/performance-optimization-complete.md +289 -0
  186. package/development/01-standards/playwright-complete.md +247 -0
  187. package/development/01-standards/postgresql-complete.md +456 -0
  188. package/development/01-standards/pytest-complete.md +340 -0
  189. package/development/01-standards/python-async-programming.md +902 -0
  190. package/development/01-standards/python-complete.md +956 -0
  191. package/development/01-standards/python-decorators-complete.md +799 -0
  192. package/development/01-standards/python-design-patterns.md +2854 -0
  193. package/development/01-standards/python-packaging-distribution.md +420 -0
  194. package/development/01-standards/python-testing-strategies.md +607 -0
  195. package/development/01-standards/python-web-frameworks-comparison.md +471 -0
  196. package/development/01-standards/redis-complete.md +317 -0
  197. package/development/01-standards/rest-api-complete.md +316 -0
  198. package/development/01-standards/rust-complete.md +578 -0
  199. package/development/01-standards/typescript-advanced-types.md +1513 -0
  200. package/development/01-standards/web-security-complete.md +292 -0
  201. package/development/02-playbooks/api-design-playbook.md +810 -0
  202. package/development/02-playbooks/database-migration-playbook.md +580 -0
  203. package/development/02-playbooks/debugging-playbook.md +692 -0
  204. package/development/02-playbooks/feature-delivery-playbook.md +430 -0
  205. package/development/02-playbooks/incident-hotfix-playbook.md +387 -0
  206. package/development/02-playbooks/performance-optimization-playbook.md +531 -0
  207. package/development/02-playbooks/performance-tuning-playbook.md +652 -0
  208. package/development/02-playbooks/refactor-playbook.md +403 -0
  209. package/development/02-playbooks/release-playbook.md +469 -0
  210. package/development/03-checklists/architecture-review-checklist.md +168 -0
  211. package/development/03-checklists/data-migration-checklist.md +157 -0
  212. package/development/03-checklists/oncall-handover-checklist.md +173 -0
  213. package/development/03-checklists/pr-checklist.md +158 -0
  214. package/development/03-checklists/production-readiness-checklist.md +190 -0
  215. package/development/03-checklists/release-readiness-checklist.md +154 -0
  216. package/development/03-checklists/security-review-checklist.md +182 -0
  217. package/development/04-antipatterns/api-antipatterns.md +657 -0
  218. package/development/04-antipatterns/architecture-antipatterns.md +686 -0
  219. package/development/04-antipatterns/backend-antipatterns.md +648 -0
  220. package/development/04-antipatterns/cicd-antipatterns.md +540 -0
  221. package/development/04-antipatterns/code-smell-antipatterns.md +571 -0
  222. package/development/04-antipatterns/data-antipatterns.md +658 -0
  223. package/development/04-antipatterns/database-antipatterns.md +578 -0
  224. package/development/04-antipatterns/frontend-antipatterns.md +635 -0
  225. package/development/04-antipatterns/reliability-antipatterns.md +700 -0
  226. package/development/04-antipatterns/security-antipatterns.md +747 -0
  227. package/development/05-cases/case-api-version-migration.md +428 -0
  228. package/development/05-cases/case-authorization-hardening.md +383 -0
  229. package/development/05-cases/case-bluegreen-rollback.md +466 -0
  230. package/development/05-cases/case-cache-snowball-protection.md +485 -0
  231. package/development/05-cases/case-ci-cd-pipeline.md +544 -0
  232. package/development/05-cases/case-database-scaling.md +500 -0
  233. package/development/05-cases/case-db-hotspot-optimization.md +487 -0
  234. package/development/05-cases/case-incident-mttr-reduction.md +563 -0
  235. package/development/05-cases/case-microservice-migration.md +375 -0
  236. package/development/05-cases/case-performance-optimization.md +406 -0
  237. package/development/05-cases/case-security-incident-response.md +345 -0
  238. package/development/06-glossary/full-stack-glossary.md +166 -0
  239. package/development/09-maturity/quarterly-audit-template.md +35 -0
  240. package/development/11-ui-excellence/ui-aesthetic-system.md +41 -0
  241. package/development/11-ui-excellence/ui-engineering-excellence.md +435 -0
  242. package/development/12-scenarios/development-scenarios-guide.md +565 -0
  243. package/development/13-implementation-assets/implementation-toolkit.md +282 -0
  244. package/development/13-implementation-assets/knowledge-gates-execution.md +43 -0
  245. package/development/14-full-lifecycle/software-lifecycle-gates.md +511 -0
  246. package/development/15-lifecycle-templates/project-templates-collection.md +791 -0
  247. package/development/api-contract-and-versioning-guide.md +36 -0
  248. package/development/api-governance-complete.md +43 -0
  249. package/development/backend-engineering-complete.md +43 -0
  250. package/development/code-review-quality-complete.md +43 -0
  251. package/development/concurrency-reliability-complete.md +43 -0
  252. package/development/database-engineering-complete.md +43 -0
  253. package/development/engineering-effectiveness-complete.md +43 -0
  254. package/development/engineering-standards-deep-dive.md +38 -0
  255. package/development/frontend-engineering-complete.md +43 -0
  256. package/development/performance-capacity-complete.md +43 -0
  257. package/development/refactor-migration-complete.md +42 -0
  258. package/development/refactoring-and-techdebt-playbook.md +37 -0
  259. package/development/security-in-development-complete.md +43 -0
  260. package/devops/01-standards/cicd-pipeline-complete.md +262 -0
  261. package/devops/01-standards/docker-complete.md +1490 -0
  262. package/devops/01-standards/github-actions-complete.md +337 -0
  263. package/devops/01-standards/kubernetes-complete.md +638 -0
  264. package/devops/01-standards/terraform-complete.md +2117 -0
  265. package/devops/02-playbooks/docker-compose-playbook.md +233 -0
  266. package/devops/02-playbooks/docker-k8s-production-playbook.md +186 -0
  267. package/devops/02-playbooks/docker-production-playbook.md +952 -0
  268. package/edge-iot/01-standards/edge-iot-complete.md +473 -0
  269. package/experts/architect/api-design.md +178 -0
  270. package/experts/architect/methodology.md +124 -0
  271. package/experts/architect/security.md +75 -0
  272. package/experts/backend-lead/methodology.md +216 -0
  273. package/experts/devops/methodology.md +160 -0
  274. package/experts/frontend-lead/methodology.md +178 -0
  275. package/experts/product-manager/industry/ecommerce.md +43 -0
  276. package/experts/product-manager/industry/saas.md +40 -0
  277. package/experts/product-manager/methodology.md +97 -0
  278. package/experts/qa-lead/methodology.md +123 -0
  279. package/experts/qa-lead/test-strategy.md +128 -0
  280. package/experts/uiux-designer/methodology.md +125 -0
  281. package/frontend/01-standards/accessibility-complete.md +532 -0
  282. package/frontend/01-standards/accessibility-standard.md +74 -0
  283. package/frontend/01-standards/admin-dashboard-and-crud.md +72 -0
  284. package/frontend/01-standards/design-tokens-complete.md +444 -0
  285. package/frontend/01-standards/forms-and-validation.md +77 -0
  286. package/frontend/01-standards/frontend-architecture-and-layering.md +119 -0
  287. package/frontend/01-standards/i18n-and-localization.md +65 -0
  288. package/frontend/01-standards/nextjs-complete.md +451 -0
  289. package/frontend/01-standards/react-complete.md +713 -0
  290. package/frontend/01-standards/react-hooks-complete-guide.md +1100 -0
  291. package/frontend/01-standards/react-hooks-complete.md +1171 -0
  292. package/frontend/01-standards/seo-and-web-vitals.md +77 -0
  293. package/frontend/01-standards/state-management-complete.md +444 -0
  294. package/frontend/01-standards/vue-complete.md +499 -0
  295. package/frontend/01-standards/vue3-complete.md +2002 -0
  296. package/frontend/01-standards/web-framework-best-practices.md +64 -0
  297. package/frontend/01-standards/web-performance-complete.md +495 -0
  298. package/frontend/02-playbooks/accessibility-a11y-playbook.md +161 -0
  299. package/frontend/02-playbooks/frontend-performance-playbook.md +707 -0
  300. package/frontend/02-playbooks/i18n-internationalization-playbook.md +120 -0
  301. package/frontend/02-playbooks/performance-optimization-playbook.md +163 -0
  302. package/frontend/02-playbooks/react-nextjs-production-playbook.md +167 -0
  303. package/frontend/02-playbooks/react-state-management-playbook.md +173 -0
  304. package/frontend/03-checklists/component-quality-checklist.md +166 -0
  305. package/frontend/03-checklists/frontend-launch-checklist.md +299 -0
  306. package/frontend/04-antipatterns/frontend-antipatterns.md +886 -0
  307. package/frontend/05-cases/case-performance-optimization.md +274 -0
  308. package/harmony/01-standards/harmonyos-arkts-standard.md +75 -0
  309. package/harmony/01-standards/harmonyos-design.md +65 -0
  310. package/high-quality-engineering-playbook.md +54 -0
  311. package/incident/01-standards/incident-response-complete.md +303 -0
  312. package/incident/02-playbooks/chaos-engineering-playbook.md +883 -0
  313. package/incident/02-playbooks/postmortem-playbook.md +398 -0
  314. package/incident/03-checklists/incident-readiness-checklist.md +181 -0
  315. package/incident/04-antipatterns/incident-antipatterns.md +490 -0
  316. package/incident/05-cases/case-cascade-failure.md +176 -0
  317. package/incident/06-glossary/incident-glossary.md +114 -0
  318. package/incident/postmortem-and-response-deep-dive.md +39 -0
  319. package/industries/ecommerce/ecommerce-complete.md +631 -0
  320. package/industries/education/education-complete.md +555 -0
  321. package/industries/fintech/fintech-complete.md +501 -0
  322. package/industries/gaming/gaming-complete.md +587 -0
  323. package/industries/healthcare/healthcare-complete.md +452 -0
  324. package/low-code/01-standards/low-code-complete.md +944 -0
  325. package/miniprogram/01-standards/ai-common-mistakes.md +61 -0
  326. package/miniprogram/01-standards/miniprogram-custom-navbar-capsule.md +77 -0
  327. package/miniprogram/01-standards/miniprogram-design.md +61 -0
  328. package/miniprogram/01-standards/miniprogram-standard.md +81 -0
  329. package/mobile/01-standards/android-material-design.md +70 -0
  330. package/mobile/01-standards/flutter-complete.md +384 -0
  331. package/mobile/01-standards/ios-design-hig.md +78 -0
  332. package/mobile/01-standards/mobile-app-standard.md +85 -0
  333. package/mobile/01-standards/react-native-complete.md +352 -0
  334. package/mobile/02-playbooks/mobile-cross-platform-playbook.md +175 -0
  335. package/mobile/02-playbooks/mobile-performance.md +473 -0
  336. package/mobile/03-checklists/mobile-release-checklist.md +234 -0
  337. package/mobile/04-antipatterns/mobile-antipatterns.md +798 -0
  338. package/mobile/05-cases/case-app-performance.md +500 -0
  339. package/mobile/05-cases/case-app-startup-optimization.md +218 -0
  340. package/mobile/06-glossary/mobile-glossary.md +484 -0
  341. package/observability/01-standards/observability-standards.md +103 -0
  342. package/observability/02-playbooks/prometheus-grafana-playbook.md +135 -0
  343. package/observability/02-playbooks/structured-logging-playbook.md +73 -0
  344. package/observability/03-checklists/observability-checklist.md +54 -0
  345. package/observability/04-antipatterns/observability-antipatterns.md +106 -0
  346. package/operations/01-standards/prometheus-monitoring-complete.md +1578 -0
  347. package/operations/02-playbooks/capacity-planning-playbook.md +620 -0
  348. package/operations/03-checklists/production-launch-checklist.md +365 -0
  349. package/operations/04-antipatterns/operations-antipatterns.md +664 -0
  350. package/operations/05-cases/case-sre-practices.md +581 -0
  351. package/operations/06-glossary/operations-glossary.md +120 -0
  352. package/operations/aiops-anomaly-detection.md +758 -0
  353. package/operations/capacity-planning.md +1061 -0
  354. package/operations/chaos-engineering.md +659 -0
  355. package/operations/incident-command-system.md +38 -0
  356. package/operations/observability-complete.md +442 -0
  357. package/operations/slo-sli-playbook.md +517 -0
  358. package/operations/sre-operations-deep-dive.md +39 -0
  359. package/package.json +8 -0
  360. package/performance/01-standards/performance-and-scalability.md +80 -0
  361. package/performance/01-standards/performance-standards.md +156 -0
  362. package/performance/02-playbooks/query-optimization-playbook.md +103 -0
  363. package/performance/03-checklists/performance-checklist.md +56 -0
  364. package/performance/04-antipatterns/performance-antipatterns.md +146 -0
  365. package/product/01-standards/product-management-complete.md +285 -0
  366. package/product/02-playbooks/feature-launch-playbook.md +207 -0
  367. package/product/02-playbooks/user-research-playbook.md +532 -0
  368. package/product/03-checklists/feature-launch-checklist.md +275 -0
  369. package/product/04-antipatterns/product-antipatterns.md +355 -0
  370. package/product/05-cases/case-mvp-to-scale.md +384 -0
  371. package/product/06-glossary/product-glossary.md +462 -0
  372. package/product/feature-prioritization-framework.md +40 -0
  373. package/product/kpi-and-metric-tree.md +37 -0
  374. package/product/product-discovery-and-prd-deep-dive.md +41 -0
  375. package/quantum/01-standards/quantum-complete.md +1186 -0
  376. package/security/01-standards/api-security-complete.md +511 -0
  377. package/security/01-standards/container-runtime-security.md +574 -0
  378. package/security/01-standards/data-protection-gdpr.md +543 -0
  379. package/security/01-standards/owasp-top10-complete.md +1890 -0
  380. package/security/01-standards/secure-coding-baseline.md +90 -0
  381. package/security/01-standards/supply-chain-security.md +441 -0
  382. package/security/01-standards/web-security-checklist.md +108 -0
  383. package/security/01-standards/zero-trust-architecture.md +521 -0
  384. package/security/02-playbooks/auth-sso-playbook.md +166 -0
  385. package/security/02-playbooks/incident-response-security-playbook.md +588 -0
  386. package/security/02-playbooks/owasp-api-security-playbook.md +129 -0
  387. package/security/02-playbooks/payment-integration-playbook.md +119 -0
  388. package/security/02-playbooks/penetration-testing-playbook.md +517 -0
  389. package/security/03-checklists/security-audit-checklist.md +356 -0
  390. package/security/04-antipatterns/security-coding-antipatterns.md +580 -0
  391. package/security/05-cases/case-log4shell-incident.md +537 -0
  392. package/security/05-cases/case-major-breaches.md +468 -0
  393. package/security/06-glossary/security-glossary.md +212 -0
  394. package/security/compliance-automation.md +993 -0
  395. package/security/container-security.md +680 -0
  396. package/security/devsecops-complete.md +426 -0
  397. package/security/sast-dast-sca.md +775 -0
  398. package/security/secrets-management.md +594 -0
  399. package/security/security-architecture-deep-dive.md +37 -0
  400. package/security/threat-modeling-stride-playbook.md +40 -0
  401. package/seed-templates/auth-system.md +59 -0
  402. package/seed-templates/blog-content.md +94 -0
  403. package/seed-templates/dashboard.md +89 -0
  404. package/seed-templates/docs-site.md +73 -0
  405. package/seed-templates/e-commerce.md +50 -0
  406. package/seed-templates/saas-landing.md +92 -0
  407. package/seed-templates/settings-page.md +51 -0
  408. package/testing/01-standards/test-strategy-and-layering.md +83 -0
  409. package/testing/01-standards/testing-strategy-complete.md +422 -0
  410. package/testing/01-standards/unit-testing-best-practices.md +118 -0
  411. package/testing/02-playbooks/e2e-testing-playbook.md +988 -0
  412. package/testing/02-playbooks/testing-strategy-playbook.md +126 -0
  413. package/testing/03-checklists/test-strategy-checklist.md +208 -0
  414. package/testing/04-antipatterns/testing-antipatterns.md +718 -0
  415. package/testing/05-cases/case-testing-transformation.md +300 -0
  416. package/testing/06-glossary/testing-glossary.md +110 -0
  417. package/testing/risk-based-test-matrix.md +36 -0
  418. package/testing/testing-strategy-deep-dive.md +37 -0
@@ -0,0 +1,375 @@
1
+ ---
2
+ id: case-microservice-migration
3
+ title: 案例研究:从单体到微服务的迁移实战
4
+ domain: development
5
+ category: 05-cases
6
+ difficulty: intermediate
7
+ tags: [agent, case, checklist, development, microservice, migration, 元数据]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 案例研究:从单体到微服务的迁移实战
12
+
13
+ ## 元数据
14
+
15
+ | 字段 | 值 |
16
+ |------|------|
17
+ | 行业 | 电商平台 |
18
+ | 系统规模 | 日活 500 万,峰值 QPS 12,000 |
19
+ | 团队规模 | 后端 28 人,运维 6 人,QA 8 人 |
20
+ | 时间跨度 | 18 个月(2023-01 至 2024-06) |
21
+ | 核心模式 | Strangler Fig Pattern + Branch by Abstraction |
22
+ | 迁移前架构 | Java Spring Boot 单体 + MySQL 主从 |
23
+ | 迁移后架构 | 23 个微服务 + API Gateway + Service Mesh |
24
+
25
+ ---
26
+
27
+ ## 一、背景
28
+
29
+ ### 1.1 业务现状
30
+
31
+ 某头部电商平台运营 5 年,核心系统为 Java Spring Boot 单体应用:
32
+
33
+ - 代码仓库:单一 Git Repo,约 120 万行 Java 代码
34
+ - 部署单元:单一 WAR 包,部署在 8 台物理机集群
35
+ - 数据库:MySQL 8.0 主从架构,主库 32 核 128GB
36
+ - 发布频率:每两周一次全量发布,窗口 4 小时
37
+ - 团队结构:4 个功能团队共享同一代码库
38
+
39
+ ### 1.2 痛点分析
40
+
41
+ | 痛点 | 表现 | 影响 |
42
+ |------|------|------|
43
+ | 发布耦合 | 任一模块变更需全量发布 | 发布频率低,阻塞业务迭代 |
44
+ | 编译缓慢 | 全量构建 45 分钟 | 开发体验差,CI 队列拥堵 |
45
+ | 故障扩散 | 商品模块 OOM 导致全站不可用 | 年度 P0 事故 4 次 |
46
+ | 扩展受限 | 订单高峰需要整体扩容 | 资源浪费 70%+ |
47
+ | 技术锁定 | 所有模块必须用同一框架版本 | 无法引入新技术栈 |
48
+
49
+ ### 1.3 迁移目标
50
+
51
+ - 核心域独立部署、独立扩容
52
+ - 发布频率提升到每日多次
53
+ - 单模块故障不影响全站
54
+ - 构建时间降到 5 分钟以内
55
+
56
+ ---
57
+
58
+ ## 二、挑战
59
+
60
+ ### 2.1 技术挑战
61
+
62
+ 1. **数据耦合深重**:120 张核心表之间存在 340+ 外键关联,模块间直接 JOIN 查询超过 600 处
63
+ 2. **分布式事务**:订单-库存-支付流程涉及 3 个模块的强一致事务
64
+ 3. **共享状态**:Session 存储在本地内存,HttpSession 有 40+ 处直接读写
65
+ 4. **代码纠缠**:通过 IDE 分析,模块间循环依赖 87 处
66
+ 5. **基础设施空白**:无容器化经验,无服务发现/治理能力
67
+
68
+ ### 2.2 组织挑战
69
+
70
+ 1. **团队无微服务经验**:28 人团队中仅 3 人有微服务项目经历
71
+ 2. **业务不能停**:迁移期间平台日交易额 2000 万+,不允许长时间停服
72
+ 3. **时间压力**:管理层要求 18 个月内完成,双十一前必须稳定
73
+ 4. **知识断层**:核心开发者 2 人已离职,部分模块无人完全理解
74
+
75
+ ### 2.3 数据挑战
76
+
77
+ 1. 单库 2.8TB 数据需要拆分到独立数据库
78
+ 2. 报表系统依赖跨模块 JOIN,涉及 15 个核心报表
79
+ 3. 历史数据迁移不允许丢失
80
+ 4. 迁移期间新旧系统数据一致性保障
81
+
82
+ ---
83
+
84
+ ## 三、方案选择
85
+
86
+ ### 3.1 方案对比
87
+
88
+ | 方案 | 优势 | 劣势 | 风险 |
89
+ |------|------|------|------|
90
+ | 大爆炸重写 | 架构最优 | 周期长、风险极高 | 业务中断 |
91
+ | Strangler Fig | 渐进式、可回滚 | 需要维护双系统 | 一致性复杂 |
92
+ | 模块化单体 | 改动最小 | 无法独立部署 | 收益有限 |
93
+ | 领域驱动拆分 | 边界清晰 | 需要深入理解业务 | 建模门槛高 |
94
+
95
+ ### 3.2 最终决策
96
+
97
+ 选择 **Strangler Fig Pattern + DDD 领域驱动设计**,理由:
98
+
99
+ 1. 业务不能停,必须渐进式替换
100
+ 2. DDD 划分确保拆分边界合理
101
+ 3. 可逐步验证每个微服务的稳定性
102
+ 4. 允许团队在实践中积累微服务经验
103
+
104
+ ### 3.3 技术栈选型
105
+
106
+ | 组件 | 选型 | 理由 |
107
+ |------|------|------|
108
+ | 服务框架 | Spring Cloud 2022 + Spring Boot 3 | 团队 Java 背景,学习成本最低 |
109
+ | 服务网关 | Spring Cloud Gateway | 统一入口,灰度切流 |
110
+ | 服务发现 | Nacos 2.x | 注册中心 + 配置中心一体 |
111
+ | 服务通信 | gRPC(内部)+ REST(外部) | 内部高性能,外部兼容性 |
112
+ | 消息队列 | RocketMQ 5.x | 事务消息支持,团队有经验 |
113
+ | 链路追踪 | SkyWalking | Java 生态原生,零侵入接入 |
114
+ | 容器编排 | Kubernetes 1.27 | 行业标准,云厂商支持好 |
115
+ | Service Mesh | Istio 1.18 | 流量治理,灰度发布 |
116
+
117
+ ---
118
+
119
+ ## 四、实施步骤
120
+
121
+ ### 4.1 第一阶段:基础设施准备(第 1-3 月)
122
+
123
+ **目标**:搭建微服务基础设施,团队能力建设
124
+
125
+ ```
126
+ 里程碑:
127
+ Week 1-2: Kubernetes 集群搭建(3 Master + 12 Worker)
128
+ Week 3-4: CI/CD 流水线迁移(Jenkins → GitLab CI + ArgoCD)
129
+ Week 5-6: Nacos/SkyWalking/RocketMQ 部署与调通
130
+ Week 7-8: Istio Service Mesh 部署与流量验证
131
+ Week 9-12: 团队培训(微服务设计 + K8s 运维 + DDD 工作坊)
132
+ ```
133
+
134
+ **关键实践**:
135
+ - 搭建完整的 Staging 环境,与生产 1:1 映射
136
+ - 编写《微服务开发规范》和《服务拆分指南》
137
+ - 每周一次 DDD 领域建模工作坊,全员参与
138
+
139
+ ### 4.2 第二阶段:领域建模与试点拆分(第 4-6 月)
140
+
141
+ **目标**:完成领域划分,试点拆分第一个微服务
142
+
143
+ **领域划分结果**:
144
+
145
+ ```
146
+ 核心域:
147
+ ├── 商品域(Product Context) → product-service
148
+ ├── 订单域(Order Context) → order-service
149
+ ├── 支付域(Payment Context) → payment-service
150
+ ├── 库存域(Inventory Context) → inventory-service
151
+ └── 用户域(User Context) → user-service
152
+
153
+ 支撑域:
154
+ ├── 物流域(Logistics Context) → logistics-service
155
+ ├── 营销域(Promotion Context) → promotion-service
156
+ ├── 搜索域(Search Context) → search-service
157
+ └── 通知域(Notification Context)→ notification-service
158
+
159
+ 通用域:
160
+ ├── 认证域(Auth Context) → auth-service
161
+ ├── 文件域(File Context) → file-service
162
+ ├── 配置域(Config Context) → config-service
163
+ └── 审计域(Audit Context) → audit-service
164
+ ```
165
+
166
+ **试点选择**:通知服务(Notification Service)
167
+
168
+ 选择理由:
169
+ 1. 业务逻辑独立,与其他模块耦合度最低
170
+ 2. 非核心链路,出问题影响可控
171
+ 3. 边界清晰,短信/邮件/站内信三个子域
172
+ 4. 团队可通过试点积累实战经验
173
+
174
+ **试点实施步骤**:
175
+
176
+ ```
177
+ Step 1: 在单体中抽取 NotificationFacade 接口
178
+ Step 2: 新建 notification-service 独立工程
179
+ Step 3: 实现 Facade 接口的微服务版本
180
+ Step 4: 通过 API Gateway 灰度切流(1% → 10% → 50% → 100%)
181
+ Step 5: 验证稳定后删除单体中的通知代码
182
+ ```
183
+
184
+ ### 4.3 第三阶段:核心域拆分(第 7-12 月)
185
+
186
+ **目标**:完成 5 个核心域的拆分
187
+
188
+ **拆分顺序与策略**:
189
+
190
+ ```
191
+ Month 7: 用户服务(User Service)
192
+ - 抽取用户注册/登录/资料管理
193
+ - Session 改造:本地 Session → Redis + JWT
194
+ - 影响面:全站登录态,需全量回归
195
+
196
+ Month 8: 商品服务(Product Service)
197
+ - 抽取商品 CRUD / SKU / 分类管理
198
+ - 数据库拆分:商品相关 35 张表迁移到独立库
199
+ - 引入 CQRS:写操作走主库,搜索走 Elasticsearch
200
+
201
+ Month 9-10: 库存服务(Inventory Service)
202
+ - 抽取库存扣减/预占/回补逻辑
203
+ - 最复杂部分:分布式库存扣减一致性
204
+ - 方案:TCC 事务(try-confirm-cancel)+ 最终一致性
205
+
206
+ Month 11: 订单服务(Order Service)
207
+ - 抽取下单/取消/退款流程
208
+ - Saga 编排模式处理长事务
209
+ - 引入 RocketMQ 事务消息保证最终一致
210
+
211
+ Month 12: 支付服务(Payment Service)
212
+ - 抽取支付/退款/对账逻辑
213
+ - 独立支付网关,PCI DSS 合规隔离
214
+ - 幂等设计防止重复支付
215
+ ```
216
+
217
+ **Strangler Fig 切流策略**:
218
+
219
+ ```
220
+ 每个服务切流步骤一致:
221
+ Day 1: 部署微服务 + 影子流量验证
222
+ Day 2-3: 灰度 1%,观察错误率/延迟/日志
223
+ Day 4-5: 灰度 10%,压测验证承载能力
224
+ Day 6-7: 灰度 50%,准备回滚预案
225
+ Day 8: 灰度 100%
226
+ Day 9-14: 稳定性观察期(14天)
227
+ Day 15: 删除单体中对应代码
228
+ ```
229
+
230
+ ### 4.4 第四阶段:支撑域拆分与治理(第 13-16 月)
231
+
232
+ **目标**:完成剩余服务拆分,建立服务治理体系
233
+
234
+ - 按优先级拆分搜索、物流、营销等支撑域服务
235
+ - 建立统一的服务治理仪表盘
236
+ - 实现熔断(Sentinel)、限流、降级策略
237
+ - 建立全链路灰度发布能力
238
+
239
+ ### 4.5 第五阶段:清理与优化(第 17-18 月)
240
+
241
+ **目标**:下线单体应用,全面进入微服务架构
242
+
243
+ - 删除单体应用残余代码
244
+ - 统一监控告警体系
245
+ - 编写运维手册和故障应急预案
246
+ - 全链路压测,验证双十一承载能力
247
+
248
+ ---
249
+
250
+ ## 五、关键技术难点与解决方案
251
+
252
+ ### 5.1 分布式事务:订单创建流程
253
+
254
+ **问题**:下单涉及订单创建 + 库存扣减 + 优惠券核销,三个服务需要事务一致
255
+
256
+ **方案**:Saga 编排模式 + 事务消息
257
+
258
+ ```
259
+ 正向流程:
260
+ 1. Order Service: 创建订单(PENDING)
261
+ 2. → 发送 RocketMQ 事务消息
262
+ 3. Inventory Service: 扣减库存
263
+ 4. Promotion Service: 核销优惠券
264
+ 5. Order Service: 更新订单状态(CONFIRMED)
265
+
266
+ 补偿流程:
267
+ - 库存扣减失败 → 取消订单
268
+ - 优惠券核销失败 → 回补库存 → 取消订单
269
+ - 超时未完成 → 定时任务扫描 PENDING 订单 → 触发补偿
270
+ ```
271
+
272
+ ### 5.2 数据库拆分:双写过渡
273
+
274
+ ```
275
+ 阶段 1: 单体写旧库 → 同步到新库(binlog 同步)
276
+ 阶段 2: 单体双写(旧库为主)→ 对账校验
277
+ 阶段 3: 微服务双写(新库为主)→ 对账校验
278
+ 阶段 4: 微服务单写新库 → 旧库只读归档
279
+ ```
280
+
281
+ ### 5.3 跨服务查询:报表系统改造
282
+
283
+ **问题**:15 个核心报表依赖跨 5 个库的 JOIN 查询
284
+
285
+ **方案**:引入数据中台(基于 ClickHouse)
286
+
287
+ ```
288
+ 各微服务 → binlog/消息 → 数据同步服务 → ClickHouse 宽表
289
+ 报表系统直接查询 ClickHouse,不再依赖业务库
290
+ ```
291
+
292
+ ---
293
+
294
+ ## 六、结果数据
295
+
296
+ ### 6.1 核心指标对比
297
+
298
+ | 指标 | 迁移前 | 迁移后 | 改善幅度 |
299
+ |------|--------|--------|----------|
300
+ | 发布频率 | 2 周一次 | 日均 8 次 | 56x |
301
+ | 构建时间 | 45 分钟 | 3-5 分钟 | 9x |
302
+ | 部署时间 | 4 小时 | 8 分钟 | 30x |
303
+ | P0 事故/年 | 4 次 | 0 次 | -100% |
304
+ | 故障恢复时间 | 45 分钟 | 5 分钟 | 9x |
305
+ | 资源利用率 | 25% | 68% | +172% |
306
+ | 峰值 QPS | 12,000 | 85,000 | 7x |
307
+ | P99 延迟 | 1.2s | 180ms | 6.7x |
308
+
309
+ ### 6.2 组织效能
310
+
311
+ | 指标 | 迁移前 | 迁移后 |
312
+ |------|--------|--------|
313
+ | 需求交付周期 | 3-4 周 | 3-5 天 |
314
+ | 代码冲突频率 | 日均 12 次 | 日均 0.3 次 |
315
+ | 新人上手时间 | 4 周 | 1 周(只需了解所属服务) |
316
+ | 独立团队数 | 1(共享代码库) | 6(每个域一个团队) |
317
+
318
+ ### 6.3 成本
319
+
320
+ | 项目 | 金额 |
321
+ |------|------|
322
+ | 基础设施投入 | K8s 集群 + 中间件:120 万/年 |
323
+ | 团队培训 | 外部顾问 + 内部培训:35 万 |
324
+ | 迁移期额外人力 | 6 人月(3 名外包):36 万 |
325
+ | 节省的服务器成本 | 资源利用率提升节省 80 万/年 |
326
+ | **净收益(首年)** | **-111 万(投入期)** |
327
+ | **净收益(第二年起)** | **+80 万/年** |
328
+
329
+ ---
330
+
331
+ ## 七、经验教训
332
+
333
+ ### 7.1 做对的事
334
+
335
+ 1. **先试点再推广**:通知服务的试点让团队积累了完整的微服务实战经验,后续核心域拆分效率提升 3 倍
336
+ 2. **Strangler Fig 渐进切流**:每个服务从 1% 灰度开始,累计发现 23 个兼容性问题,均在全量切流前修复
337
+ 3. **领域建模先行**:花 2 个月做 DDD 工作坊看似慢,但避免了后期因边界不清导致的返工
338
+ 4. **基础设施先行**:先花 3 个月搭好 K8s + 可观测性,让后续每次切流都有充分的数据支撑决策
339
+ 5. **双写 + 对账**:数据库拆分期间的双写对账机制发现了 17 处数据不一致,全部在切流前修复
340
+
341
+ ### 7.2 做错的事
342
+
343
+ 1. **低估了分布式事务复杂度**:最初计划用 Seata AT 模式,实测性能不满足要求,切换到 Saga 模式额外花了 1 个月
344
+ 2. **缺少 API 版本管理**:早期微服务之间通过 gRPC 直连,接口变更导致多次联调失败,后来才引入 Proto 版本管理
345
+ 3. **监控体系建设滞后**:第 7 个月才建完整的 Dashboard,前期切流决策主要靠人工判断
346
+ 4. **测试覆盖不足**:集成测试和契约测试建设太晚,前 3 个服务上线时靠手工回归
347
+
348
+ ### 7.3 关键认知
349
+
350
+ - 微服务不是银弹,拆分粒度过细会引入更多的分布式复杂度
351
+ - 基础设施投入是前提,没有可观测性的微服务比单体更危险
352
+ - 组织结构必须跟着架构调整(康威定律),否则拆了也白拆
353
+ - 数据拆分是最难的部分,比代码拆分难 3 倍以上
354
+
355
+ ---
356
+
357
+ ## Agent Checklist
358
+
359
+ 在 AI Agent 辅助执行类似微服务迁移项目时,应逐项确认:
360
+
361
+ - [ ] **领域分析**:是否完成了领域建模,明确了 Bounded Context 和上下文映射
362
+ - [ ] **依赖图谱**:是否生成了模块间依赖关系图,识别了循环依赖
363
+ - [ ] **拆分顺序**:是否按耦合度从低到高排列拆分顺序
364
+ - [ ] **试点选择**:首个拆分目标是否为非核心、低耦合模块
365
+ - [ ] **基础设施**:K8s / 服务发现 / 配置中心 / 链路追踪是否就绪
366
+ - [ ] **灰度切流**:是否建立了从 1% 到 100% 的渐进切流机制
367
+ - [ ] **回滚预案**:每次切流是否有明确的回滚步骤和触发条件
368
+ - [ ] **数据迁移**:数据库拆分是否有双写 + 对账机制
369
+ - [ ] **分布式事务**:跨服务事务是否有明确的一致性方案(Saga/TCC/事务消息)
370
+ - [ ] **API 契约**:服务间接口是否有版本管理和契约测试
371
+ - [ ] **监控告警**:是否建立了服务级 SLO 和告警规则
372
+ - [ ] **压测验证**:每个服务上线前是否通过了全链路压测
373
+ - [ ] **团队培训**:团队是否具备微服务开发和运维能力
374
+ - [ ] **文档齐全**:运维手册 / 故障预案 / 架构决策记录是否完整
375
+ - [ ] **成本评估**:是否计算了迁移期总成本和预期收益周期