Topic
13 articles tagged Documentation. For the wider topic, see Productivity & Operations.
Numbered steps are the easy part. Where to put prerequisites, how to handle the branch, and why the failure cases belong in the article rather than the comments.
Read article →A 40-page style guide gets read once. What belongs in a one-page version, what to leave to judgement, and how to make the rules enforceable.
Read article →Alt text is written for someone who cannot see the image, not for a crawler. The decision tree, the cases where empty is correct, and the keyword mistake.
Read article →A one-page record that answers the questions an auditor, client, or regulator actually asks. What to write down, and why doing it now costs an hour instead of a week.
Read article →Steps, expected, actual, environment. Why most bug reports get bounced back, and how to write one that gets fixed instead of triaged into a question.
Read article →Reviewers need to know what changed, why, and what you want them to look at. A structure that gets faster, better reviews on the same code.
Read article →The first three lines decide whether someone keeps reading or closes the tab. What belongs at the top of a README, and what belongs much further down.
Read article →What is going away, when, what to use instead, and what breaks if you ignore it. How to deprecate without losing the developers who depend on you.
Read article →A subject line that finishes the sentence, a body that explains why, and the habits that make git log useful two years later.
Read article →Capture meeting notes that preserve decisions, actions, owners, deadlines, open questions, and useful context without transcribing everything.
Read article →Record a project decision so future readers can see what was chosen, why, who approved it, and when it should be reviewed.
Read article →Release notes are a product story, not a changelog dump. How to lead with value, group by user, and turn updates into something people finish reading.
Read article →Explore how software engineers are using inline, local AI to effortlessly improve code documentation and technical writing without leaving their IDE.
Read article →