@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,378 @@
1
+ ---
2
+ id: design-antipatterns
3
+ title: Design Antipatterns
4
+ domain: design
5
+ category: 04-antipatterns
6
+ difficulty: intermediate
7
+ tags: [antipatterns, chaos, design, excess, look, neglect, overload, template]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Design Antipatterns
12
+
13
+ ## 概述
14
+
15
+ 设计反模式(Design Antipatterns)是在产品设计过程中反复出现的、看似合理但实际上会损害用户体验和产品质量的做法。识别并规避这些反模式能够帮助团队避免常见陷阱,提升设计决策质量。本文档分为六大类别:信息过载、导航混乱、不一致性、忽略无障碍、过度动效和 AI 模板感。
16
+
17
+ ---
18
+
19
+ ## 一、信息过载(Information Overload)
20
+
21
+ ### 1.1 厨房水槽式界面
22
+
23
+ **表现**:单个页面/屏幕试图展示所有功能和信息,没有层级优先。
24
+
25
+ **为什么看似合理**:希望用户一眼看到所有功能,减少点击。
26
+
27
+ **实际危害**:
28
+ - 用户认知负担过重,决策瘫痪
29
+ - 关键信息被淹没,核心任务完成率下降
30
+ - 页面加载慢,首屏渲染时间长
31
+
32
+ **修正方案**:
33
+ - 使用渐进式披露(Progressive Disclosure),分层呈现信息
34
+ - 按使用频率排列:高频 > 中频 > 低频
35
+ - 遵循"5-7 规则":单个视觉区域内选项不超过 7 个
36
+ - 使用 Tab / Accordion / 分步向导拆分内容
37
+
38
+ ### 1.2 数据表格地狱
39
+
40
+ **表现**:将所有字段塞进一个宽表格,用户需要横向滚动。
41
+
42
+ **实际危害**:
43
+ - 移动端完全不可用
44
+ - 用户无法聚焦关键数据列
45
+ - 数据比较困难
46
+
47
+ **修正方案**:
48
+ - 默认显示 5-7 个核心列,其余通过列选择器配置
49
+ - 移动端将行转为卡片布局
50
+ - 提供筛选/排序/搜索替代全量展示
51
+ - 关键指标通过图表可视化
52
+
53
+ ### 1.3 通知轰炸
54
+
55
+ **表现**:所有系统事件都以弹窗/Toast/红点形式通知用户。
56
+
57
+ **实际危害**:
58
+ - 用户产生"通知疲劳",开始忽略所有提示
59
+ - 真正重要的通知被淹没
60
+ - 干扰用户当前任务流
61
+
62
+ **修正方案**:
63
+ - 通知分级:Critical(弹窗)、Important(Toast)、Info(通知中心)
64
+ - 允许用户自定义通知偏好
65
+ - 合并同类通知("你有 3 条新消息"而非 3 个独立弹窗)
66
+ - 非紧急通知进入通知中心而非打断用户
67
+
68
+ ---
69
+
70
+ ## 二、导航混乱(Navigation Chaos)
71
+
72
+ ### 2.1 深层嵌套导航
73
+
74
+ **表现**:用户需要 5 次以上点击才能到达目标页面,导航层级超过 3 层。
75
+
76
+ **实际危害**:
77
+ - 用户迷失位置感,不知道自己在哪里
78
+ - 返回路径不清晰,无法快速切换
79
+ - SEO 爬虫难以到达深层页面
80
+
81
+ **修正方案**:
82
+ - 导航层级控制在 3 层以内
83
+ - 提供面包屑导航(Breadcrumb)
84
+ - 关键页面支持快捷入口或搜索直达
85
+ - 扁平化信息架构,合并相似层级
86
+
87
+ ### 2.2 隐藏的汉堡菜单综合症
88
+
89
+ **表现**:桌面端也把主导航藏在汉堡菜单里,页面看起来"干净"。
90
+
91
+ **实际危害**:
92
+ - 导航可发现性降低 50%+
93
+ - 用户必须多一次点击才能看到选项
94
+ - 新用户不知道系统有哪些功能
95
+
96
+ **修正方案**:
97
+ - 桌面端使用可见的顶部导航或侧边栏
98
+ - 汉堡菜单仅用于移动端空间受限场景
99
+ - 即使使用汉堡菜单,也保留 2-3 个高频入口可见
100
+
101
+ ### 2.3 不一致的返回逻辑
102
+
103
+ **表现**:有时返回到列表页,有时返回到首页,有时返回到上一个操作步骤。
104
+
105
+ **实际危害**:
106
+ - 用户对"返回"按钮行为无法预期
107
+ - 操作中断后无法恢复
108
+ - 移动端尤为致命,因为用户重度依赖返回手势
109
+
110
+ **修正方案**:
111
+ - 明确定义返回逻辑:返回 = 浏览历史中的上一页
112
+ - 分步流程中"返回"回到上一步,"关闭"回到起始页
113
+ - 提供面包屑作为辅助导航手段
114
+ - 测试用户的心理模型是否与实际行为一致
115
+
116
+ ---
117
+
118
+ ## 三、不一致性(Inconsistency)
119
+
120
+ ### 3.1 按钮风格不统一
121
+
122
+ **表现**:同一个产品中按钮有 5 种以上样式,圆角、大小、颜色各不相同。
123
+
124
+ **实际危害**:
125
+ - 用户无法通过视觉快速识别可操作元素
126
+ - 品牌感破碎,产品显得业余
127
+ - 维护成本高,每个页面都是一次性设计
128
+
129
+ **修正方案**:
130
+ - 定义按钮系统:Primary / Secondary / Tertiary / Ghost / Danger
131
+ - 每种按钮有 3 个尺寸:Small / Medium / Large
132
+ - 所有按钮使用统一圆角和字重
133
+ - 建立组件库并强制使用
134
+
135
+ ### 3.2 间距随机
136
+
137
+ **表现**:组件之间的间距凭感觉设定,7px、13px、22px 等非标准值随意出现。
138
+
139
+ **实际危害**:
140
+ - 页面视觉节奏混乱
141
+ - 开发还原困难,每个间距都要量
142
+ - 修改时牵一发动全身
143
+
144
+ **修正方案**:
145
+ - 使用 4px/8px 基准网格(spacing scale: 4/8/12/16/24/32/48/64)
146
+ - Design Token 中固定间距值
147
+ - Auto Layout 强制约束
148
+ - Code Review 中检查间距是否引用 Token
149
+
150
+ ### 3.3 交互模式不统一
151
+
152
+ **表现**:删除操作有时需二次确认,有时直接执行;有时用 Modal,有时用 Toast。
153
+
154
+ **实际危害**:
155
+ - 用户无法建立操作心理模型
156
+ - 误操作风险高
157
+ - 新功能设计无章可循
158
+
159
+ **修正方案**:
160
+ - 建立交互模式库:确认 / 通知 / 错误 / 引导 / 加载
161
+ - 定义每种模式的触发条件和展现形式
162
+ - 破坏性操作统一使用二次确认
163
+ - 成功反馈统一使用 Toast(非 Modal)
164
+
165
+ ---
166
+
167
+ ## 四、忽略无障碍(Accessibility Neglect)
168
+
169
+ ### 4.1 颜色是唯一信息通道
170
+
171
+ **表现**:用红色/绿色区分状态,无其他视觉提示。
172
+
173
+ **实际危害**:
174
+ - 色盲用户(男性约 8%)完全无法获取信息
175
+ - 低对比度屏幕上信息丢失
176
+ - 打印时状态信息消失
177
+
178
+ **修正方案**:
179
+ - 颜色 + 图标 + 文字标签三重编码
180
+ - 使用形状差异辅助(实心圆 vs 空心圆)
181
+ - 确保仅黑白模式下信息仍可理解
182
+ - 使用色盲模拟器(如 Stark 插件)验证
183
+
184
+ ### 4.2 对比度不足
185
+
186
+ **表现**:浅灰色文字在白色背景上,设计师觉得"高级"。
187
+
188
+ **实际危害**:
189
+ - WCAG AA 不达标,可能面临法律风险
190
+ - 阳光下/低亮度下不可读
191
+ - 老年用户群体流失
192
+
193
+ **修正方案**:
194
+ - 正文对比度 >= 4.5:1,大字 >= 3:1
195
+ - 使用 WebAIM 对比度检查器验证
196
+ - 最浅的正文灰色不低于 #595959(在白底上)
197
+ - 占位文本颜色也需可读
198
+
199
+ ### 4.3 仅鼠标可用
200
+
201
+ **表现**:所有交互仅通过鼠标 hover 和 click 触发,无键盘支持。
202
+
203
+ **实际危害**:
204
+ - 键盘用户完全无法操作
205
+ - 屏幕阅读器用户无法使用
206
+ - 触摸设备上 hover 效果不可达
207
+
208
+ **修正方案**:
209
+ - 所有交互元素可 Tab 聚焦
210
+ - 焦点样式清晰可见(不要 `outline: none` 无替代)
211
+ - 下拉菜单支持方向键导航
212
+ - Modal 支持 Esc 关闭和焦点陷阱
213
+
214
+ ---
215
+
216
+ ## 五、过度动效(Motion Excess)
217
+
218
+ ### 5.1 入场动画阻塞
219
+
220
+ **表现**:页面加载时所有元素依次飞入,用户等待 2-3 秒才能操作。
221
+
222
+ **实际危害**:
223
+ - 首次访问体验差,用户可能在动画完成前离开
224
+ - 重复访问时动画变成干扰
225
+ - 移动端性能受损,低端设备卡顿
226
+
227
+ **修正方案**:
228
+ - 首屏内容立即可见,动画仅作为增强
229
+ - 入场动画总时长 < 600ms
230
+ - 仅对首次进入的用户播放完整动画
231
+ - 尊重 `prefers-reduced-motion` 媒体查询
232
+
233
+ ### 5.2 不必要的加载动画
234
+
235
+ **表现**:数据已就绪但仍展示 skeleton/spinner 以"显得在加载"。
236
+
237
+ **实际危害**:
238
+ - 人为增加等待时间
239
+ - 用户信任度下降
240
+ - 违背"系统应尽快响应"原则
241
+
242
+ **修正方案**:
243
+ - 数据 < 200ms 返回时不显示 Loading
244
+ - 200-1000ms 显示简单 spinner
245
+ - > 1000ms 使用 skeleton screen
246
+ - 永远不人为延迟已就绪的内容
247
+
248
+ ### 5.3 视差滚动滥用
249
+
250
+ **表现**:每个页面都有多层视差效果、滚动触发动画和固定背景。
251
+
252
+ **实际危害**:
253
+ - 晕动症用户不适(前庭功能障碍)
254
+ - 移动端帧率暴跌
255
+ - 内容可读性下降,用户注意力分散
256
+
257
+ **修正方案**:
258
+ - 视差效果仅用于营销着陆页,功能页不使用
259
+ - 滚动动画不影响内容可读性
260
+ - 提供 `prefers-reduced-motion` 替代版本
261
+ - 动画性能测试在低端设备上通过
262
+
263
+ ---
264
+
265
+ ## 六、AI 模板感(AI Template Look)
266
+
267
+ ### 6.1 紫色渐变综合症
268
+
269
+ **表现**:深紫→蓝紫渐变背景、发光边框、半透明毛玻璃卡片堆砌。
270
+
271
+ **为什么会出现**:AI 工具生成的默认主题偏好紫色渐变和科技感。
272
+
273
+ **实际危害**:
274
+ - 产品与数千个 AI 生成的网站看起来一模一样
275
+ - 无品牌辨识度
276
+ - 用户直觉判断为"不可信"或"低质量"
277
+
278
+ **修正方案**:
279
+ - 使用品牌自有配色方案
280
+ - 如无品牌色,选择非紫色系主色(蓝、绿、橙、红)
281
+ - 避免大面积渐变,使用纯色 + 微妙纹理
282
+ - 视觉差异化通过排版和布局而非颜色花样
283
+
284
+ ### 6.2 Emoji 替代图标
285
+
286
+ **表现**:用 emoji(🚀🔥💡✨)替代专业设计的图标系统。
287
+
288
+ **实际危害**:
289
+ - 跨平台 emoji 渲染不一致
290
+ - 无法控制大小、颜色、风格
291
+ - 产品显得临时和不专业
292
+
293
+ **修正方案**:
294
+ - 使用统一的图标库(Lucide / Phosphor / Heroicons)
295
+ - 图标与品牌调性匹配(线性 vs 填充)
296
+ - 如需装饰元素,使用定制插画而非 emoji
297
+ - 图标可通过 CSS 控制颜色和尺寸
298
+
299
+ ### 6.3 默认字体堆砌
300
+
301
+ **表现**:仅使用 system-ui / Arial / sans-serif,全站无字体层次。
302
+
303
+ **实际危害**:
304
+ - 视觉单调,缺乏品牌感
305
+ - 标题与正文无明确区分
306
+ - 与操作系统默认界面混淆
307
+
308
+ **修正方案**:
309
+ - 至少引入一个品牌字体用于标题
310
+ - 中文推荐:思源黑体 / 苍耳字体 / 阿里普惠体
311
+ - 英文推荐:Inter / Plus Jakarta Sans / DM Sans
312
+ - 定义完整的排版系统:标题字体 + 正文字体 + 等宽字体
313
+
314
+ ### 6.4 千篇一律的 Hero 区域
315
+
316
+ **表现**:大标题 + 副标题 + CTA 按钮 + 抽象 3D 图形,所有页面 Hero 几乎相同。
317
+
318
+ **实际危害**:
319
+ - 无法传达具体价值主张
320
+ - 用户略过 Hero 直接滚动到内容区
321
+ - 浪费最有价值的首屏空间
322
+
323
+ **修正方案**:
324
+ - Hero 区展示真实产品截图或演示
325
+ - 用具体数据和案例替代抽象口号
326
+ - 提供可操作的入口(搜索框、快速开始)
327
+ - 不同页面的 Hero 针对该页面内容定制
328
+
329
+ ### 6.5 功能展示千篇一律
330
+
331
+ **表现**:三列卡片布局展示功能,每个卡片一个图标 + 标题 + 一句话描述。
332
+
333
+ **实际危害**:
334
+ - 用户无法理解功能的实际价值
335
+ - 所有 SaaS 网站看起来一样
336
+ - 缺乏信服力和差异化
337
+
338
+ **修正方案**:
339
+ - 用真实截图展示功能
340
+ - 提供前后对比(使用前 vs 使用后)
341
+ - 嵌入可交互的 Demo
342
+ - 用客户证言和数据佐证
343
+
344
+ ---
345
+
346
+ ## 反模式检测矩阵
347
+
348
+ | 反模式类别 | 检测信号 | 严重等级 |
349
+ |-----------|---------|---------|
350
+ | 信息过载 | 首屏 > 15 个可操作元素 | HIGH |
351
+ | 信息过载 | 表格 > 10 列无列选择器 | MEDIUM |
352
+ | 导航混乱 | 到达目标 > 5 次点击 | HIGH |
353
+ | 导航混乱 | 无面包屑且层级 > 2 | MEDIUM |
354
+ | 不一致性 | 按钮样式 > 5 种 | HIGH |
355
+ | 不一致性 | 非标准间距值出现 > 3 处 | MEDIUM |
356
+ | 无障碍 | 对比度 < 4.5:1 | HIGH |
357
+ | 无障碍 | 交互元素无焦点样式 | HIGH |
358
+ | 过度动效 | 入场动画 > 600ms | MEDIUM |
359
+ | 过度动效 | 无 reduced-motion 支持 | MEDIUM |
360
+ | AI 模板感 | 紫色渐变背景 | HIGH |
361
+ | AI 模板感 | 使用 emoji 作为功能图标 | MEDIUM |
362
+
363
+ ---
364
+
365
+ ## Agent Checklist
366
+
367
+ 以下为 AI Agent 在执行设计评审时用于检测反模式的要点:
368
+
369
+ - [ ] 检查页面信息密度,首屏可操作元素是否 <= 15 个
370
+ - [ ] 验证导航层级 <= 3 层,关键页面可 3 步内到达
371
+ - [ ] 确认视觉元素(按钮/间距/圆角)使用统一的 Design Token
372
+ - [ ] 使用对比度工具验证文本可读性(WCAG AA)
373
+ - [ ] 确认信息传递不仅依赖颜色,有图标/文字辅助
374
+ - [ ] 检查动效时长和性能(仅 transform/opacity)
375
+ - [ ] 扫描 AI 模板感特征:紫色渐变、emoji 图标、默认字体
376
+ - [ ] 确认 Hero 区域有真实内容而非泛泛口号
377
+ - [ ] 验证所有交互模式(确认/通知/错误)在全站一致
378
+ - [ ] 确认 `prefers-reduced-motion` 媒体查询已实现
@@ -0,0 +1,328 @@
1
+ ---
2
+ id: case-design-system-adoption
3
+ title: 案例:设计系统从零到全团队采用
4
+ domain: design
5
+ category: 05-cases
6
+ difficulty: intermediate
7
+ tags: [adoption, agent, case, checklist, design, system, 关键成功因素, 概述]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 案例:设计系统从零到全团队采用
12
+
13
+ ## 概述
14
+
15
+ 本案例记录一家中型 SaaS 公司(约 200 人研发团队,8 个产品线)从零开始搭建设计系统,到全团队采用的完整过程。项目历时 9 个月,最终实现组件复用率从 15% 提升至 82%,设计到开发交付周期缩短 40%,UI 一致性评分从 45 分提升至 91 分。本案例涵盖前期调研、核心搭建、推广策略、度量指标和踩过的坑。
16
+
17
+ ---
18
+
19
+ ## 背景
20
+
21
+ ### 组织现状
22
+
23
+ - **团队规模**:6 名设计师、40 名前端工程师、8 个产品线
24
+ - **技术栈**:React + TypeScript,部分产品线使用 Vue
25
+ - **设计工具**:Figma(刚从 Sketch 迁移完成)
26
+ - **现有状态**:无统一组件库,各产品线自建 UI 组件,风格差异大
27
+
28
+ ### 核心痛点
29
+
30
+ 1. **视觉不一致**:同一品牌下 8 个产品看起来像 8 家公司
31
+ 2. **重复造轮子**:每个产品线都有自己的 Button、Modal、Form 组件
32
+ 3. **交付效率低**:设计师每次都从零画组件,开发每次都从零写组件
33
+ 4. **维护成本高**:修改品牌色需要在 8 个代码库中分别修改
34
+ 5. **设计走查周期长**:每次走查发现大量一致性问题
35
+
36
+ ### 关键决策
37
+
38
+ 立项前团队面临的核心选择:
39
+
40
+ | 选项 | 优点 | 缺点 | 决策 |
41
+ |------|------|------|------|
42
+ | 采用开源 UI 库(Ant Design / MUI) | 快速启动 | 品牌感弱,定制成本高 | 否决 |
43
+ | 从最大产品线提取组件 | 有现成代码 | 其他产品线不认同 | 否决 |
44
+ | 从零搭建品牌设计系统 | 高度定制,全团队认同 | 初期投入大 | 采纳 |
45
+
46
+ ---
47
+
48
+ ## 第一阶段:审计与规划(第 1-2 月)
49
+
50
+ ### 1.1 组件审计
51
+
52
+ 对 8 个产品线进行组件盘点:
53
+
54
+ ```
55
+ 审计结果摘要:
56
+ - Button 变体:23 种(应统一为 5 种)
57
+ - 颜色值:147 个(应统一为 36 个)
58
+ - 字号:28 种(应统一为 8 种)
59
+ - 间距值:41 种(应统一为 10 种)
60
+ - 圆角值:12 种(应统一为 5 种)
61
+ - 模态框实现:6 种不同的 Modal 组件
62
+ ```
63
+
64
+ ### 1.2 利益相关方访谈
65
+
66
+ 访谈了 30 人(设计师、前端、PM、技术负责人),关键发现:
67
+
68
+ - 设计师最关心:减少重复绘制,提升设计一致性
69
+ - 前端最关心:API 设计合理,不破坏现有代码
70
+ - PM 最关心:不影响当前迭代进度
71
+ - 技术负责人最关心:维护成本和升级策略
72
+
73
+ ### 1.3 路线图
74
+
75
+ ```
76
+ M1-M2: 审计 + 规划 + 团队组建
77
+ M3-M4: Design Token + 基础组件(Tier 1)
78
+ M5-M6: 复合组件 + Figma 库 + 代码库发布
79
+ M7-M8: 试点产品线接入 + 文档完善
80
+ M9: 全团队推广 + 度量体系建立
81
+ ```
82
+
83
+ ### 1.4 团队组建
84
+
85
+ 成立 3 人核心小组(不是全职,各投入 50% 时间):
86
+
87
+ - 1 名设计师:负责 Figma 组件库和设计规范
88
+ - 1 名前端工程师:负责 React 组件库开发
89
+ - 1 名前端工程师:负责构建工具、文档站和 Token 管道
90
+
91
+ ---
92
+
93
+ ## 第二阶段:基础搭建(第 3-4 月)
94
+
95
+ ### 2.1 Design Token 体系
96
+
97
+ 首先建立 Token 而非直接画组件:
98
+
99
+ ```
100
+ Token 层级:
101
+ ├── Global Tokens(全局原始值)
102
+ │ ├── color.blue.500: #2196F3
103
+ │ ├── spacing.16: 16px
104
+ │ └── font.size.16: 16px
105
+ ├── Alias Tokens(语义别名)
106
+ │ ├── color.primary: {color.blue.500}
107
+ │ ├── spacing.component-gap: {spacing.16}
108
+ │ └── font.size.body: {font.size.16}
109
+ └── Component Tokens(组件级)
110
+ ├── button.primary.bg: {color.primary}
111
+ ├── button.padding-x: {spacing.16}
112
+ └── button.font-size: {font.size.body}
113
+ ```
114
+
115
+ 工具链选择:
116
+
117
+ - **设计端**:Figma Tokens Studio(同步 Token 到 JSON)
118
+ - **转换层**:Style Dictionary(JSON -> CSS Variables / TS Constants)
119
+ - **代码端**:CSS Custom Properties + Tailwind Config
120
+ - **版本管理**:Token JSON 文件纳入 Git,变更走 PR
121
+
122
+ ### 2.2 基础组件(Tier 1)
123
+
124
+ 首批 12 个原子组件:
125
+
126
+ | 组件 | 变体 | 状态 | 无障碍 |
127
+ |------|------|------|--------|
128
+ | Button | Primary/Secondary/Tertiary/Ghost/Danger | Default/Hover/Active/Focus/Disabled/Loading | aria-label, role |
129
+ | Input | Text/Password/Search/Number | Default/Focus/Error/Disabled | aria-invalid, aria-describedby |
130
+ | Checkbox | Default/Indeterminate | Unchecked/Checked/Disabled | aria-checked |
131
+ | Radio | Default | Unselected/Selected/Disabled | role="radiogroup" |
132
+ | Switch | Default | Off/On/Disabled | role="switch" |
133
+ | Select | Single/Multi | Open/Closed/Disabled | aria-expanded |
134
+ | Badge | Dot/Count/Status | -- | aria-label |
135
+ | Avatar | Image/Initial/Icon | Default/Fallback | alt text |
136
+ | Icon | 200+ 图标 | -- | aria-hidden |
137
+ | Tooltip | Top/Bottom/Left/Right | -- | role="tooltip" |
138
+ | Tag | Default/Closable | -- | aria-label |
139
+ | Divider | Horizontal/Vertical | -- | role="separator" |
140
+
141
+ ### 2.3 技术架构
142
+
143
+ ```
144
+ @company/design-tokens → Token JSON + CSS Variables
145
+ @company/ui-react → React 组件库
146
+ @company/ui-icons → SVG 图标库
147
+ @company/ui-docs → Storybook 文档站
148
+ ```
149
+
150
+ 关键技术决策:
151
+
152
+ - **构建工具**:Rollup(Tree-shaking 友好)
153
+ - **样式方案**:CSS Modules + CSS Variables(非 CSS-in-JS,减少运行时开销)
154
+ - **测试**:Vitest + Testing Library + Chromatic(视觉回归)
155
+ - **发布**:Changesets(自动版本管理 + Changelog)
156
+
157
+ ---
158
+
159
+ ## 第三阶段:扩展与文档(第 5-6 月)
160
+
161
+ ### 3.1 复合组件(Tier 2-3)
162
+
163
+ 在基础组件上构建:
164
+
165
+ - **Tier 2**:FormField、Card、ListItem、MenuItem、Breadcrumb、Pagination、Tab
166
+ - **Tier 3**:Modal、Drawer、DataTable、Form、Dropdown、DatePicker、Upload
167
+
168
+ ### 3.2 Figma 组件库
169
+
170
+ 与代码组件 1:1 对应:
171
+
172
+ - 每个 Figma 组件使用 Variants 覆盖所有变体和状态
173
+ - 组件属性面板(Component Properties)暴露关键配置
174
+ - Auto Layout 约束间距,不允许手动拖拽
175
+ - 发布为 Figma Team Library,所有设计师可引用
176
+
177
+ ### 3.3 文档站
178
+
179
+ 使用 Storybook 搭建文档站,每个组件包含:
180
+
181
+ 1. **概述**:组件用途、使用场景
182
+ 2. **Playground**:可交互的参数调节面板
183
+ 3. **变体展示**:所有变体的并排对比
184
+ 4. **Props API**:完整的参数文档
185
+ 5. **设计指南**:Do / Don't 示例
186
+ 6. **无障碍说明**:ARIA 属性和键盘操作
187
+ 7. **Figma 链接**:跳转到对应的 Figma 组件
188
+
189
+ ---
190
+
191
+ ## 第四阶段:试点接入(第 7-8 月)
192
+
193
+ ### 4.1 试点选择
194
+
195
+ 选择 2 个产品线作为试点:
196
+
197
+ - **产品线 A**:最大的产品线,影响力最大
198
+ - **产品线 C**:刚启动新版本,历史包袱最少
199
+
200
+ ### 4.2 接入策略
201
+
202
+ 采用渐进式替换而非一次性迁移:
203
+
204
+ ```
205
+ 阶段 1: 新页面强制使用设计系统组件
206
+ 阶段 2: 存量页面在功能迭代时逐步替换
207
+ 阶段 3: 专项清理遗留自建组件
208
+ ```
209
+
210
+ ### 4.3 接入过程中的问题
211
+
212
+ | 问题 | 原因 | 解决方案 |
213
+ |------|------|---------|
214
+ | 组件 API 不满足需求 | 首批设计未覆盖所有场景 | 收集需求 -> 评审 -> 迭代发布 |
215
+ | 升级破坏现有样式 | CSS 变量名冲突 | 添加命名空间前缀 |
216
+ | 设计师不愿切换 | 习惯了自己的文件 | 手把手培训 + 模板页面 |
217
+ | 开发觉得限制太多 | 组件定制能力不足 | 增加 `className` 和 `style` 透传 |
218
+ | 产品线特殊需求 | 通用组件不能满足 | 区分通用组件和业务组件边界 |
219
+
220
+ ### 4.4 接入度量
221
+
222
+ 试点 2 个月后的数据:
223
+
224
+ ```
225
+ 产品线 A:
226
+ - 组件复用率:18% -> 65%
227
+ - 新页面开发速度:提升 30%
228
+ - 设计走查问题数:减少 55%
229
+
230
+ 产品线 C:
231
+ - 组件复用率:0% -> 78%(新项目)
232
+ - 设计到开发交付时间:缩短 45%
233
+ - UI 一致性评分:92 分
234
+ ```
235
+
236
+ ---
237
+
238
+ ## 第五阶段:全团队推广(第 9 月)
239
+
240
+ ### 5.1 推广策略
241
+
242
+ 不是发邮件通知,而是多管齐下:
243
+
244
+ 1. **内部发布会**:Demo Day 展示设计系统能力和试点成果
245
+ 2. **培训工作坊**:设计师 2 小时 + 前端 2 小时,分 4 批完成
246
+ 3. **迁移指南**:编写从自建组件到设计系统的迁移文档
247
+ 4. **Codemod 工具**:自动化替换部分常见组件(Button、Input)
248
+ 5. **度量看板**:实时显示各产品线的采用率
249
+ 6. **冠军制度**:每个产品线指定 1 名设计系统冠军
250
+
251
+ ### 5.2 治理机制
252
+
253
+ - **贡献流程**:任何人可提交新组件 RFC,核心小组评审
254
+ - **发布节奏**:每两周一次 Minor Release,紧急修复随时 Patch
255
+ - **破坏性变更**:需提前一个版本标记 Deprecated,下一版本移除
256
+ - **设计审计**:每月对各产品线抽查一致性评分
257
+
258
+ ### 5.3 最终成果
259
+
260
+ | 指标 | 项目前 | 项目后 | 提升 |
261
+ |------|--------|--------|------|
262
+ | 组件复用率 | 15% | 82% | +67% |
263
+ | 新页面开发周期 | 5 天 | 3 天 | -40% |
264
+ | 设计走查问题数 | 每页 15 个 | 每页 3 个 | -80% |
265
+ | UI 一致性评分 | 45/100 | 91/100 | +46 |
266
+ | 设计师绘制时间 | 每页 8 小时 | 每页 3 小时 | -63% |
267
+ | 品牌色修改耗时 | 2 周(8 个库) | 30 分钟(1 个 Token) | -99% |
268
+
269
+ ---
270
+
271
+ ## 踩过的坑
272
+
273
+ ### 坑 1:过早追求完美
274
+
275
+ 初期花了太多时间打磨视觉细节,应该先发布最小可用版本让团队用起来。
276
+
277
+ **教训**:先有用,再好看。V1 覆盖 80% 场景即可发布。
278
+
279
+ ### 坑 2:忽略开发者体验
280
+
281
+ Figma 组件做得很好,但 React 组件 API 设计不友好(Props 命名不直觉、类型定义不完整)。
282
+
283
+ **教训**:API 设计与视觉设计同等重要,前端工程师必须深度参与。
284
+
285
+ ### 坑 3:没有度量就没有话语权
286
+
287
+ 前 4 个月没有建立度量指标,向管理层汇报只能说"感觉变好了"。
288
+
289
+ **教训**:从第一天就建立可量化指标:复用率、一致性评分、开发速度。
290
+
291
+ ### 坑 4:低估了推广难度
292
+
293
+ 以为"做好了自然会有人用",实际上需要持续推广和培训。
294
+
295
+ **教训**:推广投入不低于开发投入。冠军制度和度量看板是关键。
296
+
297
+ ### 坑 5:通用组件 vs 业务组件边界不清
298
+
299
+ 试图把所有组件都放进设计系统,包括高度业务化的组件。
300
+
301
+ **教训**:设计系统只包含通用组件(2+ 个产品线使用),业务组件由各产品线自行维护。
302
+
303
+ ---
304
+
305
+ ## 关键成功因素
306
+
307
+ 1. **管理层支持**:CTO 授权核心小组 50% 时间投入
308
+ 2. **渐进式策略**:不要求一步到位,允许渐进替换
309
+ 3. **双端同步**:Figma 组件与代码组件 1:1 对应
310
+ 4. **度量驱动**:用数据说话,每月发布采用率报告
311
+ 5. **社区运营**:内部 Slack 频道、月度分享会、贡献者表彰
312
+
313
+ ---
314
+
315
+ ## Agent Checklist
316
+
317
+ 以下为 AI Agent 在辅助设计系统搭建时的检查要点:
318
+
319
+ - [ ] 先进行组件审计,量化现状(颜色/字号/间距/组件变体数量)
320
+ - [ ] 建立 Design Token 体系后再开始画组件
321
+ - [ ] Token 使用三层结构:Global -> Alias -> Component
322
+ - [ ] 基础组件覆盖完整状态(Default/Hover/Active/Focus/Disabled/Loading/Error)
323
+ - [ ] 每个组件包含无障碍支持(ARIA 属性、键盘导航)
324
+ - [ ] Figma 组件与代码组件 1:1 对应
325
+ - [ ] 文档包含 Playground、Props API、Do/Don't 示例
326
+ - [ ] 采用渐进式接入策略(新页面强制 -> 存量逐步替换)
327
+ - [ ] 建立度量指标:复用率、一致性评分、开发速度
328
+ - [ ] 区分通用组件和业务组件的边界