@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,120 @@
1
+ ---
2
+ id: operations-glossary
3
+ title: 运维/SRE 术语表 (Operations & SRE Glossary)
4
+ domain: operations
5
+ category: 06-glossary
6
+ difficulty: intermediate
7
+ tags: [agent, checklist, glossary, operations, 可观测性, 基础设施与架构, 容量与性能, 弹性工程]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 运维/SRE 术语表 (Operations & SRE Glossary)
12
+
13
+ > 收录 50+ 核心运维与 SRE 术语,覆盖 SRE 理念、可观测性、故障管理、弹性工程和架构模式等领域。
14
+ > 适用于 SRE 评审、架构设计、On-Call 培训和团队 Onboarding 等场景。
15
+
16
+ ---
17
+
18
+ ## SRE 核心理念
19
+
20
+ | 术语 | 英文全称 | 定义 |
21
+ |------|---------|------|
22
+ | SRE | Site Reliability Engineering | 由 Google 提出的工程实践,用软件工程方法解决运维问题。SRE 的核心目标是在系统可靠性与开发速度之间找到平衡,通过 SLO、Error Budget、Toil 治理等机制实现量化管理。 |
23
+ | Toil | Toil / 苦差事 | 满足以下全部特征的运维工作:手动的、重复的、可自动化的、战术性的、缺乏持久价值的、随服务增长线性增长的。Google SRE 要求 Toil 占比不超过 50%,其余时间用于工程项目。 |
24
+ | Error Budget | Error Budget / 错误预算 | SLO 允许的不可靠余量。计算公式:`Error Budget = 1 - SLO`。例如 SLO = 99.95% 时,每月允许 21.6 分钟不可用。当 Error Budget 耗尽时,应冻结新功能发布,集中修复稳定性问题。 |
25
+ | SLI | Service Level Indicator | 服务级别指标,量化衡量服务质量的指标。好的 SLI 直接反映用户体验,常见选择:可用性(成功请求比例)、延迟(P50/P95/P99)、正确性(正确响应比例)、吞吐量。 |
26
+ | SLO | Service Level Objective | 服务级别目标,SLI 的目标值。例如"订单服务 P99 延迟 < 500ms,30 天滚动窗口"。SLO 是团队内部的可靠性目标,比 SLA 更严格,违反 SLO 不会产生法律/财务后果但会触发 Error Budget 机制。 |
27
+ | SLA | Service Level Agreement | 服务级别协议,与客户签订的具有法律约束力的可靠性承诺。违反 SLA 通常导致赔偿(如服务积分、退款)。SLA 目标应宽松于内部 SLO,留出缓冲余量。 |
28
+ | Blast Radius | Blast Radius / 爆炸半径 | 故障发生时受影响的范围。SRE 通过故障隔离(分区部署、熔断器、限流)减小 Blast Radius。评估变更风险时,Blast Radius 是关键考量因素。 |
29
+
30
+ ---
31
+
32
+ ## 可观测性
33
+
34
+ | 术语 | 英文全称 | 定义 |
35
+ |------|---------|------|
36
+ | Observability | Observability / 可观测性 | 通过系统外部输出推断系统内部状态的能力。三大支柱:Metrics(指标)、Logs(日志)、Traces(追踪)。可观测性强调"能回答之前没有预料到的问题",而非仅监控已知指标。 |
37
+ | Telemetry | Telemetry / 遥测 | 从系统中自动收集、传输和分析性能数据的过程。包括 Metrics、Logs、Traces 的采集和传输。OpenTelemetry(OTel)是当前主流的遥测标准和 SDK。 |
38
+ | Golden Signals | Golden Signals / 黄金信号 | Google SRE 定义的四个关键监控维度:延迟(Latency)、流量(Traffic)、错误率(Errors)、饱和度(Saturation)。监控这四个信号可以快速判断服务健康状态。 |
39
+ | RED Method | Rate, Errors, Duration | Tom Wilkie 提出的微服务监控方法论:Rate(请求速率)、Errors(错误率)、Duration(请求耗时)。适用于请求驱动的服务,与 Golden Signals 高度重叠但更简洁。 |
40
+ | USE Method | Utilization, Saturation, Errors | Brendan Gregg 提出的资源监控方法论:Utilization(利用率)、Saturation(饱和度/队列深度)、Errors(错误数)。适用于硬件资源(CPU、内存、磁盘、网络)监控。 |
41
+ | Distributed Tracing | Distributed Tracing / 分布式追踪 | 追踪请求在分布式系统中经过的完整路径,记录每个服务/组件的耗时和状态。通过 Trace ID 将跨服务的调用关联起来。工具:Jaeger、Zipkin、Tempo、X-Ray。 |
42
+ | Span | Span / 跨度 | 分布式追踪中的基本单元,代表一个操作(如一次 HTTP 请求、一次数据库查询)。Span 包含:操作名称、开始/结束时间、父 Span ID、标签和日志。多个 Span 组成一个 Trace。 |
43
+ | Cardinality | Cardinality / 基数 | 指标标签的不同值数量。高基数(如 user_id 作为标签)会导致时序数据库存储和查询成本爆炸。监控系统设计时必须控制标签基数,避免"基数爆炸"问题。 |
44
+
45
+ ---
46
+
47
+ ## 故障管理
48
+
49
+ | 术语 | 英文全称 | 定义 |
50
+ |------|---------|------|
51
+ | Incident | Incident / 事故 | 导致服务质量下降或不可用的事件。按影响范围和严重程度分级(P0-P4)。事故管理流程包括:检测、响应、缓解、恢复、复盘。 |
52
+ | Incident Commander | Incident Commander / 事故指挥官 | 重大事故中的总协调人,负责:评估影响范围、分配角色、协调各方、决策升级、控制沟通节奏。IC 不负责具体技术排查,而是确保流程高效运转。 |
53
+ | War Room | War Room / 作战室 | 重大事故期间临时组建的协作空间(物理或虚拟)。所有相关人员集中在 War Room 中,由 Incident Commander 统一协调。规则:聚焦恢复、减少噪声、记录时间线。 |
54
+ | MTTR | Mean Time To Recovery | 平均恢复时间,从故障发生到服务恢复正常的平均耗时。MTTR = 检测时间 + 响应时间 + 修复时间 + 验证时间。是衡量运维效率的核心指标。 |
55
+ | MTTD | Mean Time To Detect | 平均检测时间,从故障发生到被发现的平均耗时。降低 MTTD 的关键:完善的监控覆盖 + 准确的告警规则 + 合理的告警阈值。 |
56
+ | MTBF | Mean Time Between Failures | 平均无故障时间,两次故障之间的平均间隔。MTBF 越长说明系统越稳定。提升 MTBF 的手段:代码质量、架构冗余、Chaos Engineering。 |
57
+ | Postmortem | Postmortem / 事后复盘 | 事故恢复后的结构化回顾过程。内容包括:事故时间线、影响范围、根因分析、修复措施、经验教训和 Action Items。核心原则:Blameless(对事不对人)。 |
58
+ | Blameless | Blameless / 无指责文化 | Postmortem 的核心原则:关注系统和流程的改进,而非追究个人责任。基于认知:人总会犯错,但系统应该有防护措施防止个人错误导致重大事故。 |
59
+ | RCA | Root Cause Analysis | 根因分析,深入挖掘事故背后的根本原因而非表面原因。常用方法:5 Whys(五个为什么)、鱼骨图(Ishikawa Diagram)、故障树分析(FTA)。 |
60
+
61
+ ---
62
+
63
+ ## 弹性工程
64
+
65
+ | 术语 | 英文全称 | 定义 |
66
+ |------|---------|------|
67
+ | Chaos Engineering | Chaos Engineering / 混沌工程 | 通过在生产或类生产环境中主动注入故障,验证系统在不利条件下的行为是否符合预期。遵循科学实验方法:假设 → 实验 → 观察 → 结论。工具:LitmusChaos、Chaos Monkey、Gremlin。 |
68
+ | Game Day | Game Day / 演练日 | 全团队参与的计划性故障演练活动。在受控条件下模拟真实故障场景,验证团队的响应能力和系统的弹性。Game Day 是 Chaos Engineering 从工具到文化的桥梁。 |
69
+ | Circuit Breaker | Circuit Breaker / 熔断器 | 防止故障级联传播的保护机制。当下游服务失败率超过阈值时,熔断器"断开",后续请求直接返回降级响应而不再调用下游。状态:Closed(正常)→ Open(熔断)→ Half-Open(试探)。 |
70
+ | Bulkhead | Bulkhead / 舱壁隔离 | 借鉴船舶设计的故障隔离模式。将系统资源(线程池、连接池、实例)分隔为独立的隔舱,一个隔舱故障不会耗尽其他隔舱的资源。防止一个慢请求拖垮整个系统。 |
71
+ | Rate Limiting | Rate Limiting / 限流 | 限制单位时间内的请求数量,防止过载。常见算法:令牌桶(Token Bucket)、漏桶(Leaky Bucket)、滑动窗口(Sliding Window)。应在 API Gateway 和服务层均实施。 |
72
+ | Graceful Degradation | Graceful Degradation / 优雅降级 | 在系统过载或部分故障时,主动关闭非核心功能以保证核心功能可用。例如:高峰期关闭推荐系统,保证搜索和下单正常工作。 |
73
+ | Backpressure | Backpressure / 背压 | 下游处理能力不足时,向上游发出信号减缓发送速率的机制。防止上游无限制地向下游灌数据导致 OOM 或延迟爆炸。常见实现:消息队列的消费限速、HTTP 429 响应。 |
74
+ | Retry with Backoff | Retry with Exponential Backoff | 请求失败后,以指数递增的间隔进行重试(如 1s → 2s → 4s → 8s),并添加随机抖动(Jitter)避免"重试风暴"。所有重试策略必须设置最大重试次数和总超时。 |
75
+
76
+ ---
77
+
78
+ ## 基础设施与架构
79
+
80
+ | 术语 | 英文全称 | 定义 |
81
+ |------|---------|------|
82
+ | Service Mesh | Service Mesh / 服务网格 | 处理服务间通信的基础设施层,通过 Sidecar Proxy 透明地实现流量管理、安全认证和可观测性。代表实现:Istio、Linkerd、Cilium Service Mesh。 |
83
+ | Sidecar | Sidecar / 边车 | 与主容器一同部署在同一 Pod 中的辅助容器。常见用途:日志采集(Fluentd)、服务网格代理(Envoy)、配置同步。Sidecar 模式实现了关注点分离。 |
84
+ | IaC | Infrastructure as Code | 基础设施即代码,用代码定义和管理基础设施(服务器、网络、数据库等)。工具:Terraform、Pulumi、CloudFormation、Ansible。IaC 确保环境一致性、可审计和可复现。 |
85
+ | Immutable Infrastructure | Immutable Infrastructure / 不可变基础设施 | 基础设施一旦部署不再修改。需要变更时创建新实例替换旧实例。消除配置漂移(Configuration Drift)和"雪花服务器"问题。容器化是不可变基础设施的典型实现。 |
86
+ | Configuration Drift | Configuration Drift / 配置漂移 | 运行中的基础设施状态与声明式配置(IaC 代码)之间逐渐产生偏差的现象。原因:手动修改、紧急修复未同步回代码。检测工具:`terraform plan`、AWS Config。 |
87
+
88
+ ---
89
+
90
+ ## 容量与性能
91
+
92
+ | 术语 | 英文全称 | 定义 |
93
+ |------|---------|------|
94
+ | Capacity Planning | Capacity Planning / 容量规划 | 基于历史数据和增长预测,提前规划系统资源需求的过程。包括:流量预测、资源建模、成本估算和扩容计划。避免过度配置(浪费)和配置不足(宕机)。 |
95
+ | Load Shedding | Load Shedding / 负载卸除 | 系统过载时,主动丢弃部分请求以保证剩余请求的服务质量。策略包括:按优先级丢弃、按超时丢弃(已超过 SLA 的请求直接丢弃)、随机丢弃。 |
96
+ | Thundering Herd | Thundering Herd / 惊群效应 | 大量请求同时到达的现象,常见于:缓存失效后大量请求穿透到数据库、服务重启后积压请求涌入、定时任务同时触发。解决方法:缓存预热、请求排队、随机化触发时间。 |
97
+ | Horizontal Scaling | Horizontal Scaling / 水平扩展 | 通过增加实例数量提升系统处理能力。与垂直扩展(增加单机资源)相比,水平扩展理论上无上限、成本线性增长。前提:应用无状态或状态可外置。 |
98
+
99
+ ---
100
+
101
+ ## 运维流程
102
+
103
+ | 术语 | 英文全称 | 定义 |
104
+ |------|---------|------|
105
+ | Runbook | Runbook / 运维手册 | 针对特定告警或故障场景的标准操作流程文档。内容包括:触发条件、诊断步骤、修复操作、升级路径和验证方法。Runbook 可半自动化或全自动化执行,是降低 MTTR 的关键工具。 |
106
+ | Change Management | Change Management / 变更管理 | 控制生产环境变更的流程,确保变更经过评估、审批、测试和回滚准备后才能执行。变更分级:标准变更(预审批)、普通变更(需审批)、紧急变更(事后补审)。 |
107
+ | Toil Budget | Toil Budget / 苦差事预算 | 团队为 Toil 设定的时间上限(通常不超过总工时的 50%)。超出 Toil Budget 时必须启动自动化项目减少 Toil。Toil Budget 是 SRE 团队保持工程能力的制度保障。 |
108
+ | On-Call | On-Call / 值班 | SRE/运维人员在非工作时间负责响应告警和处理紧急事故的制度。健康的 On-Call 制度包括:轮值排班、升级路径、补偿机制、最大连续值班天数限制和定期回顾。 |
109
+ | War Room Protocol | War Room Protocol / 作战室规程 | 重大事故期间 War Room 的运作规则:IC 统一指挥、每 15 分钟状态同步、沟通限制在指定频道、所有操作记录到时间线、非参与者禁止进入避免干扰。 |
110
+
111
+ ---
112
+
113
+ ## Agent Checklist
114
+
115
+ - [ ] 覆盖所有要求的关键术语:SRE/Toil/Error Budget/Blast Radius/Golden Signals/RED Method/USE Method/Observability/Telemetry/Distributed Tracing/Service Mesh/Chaos Engineering/Game Day/Incident Commander/War Room
116
+ - [ ] 每个术语包含英文全称和中文定义
117
+ - [ ] 术语按领域分组(SRE 核心理念、可观测性、故障管理、弹性工程、基础设施与架构、容量与性能)
118
+ - [ ] 使用统一的表格格式,与现有术语表风格一致
119
+ - [ ] 定义准确、专业,包含实际使用场景和工具推荐
120
+ - [ ] 文件超过 100 行