学习过程记录规范
日期:2026-06-05
1. 目的
这份规范用于保证后续学习过程不会只留在对话里,而是持续沉淀到文档中,方便复习、回滚和继续学习。
2. 每次学习对话都要记录什么
只要对话推进了学习内容,就必须更新学习记录。
至少记录:
- 日期
- 当前模块
- 当前课程
- 本次讲了什么
- 学生的回答或理解
- 需要纠正的误区
- 本次结论
- 下一步学习内容
3. 记录文件
核心记录文件:
00-roadmap/learning-log.md:按时间记录每次学习过程。00-roadmap/current-state.md:记录当前学到哪里、下一步讲什么、有哪些待复习点。- 各模块
lessons/:正式讲义。 - 各模块
exercises/:练习、理解检查和答案记录。
4. 每次对话后的固定动作
每次学习相关对话结束前,执行下面动作:
- 判断本次是否产生新的学习内容、回答、纠错或计划变化。
- 如果有,更新
learning-log.md。 - 如果当前进度、下一讲或待复习点变化,更新
current-state.md。 - 如产生新讲义,放入对应模块的
lessons/。 - 如产生练习或答案,放入对应模块的
exercises/或记录进学习日志。 - 用 Git 提交这次学习记录。
5. 记录粒度
记录要完整,但不需要逐字保存整段对话。
合适的记录粒度:
- 保留关键问题和关键回答。
- 保留概念纠错。
- 保留学习结论。
- 保留下一步动作。
不需要记录:
- 寒暄。
- 重复确认。
- 与学习无关的临时操作输出。
6. 防遗忘机制
后续每次继续学习前,优先读取:
00-roadmap/current-state.md00-roadmap/learning-log.md- 当前模块 README
- 当前课程讲义
如果发现记录缺失,应先补记录,再继续讲课。
7. 仓库级 Agent 指令
已创建仓库级指令文件:
AGENTS.md
用途:
- 为进入本仓库的 agent 提供长期项目规则。
- 要求每次继续学习前读取当前状态和学习日志。
- 要求每次学习后更新日志、当前状态,并在必要时 Git 提交。
说明:
AGENTS.md不是 skill 的执行开关。- 它不能保证某个 skill 一定被自动加载。
- 它能保证即使 skill 没加载,agent 仍能看到本项目的固定工作流程。
8. 本地 Codex Skill
已创建本地 skill:
/home/zhuji/.codex/skills/ml-study-logger/SKILL.md
用途:
- 在继续本专题学习时,提醒 Codex 先读取当前学习状态。
- 在每次学习后更新学习日志和当前状态。
- 在产生有意义的学习记录变更后使用 Git 提交。
注意:
- skill 是额外保障,不替代项目内文档。
- 最可靠的记录仍然是本目录中的
learning-log.md和current-state.md。 AGENTS.md用于把这套要求固定在仓库中,skill 用于在 Codex 环境中增强触发概率。