Skip to content

Latest commit

 

History

History
33 lines (18 loc) · 658 Bytes

TEMPLATE.md

File metadata and controls

33 lines (18 loc) · 658 Bytes

NN: Step name

Date: YYYY-MM-DD · Plan phase: N · Commit: abcdef0

Goal

One or two sentences. What question does this step answer?

What was done

Short list of the work, with file paths.

Commands

# Exact commands, so the step can be repeated.

Results

Numbers with units, and the script that produced each. Figures go in docs/results/.

Disagreements

Anything that did not match a reference, an expectation, or an earlier result. Size of the gap, suspected cause, what was done. Write "None" only if there were none.

Decisions

Choices made here that later steps depend on.

Next

The step that follows.