A developer focused on writing clear and concise documentation on a laptop.

Your Writing is a Gift to Your Future Self

Good technical writing isn't about being a novelist; it's about clarity, conciseness, and empathy. The primary audience for your documentation, commits, and pull requests is often a future developer (which might be you!) who needs to understand your code quickly.

The Anatomy of a Perfect Commit Message

A commit message should explain the "why," not the "what." The code shows what you did. The message explains why you did it.

Good Commit Message Structure

Subject Line (imperative, <50 chars): `Fix: Prevent user logout on page refresh`

Body (optional, explains the 'why' and 'how'):
`The previous implementation did not persist the session token in local storage, causing the user state to reset on every refresh.`

`This change moves the token to `localStorage` and hydrates the user state from there on initial app load. This resolves issue #241.`

Writing Effective Pull Requests (PRs)

The goal of a PR description is to make the reviewer's job as easy as possible.

Provide Context: Link to the ticket or issue. Briefly explain the problem you are solving.
Explain Your Solution: Describe your approach. Why did you choose this solution over others?
Include a "How to Test": Provide step-by-step instructions for the reviewer to verify your changes.
Use Visuals: A screenshot or GIF of the UI change is worth a thousand words.

Documentation: Write for the Newcomer

When writing documentation (e.g., in a README), assume the reader knows nothing about the project. Cover the essentials:

What does this project do? (A one-sentence summary)
How do I get it set up and running? (Step-by-step installation guide)
How do I use it? (A simple "Hello World" example)