Appearance
笔记模板说明
新建一篇主题笔记时,复制下面的结构到 docs/progress/notes/topics/你的主题.md,并在 笔记索引 里加一行。
模板里"必填"的字段只有两项:用自己的话说 和 实验 / 练习记录。其余字段按需填,不强求每篇都写满。
只有写出了"自己的理解"和"自己做过什么",笔记才有价值。如果只是摘抄课程原文,等于没写。
markdown
# 标题(建议格式:主题-类型,例如"Agent 设计-实验记录"、"RAG 链路-踩坑复盘")
**日期:** YYYY-MM-DD
**关联章节:** [→ XX · 章节名](/app-dev/basics/对应文件名)
**前置知识:** 需要先看哪些内容
---
## 用自己的话说(必填)
不抄课程定义,用你理解之后的语言重新描述这个概念。
如果说不出来,说明你还没真正理解,先回去看课程再写这部分。
写完后问自己:如果把这段话给一个没学过这章的人看,他能不能大致理解?
## 实验 / 练习记录(必填)
记录你真正动手做过的事。可以是代码实验、工具调用测试,也可以是用某个场景测试模型行为。
- **做了什么:** 一两句描述操作
- **输入:** 你给模型的 prompt 或代码
- **输出:** 模型返回了什么(可以直接粘贴关键部分)
- **结论:** 你从这次实验里学到了什么
如果有多个实验,用 `### 实验 1 / 实验 2` 分开。
如果还没做实验,先不要交出这篇笔记——带着问题去做,再回来写。
## 还不清楚的点(建议填写)
列出学完这个主题后,你仍然没有搞清楚的问题。
这些问题比"我以为我懂了"更有价值——它们是下一篇笔记的起点,也是判断自己有没有真正理解的依据。
## 踩坑 / 意外发现(如果有)
记录和课程预期不同的情况:
- 某个参数的效果和你想象的不一样
- 某个工程做法在真实代码里遇到了障碍
- 某个概念在工程实践里的表现比课程里说的更复杂
## 延伸内容(可选)
- 某个相关概念的简短补充(课程里没讲透但你自己找到了答案)
- 值得注意的边界情况
- 这个话题在 AI 应用工程里的延伸方向
## 延伸阅读(可选)
- 与这个主题直接相关的资源,注明"为什么值得看"
- 参考 [资源库](/resources) 里的精选内容,不要随意堆链接
---
**下一步:** 学完这个主题之后,你打算做什么?
可以是继续读下一章、动手写一段代码、补一个"还不清楚的点",或者把这篇笔记里的问题解决掉。不同类型笔记的侧重点
写笔记之前,先想清楚这篇笔记是什么类型:
| 类型 | 重点放在哪里 |
|---|---|
| 概念复盘 | "用自己的话说" + "还不清楚的点" |
| 实验记录 | "实验 / 练习记录" + "踩坑 / 意外发现" |
| 项目复盘 | "做了什么" + "学到了什么" + "下次会怎么做" |
| 踩坑记录 | "问题是什么" + "为什么会这样" + "怎么解决的" |
不同类型笔记的结构可以适当调整,不必强行套模板每一节。
VitePress 支持 Markdown 扩展,代码块、提示框(::: tip)、数学公式(需配置)等可按官方文档启用。