Part 7 of 12 · 1 min read
How to build it so it holds up
- Open with one sentence and the user; put the demo and the headline number above the fold.
- Every number has a file and a command behind it; generate tables from results.
- Show the baseline, the interval and n next to every headline number.
- State limits plainly, including what you did not test.
- Keep the quickstart to five commands or fewer and test it on a clean machine.
- Write the architecture note as decisions: chosen, alternatives, evidence, given up.
- Put ten failure examples in the evaluation report, grouped by cause.
- Pin versions and commit the evaluation data (or how to rebuild it).
- Avoid superlatives; let the number speak.
- Re-run and regenerate before every release.