@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,124 @@
1
+ ---
2
+ id: methodology
3
+ title: Architect — System Architecture Methodology
4
+ domain: experts
5
+ category: architect
6
+ difficulty: intermediate
7
+ tags: [architecture, data, decision, design, experts, framework, infrastructure, methodology]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Architect — System Architecture Methodology
12
+
13
+ ## Architecture Decision Framework
14
+
15
+ ### Technology Selection
16
+ - Evaluate based on: team expertise, community size, long-term viability, license
17
+ - Document decision rationale in ADR (Architecture Decision Record) format
18
+ - Prefer boring technology for core infrastructure; innovate at edges
19
+ - Prototype risky integrations before committing
20
+
21
+ ### Scalability Planning
22
+ - Design for 10x current load; plan for 100x
23
+ - Identify bottlenecks early: database reads, API fanout, file I/O
24
+ - Separate read/write paths when read:write ratio exceeds 10:1
25
+ - Use connection pooling for all database and HTTP client connections
26
+
27
+ ## System Design Patterns
28
+
29
+ ### Layered Architecture
30
+ ```
31
+ ┌─────────────────────────┐
32
+ │ Presentation (UI/API) │
33
+ ├─────────────────────────┤
34
+ │ Application (Use Cases)│
35
+ ├─────────────────────────┤
36
+ │ Domain (Business Logic)│
37
+ ├─────────────────────────┤
38
+ │ Infrastructure (DB/IO) │
39
+ └─────────────────────────┘
40
+ ```
41
+ - Each layer only depends on the layer below
42
+ - Domain layer has zero external dependencies
43
+ - Infrastructure implements interfaces defined by domain
44
+
45
+ ### API Gateway Pattern
46
+ - Single entry point for all client requests
47
+ - Rate limiting, auth, logging at gateway level
48
+ - Request routing to appropriate microservice/handler
49
+ - Response aggregation for composite endpoints
50
+
51
+ ### Event-Driven Architecture
52
+ - Use events for cross-domain communication
53
+ - Event store for audit trail and replay capability
54
+ - Idempotent event handlers (at-least-once delivery)
55
+ - Dead letter queue for failed event processing
56
+
57
+ ## Data Architecture
58
+
59
+ ### Database Selection Matrix
60
+ | Requirement | Relational (PostgreSQL) | Document (MongoDB) | KV (Redis) |
61
+ |---|---|---|---|
62
+ | Complex queries | Best | Poor | N/A |
63
+ | Schema flexibility | Moderate | Best | N/A |
64
+ | Transactions | Best | Limited | Limited |
65
+ | Caching | Moderate | Moderate | Best |
66
+ | Full-text search | Good (w/ extensions) | Good | N/A |
67
+
68
+ ### Schema Design Principles
69
+ - Normalize to 3NF by default; denormalize with measurement justification
70
+ - Every table needs: `id` (UUID/ULID), `created_at`, `updated_at`
71
+ - Soft-delete with `deleted_at` for recoverable entities
72
+ - Index foreign keys and frequently queried columns
73
+ - Use enums/check constraints at DB level, not just application
74
+
75
+ ### Migration Strategy
76
+ - One migration per logical change (not per table)
77
+ - Migrations must be reversible (up + down)
78
+ - Zero-downtime migrations: add column → backfill → add constraint → remove old
79
+ - Never rename columns in production; add new, migrate, drop old
80
+
81
+ ## Infrastructure Patterns
82
+
83
+ ### Deployment Architecture
84
+ - Container-first: Dockerfile for every deployable service
85
+ - Environment parity: dev ≈ staging ≈ production
86
+ - Configuration via environment variables (12-factor)
87
+ - Health check endpoints: `/health` (liveness), `/ready` (readiness)
88
+
89
+ ### Caching Strategy
90
+ - Cache hierarchy: browser → CDN → application → database
91
+ - Cache invalidation: TTL for reads, explicit invalidation on writes
92
+ - Cache key design: `{entity}:{id}:{version}` for granular invalidation
93
+ - Never cache authenticated/personalized responses at CDN level
94
+
95
+ ### Observability
96
+ - Structured logging (JSON) with correlation IDs
97
+ - Metrics: RED method (Rate, Errors, Duration) for services
98
+ - Distributed tracing for cross-service request flows
99
+ - Alert on symptoms (error rate, latency), not causes
100
+
101
+ ## Security Architecture
102
+
103
+ ### Defense in Depth
104
+ 1. Network: firewall rules, VPC isolation, TLS everywhere
105
+ 2. Application: input validation, output encoding, CSRF tokens
106
+ 3. Data: encryption at rest, field-level encryption for PII
107
+ 4. Access: RBAC/ABAC, principle of least privilege
108
+ 5. Audit: immutable log of all access and mutations
109
+
110
+ ### Auth Architecture
111
+ - Prefer JWT for stateless API auth; sessions for server-rendered
112
+ - Access token: short-lived (15m), refresh token: longer (7d), rotate on use
113
+ - Store refresh tokens in httpOnly secure cookies, not localStorage
114
+ - Permission model: User → Role → Permission (many-to-many)
115
+
116
+ ## Architecture Review Checklist
117
+ - [ ] Single responsibility: each service/module does one thing
118
+ - [ ] Failure isolation: one component failure doesn't cascade
119
+ - [ ] Data ownership: each domain owns its data store
120
+ - [ ] API contract: OpenAPI/GraphQL schema defined before implementation
121
+ - [ ] Security: auth, authz, input validation, secrets management
122
+ - [ ] Observability: logging, metrics, tracing, alerting
123
+ - [ ] Scalability: identified bottlenecks and horizontal scaling path
124
+ - [ ] Recovery: backup strategy, disaster recovery, rollback plan
@@ -0,0 +1,75 @@
1
+ ---
2
+ id: security
3
+ title: Architect — Security Checklist (OWASP-based)
4
+ domain: experts
5
+ category: architect
6
+ difficulty: intermediate
7
+ tags: [authentication, authorization, encoding, experts, input, management, output, security]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Architect — Security Checklist (OWASP-based)
12
+
13
+ ## Authentication & Session Management
14
+
15
+ - [ ] Passwords hashed with bcrypt (cost ≥ 12) or Argon2id
16
+ - [ ] JWT access tokens expire in ≤ 15 minutes
17
+ - [ ] Refresh tokens are single-use and stored server-side
18
+ - [ ] Session invalidation on password change
19
+ - [ ] Account lockout after 5 failed attempts (15 min cooldown)
20
+ - [ ] MFA option available for sensitive operations
21
+ - [ ] Logout invalidates all tokens server-side
22
+
23
+ ## Input Validation
24
+
25
+ - [ ] ALL user input validated server-side (never trust client)
26
+ - [ ] Parameterized queries / ORM for database operations (no string concatenation)
27
+ - [ ] File uploads: validate type (magic bytes, not extension), limit size, store outside webroot
28
+ - [ ] Reject unexpected fields in request body (allowlist, not blocklist)
29
+ - [ ] Content-Type header checked on all endpoints accepting body
30
+
31
+ ## Output Encoding
32
+
33
+ - [ ] HTML output encoded to prevent XSS (`<script>` → `&lt;script&gt;`)
34
+ - [ ] JSON responses use `Content-Type: application/json` (never `text/html`)
35
+ - [ ] User-generated content sanitized before rendering
36
+ - [ ] CSP headers set: `Content-Security-Policy: default-src 'self'`
37
+
38
+ ## Authorization
39
+
40
+ - [ ] Every endpoint checks authorization (not just authentication)
41
+ - [ ] IDOR prevention: verify user owns the resource, not just that resource exists
42
+ - [ ] Admin endpoints on separate route group with role check middleware
43
+ - [ ] API keys scoped to minimum necessary permissions
44
+
45
+ ## Data Protection
46
+
47
+ - [ ] HTTPS only (HSTS header with max-age ≥ 1 year)
48
+ - [ ] Sensitive data encrypted at rest (AES-256)
49
+ - [ ] PII not logged (mask email, phone in logs)
50
+ - [ ] Database credentials in environment variables, never in code
51
+ - [ ] `.env` in `.gitignore`
52
+
53
+ ## Headers
54
+
55
+ ```
56
+ Strict-Transport-Security: max-age=31536000; includeSubDomains
57
+ Content-Security-Policy: default-src 'self'; script-src 'self'
58
+ X-Content-Type-Options: nosniff
59
+ X-Frame-Options: DENY
60
+ Referrer-Policy: strict-origin-when-cross-origin
61
+ Permissions-Policy: camera=(), microphone=(), geolocation=()
62
+ ```
63
+
64
+ ## Dependency Security
65
+
66
+ - [ ] No known vulnerabilities (`npm audit` / `cargo audit` clean)
67
+ - [ ] Dependencies pinned to exact versions in lock file
68
+ - [ ] Automated dependency update checks (Dependabot / Renovate)
69
+
70
+ ## Error Handling
71
+
72
+ - [ ] Internal errors return generic message to client (no stack traces)
73
+ - [ ] Errors logged with context on server (request ID, user ID, timestamp)
74
+ - [ ] 404 for missing resources (don't leak existence via different error codes)
75
+ - [ ] Rate limiting on all public endpoints
@@ -0,0 +1,216 @@
1
+ ---
2
+ id: methodology
3
+ title: Backend Lead — Development Methodology
4
+ domain: experts
5
+ category: backend-lead
6
+ difficulty: intermediate
7
+ tags: [authentication, best, database, experts, implementation, logging, methodology, pattern]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Backend Lead — Development Methodology
12
+
13
+ ## 工程标准库速查(按需查阅对应标准,`backend/01-standards/<id>`)
14
+
15
+ 本项目附带商业级工程标准库。**先识别项目用到的方面,再查对应标准照着做**(不确定就检索 knowledge/):
16
+
17
+ - 结构:application-layering-and-packaging(分层/服务层/分包)· backend-framework-idioms(所选框架地道写法)· api-and-error-conventions · data-modeling-and-persistence · config-and-observability
18
+ - 横切:secure-coding-baseline(安全/OWASP)· test-strategy-and-layering · performance-and-scalability · microservices-and-distributed
19
+ - 功能(项目用到才做):auth-implementation · payment-integration · file-upload-and-storage · background-jobs-and-async · email-and-notifications · search-and-filtering · realtime-and-websocket · analytics-and-growth · llm-application-standard(AI/RAG/Agent)
20
+ - 交付:deployment-and-delivery-standard · release-and-store-submission
21
+ - 前端/多端见 frontend/mobile/desktop/miniprogram/harmony/cross-platform 下对应标准(含各端官方设计规范)。
22
+
23
+ ## 结构第一:分层 + 分包(动手写代码前先定骨架)
24
+
25
+ 商业级后端的第一要务不是功能,而是**结构**。写任何实现前,先按下面定下分层与分包骨架,再填代码。详见标准《应用分层与分包标准》(`backend/01-standards/application-layering-and-packaging`),这里给硬性底线:
26
+
27
+ - **四层 + 依赖向内**:接口层(controller,仅传输) → 应用层(service,编排+事务) → 领域层(entity/VO,业务规则与不变量) → 基础设施层(repository/adapter,持久化与外部)。依赖只能向内,业务核心不依赖框架/DB/HTTP。
28
+ - **服务层规则**:无状态;一个方法=一个用例=一个事务边界;收发 DTO,**绝不返回/接收 ORM entity**;只依赖 repository/gateway 接口(注入),不依赖具体实现。
29
+ - **领域不要贫血**:把"这个对象在什么状态下能做什么"的规则封进 entity 方法(`order.cancel()`),不要散在 service 的 if 里。
30
+ - **校验分层**:边界格式校验放接口层(DTO+schema,失败 422);业务不变量放领域/服务层。
31
+ - **分包优先 package-by-feature**:`modules/<feature>/{interface,application,domain,infrastructure}`,跨 feature 通过服务接口/领域事件通信,不互相调对方 repository/entity。先模块化单体,复杂了再抽服务。
32
+ - **红线**:fat controller、controller 直连 repository/SQL、service 泄露 entity、事务写在 controller/repository、一个类贯穿所有层——出现即不合格。
33
+
34
+ ## API Implementation Pattern
35
+
36
+ ### Controller/Handler Structure
37
+ Every API endpoint follows:
38
+ 1. **Parse** — validate request body/params
39
+ 2. **Authorize** — check user has permission
40
+ 3. **Execute** — call business logic
41
+ 4. **Respond** — format and return result
42
+
43
+ ```
44
+ Request → Middleware(auth, rate-limit) → Handler(parse, authorize, execute, respond) → Response
45
+ ```
46
+
47
+ ### Input Validation Rules
48
+ - Validate at the API boundary, not in business logic
49
+ - Use schema validation library (Zod, Joi, Pydantic, serde)
50
+ - Return 422 with field-level errors:
51
+ ```json
52
+ {
53
+ "error": {
54
+ "code": "VALIDATION_ERROR",
55
+ "details": [
56
+ { "field": "email", "message": "Must be a valid email address" },
57
+ { "field": "name", "message": "Must be between 2 and 100 characters" }
58
+ ]
59
+ }
60
+ }
61
+ ```
62
+ - Never trust frontend validation alone
63
+
64
+ ### Error Handling Pattern
65
+ ```
66
+ try {
67
+ // business logic
68
+ } catch (NotFoundError) {
69
+ return 404 with generic message
70
+ } catch (ForbiddenError) {
71
+ return 403
72
+ } catch (ConflictError) {
73
+ return 409 with "resource already exists"
74
+ } catch (ValidationError) {
75
+ return 422 with field details
76
+ } catch (unknown) {
77
+ log error with full context (requestId, userId, stack trace)
78
+ return 500 with "Internal server error" (NO details to client)
79
+ }
80
+ ```
81
+
82
+ ## Database Best Practices
83
+
84
+ ### Migration Standards
85
+ - Every schema change is a migration file with up + down
86
+ - Never modify a deployed migration — create a new one
87
+ - Migrations run automatically on deploy
88
+ - Test migrations against production-like data volume
89
+
90
+ ### Query Patterns
91
+ - Use parameterized queries (NEVER string concatenation)
92
+ - Add indexes for: foreign keys, frequently queried fields, sort columns
93
+ - Pagination: cursor-based for infinite scroll, offset for page numbers
94
+ - N+1 prevention: eager load relationships or use DataLoader pattern
95
+
96
+ ### Seed Data
97
+ - `seeds/development.ts` — realistic test data for local dev
98
+ - `seeds/test.ts` — minimal data for automated tests
99
+ - Never seed production directly
100
+
101
+ ## Authentication Implementation
102
+
103
+ ### JWT Flow
104
+ ```
105
+ 1. POST /auth/login { email, password }
106
+ → Verify credentials
107
+ → Generate access token (15 min, signed)
108
+ → Generate refresh token (7 days, stored in DB + httpOnly cookie)
109
+ → Return { accessToken, user }
110
+
111
+ 2. Authenticated request:
112
+ → Client sends: Authorization: Bearer <accessToken>
113
+ → Middleware verifies signature + expiration
114
+ → Extracts user from claims
115
+
116
+ 3. Token refresh:
117
+ → POST /auth/refresh (cookie has refresh token)
118
+ → Verify refresh token exists in DB + not expired
119
+ → Invalidate old refresh token (single-use)
120
+ → Issue new access + refresh tokens
121
+
122
+ 4. Logout:
123
+ → POST /auth/logout
124
+ → Delete refresh token from DB
125
+ → Clear httpOnly cookie
126
+ ```
127
+
128
+ ### Password Rules
129
+ - Hash with bcrypt (cost 12) or Argon2id
130
+ - Minimum 8 characters
131
+ - Check against breached password list (haveibeenpwned API)
132
+ - Never log plaintext passwords
133
+ - Never return password hash in API responses
134
+
135
+ ## Logging Standards
136
+
137
+ ### What to Log
138
+ | Level | When | Example |
139
+ |---|---|---|
140
+ | ERROR | Operation failed, needs attention | Database connection lost, payment failed |
141
+ | WARN | Degraded but functioning | Cache miss, retry succeeded, rate limit approaching |
142
+ | INFO | Significant events | User signed up, order placed, deploy completed |
143
+ | DEBUG | Development troubleshooting | Query executed, cache hit, request parsed |
144
+
145
+ ### Log Format
146
+ ```json
147
+ {
148
+ "level": "error",
149
+ "timestamp": "2026-01-15T10:30:00Z",
150
+ "requestId": "req_abc123",
151
+ "userId": "usr_456",
152
+ "message": "Payment processing failed",
153
+ "error": { "code": "STRIPE_DECLINED", "message": "Card declined" },
154
+ "context": { "orderId": "ord_789", "amount": 9900, "currency": "usd" }
155
+ }
156
+ ```
157
+
158
+ ### What NOT to Log
159
+ - Passwords, tokens, API keys
160
+ - Full credit card numbers (last 4 only)
161
+ - Personal health information
162
+ - Full request/response bodies (summarize instead)
163
+
164
+ ## Testing Standards
165
+
166
+ ### Unit Tests
167
+ - Test business logic functions in isolation
168
+ - Mock external dependencies (database, APIs, email)
169
+ - Naming: `describe('createUser')` → `it('should hash password before saving')`
170
+ - Assert both success path and error paths
171
+
172
+ ### Integration Tests
173
+ - Test API endpoints with real database (test instance)
174
+ - Reset database between tests (transaction rollback or truncate)
175
+ - Test auth: verify 401 without token, 403 with wrong role
176
+ - Test validation: verify 422 for each invalid field
177
+
178
+ ### Test Coverage Targets
179
+ | Layer | Target |
180
+ |---|---|
181
+ | Business logic | ≥ 90% |
182
+ | API handlers | ≥ 80% |
183
+ | Middleware | ≥ 80% |
184
+ | Utilities | ≥ 95% |
185
+ | Overall | ≥ 80% |
186
+
187
+ ## Environment Variables
188
+
189
+ ### Naming Convention
190
+ ```
191
+ # Database
192
+ DATABASE_URL=postgres://user:pass@host:5432/dbname
193
+ DATABASE_POOL_SIZE=10
194
+
195
+ # Auth
196
+ JWT_SECRET=<random 256-bit key>
197
+ JWT_ACCESS_TTL=900 # 15 minutes in seconds
198
+ JWT_REFRESH_TTL=604800 # 7 days in seconds
199
+
200
+ # External services
201
+ STRIPE_SECRET_KEY=sk_live_...
202
+ SMTP_HOST=smtp.example.com
203
+ SMTP_PORT=587
204
+
205
+ # App
206
+ NODE_ENV=production
207
+ PORT=3001
208
+ CORS_ORIGIN=https://your-frontend.com
209
+ LOG_LEVEL=info
210
+ ```
211
+
212
+ ### Rules
213
+ - NEVER commit `.env` files (add to `.gitignore`)
214
+ - Provide `.env.example` with placeholder values
215
+ - Validate all required env vars on startup (fail fast if missing)
216
+ - Different values per environment (dev/staging/prod)
@@ -0,0 +1,160 @@
1
+ ---
2
+ id: methodology
3
+ title: DevOps — Methodology
4
+ domain: experts
5
+ category: devops
6
+ difficulty: intermediate
7
+ tags: [alerting, design, docker, environment, experts, methodology, monitoring, pipeline]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # DevOps — Methodology
12
+
13
+ ## 交付底线(能跑通 ≠ 能交付)
14
+
15
+ 详见标准《部署与交付规范》(`cicd/01-standards/deployment-and-delivery-standard`)。硬性底线:
16
+
17
+ - **Dockerfile**:多阶段、固定版本小基础镜像、**非 root**、.dockerignore、HEALTHCHECK;不把密钥/.env 打进镜像。
18
+ - **CI**:lint+类型+单元+集成+安全扫描(依赖审计/镜像扫描)+质量门,任一失败**阻断合并**;制品打不可变版本(git sha),不用 latest 部署。
19
+ - **CD 零停机**:滚动/蓝绿/金丝雀之一;新旧并存期间接口与 DB **向后兼容**;**禁止手改生产**。
20
+ - **迁移**:自动化、幂等、expand-contract、不锁表停服。
21
+ - **环境/密钥**:dev/staging/prod 隔离,同代码不同配置;密钥按环境注入,绝不进仓库/镜像/日志。
22
+ - **回滚 + 观测**:保留上一可用版本可一键回滚;发布后盯错误率/p99;健康探针 + 优雅停机。
23
+ - **随附交付物**:Dockerfile/compose、CI 配置、迁移脚本、.env.example、部署 README。
24
+
25
+ ## CI/CD Pipeline Design
26
+
27
+ ### Pipeline Stages
28
+ ```
29
+ commit → lint → test → build → deploy:staging → smoke-test → deploy:production → monitor
30
+ ```
31
+
32
+ ### Stage Details
33
+
34
+ **Lint** (< 1 min)
35
+ - TypeScript: `tsc --noEmit`
36
+ - ESLint: `eslint --max-warnings 0`
37
+ - Prettier: `prettier --check`
38
+ - Fail fast: any lint failure blocks the pipeline
39
+
40
+ **Test** (< 5 min)
41
+ - Unit tests: `jest` / `vitest` / `cargo test`
42
+ - Coverage gate: fail if below threshold (80% for business logic)
43
+ - Parallel execution when possible
44
+
45
+ **Build** (< 3 min)
46
+ - Production build with minification
47
+ - Generate source maps (for error tracking, not served to users)
48
+ - Output bundle size check (fail if > budget)
49
+
50
+ **Deploy: Staging**
51
+ - Automatic on every merged PR to main
52
+ - Same infrastructure as production (just scaled down)
53
+ - Seeded with realistic test data
54
+
55
+ **Smoke Test**
56
+ - Automated: hit key endpoints, verify 200 responses
57
+ - Verify database migration ran successfully
58
+ - Check external service connections (payment, email, etc)
59
+
60
+ **Deploy: Production**
61
+ - Manual approval gate (or auto after staging smoke passes)
62
+ - Rolling deploy (no downtime)
63
+ - Database migrations run before new code deploys
64
+
65
+ **Monitor**
66
+ - Watch error rate for 15 minutes after deploy
67
+ - Auto-rollback if error rate > 1%
68
+
69
+ ## Environment Strategy
70
+
71
+ | Environment | Purpose | Data | Access |
72
+ |---|---|---|---|
73
+ | local | Development | Seed data | Developer |
74
+ | staging | Pre-production testing | Anonymized prod copy | Team |
75
+ | production | Live users | Real data | Restricted |
76
+
77
+ ### Environment Variables
78
+ - Same variable names across all environments
79
+ - Different VALUES per environment (never different variable names)
80
+ - `.env.example` committed with placeholder values
81
+ - Actual `.env` files NEVER committed
82
+
83
+ ## Docker Standards
84
+
85
+ ### Dockerfile Best Practices
86
+ ```dockerfile
87
+ # Multi-stage build
88
+ FROM node:20-slim AS builder
89
+ WORKDIR /app
90
+ COPY package*.json ./
91
+ RUN npm ci --production=false
92
+ COPY . .
93
+ RUN npm run build
94
+
95
+ FROM node:20-slim
96
+ WORKDIR /app
97
+ COPY --from=builder /app/dist ./dist
98
+ COPY --from=builder /app/node_modules ./node_modules
99
+ EXPOSE 3000
100
+ CMD ["node", "dist/server.js"]
101
+ ```
102
+
103
+ Rules:
104
+ - Multi-stage builds (separate build/runtime)
105
+ - Pin base image versions (`node:20-slim`, not `node:latest`)
106
+ - `npm ci` not `npm install` (deterministic)
107
+ - Non-root user in production image
108
+ - `.dockerignore` excludes node_modules, .git, .env
109
+
110
+ ## Monitoring & Alerting
111
+
112
+ ### Four Golden Signals
113
+ | Signal | What to measure | Alert threshold |
114
+ |---|---|---|
115
+ | **Latency** | p95 response time | > 500ms for 5 min |
116
+ | **Traffic** | Requests per second | Drop > 50% from baseline |
117
+ | **Errors** | 5xx error rate | > 1% for 5 min |
118
+ | **Saturation** | CPU/memory usage | > 80% for 10 min |
119
+
120
+ ### Health Check Endpoint
121
+ ```
122
+ GET /api/health
123
+ → 200 { "status": "healthy", "version": "1.2.3", "uptime": 86400 }
124
+ → 503 { "status": "unhealthy", "checks": { "database": "timeout" } }
125
+ ```
126
+
127
+ Check: database connection, cache connection, external API reachability
128
+
129
+ ### Logging in Production
130
+ - Structured JSON logs (not plain text)
131
+ - Include: timestamp, level, requestId, userId, message
132
+ - Never log: passwords, tokens, PII, credit card numbers
133
+ - Log to stdout (let the platform handle aggregation)
134
+
135
+ ## Rollback Strategy
136
+
137
+ ### Criteria for rollback
138
+ - Error rate > 1% sustained for 5 minutes
139
+ - Any 500 on critical path (checkout, login)
140
+ - Performance regression > 2x baseline latency
141
+
142
+ ### Rollback steps
143
+ 1. Route traffic to previous version (< 1 min)
144
+ 2. Verify previous version is healthy
145
+ 3. Investigate root cause on the failed version
146
+ 4. Fix → test on staging → re-deploy
147
+
148
+ ### Database rollback
149
+ - Every migration has a DOWN migration
150
+ - Test DOWN migration BEFORE deploying UP
151
+ - Never drop columns immediately — deprecate, deploy, then drop in next release
152
+
153
+ ## Security in Deployment
154
+
155
+ - [ ] All secrets in environment variables / secret manager (never in code)
156
+ - [ ] HTTPS everywhere (HSTS with 1-year max-age)
157
+ - [ ] Database not publicly accessible (VPC/private network only)
158
+ - [ ] SSH access via bastion/jump server only
159
+ - [ ] Automated dependency vulnerability scanning
160
+ - [ ] Container images scanned for CVEs before deploy