Skill Tracer
Skills › Skills For Real Engineers › teach › LEARNING-RECORD-FORMAT.md

LEARNING-RECORD-FORMAT.md

46 lines · skills/productivity/teach/LEARNING-RECORD-FORMAT.md at 4ae2317

Open on GitHub
1# Learning Record Format
2
3Learning 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.
4
5They 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.
6

Learning Record Format

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.

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.

Raw lines 1 to 6
7## Template
8
9```md
10# {Short title of what was learned or established}
12{1-3 sentences: what was learned (or what prior knowledge was established), and why it matters for future sessions.}
13```
15That 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.

Template

# {Short title of what was learned or established}

{1-3 sentences: what was learned (or what prior knowledge was established), and why it matters for future sessions.}

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.

Raw lines 7 to 16
17## Optional sections
19Only include these when they add genuine value. Most records won't need them.
21- **Status** frontmatter (`active | superseded by LR-NNNN`): useful when an earlier understanding turns out to be wrong and is replaced.
22- **Evidence**: how the user demonstrated the understanding (a question answered, an exercise completed, prior experience cited). Useful when the claim might be revisited.
23- **Implications**: what this unlocks or rules out for future sessions. Worth recording when non-obvious.

Optional sections

Only include these when they add genuine value. Most records won't need them.

  • Status frontmatter (active | superseded by LR-NNNN): useful when an earlier understanding turns out to be wrong and is replaced.
  • Evidence: how the user demonstrated the understanding (a question answered, an exercise completed, prior experience cited). Useful when the claim might be revisited.
  • Implications: what this unlocks or rules out for future sessions. Worth recording when non-obvious.
Raw lines 17 to 24
25## Numbering
27Scan `./learning-records/` for the highest existing number and increment by one.

Numbering

Scan ./learning-records/ for the highest existing number and increment by one.

Raw lines 25 to 28
29## When to write a learning record
31Write one when any of these is true:
331. **The user demonstrated genuine understanding of something non-trivial**: not just exposure, but evidence they can use the concept correctly. This sets a new floor for what to teach next.
342. **The user disclosed prior knowledge**: "I already know X." Record it so future sessions don't re-teach it. Also record the _depth_ claimed.
353. **A misconception was corrected**: the user previously believed something wrong and now sees why. These are high-value: they predict future stumbling blocks for related topics.
364. **The mission shifted in response to learning**: the user discovered they cared about something different than they thought. Cross-link to [[MISSION.md]] and update it.

When to write a learning record

Write one when any of these is true:

  1. The user demonstrated genuine understanding of something non-trivial: not just exposure, but evidence they can use the concept correctly. This sets a new floor for what to teach next.
  2. The user disclosed prior knowledge: "I already know X." Record it so future sessions don't re-teach it. Also record the depth claimed.
  3. A misconception was corrected: the user previously believed something wrong and now sees why. These are high-value: they predict future stumbling blocks for related topics.
  4. The mission shifted in response to learning: the user discovered they cared about something different than they thought. Cross-link to [[MISSION.md]] and update it.
Raw lines 29 to 37
38### What does _not_ qualify
40- Material that was merely covered. Coverage is not learning. Wait for evidence.
41- Anything already captured tersely in [[GLOSSARY.md]] as a term definition. Don't duplicate.
42- Session-by-session activity logs. Learning records are not a journal: they are decision-grade insights.

What does not qualify

  • Material that was merely covered. Coverage is not learning. Wait for evidence.
  • Anything already captured tersely in [[GLOSSARY.md]] as a term definition. Don't duplicate.
  • Session-by-session activity logs. Learning records are not a journal: they are decision-grade insights.
Raw lines 38 to 43
44## Supersession
46When 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.

Supersession

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.

Raw lines 44 to 46