@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,147 @@
1
+ ---
2
+ id: case-rag-production
3
+ title: RAG 系统生产化案例:从 PoC 到生产的知识库问答系统
4
+ domain: ai
5
+ category: 05-cases
6
+ difficulty: intermediate
7
+ tags: [3-10, agent, ai, case, checklist, production, rag, 上线效果]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # RAG 系统生产化案例:从 PoC 到生产的知识库问答系统
12
+
13
+ ## 概述
14
+
15
+ 本案例记录一个企业内部知识库问答系统的 RAG(Retrieval-Augmented Generation)落地过程。
16
+ 项目从 PoC 验证到生产上线历时 4 个月,最终服务 2000+ 内部用户,日均处理 5000+ 次查询,
17
+ 答案准确率从 PoC 阶段的 62% 提升到生产环境的 91%。
18
+
19
+ ## 背景与目标
20
+
21
+ - **业务痛点**: 企业内部知识分散在 Confluence、飞书文档、PDF 手册等多个平台,员工检索效率低
22
+ - **项目目标**: 构建统一知识问答入口,响应时间 < 3s,准确率 > 85%
23
+ - **技术选型**: LangChain + Milvus + OpenAI GPT-4 / 本地部署 Qwen-14B 备选
24
+
25
+ ## PoC 阶段(第 1-2 周)
26
+
27
+ ### 快速验证
28
+
29
+ ```
30
+ 数据量: 500 篇文档
31
+ 向量库: ChromaDB(单机)
32
+ Embedding: text-embedding-ada-002
33
+ Chunk 策略: 固定 512 token,重叠 50 token
34
+ ```
35
+
36
+ ### PoC 问题清单
37
+
38
+ | 问题 | 影响 | 根因 |
39
+ |------|------|------|
40
+ | 答案幻觉严重 | 准确率仅 62% | 检索召回不足,模型补脑 |
41
+ | 长文档丢失上下文 | 关键信息遗漏 | 固定分块破坏语义完整性 |
42
+ | 表格/图片信息丢失 | 技术手册不可用 | 仅处理纯文本 |
43
+ | 响应延迟 > 8s | 用户体验差 | 未做缓存和异步 |
44
+
45
+ ## 生产化改造(第 3-10 周)
46
+
47
+ ### 1. 文档处理管道重建
48
+
49
+ - **多格式解析**: 引入 Unstructured.io 处理 PDF/DOCX/HTML/Markdown
50
+ - **表格提取**: 专用表格解析器,转为结构化 Markdown
51
+ - **图片处理**: OCR + 多模态模型生成图片描述文本
52
+ - **元数据保留**: 保留文档标题、章节层级、更新时间、作者
53
+
54
+ ### 2. 分块策略优化
55
+
56
+ ```python
57
+ # 从固定分块改为语义分块
58
+ chunking_config = {
59
+ "strategy": "semantic", # 语义边界分块
60
+ "max_tokens": 1024, # 增大上限
61
+ "min_tokens": 128, # 避免过碎
62
+ "overlap_tokens": 100, # 增加重叠
63
+ "respect_boundaries": True, # 尊重标题/段落边界
64
+ "parent_child": True, # 父子分块:检索子块,返回父块
65
+ }
66
+ ```
67
+
68
+ ### 3. 检索策略升级
69
+
70
+ - **混合检索**: 向量检索 + BM25 关键词检索,RRF 融合排序
71
+ - **查询改写**: 用 LLM 将用户口语化问题改写为检索友好的查询
72
+ - **多路召回**: Top-K 从 3 提升到 10,再用 Cross-Encoder 重排序到 Top-3
73
+ - **元数据过滤**: 支持按文档类型、部门、时间范围过滤
74
+
75
+ ### 4. 生成质量控制
76
+
77
+ - **Prompt 工程**: 明确指令"仅基于提供的上下文回答,无法回答时说明"
78
+ - **引用溯源**: 每个答案附带来源文档链接和相关段落
79
+ - **置信度评分**: 检索相似度 < 0.6 时主动提示"未找到高相关信息"
80
+ - **答案验证**: 后处理检查答案是否与检索内容一致
81
+
82
+ ### 5. 基础设施
83
+
84
+ ```
85
+ 向量数据库: Milvus 集群(3 节点,16GB 内存/节点)
86
+ 缓存层: Redis(热门问题缓存,TTL 24h)
87
+ 消息队列: RabbitMQ(文档更新异步索引)
88
+ 监控: Prometheus + Grafana(延迟/准确率/召回率看板)
89
+ ```
90
+
91
+ ## 数据同步与更新
92
+
93
+ ### 增量更新机制
94
+
95
+ - Confluence/飞书通过 Webhook 触发增量索引
96
+ - PDF/手册通过定时扫描(每 4 小时)检测变更
97
+ - 文档删除时同步清理向量库中的对应 chunk
98
+ - 全量重建索引:每周日凌晨执行,保证一致性
99
+
100
+ ### 数据质量保障
101
+
102
+ - 文档去重:基于内容 hash 去重
103
+ - 过期检测:超过 12 个月未更新的文档标记警告
104
+ - 质量评分:基于文档结构完整度、内容长度给出质量分
105
+
106
+ ## 上线效果
107
+
108
+ | 指标 | PoC | 生产 V1 | 生产 V2(当前) |
109
+ |------|-----|---------|----------------|
110
+ | 准确率 | 62% | 83% | 91% |
111
+ | 平均响应时间 | 8.2s | 3.1s | 1.8s |
112
+ | 文档覆盖 | 500 篇 | 8,000 篇 | 15,000 篇 |
113
+ | 日均查询量 | - | 1,200 | 5,000+ |
114
+ | 用户满意度 | - | 72% | 88% |
115
+
116
+ ## 关键教训
117
+
118
+ 1. **分块策略是核心**: 检索质量 80% 取决于分块质量,而非模型能力
119
+ 2. **混合检索必须做**: 纯向量检索对精确关键词(如错误码、配置项)召回不足
120
+ 3. **评测体系先行**: 在优化前先建立 200+ 标注问答对的评测集
121
+ 4. **缓存收益巨大**: 30% 的查询是重复问题,缓存命中直接省掉推理成本
122
+ 5. **用户反馈闭环**: 每个答案的"有用/无用"按钮是最有价值的优化信号
123
+
124
+ ## 成本分析
125
+
126
+ ```
127
+ 月度成本(15,000 篇文档,5,000 日查询):
128
+ - Milvus 集群: ¥3,000/月
129
+ - LLM API 调用: ¥8,000/月(GPT-4)/ ¥1,200/月(Qwen-14B 自部署)
130
+ - Redis + 中间件: ¥500/月
131
+ - 人力维护: 0.5 人/月
132
+ ```
133
+
134
+ ## Agent Checklist
135
+
136
+ - [ ] 文档处理管道是否支持目标格式(PDF/DOCX/HTML/Markdown)
137
+ - [ ] 分块策略是否基于语义边界而非固定长度
138
+ - [ ] 是否实现混合检索(向量 + 关键词)
139
+ - [ ] 是否有查询改写和重排序机制
140
+ - [ ] 生成答案是否附带来源引用
141
+ - [ ] 低置信度查询是否有降级策略
142
+ - [ ] 增量索引和数据同步是否已实现
143
+ - [ ] 评测数据集是否建立(至少 100+ 标注对)
144
+ - [ ] 监控看板是否覆盖延迟/准确率/召回率
145
+ - [ ] 缓存策略是否已配置且 TTL 合理
146
+ - [ ] 文档过期和去重机制是否就绪
147
+ - [ ] 成本预算是否明确且在可控范围内
@@ -0,0 +1,162 @@
1
+ ---
2
+ id: ai-glossary
3
+ title: AI/ML 术语表 (AI/ML Glossary)
4
+ domain: ai
5
+ category: 06-glossary
6
+ difficulty: intermediate
7
+ tags: [ai, glossary, prompt, transformer, 与注意力机制, 基础概念, 大语言模型, 工程]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # AI/ML 术语表 (AI/ML Glossary)
12
+
13
+ > 适用场景:AI 项目沟通对齐、新成员 Onboarding、技术方案评审中的概念统一。
14
+ > 涵盖范围:深度学习基础、大语言模型、训练优化、推理部署、Agent 与 RAG 等 40+ 核心术语。
15
+
16
+ ---
17
+
18
+ ## 基础概念
19
+
20
+ | 术语 | 英文 | 定义 | 关联术语 |
21
+ |------|------|------|----------|
22
+ | 机器学习 | Machine Learning (ML) | 通过数据训练算法使其自动学习规律并进行预测,无需显式编程。分为监督学习、无监督学习、强化学习三大范式。 | Deep Learning, Supervised Learning |
23
+ | 深度学习 | Deep Learning (DL) | 基于多层神经网络的机器学习方法,能自动从原始数据中学习层次化特征表示。 | Neural Network, Feature Learning |
24
+ | 神经网络 | Neural Network (NN) | 受生物神经元启发的计算模型,由输入层、隐藏层和输出层组成,通过反向传播学习权重。 | Backpropagation, Activation Function |
25
+ | 损失函数 | Loss Function | 衡量模型预测值与真实值之间差距的函数,训练目标是最小化损失。常见有交叉熵、MSE 等。 | Optimization, Gradient Descent |
26
+ | 过拟合 | Overfitting | 模型在训练集上表现好但在新数据上表现差,学习了噪声而非规律。对策包括正则化、Dropout、数据增强。 | Underfitting, Regularization |
27
+ | 特征工程 | Feature Engineering | 从原始数据中构造有助于模型学习的输入特征的过程。在传统 ML 中极其关键,深度学习中部分被自动化替代。 | Feature Selection, Embedding |
28
+
29
+ ---
30
+
31
+ ## Transformer 与注意力机制
32
+
33
+ | 术语 | 英文 | 定义 | 关联术语 |
34
+ |------|------|------|----------|
35
+ | Transformer | Transformer | Google 2017 年提出的序列模型架构,基于自注意力机制,支持并行计算,取代 RNN 成为 NLP 主流。所有现代 LLM 均基于此架构。 | Self-Attention, Encoder-Decoder |
36
+ | 注意力机制 | Attention Mechanism | 允许模型在处理某个位置时动态关注输入序列中最相关部分的机制。计算 Query-Key-Value 的加权和。 | Self-Attention, Multi-Head Attention |
37
+ | 自注意力 | Self-Attention | 输入序列对自身的注意力计算,每个 Token 关注同一序列中所有其他 Token,捕获长距离依赖。 | Attention, Transformer |
38
+ | 多头注意力 | Multi-Head Attention | 将注意力计算拆分为多个并行的"头",每个头学习不同的注意力模式,最后拼接合并。 | Self-Attention, Transformer |
39
+ | 位置编码 | Positional Encoding | 向 Token Embedding 中注入位置信息的技术,因为 Transformer 本身不感知序列顺序。包括正弦编码和 RoPE 等。 | Transformer, RoPE |
40
+
41
+ ---
42
+
43
+ ## 大语言模型 (LLM)
44
+
45
+ | 术语 | 英文 | 定义 | 关联术语 |
46
+ |------|------|------|----------|
47
+ | 大语言模型 | Large Language Model (LLM) | 参数量在数十亿以上、基于 Transformer 的语言模型,通过大规模文本预训练获得通用语言理解和生成能力。 | GPT, Claude, Llama |
48
+ | Token | Token | 文本被分词器切分后的最小单位,可以是单词、子词或字符。LLM 以 Token 为单位处理和生成文本。 | Tokenizer, BPE |
49
+ | 上下文窗口 | Context Window | LLM 单次推理能处理的最大 Token 数量。超出窗口的内容无法被模型感知。现代模型范围从 4K 到 1M+。 | Token, Long Context |
50
+ | 温度 | Temperature | 控制 LLM 输出随机性的参数。温度越低输出越确定(贪心),温度越高输出越多样(创意)。 | Top-P, Sampling |
51
+ | 幻觉 | Hallucination | LLM 生成看似合理但事实错误的内容。根因是模型基于概率生成而非事实检索。 | Grounding, RAG |
52
+ | 接地 | Grounding | 将 LLM 输出与外部可信数据源关联验证的技术,减少幻觉。常见方式包括 RAG、工具调用、引用标注。 | Hallucination, RAG |
53
+
54
+ ---
55
+
56
+ ## 训练方法
57
+
58
+ | 术语 | 英文 | 定义 | 关联术语 |
59
+ |------|------|------|----------|
60
+ | 微调 | Fine-tuning | 在预训练模型基础上,使用特定任务数据继续训练以适配目标场景。可以是全量微调或参数高效微调。 | LoRA, PEFT |
61
+ | LoRA | Low-Rank Adaptation | 参数高效微调方法,在原始权重旁增加低秩矩阵,仅训练新增参数(通常 < 1%),大幅降低微调成本。 | Fine-tuning, QLoRA, PEFT |
62
+ | QLoRA | Quantized LoRA | LoRA 的改进版本,将基础模型量化到 4-bit 后再做 LoRA 微调,使大模型微调可在消费级 GPU 上运行。 | LoRA, Quantization |
63
+ | RLHF | Reinforcement Learning from Human Feedback | 通过人类偏好反馈训练奖励模型,再用强化学习(PPO)优化 LLM 输出,使其更符合人类期望。ChatGPT 的核心训练方法之一。 | DPO, Reward Model, PPO |
64
+ | DPO | Direct Preference Optimization | RLHF 的简化替代方案,直接用偏好数据优化模型,无需单独训练奖励模型。更稳定且计算成本更低。 | RLHF, Preference Learning |
65
+ | 预训练 | Pre-training | 在大规模无标注数据上训练语言模型的初始阶段,通过预测下一个 Token(自回归)或掩码恢复(BERT)学习语言表示。 | Fine-tuning, Self-supervised |
66
+ | 蒸馏 | Distillation | 将大模型(Teacher)的知识迁移到小模型(Student)的训练技术,小模型学习大模型的输出分布而非原始标签。 | Compression, Quantization |
67
+
68
+ ---
69
+
70
+ ## 推理与优化
71
+
72
+ | 术语 | 英文 | 定义 | 关联术语 |
73
+ |------|------|------|----------|
74
+ | 推理 | Inference | 使用训练好的模型对新输入进行预测/生成的过程。推理阶段的优化重点是延迟和吞吐量。 | Latency, Throughput |
75
+ | 延迟 | Latency | 从发送推理请求到收到完整响应的时间。通常关注首 Token 延迟(TTFT)和每 Token 生成时间。 | TTFT, Throughput |
76
+ | 吞吐量 | Throughput | 单位时间内系统能处理的请求数或生成的 Token 数。衡量推理服务的处理能力。 | Latency, Batch Size |
77
+ | 量化 | Quantization | 将模型权重从高精度(FP32)压缩到低精度(FP16/INT8/INT4)以减少内存占用和加速推理,精度损失通常可控。 | GPTQ, AWQ, Distillation |
78
+ | KV Cache | Key-Value Cache | 自回归生成时缓存已计算的 Key 和 Value 矩阵,避免重复计算。是 LLM 推理内存占用的主要来源。 | PagedAttention, Inference |
79
+
80
+ ---
81
+
82
+ ## Prompt 工程
83
+
84
+ | 术语 | 英文 | 定义 | 关联术语 |
85
+ |------|------|------|----------|
86
+ | Prompt | Prompt | 输入给 LLM 的指令或上下文文本,引导模型生成期望输出。Prompt 的质量直接影响输出质量。 | System Prompt, Template |
87
+ | 少样本学习 | Few-Shot Learning | 在 Prompt 中提供少量(通常 1-5 个)输入-输出示例,引导模型理解任务格式和期望行为。 | Zero-Shot, In-Context Learning |
88
+ | 零样本学习 | Zero-Shot Learning | 不提供任何示例,仅通过任务描述让模型完成任务。依赖模型的预训练知识和指令遵循能力。 | Few-Shot, Instruction Tuning |
89
+ | 思维链 | Chain-of-Thought (CoT) | 引导 LLM 逐步推理而非直接给出答案的 Prompt 技术,在复杂推理任务上显著提升准确率。 | Few-Shot, Reasoning |
90
+ | 思维树 | Tree-of-Thought (ToT) | CoT 的扩展,允许模型探索多个推理路径并评估选择最优解,适用于需要搜索和规划的复杂任务。 | CoT, Self-Consistency |
91
+
92
+ ---
93
+
94
+ ## RAG 与检索
95
+
96
+ | 术语 | 英文 | 定义 | 关联术语 |
97
+ |------|------|------|----------|
98
+ | RAG | Retrieval-Augmented Generation | 检索增强生成,将外部知识库的检索结果作为 LLM 的上下文,生成更准确、可溯源的回答。减少幻觉的主流方案。 | Embedding, Vector DB, Grounding |
99
+ | 向量嵌入 | Embedding | 将文本/图像等非结构化数据映射为固定维度的稠密向量,使语义相近的内容在向量空间中距离更近。 | Vector DB, Similarity Search |
100
+ | 向量数据库 | Vector Database | 专门存储和检索向量嵌入的数据库,支持高效的近似最近邻(ANN)搜索。代表产品:Pinecone / Milvus / Weaviate / Qdrant。 | Embedding, ANN, HNSW |
101
+ | 混合检索 | Hybrid Search | 结合稀疏检索(BM25 关键词匹配)和稠密检索(向量语义匹配)的检索策略,兼顾精确匹配和语义理解。 | BM25, Embedding, Reranking |
102
+ | 重排序 | Reranking | 对初步检索结果用更精确的模型(如 Cross-Encoder)重新排序,提升 Top-K 结果质量。 | Retrieval, Cross-Encoder |
103
+
104
+ ---
105
+
106
+ ## Agent 与工具使用
107
+
108
+ | 术语 | 英文 | 定义 | 关联术语 |
109
+ |------|------|------|----------|
110
+ | Agent | Agent (智能体) | 基于 LLM 的自主决策系统,能感知环境、规划任务、调用工具并迭代执行,直到完成目标。 | Tool Use, Planning, ReAct |
111
+ | 工具调用 | Tool Use / Function Calling | LLM 通过结构化输出调用外部 API / 函数 / 数据库的能力,扩展模型的行动边界。 | Agent, API, JSON Schema |
112
+ | ReAct | Reasoning + Acting | Agent 架构模式,交替进行推理(Thought)和行动(Action),根据观察结果迭代决策。 | Agent, CoT, Tool Use |
113
+ | 规划 | Planning | Agent 将复杂目标分解为可执行子任务的能力,包括任务分解、依赖排序和资源分配。 | Agent, Task Decomposition |
114
+ | 多 Agent 系统 | Multi-Agent System | 多个具有不同角色和能力的 Agent 协作完成复杂任务的架构,通过消息传递和共享状态协调。 | Agent, Orchestration |
115
+ | 记忆 | Memory | Agent 存储和检索历史交互、知识和状态的机制。分为短期记忆(上下文窗口)和长期记忆(外部存储)。 | Agent, Context Window, RAG |
116
+
117
+ ---
118
+
119
+ ## MLOps 与工程化
120
+
121
+ | 术语 | 英文 | 定义 | 关联术语 |
122
+ |------|------|------|----------|
123
+ | MLOps | Machine Learning Operations | 将 DevOps 实践应用于 ML 项目的方法论,涵盖数据管理、模型训练、部署、监控的全生命周期自动化。 | CI/CD, Model Registry |
124
+ | 模型注册中心 | Model Registry | 集中管理模型版本、元数据、血缘关系的服务。支持模型的注册、审批、部署追踪。代表:MLflow / SageMaker。 | MLOps, Model Versioning |
125
+ | 数据漂移 | Data Drift | 生产环境中输入数据分布与训练数据分布发生偏移的现象,会导致模型性能下降,需持续监控。 | Concept Drift, Monitoring |
126
+ | 特征存储 | Feature Store | 集中管理和服务化机器学习特征的系统,支持特征复用、一致性保证和在线/离线服务。 | Feature Engineering, MLOps |
127
+ | A/B 测试 | A/B Testing | 将用户随机分为实验组和对照组,比较不同模型版本的效果差异,基于统计显著性做上线决策。 | Canary Deploy, Statistical Significance |
128
+ | 概念漂移 | Concept Drift | 数据中输入与输出之间的映射关系随时间发生变化,导致模型准确率下降。需要持续监控和定期重训练。 | Data Drift, Model Monitoring |
129
+
130
+ ---
131
+
132
+ ## 安全与对齐
133
+
134
+ | 术语 | 英文 | 定义 | 关联术语 |
135
+ |------|------|------|----------|
136
+ | Prompt 注入 | Prompt Injection | 攻击者通过精心构造的输入覆盖或绕过系统 Prompt 约束,使模型执行非预期行为。分为直接注入和间接注入。 | Jailbreak, Security |
137
+ | 越狱 | Jailbreak | 通过特殊 Prompt 绕过 LLM 的安全限制,使其生成被禁止的内容。常见手法包括角色扮演、多语言绕过等。 | Prompt Injection, Red Team |
138
+ | 红队测试 | Red Teaming | 模拟攻击者对 AI 系统进行对抗性测试,发现安全漏洞、偏见和有害输出。是 AI 安全评估的核心方法。 | Prompt Injection, Safety |
139
+ | 对齐 | Alignment | 确保 AI 系统的行为符合人类意图和价值观的研究和工程实践。RLHF 和 Constitutional AI 是常见的对齐方法。 | RLHF, Safety, Ethics |
140
+ | 护栏 | Guardrails | 限制 LLM 输入和输出的安全机制,包括输入过滤、输出检测、话题限制等。确保模型行为在预期范围内。 | Safety, Content Filter |
141
+ | Constitutional AI | Constitutional AI (CAI) | Anthropic 提出的对齐方法,通过一组明确的原则(宪法)指导模型的自我改进,减少对人工标注的依赖。 | Alignment, RLHF |
142
+ | 水印 | Watermarking | 在 AI 生成内容中嵌入不可见标记的技术,用于识别和追踪 AI 生成的文本/图像。 | Detection, Provenance |
143
+ | 有害内容过滤 | Content Filtering | 检测和拦截 AI 输出中有害内容(暴力、歧视、虚假信息等)的机制。通常结合分类模型和规则引擎。 | Guardrails, Safety |
144
+
145
+ ---
146
+
147
+ ## 多模态与新兴方向
148
+
149
+ | 术语 | 英文 | 定义 | 关联术语 |
150
+ |------|------|------|----------|
151
+ | 多模态 | Multimodal | 能同时处理和理解多种数据类型(文本、图像、音频、视频)的模型能力。代表模型:GPT-4V、Gemini、Claude。 | Vision, Audio |
152
+ | 视觉语言模型 | Vision-Language Model (VLM) | 同时具备图像理解和文本生成能力的模型,可以描述图片、回答关于图片的问题、执行 OCR 等任务。 | Multimodal, OCR |
153
+ | 合成数据 | Synthetic Data | 由 AI 模型生成的训练数据,用于数据稀缺场景的数据增强。需注意质量控制和分布偏差。 | Data Augmentation, Training |
154
+
155
+ ---
156
+
157
+ ## Agent Checklist
158
+
159
+ - [ ] 术语在项目文档和代码注释中使用一致,避免混用中英文别名
160
+ - [ ] 团队成员已阅读并理解与当前项目相关的核心术语
161
+ - [ ] 新增的 AI 术语已补充到本术语表
162
+ - [ ] 技术方案评审中引用术语时附带本表链接
@@ -0,0 +1,53 @@
1
+ ---
2
+ id: agent-evaluation-benchmark
3
+ title: agent-evaluation-benchmark
4
+ domain: ai
5
+ category: agent-evaluation-benchmark.md
6
+ difficulty: intermediate
7
+ tags: [agent, ai, benchmark, evaluation, 评测与基准体系]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## Agent 评测与基准体系
14
+
15
+ ### 目标
16
+ - 让 Agent 能力可量化、可回归、可持续优化。
17
+
18
+ ### 适用范围
19
+ - 适用于研发阶段评测、发布门禁评估和线上质量回归。
20
+
21
+ ### 评测维度
22
+ - 正确性:任务是否完成且结果正确。
23
+ - 稳定性:同类任务重复执行波动范围。
24
+ - 时效性:平均耗时与超时率。
25
+ - 成本:单任务 token 成本与工具调用成本。
26
+ - 安全性:是否触发策略违规或越权行为。
27
+
28
+ ### 基准集构建
29
+ - 核心场景题集:覆盖高频业务任务。
30
+ - 边界场景题集:异常输入、缺失上下文、冲突约束。
31
+ - 红队场景题集:提示注入、数据泄露诱导、越权调用。
32
+
33
+ ### 门禁规则
34
+ - 关键场景正确率不得低于既定阈值。
35
+ - 安全违规项必须为零才可发布。
36
+ - 成本与时延回退超阈值必须阻断发布。
37
+
38
+ ### 执行清单
39
+ - 每次模型、提示词、工具变更都触发回归评测。
40
+ - 基准集按业务优先级分层维护并定期扩充。
41
+ - 评测报告必须包含质量、安全、时延、成本四维趋势。
42
+
43
+ ### 验收标准
44
+ - 关键路径题集通过率达到阈值且稳定性达标。
45
+ - 安全红队场景无阻断级失败项。
46
+
47
+ ### 常见失败模式
48
+ - 只看演示样例,不做标准化回归评测。
49
+ - 只看正确率,不跟踪安全与成本退化。
50
+
51
+ ### 回滚策略
52
+ - 评测结果异常时,暂停发布并回滚到上一个评测合格版本。
53
+ - 重新执行全量基准评测后再恢复放量。
@@ -0,0 +1,41 @@
1
+ ---
2
+ id: ai-agent-memory-context-management
3
+ title: ai-agent-memory-context-management
4
+ domain: ai
5
+ category: ai-agent-memory-context-management.md
6
+ difficulty: intermediate
7
+ tags: [agent, agent上下文与记忆管理, ai, context, management, memory]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## AI Agent上下文与记忆管理
14
+
15
+ ### 目标
16
+ - 在成本可控前提下提升多轮任务连续性与决策一致性。
17
+
18
+ ### 适用范围
19
+ - 适用于多轮对话Agent、任务编排Agent与个性化助手系统。
20
+
21
+ ### 记忆分层
22
+ - 会话记忆:当前任务临时上下文,生命周期短。
23
+ - 用户记忆:偏好、历史行为摘要,需权限隔离。
24
+ - 业务记忆:结构化事实与规则库,需版本管理。
25
+
26
+ ### 执行清单
27
+ - 上下文压缩策略定义明确并可回放验证。
28
+ - 记忆写入需经过规则校验与敏感信息过滤。
29
+ - 记忆读取必须带命中理由与来源可解释信息。
30
+
31
+ ### 验收标准
32
+ - 多轮任务成功率与一致性显著提升。
33
+ - 上下文长度与token成本保持在预算内。
34
+
35
+ ### 常见失败模式
36
+ - 无差别长期记忆导致噪声累积与错误放大。
37
+ - 跨租户记忆隔离不严导致数据泄漏风险。
38
+
39
+ ### 回滚策略
40
+ - 出现记忆污染时立即停用长期记忆读取。
41
+ - 清空高风险记忆分区并回退到静态规则模式。
@@ -0,0 +1,42 @@
1
+ ---
2
+ id: ai-cost-capacity-optimization-playbook
3
+ title: ai-cost-capacity-optimization-playbook
4
+ domain: ai
5
+ category: ai-cost-capacity-optimization-playbook.md
6
+ difficulty: intermediate
7
+ tags: [ai, ai成本与容量优化手册, capacity, cost, optimization, playbook]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## AI成本与容量优化手册
14
+
15
+ ### 目标
16
+ - 在保证业务效果的前提下,实现可持续的AI成本与容量治理。
17
+
18
+ ### 适用范围
19
+ - 适用于在线推理服务、批处理任务和高并发峰值场景容量规划。
20
+
21
+ ### 优化方向
22
+ - 请求侧:Prompt压缩、上下文裁剪、缓存命中提升。
23
+ - 模型侧:模型分级与动态路由、批处理与并发优化。
24
+ - 检索侧:检索召回精简、重排序成本控制。
25
+ - 系统侧:限流配额、熔断降级、弹性扩缩容。
26
+
27
+ ### 执行清单
28
+ - 关键场景建立成本基线与预算预警阈值。
29
+ - 评估每次优化对准确率与满意度的影响。
30
+ - 建立容量压测与峰值保护策略。
31
+
32
+ ### 验收标准
33
+ - 单请求成本与总预算占比稳定下降。
34
+ - 峰值期间SLO满足目标且无严重降级。
35
+
36
+ ### 常见失败模式
37
+ - 单纯压缩token导致结果质量明显下滑。
38
+ - 忽略峰值容量演练,促销或大流量时崩溃。
39
+
40
+ ### 回滚策略
41
+ - 优化导致质量下降时回切上一策略版本。
42
+ - 分阶段恢复优化项并逐项复核收益与风险。
@@ -0,0 +1,37 @@
1
+ ---
2
+ id: ai-data-security-and-compliance-playbook
3
+ title: ai-data-security-and-compliance-playbook
4
+ domain: ai
5
+ category: ai-data-security-and-compliance-playbook.md
6
+ difficulty: intermediate
7
+ tags: [ai, ai数据安全与合规作战手册, and, compliance, data, playbook, security]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## AI数据安全与合规作战手册
14
+
15
+ ### 目标
16
+ - 确保AI系统在数据采集、处理、存储、传输全链路满足安全与合规要求。
17
+
18
+ ### 适用范围
19
+ - Prompt日志、工具调用日志、检索语料、评测数据、用户反馈数据。
20
+
21
+ ### 执行清单
22
+ - 建立数据分级与敏感字段脱敏策略。
23
+ - 输入输出日志按最小必要原则留存并设置TTL。
24
+ - 第三方模型或服务调用必须评估数据出境风险。
25
+ - 审计日志必须可追溯到账号、时间、动作和结果。
26
+
27
+ ### 验收标准
28
+ - 严重合规违规项为0。
29
+ - 敏感数据处理流程通过抽检与审计复核。
30
+
31
+ ### 常见失败模式
32
+ - 把完整原始输入永久留存,超出最小必要范围。
33
+ - 缺失删除机制,导致超期数据持续堆积。
34
+
35
+ ### 回滚策略
36
+ - 发现泄漏风险时立即停用相关数据通道并隔离数据。
37
+ - 启动应急响应,执行密钥轮换和日志溯源处置。
@@ -0,0 +1,40 @@
1
+ ---
2
+ id: ai-domain-index-and-checklist
3
+ title: ai-domain-index-and-checklist
4
+ domain: ai
5
+ category: ai-domain-index-and-checklist.md
6
+ difficulty: intermediate
7
+ tags: [ai, ai领域索引与执行清单, and, checklist, domain, index]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## AI领域索引与执行清单
14
+
15
+ ### 目标
16
+ - 为AI需求、方案、上线、运行提供统一入口和核查清单。
17
+
18
+ ### 适用范围
19
+ - LLM应用、Agent系统、RAG应用、智能工作流与自动化工具链。
20
+
21
+ ### 执行清单
22
+ - 需求阶段:目标指标、风险边界、数据来源合规性已确认。
23
+ - 设计阶段:提示词策略、工具权限模型、失败降级路径已定义。
24
+ - 开发阶段:结构化输出、重试策略、幂等策略已实现。
25
+ - 测试阶段:准确性、安全性、延迟、成本评测已通过。
26
+ - 发布阶段:灰度方案、回滚触发条件、发布验收标准已固化。
27
+ - 运行阶段:告警分级、值班流程、复盘闭环机制已建立。
28
+
29
+ ### 验收标准
30
+ - 关键链路任务成功率达到目标阈值。
31
+ - 安全与合规阻断项为0。
32
+ - 生产回滚演练在目标时间内完成。
33
+
34
+ ### 常见失败模式
35
+ - 只评估模型能力,不评估工具链与系统级风险。
36
+ - 缺少在线监控与漂移检测,质量退化发现滞后。
37
+
38
+ ### 回滚策略
39
+ - 发现P0错误或越权风险时,立即降级到安全兜底路径。
40
+ - 在30分钟内切回上一个稳定模型与提示词版本。
@@ -0,0 +1,50 @@
1
+ ---
2
+ id: ai-governance-maturity-model
3
+ title: ai-governance-maturity-model
4
+ domain: ai
5
+ category: ai-governance-maturity-model.md
6
+ difficulty: intermediate
7
+ tags: [ai, ai治理成熟度模型, governance, maturity, model]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## AI治理成熟度模型
14
+
15
+ ### 目标
16
+ - 用统一量表评估AI研发和运营能力,指导分阶段治理提升。
17
+
18
+ ### 适用范围
19
+ - 适用于AI平台团队、业务研发团队、测试安全团队和运维团队协同治理。
20
+
21
+ ### L1 初始级
22
+ - 靠个人经验驱动,规则分散,缺少可复用标准。
23
+
24
+ ### L2 规范级
25
+ - 建立基础文档、清单和上线检查,但执行不稳定。
26
+
27
+ ### L3 稳定级
28
+ - 建立标准门禁、自动评测、发布回滚、监控告警闭环。
29
+
30
+ ### L4 优化级
31
+ - 建立持续优化机制,做到成本、质量、安全协同提升。
32
+
33
+ ### L5 领先级
34
+ - 形成跨团队复用平台,具备策略自动化和治理智能化能力。
35
+
36
+ ### 执行清单
37
+ - 每季度完成成熟度评级与差距分析。
38
+ - 每个低分项必须绑定负责人、改进动作和验收节点。
39
+ - 将成熟度改进项纳入发布门禁与复盘追踪。
40
+
41
+ ### 验收标准
42
+ - 每季度至少一次成熟度自评与改进追踪。
43
+ - 关键治理指标持续改善并可审计追溯。
44
+
45
+ ### 常见失败模式
46
+ - 只做评级不做整改,导致成熟度长期停滞。
47
+ - 评估标准不统一,跨团队结果不可比。
48
+
49
+ ### 回滚策略
50
+ - 当治理指标连续恶化时,回退至上一个成熟稳定实践基线。
@@ -0,0 +1,47 @@
1
+ ---
2
+ id: ai-model-selection-and-routing-strategy
3
+ title: ai-model-selection-and-routing-strategy
4
+ domain: ai
5
+ category: ai-model-selection-and-routing-strategy.md
6
+ difficulty: intermediate
7
+ tags: [ai, ai模型选型与路由策略, and, model, routing, selection, strategy]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # 开发:Excellent(11964948@qq.com)
12
+
13
+ ## AI模型选型与路由策略
14
+
15
+ ### 目标
16
+ - 在准确率、时延、成本和稳定性之间取得可量化最优平衡。
17
+
18
+ ### 适用范围
19
+ - 适用于多模型并存的在线推理服务、Copilot产品与Agent系统。
20
+
21
+ ### 选型维度
22
+ - 任务类型:推理、抽取、生成、代码、对话、决策支持。
23
+ - 能力指标:正确率、幻觉率、指令遵循率、结构化输出稳定性。
24
+ - 性能指标:P50/P95时延、吞吐、峰值并发下退化表现。
25
+ - 经济指标:单请求成本、千token成本、峰值预算占比。
26
+
27
+ ### 路由策略
28
+ - 主模型用于核心任务,辅模型用于低风险或高并发场景。
29
+ - 按任务难度、用户等级、请求上下文动态路由。
30
+ - 高风险请求优先选择高可靠模型并启用人工确认。
31
+
32
+ ### 执行清单
33
+ - 每类任务定义默认模型、备选模型与回切条件。
34
+ - 路由策略变更必须附带回归评测与灰度验证结果。
35
+ - 记录路由命中率、失败率与成本收益趋势。
36
+
37
+ ### 验收标准
38
+ - 关键任务准确率达到业务阈值。
39
+ - 路由后整体成本下降且核心成功率不下降。
40
+
41
+ ### 常见失败模式
42
+ - 只按价格选模型,忽略失败重试导致的总成本上升。
43
+ - 无模型回切策略,导致供应波动时服务不可用。
44
+
45
+ ### 回滚策略
46
+ - 路由异常时切换至单模型稳定模式。
47
+ - 记录路由命中与失败日志,定位后逐步恢复动态路由。