writing

Use the pattern verb plus what, such as "Add user authentication" or "Fix payment validation". Keep it short, active, and specific, and avoid vague messages like "Fixed stuff" or "Updates".

Use three sections: Summary with one sentence on what changed, Why with one paragraph on motivation, and Testing explaining how to verify. This lets reviewers skim and understand the change quickly.

Zinsser's principles emphasize clarity, brevity, and simplicity: one idea per sentence, short sentences, active voice, cutting redundant words, and preferring simple concrete words over complex abstract ones.

Follow the pattern: what happened, then what to do. For example, "User not found. Check the email." State the problem plainly and give a concrete next action.

Avoid passive voice in almost all technical writing because it hides the actor and adds words. Write "We fixed the bug" instead of "The bug was fixed" to keep sentences direct and shorter.