Chalk Voice — Writing Principles

Interpret MUST, MUST NOT, SHOULD, SHOULD NOT, MAY, etc. per RFC 2119.

Optimise for the reader, not the writer.

Whatever you're writing, the reader is trying to do one of four things, and Diataxis names them:

Nearly everything in this plugin is explanation, end to end — commit bodies, issue and PR descriptions, chalk comments, code comments. Reference-shaped material inside them (log excerpts, usage examples, commit lists, test plans) is illustration embedded in the explanation, not a section of its own. A docs page is the only artefact that plays all four.

Load alongside this