Appearance
笔记索引
笔记不是课程的重复,也不是站点主入口,而是课程之外的补充层:案例拆解、实验记录、踩坑复盘和延伸思考。
笔记和课程正文的分工
课程主线章节(docs/app-dev/basics/)负责"第一遍理解"——把概念讲清楚,给出例子,建立整体框架。
笔记(docs/progress/notes/topics/)负责"第二遍加深"——记录实践里做过什么、发现了什么、还有哪些问题没彻底讲透。两者职责不同,不要在笔记里重复课程已经说清楚的内容。
| 放进课程的内容 | 放进笔记的内容 |
|---|---|
| 概念是什么、为什么重要 | 对某个点的补充解释或二次拆解 |
| 典型场景和例子 | 实验记录:输入、输出、结论 |
| 常见误区 | 实际踩坑与修正过程 |
| 下一步读什么 | 仍待解决的问题或进一步延伸 |
判断标准:如果你要写的内容课程里已经有了,就不需要写进笔记。笔记的核心价值在于补充课程正文没有展开的案例、实验和判断过程,而不是替代课程页本身。
主题笔记
在 docs/progress/notes/topics/ 下新建 Markdown 文件后,在下表加一行登记。文件名建议用"主题-类型"格式,例如 LLM基础概念-复盘.md、Agent设计-实验记录.md。
| 主题 | 文件 | 一句话说明 | 关联章节 |
|---|---|---|---|
| LLM 基础概念复盘 | LLM基础概念-复盘 | 用自己的话理解 Token、上下文窗口与温度参数,附实验记录 | LLM 基础概念 |
| Agent 设计实验记录 | Agent设计-实验记录 | Loop 控制、状态管理和终止条件的实际踩坑记录 | Agent 基础原理 |
快速参考
- 写新笔记前先看 单篇笔记模板,参考结构与字段说明
- 笔记可以链回课程章节,例如:
[→ 参考 LLM 基础概念](/shared/LLM基础概念) - 笔记完成后在上表加一行,并更新 进度总览 中的备注
- 参考资料查 资源库,避免在笔记里重复堆链接
什么时候适合写笔记
- 学完一章之后,发现有几个概念你还说不清楚
- 做完一个实验,想把输入、输出和结论记下来
- 踩了一个坑,希望下次不再重复
- 某个知识点在课程章节里说得不够,你自己找到了补充
- 对某章内容有自己的延伸理解,和课程视角不完全一样