学习记录的格式规范
Learning records live in ./learning-records/ and use sequential numbering: 0001-slug.md, 0002-slug.md, etc. Create the directory lazily — only when the first record is written.
学习记录存放在 ./learning-records/ 中,使用顺序编号:0001-slug.md、0002-slug.md 等。按需创建目录——仅在写入第一条记录时才创建。
They are the teaching equivalent of ADRs: they capture non-obvious lessons, key insights, and stated prior knowledge that will steer future sessions. They are used to calculate the zone of proximal development. They are titled 0001-<dash-case-name>.md, where the number increments each time.
它们是教学中 ADR 的等价物:记录不那么显而易见的经验教训、关键洞察和已声明的先验知识,这些将指导未来的会话。它们用于计算最近发展区。文件命名为 0001-<dash-case-name>.md,编号依次递增。
That is the whole format. A learning record can be a single paragraph. The value is recording that this is now known and why it changes what to teach next — not in filling out sections.
这就是完整的格式。学习记录可以只是一个段落。其价值在于记录这件事现在已被掌握,以及为什么它会改变接下来要教的内容——而不在于填写各种章节。
Only include these when they add genuine value. Most records won't need them.
仅在这些章节确实能增加价值时才包含。大多数记录不需要它们。
active | superseded by LR-NNNN) — useful when an earlier understanding turns out to be wrong and is replaced.active | superseded by LR-NNNN)——当早期理解被证明是错误并被替代时有用。Scan ./learning-records/ for the highest existing number and increment by one.
扫描 ./learning-records/ 找到现有的最高编号,然后加一。
Write one when any of these is true:
当以下任一情况成立时写一条:
MISSION.md and update it.MISSION.md 并更新它。GLOSSARY.md as a term definition. Don't duplicate.GLOSSARY.md 中作为术语定义简洁记录的内容。不要重复。When a later record contradicts an earlier one (the user's understanding deepened or corrected), mark the old record Status: superseded by LR-NNNN rather than deleting it. The history of how understanding evolved is itself useful signal.
当后来的记录与早期记录矛盾时(用户的理解深化或纠正了),将旧记录标记为 Status: superseded by LR-NNNN,而非删除。理解如何演变的历程本身就是有用的信号。