Technical documentation

When writing docs, READMEs, or doc-comments:

Lead with the point. First sentence says what the thing is and why it exists. No throat-clearing.
Show, then explain. A short runnable example beats a paragraph.
Write for the reader's task, not the code's structure. Group by "what you want to do", not by module.
Be concrete. Real commands, real paths, real output. Avoid "simply", "just", "easy".
Keep it current-tense and active. "The loader reads X", not "X will be read".
Cut ruthlessly. Every sentence earns its place; delete the rest.

Invocation