@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,329 @@
1
+ ---
2
+ id: design-glossary
3
+ title: 设计术语表 (Design Glossary)
4
+ domain: design
5
+ category: 06-glossary
6
+ difficulty: intermediate
7
+ tags: [accessibility, agent, checklist, design, glossary, typography, 响应式与自适应设计, 工具与流程]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 设计术语表 (Design Glossary)
12
+
13
+ > 收录 40+ 核心设计术语,覆盖设计系统、响应式设计、无障碍、排版、工具链等领域。
14
+ > 适用于设计评审、前端开发、设计系统建设、团队协作等场景。
15
+
16
+ ---
17
+
18
+ ## 设计系统与方法论
19
+
20
+ ### Design Token (设计令牌)
21
+
22
+ 设计系统中最小粒度的视觉变量,以键值对形式定义颜色、字号、间距、阴影、圆角等。跨平台通用(Web / iOS / Android),是设计师与开发者之间的单一事实来源。
23
+
24
+ - 格式标准:W3C Design Tokens Format
25
+ - 工具:Style Dictionary(Amazon)、Tokens Studio(Figma 插件)
26
+ - 层级:Global Token → Alias Token → Component Token
27
+ - 示例:`color-primary-600: #1A73E8`、`spacing-md: 16px`、`radius-lg: 12px`
28
+
29
+ 好的 Token 体系使得品牌换肤、暗色模式、多主题切换只需修改一层变量。
30
+
31
+ ### Atomic Design (原子设计)
32
+
33
+ Brad Frost 提出的设计方法论,将 UI 从小到大分为五个层级:
34
+
35
+ 1. **Atoms(原子)**:最基础的 UI 元素,如按钮、输入框、标签、图标
36
+ 2. **Molecules(分子)**:由原子组合而成的简单组件,如搜索栏 = 输入框 + 按钮
37
+ 3. **Organisms(有机体)**:由分子组成的复杂区域,如导航栏、商品卡片列表
38
+ 4. **Templates(模板)**:页面的骨架结构,定义内容区域的布局
39
+ 5. **Pages(页面)**:填充真实数据的最终页面
40
+
41
+ 帮助团队系统化地构建和组织组件,从底层保证一致性。
42
+
43
+ ### Design System (设计系统)
44
+
45
+ 一套可复用的设计原则、组件、模式和工具的集合,确保产品视觉和交互的一致性。完整的设计系统包含:
46
+
47
+ - **Design Token(变量层)**:颜色、字号、间距等基础变量
48
+ - **Component Library(组件层)**:可复用的 UI 组件
49
+ - **Pattern Library(模式层)**:常见交互模式(如表单验证、列表加载、空状态)
50
+ - **设计规范文档**:使用指南、最佳实践、Do & Don't
51
+
52
+ 代表性设计系统:Material Design(Google)、Ant Design(蚂蚁)、Arco Design(字节)、Semi Design(字节)、Carbon(IBM)。
53
+
54
+ ### Component Library (组件库)
55
+
56
+ 预构建的 UI 组件集合,包含样式、交互行为和 API 接口。
57
+
58
+ - 设计侧在 Figma 中维护组件库(含 Variants 变体)
59
+ - 开发侧在代码中维护对应实现(React / Vue / Angular)
60
+ - 两侧应保持同步(Design-Code Parity)
61
+ - 每个组件应有完整的 Props/Variants 和使用文档
62
+
63
+ 好的组件库减少重复工作、保证一致性、降低维护成本。
64
+
65
+ ### Design Handoff (设计交付)
66
+
67
+ 设计师将设计稿交付给开发团队的流程和产物:
68
+
69
+ - **标注**:间距、颜色(Token 名)、字号、行高
70
+ - **切图**:图标(SVG)、图片(PNG/WebP)
71
+ - **交互说明**:状态转换、动画参数、手势操作
72
+ - **响应式行为**:不同断点下的布局变化
73
+ - **边界情况**:超长文本、极端数据、权限差异
74
+
75
+ 工具:Figma Dev Mode、Zeplin。好的 Handoff 减少沟通成本和还原偏差。
76
+
77
+ ---
78
+
79
+ ## 响应式与自适应设计
80
+
81
+ ### Responsive Design (响应式设计)
82
+
83
+ 使用流式布局(Fluid Layout)、弹性媒体和媒体查询(Media Query),让同一套代码在不同屏幕尺寸上自动调整布局和样式。
84
+
85
+ 核心理念:内容驱动断点,而非设备驱动断点。优先 Mobile First 策略(从小屏开始设计,逐步增强)。
86
+
87
+ 技术基础:CSS Flexbox、CSS Grid、Media Query、相对单位(rem / vw / %)。
88
+
89
+ ### Adaptive Design (自适应设计)
90
+
91
+ 为不同屏幕尺寸设计多套固定布局,通过服务端或客户端检测设备后返回对应版本。
92
+
93
+ 与 Responsive 的区别:
94
+ - **Responsive**:一套代码流式适配所有尺寸
95
+ - **Adaptive**:多套代码分别适配不同尺寸
96
+
97
+ Adaptive 在性能和体验上可能更优(每套代码更精简),但维护成本更高。实践中两者常结合使用。
98
+
99
+ ### Breakpoint (断点)
100
+
101
+ 媒体查询中触发布局变化的屏幕宽度阈值。常见断点配置:
102
+
103
+ - **Mobile**:< 768px(单列布局)
104
+ - **Tablet**:768px - 1024px(双列布局)
105
+ - **Desktop**:1024px - 1440px(三列/侧边栏布局)
106
+ - **Wide Desktop**:> 1440px(最大宽度限制,内容居中)
107
+
108
+ 原则:应根据内容需要设置断点,而非固定的设备宽度。当布局在某个宽度"看起来不对"时,就是需要断点的地方。
109
+
110
+ ### Grid System (栅格系统)
111
+
112
+ 将页面水平划分为等宽列(Column)和间距(Gutter),用于对齐和组织内容:
113
+
114
+ - **12 列栅格**:Bootstrap、最通用,可被 2/3/4/6 整除
115
+ - **24 列栅格**:Ant Design,更精细的布局控制
116
+ - 参数:列数(Columns)、列宽(Column Width)、间距(Gutter)、边距(Margin)
117
+
118
+ 响应式栅格在不同断点调整列数:Mobile 4 列 → Tablet 8 列 → Desktop 12 列。
119
+
120
+ ### Fluid Layout (流式布局)
121
+
122
+ 使用百分比、vw/vh、flex、grid 等相对单位定义宽度,使布局在断点之间也能平滑缩放。与固定布局(Fixed Layout,像素定宽)相对。是 Responsive Design 的基础技术。
123
+
124
+ ### Container Query (容器查询)
125
+
126
+ CSS 新特性,允许组件根据其父容器的尺寸(而非视窗尺寸)调整样式。使组件真正可复用:同一组件放在侧边栏(300px 宽)和主内容区(800px 宽)可自动适配不同宽度。
127
+
128
+ ```css
129
+ @container (min-width: 400px) {
130
+ .card { flex-direction: row; }
131
+ }
132
+ ```
133
+
134
+ ---
135
+
136
+ ## 无障碍设计 (Accessibility)
137
+
138
+ ### A11y (Accessibility 的缩写)
139
+
140
+ "A" + 中间 11 个字母 + "y" 的数字缩写。指确保产品可被所有人使用,包括视觉、听觉、运动和认知障碍用户。不仅是道德责任,在许多国家也是法律要求(ADA、EU Directive 2016/2102、中国《信息无障碍规范》)。
141
+
142
+ 全球约 15% 的人口有某种形式的残障,无障碍设计同时也改善了所有用户的体验(如高对比度在阳光下更易读)。
143
+
144
+ ### WCAG (Web Content Accessibility Guidelines)
145
+
146
+ W3C 发布的 Web 内容无障碍指南,当前版本 WCAG 2.2。定义三个合规级别:
147
+
148
+ - **A(基本)**:最低要求,如图片有替代文字
149
+ - **AA(推荐)**:大多数法规要求的级别
150
+ - **AAA(最高)**:最严格,适合政府和教育网站
151
+
152
+ 四大原则(POUR):
153
+ 1. **可感知 (Perceivable)**:信息可通过多种感官获取
154
+ 2. **可操作 (Operable)**:界面可通过多种方式操作
155
+ 3. **可理解 (Understandable)**:内容和操作易于理解
156
+ 4. **健壮 (Robust)**:与辅助技术兼容
157
+
158
+ ### Color Contrast (颜色对比度)
159
+
160
+ 前景色与背景色之间的亮度比值。WCAG AA 要求:
161
+
162
+ - **正文文字**:对比度 >= 4.5:1
163
+ - **大文字**(>= 18pt 或 14pt 粗体):对比度 >= 3:1
164
+ - **UI 组件和图形**:对比度 >= 3:1
165
+
166
+ 工具:Stark(Figma 插件)、Colour Contrast Analyser、Chrome DevTools、WebAIM Contrast Checker。
167
+
168
+ ### Screen Reader (屏幕阅读器)
169
+
170
+ 将屏幕内容转换为语音或盲文输出的辅助技术:
171
+
172
+ - **VoiceOver**:macOS / iOS 内置
173
+ - **NVDA**:Windows 免费开源
174
+ - **JAWS**:Windows 商用
175
+ - **TalkBack**:Android 内置
176
+
177
+ 开发者需确保:语义化 HTML、正确的 ARIA 属性、合理的焦点管理、有意义的替代文字。
178
+
179
+ ### ARIA (Accessible Rich Internet Applications)
180
+
181
+ W3C 定义的一组 HTML 属性,用于增强动态 Web 内容的无障碍性:
182
+
183
+ - `role`:定义元素的语义角色(如 `role="dialog"`)
184
+ - `aria-label`:提供替代文字(如图标按钮)
185
+ - `aria-expanded`:标识展开/折叠状态
186
+ - `aria-live`:标记动态内容区域,变化时通知屏幕阅读器
187
+ - `aria-hidden`:对辅助技术隐藏装饰性元素
188
+
189
+ 核心原则:能用原生 HTML 语义的就不用 ARIA("No ARIA is better than bad ARIA")。
190
+
191
+ ### Focus Management (焦点管理)
192
+
193
+ 控制键盘焦点的位置和顺序,确保用户可以通过 Tab 键导航所有可交互元素。
194
+
195
+ 关键场景:
196
+ - 弹窗打开时焦点移入弹窗,关闭时焦点回到触发元素
197
+ - SPA 路由切换时焦点归位到页面顶部或主内容区
198
+ - 焦点不应进入视觉隐藏的元素
199
+ - 焦点环(Focus Ring)必须可见(不要 `outline: none` 不加替代)
200
+
201
+ ---
202
+
203
+ ## 排版 (Typography)
204
+
205
+ ### Typography Scale (字体比例尺)
206
+
207
+ 一组基于数学比例关系的字号序列,确保页面文字层级和谐。常用比例:
208
+
209
+ - **Minor Second (1.067)**:极紧凑,适合空间受限场景
210
+ - **Major Third (1.25)**:中等,适合大多数 Web 应用
211
+ - **Perfect Fourth (1.333)**:较松散,适合内容型网站
212
+ - **Golden Ratio (1.618)**:视觉张力强,适合标题突出的设计
213
+
214
+ 示例(基准 16px,比例 1.25):12px → 16px → 20px → 25px → 31px → 39px。
215
+
216
+ 工具:Type Scale (typescale.com)。
217
+
218
+ ### Line Height (行高)
219
+
220
+ 文本行与行之间的垂直间距:
221
+
222
+ - **正文**:行高 1.5 - 1.75 倍字号
223
+ - **标题**:行高 1.1 - 1.3 倍字号
224
+ - **紧凑列表**:行高 1.3 - 1.5 倍字号
225
+
226
+ CSS 中使用无单位值(如 `line-height: 1.5`)以确保与字号成比例。行高过小影响可读性(特别是中文),过大导致段落松散失去凝聚力。
227
+
228
+ ### Font Pairing (字体搭配)
229
+
230
+ 选择两种及以上字体组合使用:
231
+
232
+ - 通常一种用于标题(Display / Serif),一种用于正文(Sans-serif)
233
+ - 原则:对比明显但风格协调
234
+ - 同一字体家族的不同粗细也是有效搭配
235
+ - 避免使用超过 3 种字体(增加视觉噪音和加载时间)
236
+
237
+ 中文推荐:思源黑体(正文)+ 思源宋体(标题),或系统字体栈。
238
+
239
+ ### Variable Font (可变字体)
240
+
241
+ 单个字体文件包含多个可变轴(粗细 / 宽度 / 光学大小 / 倾斜等),通过 CSS `font-variation-settings` 控制。
242
+
243
+ 相比传统方式加载多个字重文件(Regular + Medium + Bold + ...),可变字体大幅减少网络请求和文件体积。代表:Inter、Source Sans 3、Noto Sans SC。
244
+
245
+ ---
246
+
247
+ ## 工具与流程
248
+
249
+ ### Figma
250
+
251
+ 基于浏览器的协作设计工具,支持实时多人编辑。核心功能:
252
+
253
+ - **Auto Layout**:类似 CSS Flexbox 的自动布局
254
+ - **Components & Variants**:组件与变体管理
255
+ - **Design Tokens**:通过插件(Tokens Studio)管理变量
256
+ - **Prototyping**:交互原型,支持 Smart Animate
257
+ - **Dev Mode**:开发标注和代码生成
258
+
259
+ 是当前主流的 UI 设计工具,替代了 Sketch + InVision 的组合。
260
+
261
+ ### Storybook
262
+
263
+ 开源的 UI 组件开发和文档工具。在隔离环境中开发、测试和展示组件:
264
+
265
+ - 通过 Stories 展示组件的不同状态和变体
266
+ - 支持 React / Vue / Angular / Web Components 等框架
267
+ - 插件生态:视觉回归测试(Chromatic)、无障碍检查(a11y addon)、交互测试(play function)
268
+ - 自动生成组件文档
269
+
270
+ 是组件驱动开发(Component-Driven Development)的核心工具。
271
+
272
+ ### Design Lint (设计检查)
273
+
274
+ 自动检测设计稿中不符合规范的元素:
275
+
276
+ - 硬编码颜色值(非 Token 引用)
277
+ - 间距不对齐网格
278
+ - 未使用设计系统中的组件
279
+ - 字号不在 Typography Scale 中
280
+ - 圆角值不一致
281
+
282
+ 类似代码中的 ESLint。工具:Figma Design Lint 插件、Stylelint(CSS 层面)。在设计评审前运行,减少人工检查成本。
283
+
284
+ ### Design Sprint (设计冲刺)
285
+
286
+ Google Ventures 提出的 5 天设计方法论:
287
+
288
+ - **Day 1**:理解问题(用户/业务/技术约束)
289
+ - **Day 2**:发散方案(Sketch 多种解决方案)
290
+ - **Day 3**:决策(投票选择最佳方案)
291
+ - **Day 4**:制作原型(高保真可点击原型)
292
+ - **Day 5**:用户测试(5 位用户验证)
293
+
294
+ 适合在短时间内验证设计方向的可行性,减少大规模投入前的风险。
295
+
296
+ ### User Flow (用户流程图)
297
+
298
+ 用图示描述用户完成特定目标的步骤序列,包括页面/状态节点和操作/条件连线。帮助设计师和开发理解全局交互路径,发现遗漏的分支和异常场景。
299
+
300
+ 工具:FigJam、Miro、draw.io、Whimsical。
301
+
302
+ ### Wireframe (线框图)
303
+
304
+ 低保真度的页面结构草图,关注信息架构和布局,不含颜色、字体、图片细节。用于快速沟通设计方向、验证信息层级,成本低、迭代快。线框图确认后再进入高保真设计阶段。
305
+
306
+ ### Mockup (视觉稿)
307
+
308
+ 高保真度的静态设计稿,包含完整的颜色、字体、图片和细节。是设计评审和开发实现的主要依据。通常在 Figma 中制作,与设计系统组件关联。
309
+
310
+ ### Prototype (交互原型)
311
+
312
+ 可点击的交互演示,模拟用户操作流程。从低保真(可点击线框图)到高保真(接近真实交互的动画和状态)。用途:可用性测试、利益相关者演示、开发沟通。
313
+
314
+ Figma Prototype 支持:过渡动画、Smart Animate、条件逻辑、变量控制。
315
+
316
+ ---
317
+
318
+ ## Agent Checklist
319
+
320
+ - [ ] Design Token 已定义覆盖颜色、字号、间距、阴影、圆角
321
+ - [ ] 组件库遵循 Atomic Design 分层(原子/分子/有机体)
322
+ - [ ] Typography Scale 使用一致的数学比例
323
+ - [ ] 响应式设计覆盖至少 3 个断点(Mobile / Tablet / Desktop)
324
+ - [ ] 颜色对比度符合 WCAG AA 标准(正文 >= 4.5:1)
325
+ - [ ] 焦点管理和键盘导航已在设计中考虑
326
+ - [ ] ARIA 属性正确使用,优先原生 HTML 语义
327
+ - [ ] Storybook 覆盖所有组件的核心状态和变体
328
+ - [ ] 设计交付物(标注/切图/交互说明)完整
329
+ - [ ] Design Lint 在评审前运行无违规