@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,578 @@
1
+ ---
2
+ id: rust-complete
3
+ title: Rust语言完整指南
4
+ domain: development
5
+ category: 01-standards
6
+ difficulty: intermediate
7
+ tags: [complete, development, rust, 参考资料, 学习路径, 最佳实践, 核心概念, 概述]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Rust语言完整指南
12
+
13
+ ## 概述
14
+ Rust是一门系统编程语言,专注于安全性、并发性和性能。通过所有权系统保证内存安全,无需垃圾回收器。广泛用于系统编程、WebAssembly、嵌入式开发。
15
+
16
+ ## 核心概念
17
+
18
+ ### 1. 所有权系统
19
+
20
+ **所有权规则**:
21
+ ```rust
22
+ fn main() {
23
+ // 1. 每个值有一个所有者
24
+ let s1 = String::from("hello");
25
+
26
+ // 2. 同一时刻只能有一个所有者
27
+ let s2 = s1; // s1的所有权转移给s2
28
+ // println!("{}", s1); // 错误: s1已失效
29
+
30
+ // 3. 所有者离开作用域时,值被释放
31
+ {
32
+ let s3 = String::from("world");
33
+ } // s3在这里被释放
34
+ }
35
+ ```
36
+
37
+ **借用**:
38
+ ```rust
39
+ fn main() {
40
+ let s = String::from("hello");
41
+
42
+ // 不可变借用(&T)
43
+ let len = calculate_length(&s);
44
+ println!("Length of '{}' is {}", s, len);
45
+
46
+ // 可变借用(&mut T)
47
+ let mut s2 = String::from("hello");
48
+ change(&mut s2);
49
+ println!("{}", s2); // "hello, world"
50
+
51
+ // 借用规则:
52
+ // 1. 可以有多个不可变借用
53
+ let r1 = &s;
54
+ let r2 = &s;
55
+
56
+ // 2. 或一个可变借用
57
+ // let r3 = &mut s; // 错误: 已有不可变借用
58
+ }
59
+
60
+ fn calculate_length(s: &String) -> usize {
61
+ s.len()
62
+ }
63
+
64
+ fn change(s: &mut String) {
65
+ s.push_str(", world");
66
+ }
67
+ ```
68
+
69
+ ### 2. 数据类型
70
+
71
+ **标量类型**:
72
+ ```rust
73
+ fn main() {
74
+ // 整数
75
+ let a: i32 = 42;
76
+ let b: u8 = 255;
77
+
78
+ // 浮点数
79
+ let x: f64 = 3.14;
80
+ let y: f32 = 2.71;
81
+
82
+ // 布尔
83
+ let t: bool = true;
84
+
85
+ // 字符
86
+ let c: char = 'z';
87
+
88
+ // 元组
89
+ let tup: (i32, f64, u8) = (500, 6.4, 1);
90
+ let (x, y, z) = tup;
91
+ let first = tup.0;
92
+
93
+ // 数组(固定长度)
94
+ let arr = [1, 2, 3, 4, 5];
95
+ let first = arr[0];
96
+ }
97
+ ```
98
+
99
+ **结构体**:
100
+ ```rust
101
+ // 基本结构体
102
+ struct User {
103
+ username: String,
104
+ email: String,
105
+ age: u32,
106
+ active: bool,
107
+ }
108
+
109
+ // 创建实例
110
+ let user1 = User {
111
+ email: String::from("alice@example.com"),
112
+ username: String::from("alice"),
113
+ age: 30,
114
+ active: true,
115
+ };
116
+
117
+ // 结构体更新语法
118
+ let user2 = User {
119
+ email: String::from("bob@example.com"),
120
+ ..user1 // 其余字段来自user1
121
+ };
122
+
123
+ // 元组结构体
124
+ struct Point(i32, i32, i32);
125
+ let origin = Point(0, 0, 0);
126
+
127
+ // 单元结构体
128
+ struct AlwaysEqual;
129
+
130
+ // 方法
131
+ impl User {
132
+ // 关联函数(构造器)
133
+ fn new(email: String, username: String) -> Self {
134
+ Self {
135
+ email,
136
+ username,
137
+ age: 0,
138
+ active: true,
139
+ }
140
+ }
141
+
142
+ // 方法
143
+ fn is_adult(&self) -> bool {
144
+ self.age >= 18
145
+ }
146
+
147
+ fn set_age(&mut self, age: u32) {
148
+ self.age = age;
149
+ }
150
+ }
151
+
152
+ // 使用
153
+ let mut user = User::new(
154
+ String::from("alice@example.com"),
155
+ String::from("alice")
156
+ );
157
+ user.set_age(30);
158
+ println!("Is adult: {}", user.is_adult());
159
+ ```
160
+
161
+ **枚举**:
162
+ ```rust
163
+ // 基本枚举
164
+ enum Direction {
165
+ Up,
166
+ Down,
167
+ Left,
168
+ Right,
169
+ }
170
+
171
+ // 带数据的枚举
172
+ enum Message {
173
+ Quit,
174
+ Move { x: i32, y: i32 },
175
+ Write(String),
176
+ ChangeColor(i32, i32, i32),
177
+ }
178
+
179
+ // 使用
180
+ let msg = Message::Move { x: 10, y: 20 };
181
+
182
+ match msg {
183
+ Message::Quit => println!("Quit"),
184
+ Message::Move { x, y } => println!("Move to ({}, {})", x, y),
185
+ Message::Write(text) => println!("Text: {}", text),
186
+ Message::ChangeColor(r, g, b) => println!("Color: ({}, {}, {})", r, g, b),
187
+ }
188
+
189
+ // Option枚举(空值处理)
190
+ fn divide(a: f64, b: f64) -> Option<f64> {
191
+ if b == 0.0 {
192
+ None
193
+ } else {
194
+ Some(a / b)
195
+ }
196
+ }
197
+
198
+ let result = divide(10.0, 2.0);
199
+ match result {
200
+ Some(x) => println!("Result: {}", x),
201
+ None => println!("Cannot divide by zero"),
202
+ }
203
+
204
+ // if let语法
205
+ if let Some(x) = result {
206
+ println!("Result: {}", x);
207
+ }
208
+ ```
209
+
210
+ ### 3. 模式匹配
211
+
212
+ **match表达式**:
213
+ ```rust
214
+ fn main() {
215
+ let number = 13;
216
+
217
+ match number {
218
+ 1 => println!("One"),
219
+ 2 | 3 | 5 | 7 | 11 | 13 => println!("Prime"),
220
+ 13..=19 => println!("Teen"),
221
+ _ => println!("Other"),
222
+ }
223
+
224
+ // 解构
225
+ let point = (3, 5);
226
+ match point {
227
+ (0, 0) => println!("Origin"),
228
+ (0, y) => println!("On Y axis at {}", y),
229
+ (x, 0) => println!("On X axis at {}", x),
230
+ (x, y) => println!("At ({}, {})", x, y),
231
+ }
232
+ }
233
+ ```
234
+
235
+ ### 4. 错误处理
236
+
237
+ **Result<T, E>**:
238
+ ```rust
239
+ use std::fs::File;
240
+ use std::io::ErrorKind;
241
+
242
+ fn main() {
243
+ // 打开文件
244
+ let file_result = File::open("hello.txt");
245
+
246
+ let file = match file_result {
247
+ Ok(file) => file,
248
+ Err(error) => match error.kind() {
249
+ ErrorKind::NotFound => match File::create("hello.txt") {
250
+ Ok(fc) => fc,
251
+ Err(e) => panic!("Problem creating file: {:?}", e),
252
+ },
253
+ other_error => panic!("Problem opening file: {:?}", other_error),
254
+ },
255
+ };
256
+
257
+ // unwrap和expect
258
+ let file = File::open("hello.txt").unwrap();
259
+ let file = File::open("hello.txt").expect("Failed to open hello.txt");
260
+
261
+ // ?运算符
262
+ let file = File::open("hello.txt")?;
263
+ }
264
+
265
+ // 自定义错误类型
266
+ #[derive(Debug)]
267
+ enum MyError {
268
+ Io(std::io::Error),
269
+ Parse(std::num::ParseIntError),
270
+ }
271
+
272
+ fn read_number_from_file(filename: &str) -> Result<i32, MyError> {
273
+ let content = std::fs::read_to_string(filename).map_err(MyError::Io)?;
274
+ let number = content.trim().parse::<i32>().map_err(MyError::Parse)?;
275
+ Ok(number)
276
+ }
277
+ ```
278
+
279
+ ### 5. 泛型和Trait
280
+
281
+ **泛型**:
282
+ ```rust
283
+ // 泛型函数
284
+ fn largest<T: PartialOrd>(list: &[T]) -> &T {
285
+ let mut largest = &list[0];
286
+
287
+ for item in list {
288
+ if item > largest {
289
+ largest = item;
290
+ }
291
+ }
292
+
293
+ largest
294
+ }
295
+
296
+ // 泛型结构体
297
+ struct Point<T> {
298
+ x: T,
299
+ y: T,
300
+ }
301
+
302
+ impl<T> Point<T> {
303
+ fn x(&self) -> &T {
304
+ &self.x
305
+ }
306
+ }
307
+
308
+ // 多个泛型参数
309
+ struct Point2<T, U> {
310
+ x: T,
311
+ y: U,
312
+ }
313
+ ```
314
+
315
+ **Trait**:
316
+ ```rust
317
+ // 定义Trait
318
+ pub trait Summary {
319
+ fn summarize(&self) -> String;
320
+
321
+ // 默认实现
322
+ fn author(&self) -> String {
323
+ String::from("Unknown")
324
+ }
325
+ }
326
+
327
+ // 实现Trait
328
+ pub struct Article {
329
+ pub title: String,
330
+ pub content: String,
331
+ pub author: String,
332
+ }
333
+
334
+ impl Summary for Article {
335
+ fn summarize(&self) -> String {
336
+ format!("{} by {}", self.title, self.author)
337
+ }
338
+ }
339
+
340
+ // Trait作为参数
341
+ fn notify(item: &impl Summary) {
342
+ println!("Breaking news! {}", item.summarize());
343
+ }
344
+
345
+ // Trait bound
346
+ fn notify2<T: Summary>(item: &T) {
347
+ println!("Breaking news! {}", item.summarize());
348
+ }
349
+
350
+ // 多个Trait
351
+ fn notify3(item: &(impl Summary + Display)) {}
352
+
353
+ // where子句
354
+ fn some_function<T, U>(t: &T, u: &U) -> i32
355
+ where
356
+ T: Display + Clone,
357
+ U: Clone + Debug,
358
+ {
359
+ 0
360
+ }
361
+ ```
362
+
363
+ ### 6. 并发
364
+
365
+ **线程**:
366
+ ```rust
367
+ use std::thread;
368
+ use std::time::Duration;
369
+
370
+ fn main() {
371
+ // 创建线程
372
+ let handle = thread::spawn(|| {
373
+ for i in 1..10 {
374
+ println!("Spawned thread: {}", i);
375
+ thread::sleep(Duration::from_millis(1));
376
+ }
377
+ });
378
+
379
+ for i in 1..5 {
380
+ println!("Main thread: {}", i);
381
+ thread::sleep(Duration::from_millis(1));
382
+ }
383
+
384
+ // 等待线程完成
385
+ handle.join().unwrap();
386
+
387
+ // 使用move闭包
388
+ let v = vec![1, 2, 3];
389
+ let handle = thread::spawn(move || {
390
+ println!("Vector: {:?}", v);
391
+ });
392
+ handle.join().unwrap();
393
+ }
394
+ ```
395
+
396
+ **消息传递**:
397
+ ```rust
398
+ use std::sync::mpsc;
399
+ use std::thread;
400
+
401
+ fn main() {
402
+ let (tx, rx) = mpsc::channel();
403
+
404
+ thread::spawn(move || {
405
+ let val = String::from("hi");
406
+ tx.send(val).unwrap();
407
+ });
408
+
409
+ let received = rx.recv().unwrap();
410
+ println!("Got: {}", received);
411
+
412
+ // 多生产者
413
+ let (tx1, rx1) = mpsc::channel();
414
+ let tx2 = tx1.clone();
415
+
416
+ thread::spawn(move || {
417
+ let vals = vec![
418
+ String::from("hi"),
419
+ String::from("from"),
420
+ String::from("the"),
421
+ String::from("thread"),
422
+ ];
423
+
424
+ for val in vals {
425
+ tx1.send(val).unwrap();
426
+ }
427
+ });
428
+
429
+ thread::spawn(move || {
430
+ let vals = vec![
431
+ String::from("more"),
432
+ String::from("messages"),
433
+ ];
434
+
435
+ for val in vals {
436
+ tx2.send(val).unwrap();
437
+ }
438
+ });
439
+
440
+ for received in rx1 {
441
+ println!("Got: {}", received);
442
+ }
443
+ }
444
+ ```
445
+
446
+ **共享状态**:
447
+ ```rust
448
+ use std::sync::{Arc, Mutex};
449
+ use std::thread;
450
+
451
+ fn main() {
452
+ let counter = Arc::new(Mutex::new(0));
453
+ let mut handles = vec![];
454
+
455
+ for _ in 0..10 {
456
+ let counter = Arc::clone(&counter);
457
+ let handle = thread::spawn(move || {
458
+ let mut num = counter.lock().unwrap();
459
+ *num += 1;
460
+ });
461
+ handles.push(handle);
462
+ }
463
+
464
+ for handle in handles {
465
+ handle.join().unwrap();
466
+ }
467
+
468
+ println!("Result: {}", *counter.lock().unwrap());
469
+ }
470
+ ```
471
+
472
+ ## 最佳实践
473
+
474
+ ### ✅ DO
475
+
476
+ 1. **使用clippy检查代码**
477
+ ```bash
478
+ cargo clippy
479
+ ```
480
+
481
+ 2. **使用Result而不是panic**
482
+ ```rust
483
+ // ✅ 好
484
+ fn divide(a: f64, b: f64) -> Result<f64, String> {
485
+ if b == 0.0 {
486
+ Err(String::from("division by zero"))
487
+ } else {
488
+ Ok(a / b)
489
+ }
490
+ }
491
+
492
+ // ❌ 差
493
+ fn divide(a: f64, b: f64) -> f64 {
494
+ if b == 0.0 {
495
+ panic!("division by zero");
496
+ }
497
+ a / b
498
+ }
499
+ ```
500
+
501
+ 3. **使用文档注释**
502
+ ```rust
503
+ /// Adds two numbers.
504
+ ///
505
+ /// # Examples
506
+ /// ```
507
+ /// let result = add(2, 3);
508
+ /// assert_eq!(result, 5);
509
+ /// ```
510
+ fn add(a: i32, b: i32) -> i32 {
511
+ a + b
512
+ }
513
+ ```
514
+
515
+ ### ❌ DON'T
516
+
517
+ 1. **不要过度使用unwrap**
518
+ ```rust
519
+ // ❌ 差
520
+ let file = File::open("file.txt").unwrap();
521
+
522
+ // ✅ 好
523
+ let file = File::open("file.txt")
524
+ .expect("Failed to open file.txt");
525
+ ```
526
+
527
+ 2. **不要忽略错误**
528
+ ```rust
529
+ // ❌ 差
530
+ let _ = dangerous_operation();
531
+
532
+ // ✅ 好
533
+ if let Err(e) = dangerous_operation() {
534
+ eprintln!("Error: {}", e);
535
+ }
536
+ ```
537
+
538
+ ## 学习路径
539
+
540
+ ### 初级 (2-3周)
541
+ 1. 所有权和借用
542
+ 2. 基本数据类型
543
+ 3. 函数和控制流
544
+
545
+ ### 中级 (2-3周)
546
+ 1. 结构体和枚举
547
+ 2. 模式匹配
548
+ 3. 错误处理
549
+
550
+ ### 高级 (2-4周)
551
+ 1. 泛型和Trait
552
+ 2. 并发编程
553
+ 3. 智能指针
554
+
555
+ ### 专家级 (持续)
556
+ 1. 异步编程(async/await)
557
+ 2. unsafe Rust
558
+ 3. 嵌入式开发
559
+
560
+ ## 参考资料
561
+
562
+ ### 官方
563
+ - [Rust官方书籍](https://doc.rust-lang.org/book/)
564
+ - [Rust标准库文档](https://doc.rust-lang.org/std/)
565
+
566
+ ### 社区
567
+ - [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
568
+ - [Rustlings练习](https://github.com/rust-lang/rustlings)
569
+
570
+ ---
571
+
572
+ **知识ID**: `rust-complete`
573
+ **领域**: development
574
+ **类型**: standards
575
+ **难度**: advanced
576
+ **质量分**: 94
577
+ **维护者**: dev-team@umadev.com
578
+ **最后更新**: 2026-03-28