@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,484 @@
1
+ ---
2
+ id: mobile-glossary
3
+ title: Mobile Development Glossary
4
+ domain: mobile
5
+ category: 06-glossary
6
+ difficulty: intermediate
7
+ tags: [agent, checklist, glossary, mobile, 术语对比速查表, 概述]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Mobile Development Glossary
12
+
13
+ ## 概述
14
+
15
+ 移动开发术语表涵盖 iOS、Android 和跨平台开发中的核心概念、框架、工具和技术。本术语表按字母顺序排列,每个词条包含定义、平台归属、使用场景和关联术语,适用于移动端开发工程师、技术负责人和全栈工程师。
16
+
17
+ ---
18
+
19
+ ## A
20
+
21
+ ### AAB (Android App Bundle)
22
+
23
+ **定义**:Google 推出的 Android 应用发布格式,替代传统 APK。Google Play 根据用户设备配置(屏幕密度、CPU 架构、语言)动态生成优化后的 APK,减小下载体积。
24
+
25
+ **平台**:Android
26
+
27
+ **关联术语**:APK、Dynamic Delivery、App Thinning
28
+
29
+ ### ABI (Application Binary Interface)
30
+
31
+ **定义**:应用二进制接口,定义了应用与操作系统之间的二进制级别交互规范。Android 常见 ABI:arm64-v8a、armeabi-v7a、x86_64。
32
+
33
+ **平台**:Android / iOS
34
+
35
+ **关联术语**:NDK、Native Module
36
+
37
+ ### ANR (Application Not Responding)
38
+
39
+ **定义**:Android 系统检测到应用主线程被阻塞超过阈值时弹出的无响应对话框。输入事件 5 秒无响应或 BroadcastReceiver 10 秒未完成会触发 ANR。
40
+
41
+ **平台**:Android
42
+
43
+ **解决方案**:将耗时操作移到后台线程,避免主线程 I/O 和复杂计算。
44
+
45
+ **关联术语**:Main Thread、Jank
46
+
47
+ ### APK (Android Package Kit)
48
+
49
+ **定义**:Android 应用的打包分发格式,包含编译后的代码(DEX)、资源文件、清单文件和签名信息。
50
+
51
+ **平台**:Android
52
+
53
+ **关联术语**:AAB、DEX、ProGuard
54
+
55
+ ### App Thinning
56
+
57
+ **定义**:Apple 的应用瘦身技术集合,包括 Slicing(按设备生成变体)、Bitcode(服务端优化编译)和 On-Demand Resources(按需下载资源)。
58
+
59
+ **平台**:iOS
60
+
61
+ **关联术语**:AAB、Bundle Size
62
+
63
+ ### ARC (Automatic Reference Counting)
64
+
65
+ **定义**:Apple 的自动引用计数内存管理机制。编译器自动插入 retain/release 代码管理对象生命周期,开发者需注意循环引用(Retain Cycle)。
66
+
67
+ **平台**:iOS
68
+
69
+ **关联术语**:Retain Cycle、weak/unowned、GC
70
+
71
+ ### ASO (App Store Optimization)
72
+
73
+ **定义**:应用商店优化,提升 App 在搜索结果中排名的策略。优化维度包括标题关键词、图标截图、描述文案、评分评论、下载量和本地化。
74
+
75
+ **平台**:iOS / Android
76
+
77
+ **关联术语**:Bundle Size、Launch Screen
78
+
79
+ ---
80
+
81
+ ## B
82
+
83
+ ### Bridge
84
+
85
+ **定义**:在跨平台框架中,连接 JavaScript/Dart 层与原生平台层的通信机制。React Native 旧架构使用异步 Bridge(JSON 序列化),新架构使用 JSI 实现同步调用。
86
+
87
+ **平台**:跨平台(React Native)
88
+
89
+ **关联术语**:JSI、Turbo Modules、React Native
90
+
91
+ ---
92
+
93
+ ## C
94
+
95
+ ### CocoaPods
96
+
97
+ **定义**:iOS/macOS 的依赖管理工具,使用 Podfile 声明依赖,从中心仓库下载并集成第三方库。正逐渐被 Swift Package Manager 取代。
98
+
99
+ **平台**:iOS
100
+
101
+ **关联术语**:SPM、Gradle
102
+
103
+ ### CodePush
104
+
105
+ **定义**:微软提供的移动端热更新服务,允许 React Native 应用绑定更新 JS Bundle 和资源文件而无需重新提交应用商店审核。
106
+
107
+ **平台**:跨平台(React Native)
108
+
109
+ **注意**:Apple 和 Google 对热更新有政策限制,不允许改变应用核心功能。
110
+
111
+ **关联术语**:OTA、JS Bundle、Expo Updates
112
+
113
+ ### Compose (Jetpack Compose)
114
+
115
+ **定义**:Google 推出的 Android 声明式 UI 框架,使用 Kotlin 代码构建 UI,替代传统 XML 布局。类似 iOS 的 SwiftUI。
116
+
117
+ **平台**:Android
118
+
119
+ **关联术语**:SwiftUI、Flutter、声明式 UI
120
+
121
+ ### Core Data
122
+
123
+ **定义**:Apple 提供的对象图和持久化框架,支持数据建模、查询、关系管理和 iCloud 同步。底层通常使用 SQLite。
124
+
125
+ **平台**:iOS / macOS
126
+
127
+ **关联术语**:Room、Realm、SQLite
128
+
129
+ ### Cross-Platform
130
+
131
+ **定义**:使用同一套代码编译或运行在多个平台(iOS + Android + Web)的开发方式。分为编译型跨平台(Flutter -> 原生代码)和运行时跨平台(React Native -> JSI 调用原生组件)。
132
+
133
+ **关联术语**:React Native、Flutter、KMP
134
+
135
+ ---
136
+
137
+ ## D
138
+
139
+ ### Deep Link
140
+
141
+ **定义**:深度链接,通过 URL 直接打开应用内的特定页面或内容。分为三种类型:URI Scheme(自定义协议)、Universal Links(iOS)、App Links(Android)。
142
+
143
+ **使用场景**:营销推广、跨应用跳转、Web 到 App 引流。
144
+
145
+ **关联术语**:Universal Links、App Links、Deferred Deep Link
146
+
147
+ ### DEX (Dalvik Executable)
148
+
149
+ **定义**:Android 平台上的可执行文件格式,由 Java/Kotlin 字节码转换而来。ART 在安装时将 DEX 编译为本地机器码(AOT 编译)。
150
+
151
+ **平台**:Android
152
+
153
+ **关联术语**:ART、APK、R8
154
+
155
+ ---
156
+
157
+ ## E
158
+
159
+ ### Expo
160
+
161
+ **定义**:React Native 的开发平台和工具链,提供托管的构建服务(EAS Build)、OTA 更新(EAS Update)、推送通知等,简化开发和部署流程。
162
+
163
+ **平台**:跨平台(React Native)
164
+
165
+ **关联术语**:React Native、Metro、EAS
166
+
167
+ ---
168
+
169
+ ## F
170
+
171
+ ### Fabric (React Native New Architecture)
172
+
173
+ **定义**:React Native 新架构中的渲染系统,替代旧架构。核心组件包括 JSI、Turbo Modules、Fabric Renderer 和 Codegen,支持同步渲染和并发特性。
174
+
175
+ **平台**:跨平台(React Native)
176
+
177
+ **关联术语**:Bridge、JSI、Turbo Modules
178
+
179
+ ### FlashList
180
+
181
+ **定义**:Shopify 开源的高性能列表组件,替代 React Native 的 FlatList。通过更好的单元格回收和布局策略显著提升长列表滚动性能。
182
+
183
+ **平台**:跨平台(React Native)
184
+
185
+ **关联术语**:FlatList、RecyclerView、UICollectionView
186
+
187
+ ### Flutter
188
+
189
+ **定义**:Google 开源的跨平台 UI 框架,使用 Dart 语言,自带渲染引擎(Skia/Impeller),不依赖平台原生 UI 组件。UI 一致性高、性能接近原生。
190
+
191
+ **平台**:跨平台
192
+
193
+ **关联术语**:React Native、Dart、Platform Channel
194
+
195
+ ---
196
+
197
+ ## G
198
+
199
+ ### Gradle
200
+
201
+ **定义**:Android 项目的构建工具,使用 Groovy 或 Kotlin DSL 定义构建脚本。管理依赖、编译、打包、签名和发布。
202
+
203
+ **平台**:Android
204
+
205
+ **关联术语**:CocoaPods、SPM、Maven
206
+
207
+ ---
208
+
209
+ ## H
210
+
211
+ ### Hermes
212
+
213
+ **定义**:Meta 为 React Native 优化的 JavaScript 引擎。支持字节码预编译(HBC),启动时间减少 50%+,内存使用减少 30%+。
214
+
215
+ **平台**:跨平台(React Native)
216
+
217
+ **关联术语**:JavaScriptCore、V8、JS Bundle
218
+
219
+ ### Hot Reload
220
+
221
+ **定义**:在不重启应用的情况下实时更新代码变更的开发特性。保留应用状态的同时更新 UI 和逻辑。Flutter 称 Hot Reload,React Native 称 Fast Refresh。
222
+
223
+ **关联术语**:Fast Refresh、CodePush
224
+
225
+ ### Hybrid App
226
+
227
+ **定义**:使用 Web 技术(HTML/CSS/JavaScript)开发核心功能,通过 WebView 容器运行并调用原生能力的应用。代表框架:Ionic、Capacitor。
228
+
229
+ **关联术语**:WebView、PWA、Native App
230
+
231
+ ---
232
+
233
+ ## J
234
+
235
+ ### Jank
236
+
237
+ **定义**:UI 渲染帧率低于目标刷新率(60fps = 16.67ms/帧)导致的视觉卡顿。常见原因:主线程耗时操作、过度绘制、布局嵌套过深。
238
+
239
+ **关联术语**:ANR、FPS、Main Thread
240
+
241
+ ### JSI (JavaScript Interface)
242
+
243
+ **定义**:React Native 新架构中 JavaScript 与 C++ 层的直接通信接口,替代旧的异步 Bridge。允许 JS 同步调用原生方法,消除序列化开销。
244
+
245
+ **平台**:跨平台(React Native)
246
+
247
+ **关联术语**:Bridge、Turbo Modules、Fabric
248
+
249
+ ---
250
+
251
+ ## K
252
+
253
+ ### Kotlin Multiplatform (KMP)
254
+
255
+ **定义**:JetBrains 的跨平台方案,允许在 iOS 和 Android 之间共享 Kotlin 业务逻辑代码,UI 层仍使用各平台原生框架(SwiftUI / Compose)。
256
+
257
+ **关联术语**:Flutter、React Native、Compose Multiplatform
258
+
259
+ ---
260
+
261
+ ## L
262
+
263
+ ### Launch Screen / Splash Screen
264
+
265
+ **定义**:应用启动时显示的初始屏幕。iOS 使用 Storyboard 定义,Android 12+ 引入 SplashScreen API。应展示品牌标识,持续时间尽量短。
266
+
267
+ **关联术语**:Cold Start、App Startup
268
+
269
+ ---
270
+
271
+ ## M
272
+
273
+ ### Mini Program
274
+
275
+ **定义**:运行在超级 App(微信、支付宝、抖音等)内部的轻量应用。使用类 Web 技术开发,在宿主 App 沙箱中运行。无需安装、即用即走,是中国市场特有的移动端形态。
276
+
277
+ **关联术语**:PWA、Hybrid App、WebView
278
+
279
+ ### MMKV
280
+
281
+ **定义**:微信团队开源的高性能键值存储库,基于 mmap 内存映射,读写性能远超 SharedPreferences 和 AsyncStorage。
282
+
283
+ **平台**:Android / iOS / 跨平台
284
+
285
+ **关联术语**:AsyncStorage、SharedPreferences、UserDefaults
286
+
287
+ ---
288
+
289
+ ## N
290
+
291
+ ### NDK (Native Development Kit)
292
+
293
+ **定义**:Android 原生开发工具包,允许使用 C/C++ 编写高性能代码模块。适用于计算密集型任务、游戏引擎和已有 C/C++ 库的集成。
294
+
295
+ **平台**:Android
296
+
297
+ **关联术语**:JNI、ABI、FFI
298
+
299
+ ### Navigation
300
+
301
+ **定义**:应用内页面跳转和路由管理。各平台方案不同:iOS(NavigationStack)、Android(Navigation Component)、React Native(React Navigation / Expo Router)、Flutter(GoRouter)。
302
+
303
+ **关联术语**:Deep Link、Stack Navigation、Tab Navigation
304
+
305
+ ---
306
+
307
+ ## O
308
+
309
+ ### OTA (Over-The-Air) Update
310
+
311
+ **定义**:通过网络推送应用更新,无需经过应用商店审核。React Native 使用 CodePush/Expo Updates,Flutter 使用 Shorebird。仅适用于 JS/Dart 层变更。
312
+
313
+ **关联术语**:CodePush、Expo Updates、Hot Reload
314
+
315
+ ---
316
+
317
+ ## P
318
+
319
+ ### Platform Channel
320
+
321
+ **定义**:Flutter 中 Dart 代码与平台原生代码(Swift/Kotlin)之间的通信机制。支持 MethodChannel(方法调用)、EventChannel(事件流)和 BasicMessageChannel(消息传递)。
322
+
323
+ **平台**:Flutter
324
+
325
+ **关联术语**:Bridge、JSI、FFI
326
+
327
+ ### ProGuard / R8
328
+
329
+ **定义**:Android 代码混淆和优化工具。R8 是 Google 的替代品(默认启用),功能包括代码缩减(Tree Shaking)、混淆和优化。
330
+
331
+ **平台**:Android
332
+
333
+ **关联术语**:DEX、APK、Bundle Size
334
+
335
+ ### Push Notification
336
+
337
+ **定义**:服务器向移动设备推送消息的机制。iOS 使用 APNs,Android 使用 FCM。国内 Android 需适配各厂商推送通道(华为/小米/OPPO/vivo)。
338
+
339
+ **平台**:iOS / Android
340
+
341
+ **关联术语**:APNs、FCM、Local Notification
342
+
343
+ ### PWA (Progressive Web App)
344
+
345
+ **定义**:使用 Web 技术构建的具备原生体验的 Web 应用。核心技术:Service Worker、Web App Manifest、Cache API。优势:无需应用商店、即时更新。劣势:iOS 支持有限。
346
+
347
+ **关联术语**:Hybrid App、Mini Program、WebView
348
+
349
+ ---
350
+
351
+ ## R
352
+
353
+ ### React Native
354
+
355
+ **定义**:Meta 开源的跨平台移动框架,使用 React 和 JavaScript/TypeScript 构建原生应用。UI 组件映射到平台原生视图。新架构包含 JSI + Fabric + Turbo Modules。
356
+
357
+ **关联术语**:Flutter、Expo、Hermes、JSI
358
+
359
+ ### Realm
360
+
361
+ **定义**:MongoDB 旗下的移动端数据库,面向对象的数据模型,支持实时同步和跨平台。比 SQLite 更易用。
362
+
363
+ **平台**:iOS / Android / 跨平台
364
+
365
+ **关联术语**:Core Data、Room、SQLite
366
+
367
+ ### Retain Cycle
368
+
369
+ **定义**:iOS 中两个或多个对象相互强引用导致无法被 ARC 释放的内存泄漏。常见于闭包捕获 self、delegate 和定时器。使用 `weak` 或 `unowned` 修饰解决。
370
+
371
+ **平台**:iOS
372
+
373
+ **关联术语**:ARC、Memory Leak
374
+
375
+ ### Room
376
+
377
+ **定义**:Android Jetpack 提供的 SQLite 抽象层,使用注解定义 Schema,编译时验证 SQL,支持 Flow 响应式数据。
378
+
379
+ **平台**:Android
380
+
381
+ **关联术语**:Core Data、Realm、SQLite
382
+
383
+ ---
384
+
385
+ ## S
386
+
387
+ ### SPM (Swift Package Manager)
388
+
389
+ **定义**:Apple 官方的依赖管理工具,集成在 Xcode 中。逐步替代 CocoaPods 成为 iOS 生态主流方案。
390
+
391
+ **平台**:iOS / macOS
392
+
393
+ **关联术语**:CocoaPods、Gradle
394
+
395
+ ### SwiftUI
396
+
397
+ **定义**:Apple 的声明式 UI 框架,使用 Swift 描述 UI,支持实时预览。iOS 13+ 可用,建议 iOS 15+ 使用以获得完整功能。
398
+
399
+ **平台**:iOS / macOS / watchOS / tvOS
400
+
401
+ **关联术语**:Compose、Flutter、UIKit
402
+
403
+ ---
404
+
405
+ ## T
406
+
407
+ ### TestFlight
408
+
409
+ **定义**:Apple 官方的 Beta 测试分发平台。支持内部测试(25 人)和外部测试(10000 人),外部测试需通过审核。
410
+
411
+ **平台**:iOS
412
+
413
+ **关联术语**:App Signing、App Distribution
414
+
415
+ ### Turbo Modules
416
+
417
+ **定义**:React Native 新架构中的原生模块系统,通过 JSI 实现同步调用,支持懒加载,由 Codegen 自动生成类型安全接口。
418
+
419
+ **平台**:跨平台(React Native)
420
+
421
+ **关联术语**:JSI、Bridge、Fabric
422
+
423
+ ---
424
+
425
+ ## U
426
+
427
+ ### Universal Links / App Links
428
+
429
+ **定义**:平台级深度链接方案。Universal Links(iOS)和 App Links(Android)使用 HTTPS URL,系统根据关联配置决定打开 App 还是浏览器。
430
+
431
+ **平台**:iOS / Android
432
+
433
+ **关联术语**:Deep Link、URI Scheme
434
+
435
+ ---
436
+
437
+ ## W
438
+
439
+ ### WebView
440
+
441
+ **定义**:在原生应用中嵌入的浏览器视图组件。iOS 使用 WKWebView,Android 使用基于 Chromium 的 WebView。性能低于原生渲染,应避免在核心页面大量使用。
442
+
443
+ **关联术语**:Hybrid App、PWA
444
+
445
+ ### Widget
446
+
447
+ **定义**:有两个含义:(1) Flutter 中的 UI 构建块(一切皆 Widget);(2) iOS/Android 桌面小组件(WidgetKit / App Widget),在主屏幕显示应用信息摘要。
448
+
449
+ **平台**:Flutter / iOS / Android
450
+
451
+ **关联术语**:Compose、SwiftUI、WidgetKit
452
+
453
+ ---
454
+
455
+ ## 术语对比速查表
456
+
457
+ | 维度 | iOS | Android | React Native | Flutter |
458
+ |------|-----|---------|-------------|---------|
459
+ | 语言 | Swift / ObjC | Kotlin / Java | JS / TS | Dart |
460
+ | UI 框架 | SwiftUI / UIKit | Compose / XML | RN Components | Flutter Widget |
461
+ | 包管理 | SPM / CocoaPods | Gradle / Maven | npm / yarn | pub |
462
+ | 本地存储 | Core Data / UserDefaults | Room / SharedPreferences | MMKV / AsyncStorage | Hive / sqflite |
463
+ | 推送 | APNs | FCM | Expo Notifications | Firebase Messaging |
464
+ | 深度链接 | Universal Links | App Links | React Navigation | GoRouter |
465
+ | 发布格式 | IPA | AAB / APK | -- | -- |
466
+ | 混淆工具 | -- | R8 / ProGuard | -- | obfuscate flag |
467
+ | Beta 测试 | TestFlight | Firebase App Distribution | -- | -- |
468
+
469
+ ---
470
+
471
+ ## Agent Checklist
472
+
473
+ 以下为 AI Agent 在移动开发项目中使用本术语表的要点:
474
+
475
+ - [ ] 根据项目需求选择技术栈(原生 vs React Native vs Flutter vs KMP)
476
+ - [ ] React Native 项目确认是否启用新架构(JSI + Fabric + Turbo Modules)
477
+ - [ ] 确认 JS 引擎选择(React Native 推荐 Hermes)
478
+ - [ ] 列表组件使用高性能方案(FlashList / RecyclerView / UICollectionView)
479
+ - [ ] 本地存储根据场景选择(键值对用 MMKV,关系数据用 Room/Core Data)
480
+ - [ ] 深度链接使用平台级方案(Universal Links / App Links)而非仅 URI Scheme
481
+ - [ ] Android 发布使用 AAB 格式而非 APK
482
+ - [ ] iOS 注意 ARC 循环引用(闭包中使用 weak self)
483
+ - [ ] 跨平台项目注意原生模块的平台差异和桥接性能
484
+ - [ ] 建立性能监控:启动时间、帧率、内存、崩溃率、ANR 率
@@ -0,0 +1,103 @@
1
+ ---
2
+ id: observability-standards
3
+ title: 可观测性标准(日志/指标/追踪)
4
+ domain: observability
5
+ category: 01-standards
6
+ difficulty: intermediate
7
+ tags: [observability, logging, metrics, tracing, monitoring, alerting, structured-logging, request-id]
8
+ quality_score: 90
9
+ maintainer: platform-team@umadev.com
10
+ last_updated: 2026-06-14
11
+ ---
12
+
13
+ # 可观测性标准(日志 / 指标 / 追踪)
14
+
15
+ ## 三柱可观测性
16
+
17
+ ### 1. 结构化日志
18
+ ```json
19
+ {
20
+ "timestamp": "2024-06-14T10:30:00.123Z",
21
+ "level": "INFO",
22
+ "service": "order-service",
23
+ "requestId": "req_abc123",
24
+ "userId": "usr_xyz",
25
+ "message": "Order created",
26
+ "orderId": "ord_456",
27
+ "amount": 99.50,
28
+ "duration_ms": 45
29
+ }
30
+ ```
31
+
32
+ **必须包含的字段:**
33
+ - `timestamp`(ISO-8601 UTC)
34
+ - `level`(DEBUG / INFO / WARN / ERROR)
35
+ - `requestId`(贯穿整个请求链路)
36
+ - `service`(服务名)
37
+ - `message`(人类可读描述)
38
+
39
+ **日志级别使用:**
40
+ - DEBUG:开发调试(默认关闭)
41
+ - INFO:正常业务流程(订单创建、用户注册)
42
+ - WARN:异常但可恢复(重试成功、降级触发)
43
+ - ERROR:需要人工干预(数据库连接失败、外部 API 超时)
44
+
45
+ ### 2. 指标
46
+ ```
47
+ # RED 指标(每个端点必须)
48
+ http_requests_total{method="GET", path="/api/orders", status="200"} 1500
49
+ http_request_duration_seconds_bucket{path="/api/orders", le="0.1"} 1200
50
+ http_requests_errors_total{path="/api/orders", error="500"} 3
51
+
52
+ # 业务指标
53
+ orders_created_total{plan="pro"} 42
54
+ payment_amount_total{currency="USD"} 4200.50
55
+ ```
56
+
57
+ **关键指标:**
58
+ - **RED**:Rate(请求量)、Errors(错误率)、Duration(延迟分布)
59
+ - **USE**:Utilization(资源使用)、Saturation(饱和度)、Errors(错误)
60
+ - **业务**:注册量、订单量、收入、活跃用户
61
+
62
+ ### 3. 分布式追踪
63
+ ```
64
+ Trace: req_abc123
65
+ ├── span: POST /api/orders (45ms)
66
+ │ ├── span: validate_input (2ms)
67
+ │ ├── span: db.insert_order (15ms)
68
+ │ ├── span: payment.charge (20ms)
69
+ │ └── span: enqueue_notification (1ms)
70
+ ```
71
+
72
+ **追踪头传播:**
73
+ ```http
74
+ traceparent: 00-abcdef1234567890-1234567890-01
75
+ ```
76
+
77
+ ## 告警规则
78
+
79
+ | 指标 | 阈值 | 动作 |
80
+ |------|------|------|
81
+ | 5xx 错误率 | > 1% 持续 5min | PagerDuty P1 |
82
+ | p95 延迟 | > 500ms 持续 10min | PagerDuty P2 |
83
+ | 429 速率限制 | > 100/min 持续 5min | Slack 通知 |
84
+ | 数据库连接池 | > 80% 使用 | Slack 通知 |
85
+ | 磁盘空间 | < 10% 剩余 | PagerDuty P1 |
86
+
87
+ ## 健康检查端点
88
+
89
+ ```json
90
+ GET /api/health
91
+
92
+ {
93
+ "status": "healthy",
94
+ "service": "order-service",
95
+ "version": "2.1.0",
96
+ "uptime": 3600,
97
+ "checks": {
98
+ "database": "ok",
99
+ "redis": "ok",
100
+ "external_api": "degraded"
101
+ }
102
+ }
103
+ ```