@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,469 @@
1
+ ---
2
+ id: release-playbook
3
+ title: 发布作战手册 (Release Playbook)
4
+ domain: development
5
+ category: 02-playbooks
6
+ difficulty: intermediate
7
+ tags: [2024-01-15, agent, checklist, development, playbook, release, 前置条件, 发布清单]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 发布作战手册 (Release Playbook)
12
+
13
+ ## 概述
14
+
15
+ 发布是将经过验证的代码安全地部署到生产环境的过程。本手册覆盖从发布准备、质量门禁、灰度放量、监控观测到回滚恢复的完整流程。适用于常规发布、紧急发布和大版本发布三种场景。
16
+
17
+ ## 前置条件
18
+
19
+ ### 必须满足
20
+
21
+ - [ ] 所有功能开发已完成并通过 Code Review
22
+ - [ ] CI 流水线全部通过(Lint、测试、安全扫描)
23
+ - [ ] 测试报告已生成,测试通过率 >= 99%
24
+ - [ ] 已确认无阻断级别的已知 Bug
25
+ - [ ] 回滚方案已准备并经过验证
26
+ - [ ] 发布窗口已预约(避免高峰时段)
27
+ - [ ] On-call 值班人员已确认
28
+
29
+ ### 建议满足
30
+
31
+ - [ ] 性能测试已通过
32
+ - [ ] 安全扫描无高危漏洞
33
+ - [ ] 数据库迁移脚本已在预发布环境验证
34
+ - [ ] 变更通知已发送给相关方
35
+
36
+ ---
37
+
38
+ ## 步骤一:发布准备
39
+
40
+ ### 1.1 版本号管理
41
+
42
+ ```bash
43
+ # 语义版本号规则
44
+ # MAJOR.MINOR.PATCH
45
+ # MAJOR: 不兼容的 API 变更
46
+ # MINOR: 向后兼容的功能新增
47
+ # PATCH: 向后兼容的 Bug 修复
48
+
49
+ # 查看当前版本
50
+ git describe --tags --abbrev=0
51
+
52
+ # 创建发布分支
53
+ git checkout develop
54
+ git pull origin develop
55
+ git checkout -b release/v1.2.0
56
+
57
+ # 更新版本号
58
+ # Python
59
+ sed -i 's/version = ".*"/version = "1.2.0"/' pyproject.toml
60
+ # Node.js
61
+ npm version 1.2.0 --no-git-tag-version
62
+ # 手动更新其他版本引用
63
+ ```
64
+
65
+ ### 1.2 Changelog 生成
66
+
67
+ ```bash
68
+ # 基于 Conventional Commits 自动生成
69
+ # 安装: pip install git-changelog
70
+ git-changelog --output CHANGELOG.md --style conventional
71
+
72
+ # 或手动整理
73
+ cat >> CHANGELOG.md << 'EOF'
74
+
75
+ ## [1.2.0] - 2024-01-15
76
+
77
+ ### Added
78
+ - 新增订单导出功能 (#123)
79
+ - 新增批量操作接口 (#145)
80
+
81
+ ### Changed
82
+ - 优化列表查询性能,P99 降低 40% (#156)
83
+ - 升级 Redis 客户端到 v5.0 (#160)
84
+
85
+ ### Fixed
86
+ - 修复并发场景下的库存扣减问题 (#167)
87
+ - 修复分页查询的 off-by-one 错误 (#170)
88
+
89
+ ### Security
90
+ - 升级依赖修复 CVE-2024-XXXX (#175)
91
+ EOF
92
+ ```
93
+
94
+ ### 1.3 发布清单
95
+
96
+ ```markdown
97
+ ## 发布清单 v1.2.0
98
+
99
+ ### 代码
100
+ - [ ] release 分支已从 develop 创建
101
+ - [ ] 版本号已更新
102
+ - [ ] CHANGELOG 已更新
103
+ - [ ] 无未合并的 hotfix
104
+
105
+ ### 质量
106
+ - [ ] 单元测试通过率 100%
107
+ - [ ] 集成测试通过率 >= 99%
108
+ - [ ] 代码覆盖率 >= 80%
109
+ - [ ] 静态分析无新增告警
110
+ - [ ] 安全扫描无高危/严重漏洞
111
+
112
+ ### 数据库
113
+ - [ ] 迁移脚本已编写并测试
114
+ - [ ] 迁移支持回滚
115
+ - [ ] 预发布环境已验证迁移
116
+ - [ ] 大表变更有预估执行时间
117
+
118
+ ### 基础设施
119
+ - [ ] Docker 镜像构建成功
120
+ - [ ] 配置变更已同步到各环境
121
+ - [ ] 新增的环境变量/Secret 已配置
122
+ - [ ] 资源配额已确认(CPU/内存/存储)
123
+
124
+ ### 监控
125
+ - [ ] 核心指标告警已配置
126
+ - [ ] 新功能的监控指标已添加
127
+ - [ ] Dashboard 已更新
128
+
129
+ ### 通知
130
+ - [ ] 发布计划已通知团队
131
+ - [ ] 影响范围已通知下游
132
+ - [ ] On-call 人员已确认
133
+ ```
134
+
135
+ ---
136
+
137
+ ## 步骤二:质量门禁
138
+
139
+ ### 2.1 自动化门禁
140
+
141
+ ```bash
142
+ #!/bin/bash
143
+ # release_gate_check.sh - 发布前自动检查
144
+
145
+ set -e
146
+ PASS=0
147
+ FAIL=0
148
+
149
+ check() {
150
+ local name=$1
151
+ local cmd=$2
152
+ echo -n "[$name] "
153
+ if eval "$cmd" > /dev/null 2>&1; then
154
+ echo "PASS"
155
+ ((PASS++))
156
+ else
157
+ echo "FAIL"
158
+ ((FAIL++))
159
+ fi
160
+ }
161
+
162
+ echo "=== 发布门禁检查 ==="
163
+
164
+ check "Lint" "ruff check src/"
165
+ check "Type Check" "mypy src/"
166
+ check "Unit Tests" "pytest tests/unit/ -q"
167
+ check "Integration Tests" "pytest tests/integration/ -q"
168
+ check "Security Scan" "trivy image app:latest --severity HIGH,CRITICAL --exit-code 1"
169
+ check "License Check" "pip-licenses --fail-on 'GPL;AGPL'"
170
+ check "Docker Build" "docker build -t app:release-candidate ."
171
+
172
+ echo ""
173
+ echo "=== 结果: $PASS 通过, $FAIL 失败 ==="
174
+
175
+ if [ $FAIL -gt 0 ]; then
176
+ echo "门禁未通过,不允许发布"
177
+ exit 1
178
+ fi
179
+ echo "门禁通过,可以发布"
180
+ ```
181
+
182
+ ### 2.2 手动检查项
183
+
184
+ ```markdown
185
+ ### 发布前人工检查
186
+
187
+ - [ ] 在预发布环境完整走通核心用户旅程
188
+ - [ ] 确认配置文件差异(staging vs production)
189
+ - [ ] 确认第三方服务状态正常
190
+ - [ ] 确认没有正在进行的大批量数据处理
191
+ - [ ] 确认发布窗口没有冲突的其他变更
192
+ ```
193
+
194
+ ---
195
+
196
+ ## 步骤三:执行发布
197
+
198
+ ### 3.1 数据库迁移
199
+
200
+ ```bash
201
+ # 先在生产环境执行数据库迁移
202
+ # 原则:迁移必须向后兼容(旧代码能跑新 schema)
203
+
204
+ # 备份当前数据库
205
+ pg_dump -h db-host -U user -d production > backup_pre_release_v120.sql
206
+
207
+ # 执行迁移
208
+ python manage.py migrate --database production
209
+
210
+ # 验证迁移
211
+ python manage.py showmigrations --database production | grep -E "^\[X\]"
212
+
213
+ # 如果迁移失败,回滚
214
+ python manage.py migrate <app> <previous_migration> --database production
215
+ ```
216
+
217
+ ### 3.2 灰度发布
218
+
219
+ ```bash
220
+ # Kubernetes 灰度部署
221
+
222
+ # 阶段 1: 金丝雀 (5%)
223
+ kubectl apply -f - << 'EOF'
224
+ apiVersion: apps/v1
225
+ kind: Deployment
226
+ metadata:
227
+ name: app-canary
228
+ namespace: production
229
+ spec:
230
+ replicas: 1 # 生产环境有 19 个副本,1 个金丝雀 = ~5%
231
+ selector:
232
+ matchLabels:
233
+ app: myapp
234
+ track: canary
235
+ template:
236
+ metadata:
237
+ labels:
238
+ app: myapp
239
+ track: canary
240
+ spec:
241
+ containers:
242
+ - name: app
243
+ image: app:v1.2.0
244
+ resources:
245
+ requests:
246
+ cpu: "500m"
247
+ memory: "512Mi"
248
+ limits:
249
+ cpu: "1000m"
250
+ memory: "1Gi"
251
+ readinessProbe:
252
+ httpGet:
253
+ path: /health
254
+ port: 8080
255
+ initialDelaySeconds: 10
256
+ periodSeconds: 5
257
+ EOF
258
+
259
+ echo "金丝雀已部署,观察 30 分钟..."
260
+ ```
261
+
262
+ ```bash
263
+ # 阶段 2: 验证金丝雀
264
+ # 持续监控金丝雀指标
265
+ for i in $(seq 1 30); do
266
+ echo "=== 检查 $i/30 (每分钟一次) ==="
267
+
268
+ # 错误率
269
+ ERROR_RATE=$(curl -s "http://prometheus:9090/api/v1/query?query=rate(http_errors_total{track='canary'}[5m])" | jq -r '.data.result[0].value[1] // "0"')
270
+ echo "金丝雀错误率: $ERROR_RATE"
271
+
272
+ # P99 延迟
273
+ P99=$(curl -s "http://prometheus:9090/api/v1/query?query=histogram_quantile(0.99,rate(http_duration_seconds_bucket{track='canary'}[5m]))" | jq -r '.data.result[0].value[1] // "0"')
274
+ echo "金丝雀 P99: ${P99}s"
275
+
276
+ sleep 60
277
+ done
278
+ ```
279
+
280
+ ```bash
281
+ # 阶段 3: 全量发布
282
+ kubectl set image deployment/app app=app:v1.2.0 -n production
283
+ kubectl rollout status deployment/app -n production
284
+
285
+ # 删除金丝雀
286
+ kubectl delete deployment app-canary -n production
287
+ ```
288
+
289
+ ### 3.3 发布类型矩阵
290
+
291
+ | 类型 | 灰度策略 | 观察时间 | 回滚授权 |
292
+ |------|----------|---------|---------|
293
+ | 常规发布 | 5% -> 25% -> 50% -> 100% | 每阶段 30 分钟 | 发布负责人 |
294
+ | 大版本发布 | 1% -> 5% -> 25% -> 50% -> 100% | 每阶段 2 小时 | 技术总监 |
295
+ | 紧急发布 | 直接 100%(已验证的 hotfix) | 15 分钟 | On-call 负责人 |
296
+ | 配置变更 | 特性开关渐进 | 即时 | 发布负责人 |
297
+
298
+ ---
299
+
300
+ ## 步骤四:发布后观测
301
+
302
+ ### 4.1 核心指标监控
303
+
304
+ ```bash
305
+ #!/bin/bash
306
+ # post_release_monitor.sh
307
+
308
+ echo "=== 发布后监控 (每 5 分钟检查一次,持续 2 小时) ==="
309
+
310
+ BASELINE_ERROR_RATE=0.001
311
+ BASELINE_P99=0.2
312
+
313
+ for i in $(seq 1 24); do
314
+ echo ""
315
+ echo "--- 检查 $i/24 ---"
316
+ TIMESTAMP=$(date '+%Y-%m-%d %H:%M:%S')
317
+
318
+ # 错误率
319
+ ERROR_RATE=$(curl -s "http://prometheus:9090/api/v1/query?query=rate(http_errors_total[5m])" | jq -r '.data.result[0].value[1] // "0"')
320
+
321
+ # P99
322
+ P99=$(curl -s "http://prometheus:9090/api/v1/query?query=histogram_quantile(0.99,rate(http_duration_seconds_bucket[5m]))" | jq -r '.data.result[0].value[1] // "0"')
323
+
324
+ # QPS
325
+ QPS=$(curl -s "http://prometheus:9090/api/v1/query?query=rate(http_requests_total[5m])" | jq -r '.data.result[0].value[1] // "0"')
326
+
327
+ echo "[$TIMESTAMP] 错误率=$ERROR_RATE P99=${P99}s QPS=$QPS"
328
+
329
+ # 异常检测
330
+ if (( $(echo "$ERROR_RATE > $BASELINE_ERROR_RATE * 2" | bc -l) )); then
331
+ echo "!!! 警告: 错误率超过基线 2 倍 !!!"
332
+ fi
333
+
334
+ sleep 300
335
+ done
336
+
337
+ echo "=== 观察完成 ==="
338
+ ```
339
+
340
+ ### 4.2 业务指标确认
341
+
342
+ ```markdown
343
+ ### 发布后业务检查
344
+
345
+ - [ ] 核心交易量正常(与上周同期对比偏差 < 10%)
346
+ - [ ] 用户登录成功率正常
347
+ - [ ] 支付成功率正常
348
+ - [ ] 搜索结果正常
349
+ - [ ] 无异常客服工单上升
350
+ ```
351
+
352
+ ### 4.3 发布确认
353
+
354
+ ```bash
355
+ # 发布成功后的收尾
356
+ # 1. 合并 release 分支
357
+ git checkout main
358
+ git merge --no-ff release/v1.2.0
359
+ git tag -a v1.2.0 -m "Release v1.2.0"
360
+ git push origin main --tags
361
+
362
+ # 2. 同步到 develop
363
+ git checkout develop
364
+ git merge --no-ff release/v1.2.0
365
+ git push origin develop
366
+
367
+ # 3. 删除 release 分支
368
+ git branch -d release/v1.2.0
369
+ git push origin --delete release/v1.2.0
370
+
371
+ # 4. 更新发布记录
372
+ gh release create v1.2.0 --title "v1.2.0" --notes-file CHANGELOG.md
373
+ ```
374
+
375
+ ---
376
+
377
+ ## 步骤五:发布后清理
378
+
379
+ ### 5.1 资源清理
380
+
381
+ ```bash
382
+ # 清理旧版本镜像(保留最近 5 个版本)
383
+ docker images app --format "{{.Tag}}" | sort -V | head -n -5 | xargs -I {} docker rmi app:{}
384
+
385
+ # 清理预发布环境
386
+ kubectl delete deployment app-canary -n production 2>/dev/null || true
387
+ ```
388
+
389
+ ### 5.2 文档更新
390
+
391
+ - [ ] API 文档已发布新版本
392
+ - [ ] 用户文档/帮助中心已更新
393
+ - [ ] 内部 Wiki 已更新
394
+ - [ ] 发布邮件/通知已发送
395
+
396
+ ---
397
+
398
+ ## 回滚方案
399
+
400
+ ### 快速回滚
401
+
402
+ ```bash
403
+ # Kubernetes 一键回滚
404
+ kubectl rollout undo deployment/app -n production
405
+
406
+ # 验证回滚
407
+ kubectl rollout status deployment/app -n production
408
+
409
+ # 确认服务恢复
410
+ for endpoint in /health /api/v1/status; do
411
+ STATUS=$(curl -s -o /dev/null -w "%{http_code}" "http://api.example.com$endpoint")
412
+ echo "$endpoint: $STATUS"
413
+ done
414
+ ```
415
+
416
+ ### 数据库回滚
417
+
418
+ ```bash
419
+ # 回滚迁移
420
+ python manage.py migrate <app> <previous_migration> --database production
421
+
422
+ # 如果需要数据修复
423
+ psql -h db-host -U user -d production < backup_pre_release_v120.sql
424
+ ```
425
+
426
+ ### 回滚决策矩阵
427
+
428
+ | 信号 | 阈值 | 动作 | 决策者 |
429
+ |------|------|------|--------|
430
+ | 5xx 错误率 | > 1% | 立即回滚 | 自动 |
431
+ | P99 延迟 | > 基线 3 倍 | 立即回滚 | 自动 |
432
+ | 核心功能异常 | 任何 | 立即回滚 | On-call |
433
+ | 非核心功能异常 | 影响 > 5% 用户 | 评估后回滚 | 发布负责人 |
434
+ | 数据异常 | 任何数据不一致 | 立即回滚 + 数据修复 | 技术总监 |
435
+
436
+ ### 回滚后处理
437
+
438
+ ```bash
439
+ # 1. 确认回滚成功
440
+ kubectl get pods -n production -l app=myapp
441
+ curl -s http://api.example.com/health | jq '.'
442
+
443
+ # 2. 通知相关方
444
+ echo "v1.2.0 已回滚至 v1.1.x,原因: [填写原因]"
445
+
446
+ # 3. 创建故障报告
447
+ # 参考 incident-hotfix-playbook.md
448
+
449
+ # 4. 修复后重新走发布流程
450
+ ```
451
+
452
+ ---
453
+
454
+ ## Agent Checklist
455
+
456
+ AI 编码 Agent 在协助发布时必须逐项确认:
457
+
458
+ - [ ] **版本号正确**:符合语义版本规范,所有引用处已同步
459
+ - [ ] **Changelog 完整**:所有变更已记录,格式规范
460
+ - [ ] **质量门禁通过**:Lint、测试、安全扫描全部绿色
461
+ - [ ] **迁移已验证**:数据库迁移在预发布环境成功执行
462
+ - [ ] **回滚已准备**:回滚脚本存在且经过验证
463
+ - [ ] **灰度配置就绪**:金丝雀部署配置正确
464
+ - [ ] **监控已配置**:核心指标告警和 Dashboard 就绪
465
+ - [ ] **发布窗口确认**:避开高峰时段,On-call 已确认
466
+ - [ ] **观测进行中**:发布后持续监控至少 2 小时
467
+ - [ ] **分支已合并**:release 分支已合并到 main 和 develop
468
+ - [ ] **Tag 已创建**:Git tag 和 GitHub Release 已创建
469
+ - [ ] **通知已发送**:发布结果已通知所有相关方
@@ -0,0 +1,168 @@
1
+ ---
2
+ id: architecture-review-checklist
3
+ title: 架构评审检查清单 (Architecture Review Checklist)
4
+ domain: development
5
+ category: 03-checklists
6
+ difficulty: intermediate
7
+ tags: [architecture, checklist, development, review, 参考, 可维护性与演进性, 可观测性, 成本与可行性]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 架构评审检查清单 (Architecture Review Checklist)
12
+
13
+ > 适用场景:新系统设计评审、重大重构方案评审、技术选型决策、架构变更审批。
14
+ > 通过标准:所有 MUST 项全部通过,SHOULD 项覆盖率 >= 80%,未通过项需记录风险接受决策。
15
+
16
+ ---
17
+
18
+ ## 1. 模块边界与职责
19
+
20
+ - [ ] **系统边界已明确定义** — 系统上下文图(C4 Level 1)已绘制,外部系统 / 用户 / 数据源已标识。
21
+ - [ ] **模块划分合理** — 每个模块有明确的单一职责,模块名称准确反映其业务能力。
22
+ - [ ] **依赖方向单一** — 高层模块不依赖低层模块的实现细节,遵循依赖倒置原则。
23
+ - [ ] **循环依赖已消除** — 模块间无循环依赖,依赖图为有向无环图(DAG)。
24
+ - [ ] **接口契约已定义** — 模块间通过明确的接口(API / Event / Message)通信,非直接访问内部数据。
25
+ - [ ] **领域模型已对齐** — 模块划分与业务领域(Bounded Context)对齐,无跨域混杂。
26
+
27
+ ---
28
+
29
+ ## 2. 非功能需求(NFR)
30
+
31
+ ### 2.1 性能
32
+
33
+ - [ ] **性能目标已量化** — 关键接口的延迟目标(P50 / P95 / P99)和吞吐量目标(QPS / TPS)已定义。
34
+ - [ ] **容量模型已建立** — 基于业务增长预测,1 年 / 3 年内的数据量、请求量、存储量已估算。
35
+ - [ ] **热点路径已识别** — 高频访问的接口和数据已标识,有针对性的优化方案(缓存 / 异步 / 预计算)。
36
+ - [ ] **性能测试方案已规划** — 压测场景、工具、目标指标、执行频率已确定。
37
+
38
+ ### 2.2 可用性
39
+
40
+ - [ ] **可用性目标已定义** — SLA 等级已明确(如 99.9% / 99.95% / 99.99%),对应允许的停机时间已计算。
41
+ - [ ] **RPO / RTO 已定义** — 数据恢复点目标和恢复时间目标已量化,与业务方达成一致。
42
+ - [ ] **故障场景已枚举** — 各组件故障对系统整体影响已分析,故障传播路径已识别。
43
+
44
+ ### 2.3 可扩展性
45
+
46
+ - [ ] **水平扩展路径已规划** — 系统可通过增加实例实现线性扩展,无全局锁或共享状态瓶颈。
47
+ - [ ] **数据分片策略已定义**(如适用)— 分片键选择、数据分布、跨分片查询方案已设计。
48
+ - [ ] **扩展成本可预估** — 从当前规模扩展 10x 的资源成本和架构改动范围已评估。
49
+
50
+ ### 2.4 安全性
51
+
52
+ - [ ] **威胁模型已建立** — 使用 STRIDE / DREAD 等方法识别攻击面和潜在威胁。
53
+ - [ ] **安全架构已设计** — 认证、授权、加密、审计的架构层面方案已定义。
54
+ - [ ] **数据分级已完成** — 数据按敏感程度分级(公开 / 内部 / 机密 / 绝密),不同级别有对应保护措施。
55
+ - [ ] **合规要求已纳入** — GDPR / 个人信息保护法 / 行业法规的技术要求已体现在架构设计中。
56
+
57
+ ---
58
+
59
+ ## 3. 可观测性
60
+
61
+ - [ ] **监控方案已设计** — Metrics / Logging / Tracing 三大支柱的技术选型和集成方案已确定。
62
+ - [ ] **关键指标已预定义** — 四大黄金指标(延迟、流量、错误率、饱和度)+ 业务指标的采集点已规划。
63
+ - [ ] **告警策略已设计** — 告警分级、通知渠道、升级路径、抑制规则的方案已设计。
64
+ - [ ] **Dashboard 已规划** — 系统全局视图、服务级视图、业务级视图的 Dashboard 布局已设计。
65
+ - [ ] **日志规范已定义** — 日志格式、级别使用规范、敏感信息脱敏规则已制定。
66
+ - [ ] **分布式追踪已设计** — traceId 传递机制、采样策略、存储方案已确定。
67
+
68
+ ---
69
+
70
+ ## 4. 数据架构
71
+
72
+ ### 4.1 数据存储
73
+
74
+ - [ ] **存储选型有依据** — 每个数据存储(RDBMS / NoSQL / 对象存储 / 搜索引擎)的选型有明确理由。
75
+ - [ ] **数据模型已设计** — ER 图或文档模型已定义,索引策略已规划。
76
+ - [ ] **数据量级已评估** — 初始数据量和增长速度已估算,存储扩展方案已设计。
77
+ - [ ] **数据备份策略已定义** — 全量 / 增量备份频率、保留策略、恢复演练计划已确定。
78
+
79
+ ### 4.2 数据一致性
80
+
81
+ - [ ] **一致性模型已选择** — 强一致 / 最终一致 / 因果一致的选择有业务场景支撑。
82
+ - [ ] **分布式事务方案已设计**(如适用)— Saga / TCC / 本地消息表等补偿方案已选定。
83
+ - [ ] **对账机制已设计** — 关键业务数据有定期对账流程,不一致时有修复方案。
84
+ - [ ] **幂等性设计已覆盖** — 所有写操作支持幂等重试,幂等键生成与存储方案已设计。
85
+
86
+ ### 4.3 数据流
87
+
88
+ - [ ] **数据流向已可视化** — 数据从产生到消费的完整流转路径已绘制。
89
+ - [ ] **消息队列选型合理** — Kafka / RabbitMQ / SQS 等选型匹配吞吐量、延迟、顺序性需求。
90
+ - [ ] **消息可靠性已保证** — At-least-once / Exactly-once 语义已确认,消费失败有重试和死信队列。
91
+
92
+ ---
93
+
94
+ ## 5. 故障处理与韧性
95
+
96
+ ### 5.1 故障隔离
97
+
98
+ - [ ] **服务间故障隔离** — 单个服务故障不级联影响其他服务,故障域已明确划分。
99
+ - [ ] **资源隔离已实施** — 线程池 / 连接池 / 队列隔离,防止慢调用耗尽共享资源。
100
+ - [ ] **租户隔离已设计**(如多租户)— 计算 / 存储 / 网络层面的租户隔离方案已确定。
101
+
102
+ ### 5.2 降级与熔断
103
+
104
+ - [ ] **降级策略已定义** — 各非核心功能的降级方案已设计(缓存兜底 / 默认值 / 功能关闭)。
105
+ - [ ] **熔断器已设计** — 下游服务调用的熔断阈值、半开探测、恢复策略已定义。
106
+ - [ ] **限流策略已设计** — 全局限流 + 租户级限流 + 接口级限流的分层方案已确定。
107
+ - [ ] **超时策略已设计** — 所有远程调用有超时配置,超时值基于上下游 SLA 设定。
108
+
109
+ ### 5.3 回滚与恢复
110
+
111
+ - [ ] **回滚方案已设计** — 应用版本、数据库 Schema、配置变更均有可执行的回滚步骤。
112
+ - [ ] **灰度发布已支持** — 新版本可按用户 / 流量比例分批发布,异常时快速回滚。
113
+ - [ ] **灾难恢复方案已设计** — 主区域完全不可用时的恢复方案(热备 / 温备 / 冷备)已确定。
114
+
115
+ ---
116
+
117
+ ## 6. 可维护性与演进性
118
+
119
+ - [ ] **技术栈统一且成熟** — 技术选型优先使用团队熟悉的成熟技术,新技术引入有 POC 验证。
120
+ - [ ] **模块可独立部署** — 各模块可独立构建、测试、部署,无需全量发布。
121
+ - [ ] **配置外部化** — 所有环境差异通过配置注入,无代码级别的环境判断。
122
+ - [ ] **Feature Flag 机制已设计** — 支持功能开关,新功能可在线上安全地启停。
123
+ - [ ] **版本兼容策略已定义** — 接口版本化规范、废弃流程、迁移窗口已确定。
124
+ - [ ] **技术债务已评估** — 已识别的技术债务有清单和优先级排序,有计划的偿还节奏。
125
+
126
+ ---
127
+
128
+ ## 7. 成本与可行性
129
+
130
+ - [ ] **资源成本已估算** — 计算 / 存储 / 网络 / 第三方服务的月度费用已估算。
131
+ - [ ] **成本优化方案已考虑** — Reserved Instance / Spot / Serverless 等降本选项已评估。
132
+ - [ ] **团队能力匹配** — 当前团队具备实施和维护该架构的技术能力,或有明确的招聘 / 培训计划。
133
+ - [ ] **里程碑可达** — 架构实施分阶段,每阶段交付物和时间线现实可行。
134
+ - [ ] **替代方案已对比** — 至少评估了 2 个替代方案,选型决策有 ADR 记录。
135
+
136
+ ---
137
+
138
+ ## 8. 文档交付物
139
+
140
+ - [ ] **架构概览图** — C4 Level 1(系统上下文)和 Level 2(容器图)已绘制。
141
+ - [ ] **技术选型文档** — 各组件的技术选型理由和对比分析已记录。
142
+ - [ ] **数据模型文档** — ER 图 / Schema 定义 / 数据字典已完成。
143
+ - [ ] **接口契约文档** — 各模块间 API 定义(OpenAPI / Protobuf / AsyncAPI)已发布。
144
+ - [ ] **NFR 指标文档** — 非功能需求的具体量化指标已汇总。
145
+ - [ ] **ADR 文档** — 重要架构决策已记录为 Architecture Decision Record。
146
+
147
+ ---
148
+
149
+ ## 参考
150
+
151
+ - C4 Model — https://c4model.com/
152
+ - AWS Well-Architected Framework — https://aws.amazon.com/architecture/well-architected/
153
+ - Microsoft Azure Architecture Center — https://learn.microsoft.com/en-us/azure/architecture/
154
+ - Martin Fowler: Patterns of Enterprise Application Architecture
155
+
156
+ ---
157
+
158
+ ## Agent Checklist
159
+
160
+ 供 AI Agent 在执行架构评审时使用的自检项:
161
+
162
+ - [ ] 已审查架构图(系统上下文图 + 容器图),确认模块边界和依赖方向正确。
163
+ - [ ] 已逐项核对非功能需求,每个 NFR 有量化的目标值。
164
+ - [ ] 已验证数据一致性方案覆盖所有跨服务写操作场景。
165
+ - [ ] 已评估单点故障风险,确认关键路径无 SPOF。
166
+ - [ ] 已检查故障场景下的降级和恢复路径。
167
+ - [ ] 已核对技术选型与团队能力的匹配度。
168
+ - [ ] 架构评审结论已记录,包含通过项、风险项、和行动项清单。