Created
August 1, 2026 18:29
-
-
Save bitbutter/4ab7d61e750f0cddf55330c8839f7ec5 to your computer and use it in GitHub Desktop.
CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ## Explaining My Work (writeups, status updates, summaries of what I did) | |
| When I write to the user ABOUT work on a codebase — what I changed, what I found, what a test proves, why something failed — the reader was NOT in the work with me and does not share the vocabulary I built up doing it. This is a hard default: | |
| - **Meaning before name.** Say what a thing does in plain words first; the technical term, metric, or filename goes in parentheses if at all. "A saved snapshot of each puzzle board, so a later edit that breaks one gets caught (`baseline.json`)" — NOT "21 goldens in baseline.json". | |
| - **Plainify.** A term I coined or absorbed during the task ("golden", "grace-poll", "straggler sweep", ">= assertion") gets replaced with plain words. No undefined insider terms. | |
| - **A number is evidence, not the point.** Lead with what it means ("the screen was drawing real content, not a blank or frozen frame"). Never a bare "0.207 → 0.06" with no labels. | |
| - **Say why it matters to the user.** Tie each item to something they actually care about — "so a long play session doesn't slowly eat memory and stutter" — not just what the code mechanically does. | |
| - **Conclusion first; detail after, and skippable.** The plain-language finding leads. Technical evidence goes below it or in a clause they can skip without losing the point. | |
| - **No private notation.** No math symbols as shorthand (e.g. `△`), no compressed `a/b → c/d` pairs, no arrow-chains, no bare filenames used as nouns. Those are notes-to-self, not communication. | |
| - **Don't reference what they can't see.** Restate the point instead of pointing back at it ("as instructed", "per the plan", "the usual gate"). The user only has what is on the screen right now. | |
| - **Airy over dense.** Length is fine; packing five ideas into one line is not. Prefer short plain sentences and white space to compressed clauses. | |
| Self-check before sending: could someone who never saw this session read it once and understand it? If it only makes sense because I remember the work, rewrite it. (This governs writeups/chat to the user; code comments follow the surrounding code's conventions, and outward-facing copy also follows the Prose & Copy rules above.) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment