Shapes
A shape is the fixed skeleton of one kind of document. Every document of a kind has the same parts in the same order, so a reader who has seen one knows where to look in the next. That is the skeletal-notes effect at the scale of a collection (learning science). Each shape names the principles it applies.
Contents
| Shape | For |
|---|---|
| note.md | one topic, learned or worked on: a course note, a research note, a concept |
| readme-and-folder.md | what a folder holds and how to use it, read by someone who arrived from a search |
| report.md | a solved problem explained step by step, so the reader can solve the next one |
| commit.md | why a change was made, in the version history |
| decision-record.md | one choice that shapes more than one file, and why it was made |
Choosing a shape
- One document, one shape. A text that needs two shapes is two documents (one mode per document).
- When no shape fits, write to the standard and propose a shape once three documents of the new kind exist.