贡献指南
感谢你愿意给这个项目添砖加瓦。无论是写词条、改错字、补充图示还是提建议，都欢迎。
三种贡献方式
1. 投稿一个完整词条（最高优先级）
这是最有价值的贡献。流程：
- 从 Issue 列表 里找一个标了
help wanted的词，或者自己开 Issue 说"我想写 XXX"（避免撞车） - 复制
terms/_template.md作为起点 - 按五层结构写完，提 PR
- 等待 Review（通常 3 天内）
2. 补充 / 纠错
发现某个词条的 L4 公式写错了，或者 L5 的沿革有更正？直接开 Issue 或 PR，标注清楚出处。请附上可验证的来源（论文链接、官方文档、原始推文）--这是考据派项目，不收"我感觉是这样"。
3. 补充图示 / 图示设计
assets/ 目录收 SVG 格式的示意图或封面图。要求：
- 原创或基于 CC0 素材二次创作
- 文件名格式：
词条slug-描述.svg，例如rag-open-book-exam.svg - 提 PR 时附一句话说明图示要表达的概念
写作规范（必读）
调性：硬核考据为主，通俗类比辅助
这是核心原则，请务必读透：
- 硬核考据是主菜。每个技术结论都要能追溯。L3 及之后的关键论断必须附论文/文档链接。L4 是项目的灵魂，宁可写得硬，不要写得虚。
- 通俗类比是入口，不是目的。L1/L2 的作用是让读者愿意读下去、有能力读 L3+。类比要服务于"建立准确直觉"，而不是"听起来有趣"。
- 幽默是副产品，不是 KPI。如果某个概念天然有反讽点或好笑之处（如"注意力机制其实不含注意力"），点出来即可；没有就老老实实解释，绝不为搞笑而牺牲准确性或篇幅。
- 禁止：标题党、夸大、AI 玄学化、用"颠覆""革命""杀手级"这类词、刻意堆段子。
一句话自检：把这篇的 L1/L2 删掉，L3-L5 单独看，是否仍然是一篇扎实的技术解读？ 如果不是，说明硬核部分没写够，不是幽默部分没写够。
五层结构（必须全部包含）
| 层 | 字数 | 要点 |
|---|---|---|
| L1 一句话点破 | 1~2 句 | 一句话说清本质。能秒懂就不绕弯。准确优先，幽默其次。 |
| L2 通俗类比 | 100~300 字 | 一个类比建立直觉，不要堆三个。类比要对应到真实机制，不能跑偏。 |
| L3 正经定义 | 200~400 字 | 像维基百科词条那样写，中立、准确、无废话。 |
| L4 原理深挖 | 500~1500 字 | 公式 / 架构图 / 代码 demo 三选一或全上。这一层是项目的灵魂。 |
| L5 沿革与坑 | 200~500 字 | 历史脉络、常见误解、面试题。要有信息量，不是轶事堆砌。 |
文件命名
- 词条：
terms/<slug>.md，slug 用英文小写 + 连字符，例如model-distillation.md - Demo：
demos/<slug>/，目录下放README.md+ 代码 - 图片：
assets/<slug>-<描述>.svg
Frontmatter
每个词条开头必须有：
yaml
---
title: RAG（检索增强生成）
slug: rag
category: 热点
tags: [LLM, 检索, 向量数据库]
author: 你的名字 / GitHub ID
created: 2026-07-19
updated: 2026-07-19
---Review 标准
PR 合并前会检查：
- [ ] 五层结构齐全
- [ ] L3 及之后的关键论断有出处
- [ ] 代码 demo 能跑（如果有）
- [ ] 没有抄袭（自己的话写，引用要标注）
- [ ] 文件名、frontmatter 符合规范
行为准则
对人友好。对技术严格。不咬人。
License
提交即表示你同意内容以 CC BY-SA 4.0 发布，代码以 MIT 发布。署名会保留在你的词条 frontmatter 的 author 字段。