@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,387 @@
1
+ ---
2
+ id: incident-hotfix-playbook
3
+ title: 线上故障热修复手册 (Incident Hotfix Playbook)
4
+ domain: development
5
+ category: 02-playbooks
6
+ difficulty: intermediate
7
+ tags: [development, hotfix, incident, playbook, 修复方案, 前置条件, 基本信息, 时间线]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 线上故障热修复手册 (Incident Hotfix Playbook)
12
+
13
+ ## 概述
14
+
15
+ 线上故障热修复是在生产环境出现服务异常时,以最快速度恢复服务、最小化业务损失的紧急响应流程。本手册覆盖从故障发现、定级响应、紧急修复到复盘防复发的完整链路,确保每次热修复都可控、可追溯、可回滚。
16
+
17
+ ## 前置条件
18
+
19
+ ### 平时准备(故障发生前必须就绪)
20
+
21
+ - [ ] 核心服务有健康检查端点和自动告警
22
+ - [ ] 具备一键回滚能力(版本回退或流量切换)
23
+ - [ ] On-call 轮值表和升级路径已定义并通知到人
24
+ - [ ] 关键服务的 Runbook 已就绪(至少涵盖 Top 10 故障场景)
25
+ - [ ] 日志、指标、链路追踪三大可观测性支柱已部署
26
+ - [ ] 数据库有定期备份和恢复测试记录
27
+
28
+ ### 工具准备
29
+
30
+ - [ ] 告警通知渠道(钉钉/企微/Slack/PagerDuty)
31
+ - [ ] 远程访问生产环境的安全通道(VPN/堡垒机)
32
+ - [ ] 故障响应协作频道(专用 War Room)
33
+
34
+ ---
35
+
36
+ ## 步骤一:故障发现与定级
37
+
38
+ ### 1.1 发现渠道
39
+
40
+ | 渠道 | 响应时间要求 | 负责人 |
41
+ |------|-------------|--------|
42
+ | 监控告警自动触发 | 1 分钟内确认 | On-call 值班 |
43
+ | 用户报障(客服/工单) | 5 分钟内确认 | 客服 -> On-call |
44
+ | 内部发现(开发/测试) | 3 分钟内确认 | 发现人 -> On-call |
45
+
46
+ ### 1.2 故障定级
47
+
48
+ ```
49
+ P0 - 核心业务完全不可用(支付、登录、核心交易链路中断)
50
+ 响应要求:5 分钟内启动 War Room,15 分钟内出止损方案
51
+ 通知范围:CTO + 技术总监 + 全部相关团队
52
+
53
+ P1 - 核心业务严重降级(部分功能不可用、性能严重下降)
54
+ 响应要求:15 分钟内启动响应,30 分钟内出止损方案
55
+ 通知范围:技术总监 + 服务负责人
56
+
57
+ P2 - 非核心功能异常(边缘功能故障、非关键页面报错)
58
+ 响应要求:30 分钟内响应,2 小时内修复
59
+ 通知范围:服务负责人
60
+
61
+ P3 - 轻微异常(日志报错但不影响用户、数据轻微偏差)
62
+ 响应要求:下一个工作日内处理
63
+ 通知范围:开发团队
64
+ ```
65
+
66
+ ### 1.3 启动 War Room
67
+
68
+ ```bash
69
+ # 创建故障记录
70
+ cat > incident-$(date +%Y%m%d%H%M).md << 'EOF'
71
+ # 故障记录
72
+
73
+ **时间**: YYYY-MM-DD HH:MM
74
+ **定级**: P0/P1/P2/P3
75
+ **现象**: [简述故障表现]
76
+ **影响范围**: [受影响的用户群体和业务功能]
77
+ **当前状态**: 响应中 / 止损中 / 修复中 / 观察中 / 已关闭
78
+
79
+ ## 时间线
80
+ | 时间 | 事件 | 操作人 |
81
+ |------|------|--------|
82
+
83
+ ## 根因
84
+ [待分析]
85
+
86
+ ## 修复方案
87
+ [待确定]
88
+ EOF
89
+ ```
90
+
91
+ ---
92
+
93
+ ## 步骤二:止损(最高优先级)
94
+
95
+ ### 2.1 止损决策树
96
+
97
+ ```
98
+ 故障发生
99
+ ├── 最近有发布?
100
+ │ ├── 是 → 立即回滚到上一个稳定版本
101
+ │ └── 否 → 继续排查
102
+ ├── 流量突增导致?
103
+ │ ├── 是 → 开启限流/降级/熔断
104
+ │ └── 否 → 继续排查
105
+ ├── 第三方依赖故障?
106
+ │ ├── 是 → 切换备用方案/开启缓存兜底
107
+ │ └── 否 → 继续排查
108
+ ├── 数据异常?
109
+ │ ├── 是 → 暂停写入,保护现有数据
110
+ │ └── 否 → 继续排查
111
+ └── 未知原因?
112
+ └── 先降级非核心功能,保护核心链路
113
+ ```
114
+
115
+ ### 2.2 常用止损命令
116
+
117
+ ```bash
118
+ # 版本回滚 - Kubernetes
119
+ kubectl rollout undo deployment/<service-name> -n production
120
+ kubectl rollout status deployment/<service-name> -n production
121
+
122
+ # 版本回滚 - Docker Compose
123
+ docker-compose -f docker-compose.prod.yml pull <service>:<previous-tag>
124
+ docker-compose -f docker-compose.prod.yml up -d <service>
125
+
126
+ # 流量切换 - Nginx
127
+ # 切换到备用上游
128
+ sed -i 's/upstream_primary/upstream_backup/' /etc/nginx/conf.d/upstream.conf
129
+ nginx -t && nginx -s reload
130
+
131
+ # 开启限流 - Redis 令牌桶
132
+ redis-cli SET rate_limit:api:threshold 100 # 每秒100次
133
+ redis-cli SET rate_limit:api:enabled true
134
+
135
+ # 开启降级 - 特性开关
136
+ curl -X PUT http://feature-flags/api/flags/non_critical_features \
137
+ -H "Content-Type: application/json" \
138
+ -d '{"enabled": false}'
139
+
140
+ # 数据库紧急操作 - 阻止有害写入
141
+ # 只在确认有害 SQL 时使用
142
+ mysql -e "SHOW PROCESSLIST;" | grep "harmful_query_pattern"
143
+ mysql -e "KILL <process_id>;"
144
+ ```
145
+
146
+ ### 2.3 止损验证
147
+
148
+ ```bash
149
+ # 验证服务恢复
150
+ for i in {1..10}; do
151
+ STATUS=$(curl -s -o /dev/null -w "%{http_code}" http://api.example.com/health)
152
+ echo "Health check $i: $STATUS"
153
+ sleep 2
154
+ done
155
+
156
+ # 验证核心链路
157
+ curl -s http://api.example.com/api/v1/orders/test | jq '.status'
158
+
159
+ # 验证错误率下降
160
+ curl -s 'http://prometheus:9090/api/v1/query?query=rate(http_errors_total{service="target"}[1m])' | jq '.data.result[0].value[1]'
161
+ ```
162
+
163
+ ---
164
+
165
+ ## 步骤三:根因分析
166
+
167
+ ### 3.1 日志排查
168
+
169
+ ```bash
170
+ # 查看错误日志 - Kubernetes
171
+ kubectl logs -n production deployment/<service> --since=30m | grep -i error | tail -50
172
+
173
+ # 按时间范围查看 - 使用 stern 多 Pod 聚合
174
+ stern <service> -n production --since 30m | grep -E "(ERROR|FATAL|panic)"
175
+
176
+ # Elasticsearch 日志查询
177
+ curl -s 'http://elasticsearch:9200/logs-*/_search' -H 'Content-Type: application/json' -d '{
178
+ "query": {
179
+ "bool": {
180
+ "must": [
181
+ {"range": {"@timestamp": {"gte": "now-30m"}}},
182
+ {"match": {"level": "ERROR"}}
183
+ ]
184
+ }
185
+ },
186
+ "sort": [{"@timestamp": "desc"}],
187
+ "size": 50
188
+ }'
189
+ ```
190
+
191
+ ### 3.2 指标分析
192
+
193
+ ```bash
194
+ # 查看关键指标变化
195
+ # 错误率飙升时间点
196
+ curl -s 'http://prometheus:9090/api/v1/query_range?query=rate(http_errors_total[1m])&start=2024-01-01T00:00:00Z&end=2024-01-01T01:00:00Z&step=60s'
197
+
198
+ # CPU/内存使用率
199
+ curl -s 'http://prometheus:9090/api/v1/query?query=container_cpu_usage_seconds_total{pod=~"service.*"}'
200
+
201
+ # 数据库连接池
202
+ curl -s 'http://prometheus:9090/api/v1/query?query=db_pool_active_connections{service="target"}'
203
+ ```
204
+
205
+ ### 3.3 链路追踪
206
+
207
+ ```bash
208
+ # 查找慢请求的完整链路 (Jaeger)
209
+ curl -s "http://jaeger:16686/api/traces?service=<service>&operation=<endpoint>&minDuration=5s&limit=10"
210
+
211
+ # 通过 trace ID 查看完整链路
212
+ curl -s "http://jaeger:16686/api/traces/<trace-id>"
213
+ ```
214
+
215
+ ### 3.4 五个为什么 (5 Whys)
216
+
217
+ ```markdown
218
+ **现象**: API 返回 500 错误
219
+
220
+ **Why 1**: 数据库查询超时
221
+ **Why 2**: 慢查询未命中索引
222
+ **Why 3**: 新版本代码改变了查询条件,绕过了已有索引
223
+ **Why 4**: Code Review 未覆盖查询计划检查
224
+ **Why 5**: 没有查询性能的自动化门禁
225
+
226
+ **根因**: 缺少查询性能自动化检测机制
227
+ **防复发**: 在 CI 中加入慢查询检测 + 预发布环境自动执行 EXPLAIN
228
+ ```
229
+
230
+ ---
231
+
232
+ ## 步骤四:修复与发布
233
+
234
+ ### 4.1 热修复分支策略
235
+
236
+ ```bash
237
+ # 从生产分支创建热修复分支
238
+ git checkout main
239
+ git pull origin main
240
+ git checkout -b hotfix/incident-20240101-db-timeout
241
+
242
+ # 实施最小修复
243
+ # 原则:只修复问题本身,不做额外改进
244
+
245
+ # 提交
246
+ git add -A
247
+ git commit -m "hotfix: add missing index for order query timeout
248
+
249
+ Incident: INC-2024-001
250
+ Root cause: new query pattern bypassed existing index
251
+ Fix: add composite index on (user_id, created_at, status)"
252
+
253
+ # 推送并创建 PR
254
+ git push origin hotfix/incident-20240101-db-timeout
255
+ gh pr create --title "hotfix: fix order query timeout" \
256
+ --body "Incident: INC-2024-001" \
257
+ --base main --label "hotfix"
258
+ ```
259
+
260
+ ### 4.2 热修复审查原则
261
+
262
+ - 审查范围:仅限于修复相关的变更
263
+ - 审查时间:P0/P1 可以先发布后补审,P2/P3 必须先审后发
264
+ - 审查人数:至少一人,P0 可由 On-call 负责人自审
265
+ - 必须验证:回滚可行性
266
+
267
+ ### 4.3 发布验证
268
+
269
+ ```bash
270
+ # 发布热修复
271
+ kubectl set image deployment/<service> <container>=<image>:<hotfix-tag> -n production
272
+
273
+ # 逐步验证
274
+ echo "Step 1: 健康检查"
275
+ kubectl rollout status deployment/<service> -n production
276
+
277
+ echo "Step 2: 功能验证"
278
+ curl -s http://api.example.com/api/v1/orders?user_id=test | jq '.status'
279
+
280
+ echo "Step 3: 性能验证"
281
+ curl -s 'http://prometheus:9090/api/v1/query?query=histogram_quantile(0.99,rate(http_duration_seconds_bucket{handler="/api/v1/orders"}[5m]))' | jq '.data.result[0].value[1]'
282
+
283
+ echo "Step 4: 错误率验证"
284
+ curl -s 'http://prometheus:9090/api/v1/query?query=rate(http_errors_total{handler="/api/v1/orders"}[5m])' | jq '.data.result[0].value[1]'
285
+ ```
286
+
287
+ ---
288
+
289
+ ## 步骤五:复盘与防复发
290
+
291
+ ### 5.1 复盘模板
292
+
293
+ ```markdown
294
+ # 故障复盘报告
295
+
296
+ ## 基本信息
297
+ - 故障编号: INC-YYYY-NNN
298
+ - 发生时间: YYYY-MM-DD HH:MM ~ HH:MM
299
+ - 影响时长: X 分钟
300
+ - 影响范围: [用户数/交易量/业务功能]
301
+ - 故障等级: P0/P1/P2/P3
302
+
303
+ ## 时间线
304
+ | 时间 | 事件 | 操作人 |
305
+ |------|------|--------|
306
+ | HH:MM | 告警触发 | 系统 |
307
+ | HH:MM | On-call 确认 | 张三 |
308
+ | HH:MM | 止损完成 | 张三 |
309
+ | HH:MM | 根因确认 | 李四 |
310
+ | HH:MM | 修复发布 | 张三 |
311
+ | HH:MM | 全面恢复确认 | 张三 |
312
+
313
+ ## 根因分析
314
+ [使用 5 Whys 方法]
315
+
316
+ ## 修复方案
317
+ [说明修复内容]
318
+
319
+ ## 防复发措施
320
+ | 措施 | 负责人 | 完成时间 | 状态 |
321
+ |------|--------|---------|------|
322
+ | 添加索引性能门禁 | 张三 | 2024-01-15 | 待完成 |
323
+ | 补充慢查询监控 | 李四 | 2024-01-10 | 待完成 |
324
+
325
+ ## 经验教训
326
+ [团队应学到什么]
327
+ ```
328
+
329
+ ### 5.2 24 小时内必须完成
330
+
331
+ - [ ] 热修复代码已合并到 main 和 develop 分支
332
+ - [ ] 补充回归测试覆盖此次故障场景
333
+ - [ ] 更新 Runbook(如果是新的故障模式)
334
+ - [ ] 提交复盘报告
335
+ - [ ] 防复发措施录入任务追踪系统
336
+
337
+ ---
338
+
339
+ ## 回滚方案
340
+
341
+ ### 热修复回滚
342
+
343
+ ```bash
344
+ # 如果热修复引入了新问题,立即回滚
345
+ kubectl rollout undo deployment/<service> -n production
346
+
347
+ # 验证回滚成功
348
+ kubectl rollout status deployment/<service> -n production
349
+ curl -s http://api.example.com/health | jq '.status'
350
+ ```
351
+
352
+ ### 数据回滚
353
+
354
+ ```bash
355
+ # 如果热修复涉及数据变更,先备份再操作
356
+ pg_dump -h db-host -U user -d dbname -t affected_table > backup_before_hotfix.sql
357
+
358
+ # 数据修复后如需回滚
359
+ psql -h db-host -U user -d dbname < backup_before_hotfix.sql
360
+ ```
361
+
362
+ ### 回滚触发条件
363
+
364
+ | 场景 | 阈值 | 处理 |
365
+ |------|------|------|
366
+ | 热修复后错误率上升 | > 修复前水平 | 立即回滚热修复 |
367
+ | 热修复后出现新错误类型 | 任意新 5xx | 立即回滚热修复 |
368
+ | 热修复后性能恶化 | P99 > 修复前 2 倍 | 回滚并重新分析 |
369
+
370
+ ---
371
+
372
+ ## Agent Checklist
373
+
374
+ AI 编码 Agent 在协助故障修复时必须逐项确认:
375
+
376
+ - [ ] **故障定级完成**:已明确 P0/P1/P2/P3 级别和影响范围
377
+ - [ ] **止损优先**:在深入分析前,先确保止损措施到位
378
+ - [ ] **最小修复原则**:热修复仅修复故障本身,不做额外改进
379
+ - [ ] **回滚可行性**:修复方案有明确的回滚步骤和验证方法
380
+ - [ ] **数据安全**:涉及数据变更时先备份
381
+ - [ ] **不跳过审查**:P0 可先发后审,但不能完全跳过
382
+ - [ ] **测试覆盖**:热修复后 24 小时内补充针对性测试
383
+ - [ ] **分支合并**:热修复代码已同步到所有活跃分支
384
+ - [ ] **复盘提交**:故障复盘报告在 48 小时内完成
385
+ - [ ] **防复发跟踪**:所有防复发措施有负责人和截止时间
386
+ - [ ] **Runbook 更新**:新故障模式已补充到 Runbook
387
+ - [ ] **告警优化**:如果此次故障告警不及时,已优化告警规则