markdown

The rules for every Markdown file in the repository, inside docs/ or not: prose a reader understands on the first pass, MECE structure, headings rather than bold, checklists for TODOs. Read before wri

SKILL.md

GitHub

Markdown

The goal is prose a reader understands on the first pass. Everything below serves that.

Prose

  • Plain words. One idea per sentence. The plain statement first, the reason for it after.
  • Three habits make a reader decode instead of read: a second clause hung off a dash, an abstract noun standing where a verb would do, and the clever phrasing of a point arriving before the obvious one. Undo each where you find it.
  • Correct and fresh. Keep the facts.
  • Cutting narration and redundancy is one way to get there. It is not the point. A passage that came out shorter and harder to follow has failed.

Structure

  • Keep a document simple and MECE.
  • Do not use **...** (bold) for sub-sections. Use Markdown sections instead.
  • Use a Markdown checklist for TODOs (- [ ] ...) and what's done (- [x] ...).

Numbers

  • A measured figure belongs in the table that holds its measurement, not in prose beside it: the table gets refreshed and the prose does not.
  • A table whose refresh you cannot see is a reason to find how it was measured, not to delete it. Name the command beside the table; deleting a measurement loses a fact.
  • Name the shape to grep for, not how many sites there are. A count goes stale with the next site.

Finish

Run mise run format after editing.