What I write
- Release notes. The notes for one release, with breaking changes, removals and deprecations ahead of everything else.
- Changelogs. The running record of every release, written so one entry still makes sense when a tool lifts it out of the page.
- Migration notes. What to change, in what order, when a release breaks something.
How I write it
I read the changes and ask what each one does to a developer who upgrades. The answer to that question goes at the top of the note.
I run the release before I write about it, as I do with any product.
What you get
You get release notes in your format for each release, and a changelog that stays readable as releases add up. If you'd rather I handle the changelog while you work on the product, that's the arrangement.
Work you can check
I have no client release notes I can link in public. My published work on release communication is on this site:
- How to write a changelog, with counts from a month of one real changelog.
- Writing release notes that developers trust, built on real notes that buried a critical fix.
- The release notes template, with a checker that fails a note missing its rollback line.
How we'd work together
Email hello@ninadpathak.com with the product and the reader, or book a 30-minute call at https://zcal.co/ninadpathak/meet. This page lists no rate, so ask for a quote with the scope.
- We talk for 30 minutes about the reader and what the release note has to do for them.
- You get a written brief and a timeline within 24 hours of that call.
- I need access to the release itself, such as a demo account, API keys and an account with real data in it, because I run the product before I write about it.
- Once the brief is agreed, the first piece is a paid trial, and we carry on only if you're happy with it.
- A draft takes about 5 days from the brief and revisions take 2, so you can publish in one working week.
- There are two rounds of review at most.
- I deliver in Google Docs or as a Markdown pull request, or in whatever your team uses, and I can load it into your CMS if you'd like.
Once we've worked together for a while, the same cycle comes down to 4 days end to end.
Related reading
These pages sit in the technical documentation topic, under shipping changes. My thoughts on Ghostty's hand-crafted release notes cover who release notes are for now that agents read changelogs too.
FAQ
What does a release notes writing service include?
The notes for each release, the changelog entry and any migration notes, written from the changes and checked against the release where I have access.
Can you take over our changelog?
Yes. I can handle the changelog and the release notes for each release while your team works on the product.
How fast can release notes be turned around?
A draft takes about 5 days from an agreed brief and revisions take 2. Once we've worked together for a while, the cycle comes down to 4 days end to end.