@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,190 @@
1
+ ---
2
+ id: production-readiness-checklist
3
+ title: 生产就绪检查清单 (Production Readiness Checklist)
4
+ domain: development
5
+ category: 03-checklists
6
+ difficulty: intermediate
7
+ tags: [checklist, development, production, readiness, 可靠性与容灾, 合规与审计, 基础设施与部署, 安全]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 生产就绪检查清单 (Production Readiness Checklist)
12
+
13
+ > 适用场景:服务首次上线、重大架构变更上线、跨区域部署前的全面审查。
14
+ > 通过标准:所有 MUST 项全部勾选,SHOULD 项覆盖率 >= 90%,MAY 项视业务风险评估决定。
15
+
16
+ ---
17
+
18
+ ## 1. 基础设施与部署
19
+
20
+ ### 1.1 计算资源
21
+
22
+ - [ ] **资源规格已确认** — CPU / 内存 / 磁盘 IOPS 经过容量评估,预留 >= 30% 余量。
23
+ - [ ] **自动扩缩容策略已配置** — HPA / VPA 或云厂商 Auto Scaling 规则已生效,扩容触发阈值与冷却时间已验证。
24
+ - [ ] **节点亲和性与反亲和性已设置** — 关键服务跨可用区分布,单 AZ 故障不影响整体可用性。
25
+ - [ ] **资源限制(limits/requests)已声明** — 所有 Pod 均设置 CPU 和内存的 requests 与 limits,防止资源争抢。
26
+ - [ ] **磁盘类型与大小已规划** — SSD / HDD 选型匹配 IO 需求,PV 容量预留 >= 50% 增长空间。
27
+
28
+ ### 1.2 网络
29
+
30
+ - [ ] **DNS 解析已配置且 TTL 合理** — 生产域名已指向正确端点,TTL <= 300s 以便快速切换。
31
+ - [ ] **负载均衡健康检查已启用** — LB 健康检查路径返回 200,间隔 <= 10s,不健康阈值 <= 3 次。
32
+ - [ ] **TLS 证书已部署且自动续期** — 证书有效期 >= 30 天,自动续期机制(如 cert-manager)已验证。
33
+ - [ ] **网络策略已实施** — NetworkPolicy 或安全组仅开放必要端口,默认拒绝所有入站流量。
34
+ - [ ] **CDN / 边缘缓存已配置** — 静态资源通过 CDN 分发,缓存策略(Cache-Control / ETag)已验证。
35
+
36
+ ### 1.3 部署流程
37
+
38
+ - [ ] **CI/CD 流水线完整可用** — 从代码提交到生产部署全链路自动化,手动步骤已记录并最小化。
39
+ - [ ] **蓝绿或金丝雀发布策略已实施** — 新版本可分批放量,异常时可快速切回旧版本。
40
+ - [ ] **部署脚本幂等性已验证** — 重复执行部署不会产生副作用或数据损坏。
41
+ - [ ] **制品版本可追溯** — 镜像 / 包版本与 Git commit SHA 一一对应,可从生产环境反查代码。
42
+ - [ ] **环境变量与配置已参数化** — 无硬编码的环境特定值,所有配置通过 ConfigMap / Secret / 环境变量注入。
43
+
44
+ ---
45
+
46
+ ## 2. 监控与可观测性
47
+
48
+ ### 2.1 指标(Metrics)
49
+
50
+ - [ ] **四大黄金指标已覆盖** — 延迟(latency)、流量(traffic)、错误率(errors)、饱和度(saturation)均有对应指标。
51
+ - [ ] **业务关键指标已定义** — 注册转化率、订单成功率、支付完成率等核心业务指标已接入监控。
52
+ - [ ] **指标采集频率已确认** — 关键指标采集间隔 <= 15s,存储保留期 >= 90 天。
53
+ - [ ] **SLI / SLO 已定义** — 可用性、延迟百分位(P50/P95/P99)目标已量化,有对应 Dashboard。
54
+
55
+ ### 2.2 日志(Logging)
56
+
57
+ - [ ] **结构化日志已实施** — 使用 JSON 格式,包含 timestamp、level、service、traceId、message 字段。
58
+ - [ ] **日志分级合理** — ERROR 仅用于需要人工介入的异常,WARN 用于可自愈的异常,INFO 用于关键业务事件。
59
+ - [ ] **日志集中化采集** — 日志通过 Fluentd / Filebeat / Vector 等统一采集到 ELK / Loki / CloudWatch。
60
+ - [ ] **敏感信息已脱敏** — 日志中不包含密码、Token、身份证号、银行卡号等敏感字段。
61
+ - [ ] **日志保留策略已配置** — 热数据 >= 7 天,温数据 >= 30 天,冷数据归档 >= 180 天。
62
+
63
+ ### 2.3 链路追踪(Tracing)
64
+
65
+ - [ ] **分布式追踪已接入** — 使用 OpenTelemetry / Jaeger / Zipkin,关键链路 traceId 贯穿全链路。
66
+ - [ ] **采样率已配置** — 生产环境采样率基于流量调整,异常请求 100% 采集。
67
+ - [ ] **跨服务调用可追踪** — 从网关入口到最终数据库操作,完整链路可在追踪系统中查看。
68
+
69
+ ### 2.4 告警(Alerting)
70
+
71
+ - [ ] **告警分级已定义** — P0(立即响应,<= 5min)、P1(紧急,<= 15min)、P2(重要,<= 1h)、P3(一般,下一工作日)。
72
+ - [ ] **告警通知渠道已配置** — P0/P1 通过电话 + 短信 + IM,P2 通过 IM + 邮件,P3 通过邮件。
73
+ - [ ] **告警升级路径已明确** — 超时未响应自动升级到上级,升级链条至少 3 级。
74
+ - [ ] **告警抑制与聚合已配置** — 同一故障不重复告警,关联告警合并通知。
75
+ - [ ] **告警阈值经过历史数据校准** — 非拍脑袋阈值,基于 P95/P99 历史数据 + 业务容忍度设定。
76
+
77
+ ---
78
+
79
+ ## 3. 安全
80
+
81
+ - [ ] **认证机制已实施** — 所有 API 端点要求认证(JWT / OAuth2 / mTLS),无匿名可访问的敏感接口。
82
+ - [ ] **授权模型已实施** — RBAC / ABAC 权限模型已落地,遵循最小权限原则。
83
+ - [ ] **密钥管理规范** — 密钥 / Token / 证书通过 Vault / KMS / Secret Manager 管理,不存储在代码或配置文件中。
84
+ - [ ] **数据加密已实施** — 传输层 TLS 1.2+,存储层敏感字段 AES-256 加密。
85
+ - [ ] **输入验证已覆盖** — 所有外部输入经过白名单校验或参数化查询,防止 SQL 注入 / XSS / SSRF。
86
+ - [ ] **安全头部已配置** — HSTS / CSP / X-Frame-Options / X-Content-Type-Options 已设置。
87
+ - [ ] **依赖漏洞已扫描** — 无已知 Critical / High 漏洞,扫描工具(Snyk / Trivy / Dependabot)已集成到 CI。
88
+ - [ ] **WAF / 速率限制已启用** — 针对公网入口启用 WAF 规则和请求频率限制。
89
+
90
+ ---
91
+
92
+ ## 4. 性能
93
+
94
+ - [ ] **性能基线已建立** — 核心接口 P50 / P95 / P99 延迟基线已记录,QPS 上限已确认。
95
+ - [ ] **压力测试已完成** — 使用 k6 / JMeter / Locust 进行压测,覆盖正常流量和峰值流量(>= 2x 预期峰值)。
96
+ - [ ] **数据库查询已优化** — 慢查询(> 200ms)已加索引或重写,EXPLAIN 分析已完成。
97
+ - [ ] **缓存策略已实施** — 热点数据使用 Redis / Memcached 缓存,命中率 >= 80%,缓存失效策略已定义。
98
+ - [ ] **连接池已配置** — 数据库 / Redis / HTTP 客户端连接池大小经过调优,无连接泄漏。
99
+ - [ ] **超时设置已配置** — 所有外部调用(HTTP / RPC / DB)设置合理超时,无无限等待风险。
100
+ - [ ] **异步处理已实施** — 耗时操作通过消息队列异步化,不阻塞主请求链路。
101
+
102
+ ---
103
+
104
+ ## 5. 可靠性与容灾
105
+
106
+ ### 5.1 高可用
107
+
108
+ - [ ] **服务多实例部署** — 关键服务 >= 2 个实例,跨可用区分布。
109
+ - [ ] **数据库主从 / 多副本** — 数据库具备自动主从切换能力,RTO <= 30s。
110
+ - [ ] **无单点故障** — 架构中无 SPOF,任一组件故障不导致整体不可用。
111
+ - [ ] **优雅关闭已实现** — 收到 SIGTERM 后完成进行中请求,释放资源后退出,关闭超时 <= 30s。
112
+
113
+ ### 5.2 容灾与恢复
114
+
115
+ - [ ] **备份策略已实施** — 数据库全量备份 >= 每日 1 次,增量备份 >= 每小时 1 次。
116
+ - [ ] **备份恢复已演练** — 最近 30 天内完成过恢复演练,RPO / RTO 满足业务要求。
117
+ - [ ] **跨区域灾备已配置**(如适用)— 异地备份已验证,主区域完全不可用时可在备区域恢复。
118
+ - [ ] **回滚方案已文档化且可执行** — 应用回滚、数据回滚、配置回滚步骤已验证。
119
+
120
+ ### 5.3 降级与熔断
121
+
122
+ - [ ] **熔断器已配置** — 下游服务异常时自动熔断,防止级联故障,恢复探测间隔已设置。
123
+ - [ ] **降级策略已定义** — 非核心功能可降级为缓存数据 / 默认值 / 功能关闭。
124
+ - [ ] **限流策略已实施** — 基于用户 / IP / 接口的限流规则已配置,超限返回 429。
125
+
126
+ ---
127
+
128
+ ## 6. 数据完整性
129
+
130
+ - [ ] **数据一致性校验已实施** — 关键业务数据有对账机制,定期比对上下游数据。
131
+ - [ ] **幂等性已保证** — 写入接口支持幂等重试,不会产生重复数据。
132
+ - [ ] **数据库 Schema 变更已兼容** — 无破坏性 DDL(如删列、改类型),Schema 变更可前向兼容。
133
+ - [ ] **数据生命周期已管理** — 过期数据有归档 / 清理策略,存储增长可控。
134
+
135
+ ---
136
+
137
+ ## 7. 文档与运维手册
138
+
139
+ - [ ] **架构文档已更新** — 系统架构图、组件交互图、数据流图与当前实现一致。
140
+ - [ ] **API 文档已发布** — OpenAPI / Swagger 文档已生成并可访问,版本与生产一致。
141
+ - [ ] **Runbook 已编写** — 常见故障场景的诊断与处理步骤已文档化,新人可按步骤操作。
142
+ - [ ] **变更日志已记录** — CHANGELOG 记录本次上线的所有变更项、影响范围、回滚方式。
143
+ - [ ] **值班手册已更新** — 告警处理流程、升级路径、关键联系人信息已同步至值班团队。
144
+ - [ ] **依赖清单已维护** — 上下游服务依赖关系、第三方 SLA、联系方式已汇总。
145
+
146
+ ---
147
+
148
+ ## 8. 合规与审计
149
+
150
+ - [ ] **审计日志已启用** — 关键操作(登录、权限变更、数据修改、配置变更)有不可篡改的审计日志。
151
+ - [ ] **数据合规已确认** — 个人数据处理符合 GDPR / 个人信息保护法要求,隐私政策已更新。
152
+ - [ ] **访问控制可审计** — 谁在什么时间访问了什么资源可追溯查询。
153
+ - [ ] **保留策略符合法规** — 日志 / 数据保留期限满足行业监管要求。
154
+
155
+ ---
156
+
157
+ ## 通过标准汇总
158
+
159
+ | 类别 | MUST 项数 | 通过条件 |
160
+ |------|-----------|----------|
161
+ | 基础设施与部署 | 15 | 全部通过 |
162
+ | 监控与可观测性 | 16 | 全部通过 |
163
+ | 安全 | 8 | 全部通过 |
164
+ | 性能 | 7 | 全部通过 |
165
+ | 可靠性与容灾 | 11 | 全部通过 |
166
+ | 数据完整性 | 4 | 全部通过 |
167
+ | 文档与运维手册 | 6 | 全部通过 |
168
+ | 合规与审计 | 4 | 全部通过 |
169
+
170
+ ---
171
+
172
+ ## 参考
173
+
174
+ - Google SRE Book: Production Readiness Review — https://sre.google/sre-book/evolving-sre-engagement-model/
175
+ - AWS Well-Architected Framework — https://aws.amazon.com/architecture/well-architected/
176
+ - The Twelve-Factor App — https://12factor.net/
177
+
178
+ ---
179
+
180
+ ## Agent Checklist
181
+
182
+ 供 AI Agent 在执行生产就绪检查时使用的自检项:
183
+
184
+ - [ ] 已逐项核对上述所有检查项,未跳过任何类别。
185
+ - [ ] 对每个未通过项已记录具体原因和修复建议。
186
+ - [ ] 已与业务方确认 SLI / SLO 目标值。
187
+ - [ ] 已验证备份恢复流程可实际执行(非纸面验证)。
188
+ - [ ] 已确认告警通知链路端到端可达(发送测试告警)。
189
+ - [ ] 已在预发布环境完成全量验证后再执行生产检查。
190
+ - [ ] 检查结果已生成报告并存档至 `output/` 目录。
@@ -0,0 +1,154 @@
1
+ ---
2
+ id: release-readiness-checklist
3
+ title: 发布就绪检查清单 (Release Readiness Checklist)
4
+ domain: development
5
+ category: 03-checklists
6
+ difficulty: intermediate
7
+ tags: [checklist, development, readiness, release, 依赖确认, 发布后验证, 发布计划, 变更记录]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 发布就绪检查清单 (Release Readiness Checklist)
12
+
13
+ > 适用场景:版本发布前的最终审查,包括常规发布、热修复发布、重大版本升级。
14
+ > 通过标准:所有 MUST 项全部通过方可发布;SHOULD 项未通过需要发布负责人签字确认风险接受。
15
+
16
+ ---
17
+
18
+ ## 1. 质量门禁
19
+
20
+ ### 1.1 测试通过
21
+
22
+ - [ ] **单元测试全部通过** — 单元测试套件 0 失败,覆盖率不低于既有基线(不因本次发布降低)。
23
+ - [ ] **集成测试全部通过** — 模块间集成测试通过,包括数据库 / 缓存 / 消息队列的集成场景。
24
+ - [ ] **E2E 测试通过** — 核心用户流程(登录 / 核心业务操作 / 支付等)端到端测试通过。
25
+ - [ ] **回归测试全部通过** — 自动化回归套件 0 失败,关键业务路径人工回归已完成。
26
+ - [ ] **冒烟测试脚本已准备** — 发布后执行的冒烟测试用例已编写,覆盖核心功能可用性。
27
+
28
+ ### 1.2 缺陷状态
29
+
30
+ - [ ] **无 P0 / P1 未修复缺陷** — 所有 Critical / High 级别缺陷已修复并验证。
31
+ - [ ] **P2 缺陷已评估** — Medium 级别缺陷已逐个评估,确认不影响核心功能或已有 workaround。
32
+ - [ ] **已知问题已记录** — 本次发布的已知问题列表已整理,包含影响范围和临时应对方案。
33
+
34
+ ### 1.3 安全扫描
35
+
36
+ - [ ] **依赖漏洞扫描通过** — 无 Critical / High 级别已知漏洞(Snyk / Trivy / npm audit)。
37
+ - [ ] **SAST 扫描通过** — 静态代码安全扫描(Semgrep / SonarQube)无高危发现。
38
+ - [ ] **容器镜像扫描通过** — 生产镜像漏洞扫描无 Critical 发现。
39
+
40
+ ---
41
+
42
+ ## 2. 性能验证
43
+
44
+ - [ ] **性能基线对比通过** — 核心接口 P95 延迟未较上一版本退化 > 10%。
45
+ - [ ] **压力测试已执行** — 在预发布环境执行压测,QPS 达到预期峰值的 >= 2x 无异常。
46
+ - [ ] **资源使用评估通过** — CPU / 内存 / 磁盘 / 网络使用在预期范围内,无资源泄漏趋势。
47
+ - [ ] **慢查询已检查** — 新增数据库查询无 > 200ms 的慢查询,或已确认可接受。
48
+ - [ ] **前端性能达标**(如适用)— Lighthouse 评分 >= 80,LCP <= 2.5s,FID <= 100ms,CLS <= 0.1。
49
+
50
+ ---
51
+
52
+ ## 3. 监控与告警
53
+
54
+ - [ ] **监控面板已更新** — Grafana / CloudWatch Dashboard 已包含新功能的关键指标。
55
+ - [ ] **告警规则已配置** — 新增功能的异常阈值告警已配置,通知渠道已验证。
56
+ - [ ] **SLI / SLO 指标已更新** — 新增接口已纳入 SLI 计算范围。
57
+ - [ ] **日志采集已验证** — 新增日志在预发布环境可正常检索和查询。
58
+ - [ ] **链路追踪已验证** — 新增服务调用链路在追踪系统中可完整查看。
59
+
60
+ ---
61
+
62
+ ## 4. 回滚准备
63
+
64
+ - [ ] **回滚方案已文档化** — 回滚步骤已编写,包含应用回滚、数据回滚、配置回滚的具体操作。
65
+ - [ ] **回滚已演练** — 在预发布环境执行过回滚操作,验证回滚后系统正常。
66
+ - [ ] **回滚触发条件已定义** — 明确什么指标异常时触发回滚(如错误率 > 5%,P99 延迟 > 3s)。
67
+ - [ ] **数据库变更可回滚** — DB migration 有对应的 rollback migration,且已验证。
68
+ - [ ] **Feature Flag 可关闭**(如使用)— 新功能可通过 Feature Flag 立即关闭而无需部署。
69
+
70
+ ---
71
+
72
+ ## 5. 发布计划
73
+
74
+ ### 5.1 时间窗口
75
+
76
+ - [ ] **发布时间已确定** — 避开业务高峰期,选择低流量窗口(如工作日上午 10:00-12:00)。
77
+ - [ ] **变更窗口已申请** — 变更管理系统中已提交并获批变更申请。
78
+ - [ ] **维护通知已发送**(如有停机)— 提前 >= 24 小时通知受影响用户。
79
+ - [ ] **发布时长已评估** — 发布预计耗时已评估,预留充足的验证和观察时间。
80
+
81
+ ### 5.2 人员安排
82
+
83
+ - [ ] **发布负责人已指定** — 有明确的发布协调人,对发布过程全程负责。
84
+ - [ ] **值班人员已安排** — 发布后 >= 2 小时有工程师值守,P0/P1 告警可 5 分钟内响应。
85
+ - [ ] **上下游团队已通知** — 依赖服务方和被依赖方已知悉发布计划和潜在影响。
86
+ - [ ] **DBA 支持已确认**(如涉及 DB 变更)— DBA 在发布窗口内可支持数据库操作。
87
+
88
+ ### 5.3 发布策略
89
+
90
+ - [ ] **发布方式已确定** — 蓝绿 / 金丝雀 / 滚动更新策略已选定,配置已就绪。
91
+ - [ ] **灰度比例已规划** — 金丝雀发布的流量比例和观察时间已定义(如 5% -> 20% -> 50% -> 100%)。
92
+ - [ ] **健康检查已配置** — 部署后自动执行健康检查,不健康实例自动排除。
93
+
94
+ ---
95
+
96
+ ## 6. 依赖确认
97
+
98
+ - [ ] **上游依赖版本已锁定** — 本次发布依赖的外部服务版本已确认稳定。
99
+ - [ ] **下游兼容性已确认** — 本次变更不影响下游消费方,或已协调下游同步升级。
100
+ - [ ] **第三方服务状态正常** — 依赖的第三方 API / SaaS 服务当前运行正常(检查 Status Page)。
101
+ - [ ] **基础设施就绪** — 新增资源(DB 实例 / 缓存集群 / 消息队列 Topic)已创建并就绪。
102
+ - [ ] **配置变更已同步** — 环境变量 / ConfigMap / Feature Flag 已在生产环境准备好。
103
+
104
+ ---
105
+
106
+ ## 7. 变更记录
107
+
108
+ - [ ] **CHANGELOG 已更新** — 本版本所有变更项已记录,包含新功能、修复、破坏性变更。
109
+ - [ ] **版本号已更新** — 遵循 SemVer 规范(MAJOR.MINOR.PATCH),版本号已在代码和构建配置中更新。
110
+ - [ ] **Release Notes 已编写** — 面向用户的发布说明已撰写,语言简洁清晰。
111
+ - [ ] **内部发布邮件已准备** — 包含变更摘要、影响范围、值班安排、回滚方案的内部邮件已拟好。
112
+
113
+ ---
114
+
115
+ ## 8. 发布后验证
116
+
117
+ - [ ] **冒烟测试已执行** — 发布后立即执行冒烟测试,核心功能全部可用。
118
+ - [ ] **监控指标已观察** — 发布后 >= 30 分钟持续观察关键指标,无异常波动。
119
+ - [ ] **日志无异常** — 无新增 ERROR 级别日志,无异常堆栈追踪。
120
+ - [ ] **用户反馈通道已开启** — 客服 / 社区 / 内部反馈渠道已关注,可快速接收异常报告。
121
+ - [ ] **发布结果已记录** — 发布时间、执行人、验证结果、观察期结论已记录。
122
+
123
+ ---
124
+
125
+ ## 热修复发布附加项
126
+
127
+ 以下检查项适用于紧急热修复场景(在常规检查的基础上追加):
128
+
129
+ - [ ] **影响范围已精确评估** — 仅修改受影响的最小代码范围,不夹带其他变更。
130
+ - [ ] **修复已在预发布环境验证** — 即使紧急,也必须在 staging 验证后再发生产。
131
+ - [ ] **事故时间线已记录** — 从问题发现到修复发布的完整时间线已记录。
132
+ - [ ] **事后复盘已排期** — 热修复后 48 小时内安排事后复盘(Post-Mortem)。
133
+
134
+ ---
135
+
136
+ ## 参考
137
+
138
+ - Semantic Versioning — https://semver.org/
139
+ - Google SRE: Release Engineering — https://sre.google/sre-book/release-engineering/
140
+ - Continuous Delivery by Jez Humble & David Farley
141
+
142
+ ---
143
+
144
+ ## Agent Checklist
145
+
146
+ 供 AI Agent 在执行发布就绪检查时使用的自检项:
147
+
148
+ - [ ] 已确认 CI 流水线全部通过,无跳过或忽略的失败项。
149
+ - [ ] 已核对依赖服务状态,确认上下游正常运行。
150
+ - [ ] 已验证回滚方案在预发布环境可执行。
151
+ - [ ] 已确认值班人员安排和告警通知链路可达。
152
+ - [ ] 已检查 CHANGELOG 和版本号是否已正确更新。
153
+ - [ ] 已核对发布后冒烟测试用例覆盖核心业务路径。
154
+ - [ ] 发布就绪检查报告已生成并存档至 `output/` 目录。
@@ -0,0 +1,182 @@
1
+ ---
2
+ id: security-review-checklist
3
+ title: 安全评审检查清单 (Security Review Checklist)
4
+ domain: development
5
+ category: 03-checklists
6
+ difficulty: intermediate
7
+ tags: [checklist, development, owasp, review, security, 依赖与供应链安全, 基础设施安全, 安全]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 安全评审检查清单 (Security Review Checklist)
12
+
13
+ > 适用场景:新功能安全评审、定期安全审计、第三方集成安全评估、合规检查。
14
+ > 通过标准:所有 Critical / High 项全部通过,Medium 项覆盖率 >= 90%,Low 项记录并排期修复。
15
+
16
+ ---
17
+
18
+ ## 1. 认证(Authentication)
19
+
20
+ ### 1.1 身份验证机制
21
+
22
+ - [ ] **认证方案已确定** — 使用标准协议(OAuth 2.0 / OpenID Connect / SAML),非自研认证方案。
23
+ - [ ] **密码策略已实施** — 最小长度 >= 8 字符,要求包含大小写字母 + 数字 + 特殊字符,禁止常见弱密码。
24
+ - [ ] **密码存储安全** — 使用 bcrypt / scrypt / Argon2 哈希存储,cost factor >= 10,不使用 MD5 / SHA1。
25
+ - [ ] **多因素认证已支持** — 高权限账户强制 MFA(TOTP / WebAuthn / SMS),普通用户可选开启。
26
+ - [ ] **登录失败锁定已配置** — 连续失败 >= 5 次锁定账户 15 分钟,或启用渐进式延迟。
27
+ - [ ] **会话管理安全** — Session ID 随机生成(>= 128 bit),登录后重新生成,HttpOnly + Secure + SameSite 属性已设置。
28
+
29
+ ### 1.2 Token 安全
30
+
31
+ - [ ] **JWT 签名算法安全** — 使用 RS256 / ES256,禁止 none / HS256(对称密钥场景除外)。
32
+ - [ ] **Token 有效期合理** — Access Token <= 15 分钟,Refresh Token <= 7 天,支持主动撤销。
33
+ - [ ] **Token 存储安全** — 前端存储于 HttpOnly Cookie 或内存中,不使用 localStorage。
34
+ - [ ] **Token 刷新机制安全** — Refresh Token 轮转(使用后失效),检测重放攻击时撤销整个会话。
35
+
36
+ ---
37
+
38
+ ## 2. 授权(Authorization)
39
+
40
+ - [ ] **权限模型已实施** — RBAC / ABAC 权限体系已落地,角色与权限映射已文档化。
41
+ - [ ] **最小权限原则** — 用户 / 服务账号仅拥有完成职能所需的最小权限集。
42
+ - [ ] **越权访问已防护** — 水平越权(访问同级别其他用户数据)和垂直越权(提升自身权限)均有检查。
43
+ - [ ] **资源级别权限校验** — 每次资源访问都验证当前用户是否有权操作该具体资源,不仅检查角色。
44
+ - [ ] **管理接口隔离** — Admin API 独立部署或网络隔离,不对公网暴露。
45
+ - [ ] **权限变更有审计** — 角色分配、权限调整操作记录审计日志,支持事后追溯。
46
+ - [ ] **服务间认证已实施** — 微服务间调用使用 mTLS / Service Mesh / API Key,不允许无认证内部调用。
47
+
48
+ ---
49
+
50
+ ## 3. 输入验证与注入防护
51
+
52
+ ### 3.1 SQL 注入
53
+
54
+ - [ ] **参数化查询已全面使用** — 所有数据库操作使用 ORM 或参数化查询(Prepared Statement),无字符串拼接 SQL。
55
+ - [ ] **数据库账号权限最小化** — 应用使用的数据库账号无 DROP / GRANT / CREATE USER 权限。
56
+ - [ ] **动态排序/分页字段白名单** — ORDER BY / LIMIT 等动态字段通过白名单校验,不直接拼接用户输入。
57
+
58
+ ### 3.2 XSS(跨站脚本)
59
+
60
+ - [ ] **输出编码已实施** — 所有动态内容输出时根据上下文进行 HTML / JS / URL / CSS 编码。
61
+ - [ ] **CSP 头已配置** — Content-Security-Policy 限制脚本来源,禁止 inline script(或使用 nonce)。
62
+ - [ ] **富文本输入已净化** — 使用 DOMPurify / bleach 等白名单净化库处理 HTML 输入。
63
+ - [ ] **Cookie 设置 HttpOnly** — 敏感 Cookie 不可被 JavaScript 访问。
64
+
65
+ ### 3.3 其他注入
66
+
67
+ - [ ] **SSRF 防护已实施** — 用户可控 URL 经过内网地址 / 回环地址 / 元数据端点过滤。
68
+ - [ ] **命令注入已防护** — 避免直接调用 shell 命令,必须调用时使用参数数组而非字符串拼接。
69
+ - [ ] **路径遍历已防护** — 文件操作路径经过规范化处理,禁止 `../` 遍历。
70
+ - [ ] **XML 外部实体(XXE)已禁用** — XML 解析器禁用 DTD 和外部实体加载。
71
+ - [ ] **反序列化安全** — 不反序列化不可信数据,或使用安全的序列化格式(JSON 而非 Pickle / Java Serialization)。
72
+
73
+ ### 3.4 通用输入校验
74
+
75
+ - [ ] **白名单优于黑名单** — 输入校验优先使用允许列表,拒绝不在列表中的输入。
76
+ - [ ] **文件上传已限制** — 文件类型通过 MIME + 魔数校验,大小有上限,存储路径不可被直接访问。
77
+ - [ ] **请求体大小已限制** — 配置最大请求体大小(如 10MB),防止大负载 DoS。
78
+
79
+ ---
80
+
81
+ ## 4. 数据保护
82
+
83
+ ### 4.1 传输加密
84
+
85
+ - [ ] **TLS 1.2+ 已强制** — 禁用 TLS 1.0 / 1.1 / SSLv3,仅允许安全密码套件。
86
+ - [ ] **HSTS 已启用** — Strict-Transport-Security 头 max-age >= 31536000,包含 includeSubDomains。
87
+ - [ ] **内部通信加密** — 微服务间通信使用 mTLS 或加密通道,不传输明文敏感数据。
88
+
89
+ ### 4.2 存储加密
90
+
91
+ - [ ] **敏感字段加密存储** — 密码、密钥、身份证号、银行卡号等使用 AES-256-GCM 或同等强度加密。
92
+ - [ ] **加密密钥独立管理** — 密钥存储于 KMS / Vault,与加密数据物理分离,支持密钥轮转。
93
+ - [ ] **备份数据已加密** — 数据库备份、日志归档均加密存储,访问需要独立授权。
94
+
95
+ ### 4.3 敏感信息管理
96
+
97
+ - [ ] **密钥不在代码中** — 代码库中无硬编码的 API Key / Secret / 密码,CI/CD 使用密钥管理服务注入。
98
+ - [ ] **日志中无敏感信息** — 日志输出已脱敏,不包含密码、Token、PII 数据。
99
+ - [ ] **错误响应不泄露内部信息** — 生产环境错误响应不包含堆栈追踪、数据库表名、内部 IP。
100
+ - [ ] **Git 历史已清理** — 历史提交中无泄露的密钥 / 密码(使用 git-secrets / truffleHog 扫描)。
101
+
102
+ ---
103
+
104
+ ## 5. API 安全
105
+
106
+ - [ ] **速率限制已实施** — 按用户 / IP / 接口配置请求频率限制,超限返回 HTTP 429。
107
+ - [ ] **CORS 策略已配置** — Access-Control-Allow-Origin 明确指定允许的域名,不使用 `*`(公共 API 除外)。
108
+ - [ ] **CSRF 防护已实施** — 状态变更操作使用 CSRF Token 或 SameSite Cookie + Origin 头校验。
109
+ - [ ] **API 版本化已实施** — API 变更通过版本号管理(URL / Header),废弃版本有迁移期。
110
+ - [ ] **请求/响应 Schema 校验** — 使用 JSON Schema / Protobuf 校验请求格式,拒绝异常结构。
111
+ - [ ] **GraphQL 安全**(如适用)— 查询深度限制、复杂度限制、内省在生产环境禁用。
112
+
113
+ ---
114
+
115
+ ## 6. 依赖与供应链安全
116
+
117
+ - [ ] **依赖漏洞扫描已集成** — CI 中运行 Snyk / Trivy / npm audit / pip-audit,Critical / High 阻断发布。
118
+ - [ ] **依赖版本已锁定** — 使用 lock 文件(package-lock.json / poetry.lock / go.sum),构建可重现。
119
+ - [ ] **基础镜像安全** — Docker 基础镜像使用官方镜像 + 固定版本号,定期更新。
120
+ - [ ] **容器以非 root 运行** — Dockerfile 指定非 root 用户,不使用 `--privileged` 模式。
121
+ - [ ] **软件物料清单(SBOM)已生成** — 使用 Syft / CycloneDX 生成 SBOM,可追溯所有依赖来源。
122
+ - [ ] **第三方库许可证合规** — 无 GPL(如商业项目不兼容)或其他限制性许可证冲突。
123
+
124
+ ---
125
+
126
+ ## 7. 基础设施安全
127
+
128
+ - [ ] **网络分段已实施** — 数据库 / 缓存 / 内部服务不对公网暴露,通过私有子网 + 安全组隔离。
129
+ - [ ] **SSH / 远程访问受控** — 禁用密码登录,使用密钥认证 + 跳板机,会话有审计记录。
130
+ - [ ] **Kubernetes 安全策略** — PodSecurityPolicy / OPA / Kyverno 限制特权容器、hostNetwork、hostPID。
131
+ - [ ] **镜像签名与验证** — 容器镜像经过签名(Cosign / Notation),部署时验证签名完整性。
132
+ - [ ] **Secret 管理** — Kubernetes Secret 加密存储(etcd 加密),或使用 External Secrets Operator 对接 Vault。
133
+
134
+ ---
135
+
136
+ ## 8. 安全监控与响应
137
+
138
+ - [ ] **安全事件日志集中化** — 认证失败、授权拒绝、异常访问模式日志统一采集到 SIEM。
139
+ - [ ] **异常检测规则已配置** — 暴力破解、异地登录、大量 403/401 等模式有自动告警。
140
+ - [ ] **安全事件响应流程已定义** — 事件分级、通知链路、处置步骤、事后复盘流程已文档化。
141
+ - [ ] **渗透测试已完成** — 上线前完成内部或第三方渗透测试,高危发现已修复。
142
+ - [ ] **安全联系方式已公开** — security.txt 或安全响应邮箱已配置,外部可报告漏洞。
143
+
144
+ ---
145
+
146
+ ## 9. OWASP Top 10 对照
147
+
148
+ | OWASP 风险 | 对应检查项 | 状态 |
149
+ |-------------|-----------|------|
150
+ | A01: Broken Access Control | 第 2 节(授权)全部 | |
151
+ | A02: Cryptographic Failures | 第 4 节(数据保护)全部 | |
152
+ | A03: Injection | 第 3 节(输入验证)全部 | |
153
+ | A04: Insecure Design | 架构评审检查清单 | |
154
+ | A05: Security Misconfiguration | 第 7 节(基础设施安全)| |
155
+ | A06: Vulnerable Components | 第 6 节(依赖安全)全部 | |
156
+ | A07: Auth Failures | 第 1 节(认证)全部 | |
157
+ | A08: Software/Data Integrity | 第 6 节(SBOM + 镜像签名)| |
158
+ | A09: Logging/Monitoring Failures | 第 8 节(安全监控)全部 | |
159
+ | A10: SSRF | 3.3 节(SSRF 防护)| |
160
+
161
+ ---
162
+
163
+ ## 参考
164
+
165
+ - OWASP Top 10 (2021) — https://owasp.org/Top10/
166
+ - OWASP ASVS (Application Security Verification Standard) — https://owasp.org/www-project-application-security-verification-standard/
167
+ - CWE/SANS Top 25 — https://cwe.mitre.org/top25/
168
+ - NIST Cybersecurity Framework — https://www.nist.gov/cyberframework
169
+
170
+ ---
171
+
172
+ ## Agent Checklist
173
+
174
+ 供 AI Agent 在执行安全评审时使用的自检项:
175
+
176
+ - [ ] 已逐项核对 OWASP Top 10 对照表,无遗漏风险类别。
177
+ - [ ] 已使用自动化工具扫描(Trivy / Snyk / Semgrep),非纯人工目检。
178
+ - [ ] 已检查 Git 历史中是否存在泄露的密钥或凭证。
179
+ - [ ] 已验证所有外部输入的处理路径,包括 Header / Cookie / Query / Body / File。
180
+ - [ ] 已确认安全配置在所有环境(dev / staging / prod)一致。
181
+ - [ ] 已记录每个未通过项的风险等级(Critical / High / Medium / Low)和修复建议。
182
+ - [ ] 安全评审报告已存档至 `output/` 目录。