I would love every professional software to have a full release note for each update, as well as options to not have your web app update until you are ready for the changes to your flow.
Ask HN: How do you handle release notes for multiple audiences?
41–50 of 52 posts
Re: Ask HN: How do you handle release notes for multiple audiences?
#42As per industry standards: v1.4.18 - "Bug fixes and performance improvements" v1.4.17 - "Bug fixes and performance improvements" v1.4.16 - "Bug fixes and performance improvements"
They forget always the "," between "bug" and "fixes".
Re: Ask HN: How do you handle release notes for multiple audiences?
#43- The git commit log is the raw material. We try to have clean commits, but it's as messy as it is.
- This gets compiled into CHANGELOG.md at release time; we include all functionality and bugfixes, basically anything that any user or non-team dev might be interested or care about. But if some feature required multiple commits, we only include one line item for it. And if a feature gets reverted, we don't include both the feature and the reversion (that would be very confusing). This is for posterity.
- From the CHANGELOG we gather the "important subset" for the github release notes; this includes all features and major bugfixes, but only major API additions or changes. This has "see the CHANGELOG[link] for the full list of changes" at the bottom. This is for developers and users who follow us on github and are therefore more dev-savvy.
- From these release notes we produce the website release notes. This includes a complete list of new features, options, and commands, and important bugfixes (ones that a user might have experienced and would compel them to upgrade). But not any API changes unless it was a topline item for this release. This is for users and links back to the CHANGELOG.
- From the release webpage we pull highlights for social media, which link back to the release webpage.
We can always target different groups on social media with different subsets of functionality, but linking back up through the funnel leaves a trail of breadcrumbs for people who are more interested in the details.
Re: Ask HN: How do you handle release notes for multiple audiences?
#44Earlier quoted context omitted.
They forget always the "," between "bug" and "fixes".
I’m French but… there isn’t a comma, is there? “Fixes” is the main noun, “bug” qualifies the noun. “Fixes of bugs” or “bugfixes” like “weekday” or “storm trooper”. Whether there is a space or not depends on lexicalization, ie whether it feels like one concept. Bugfix is a single concept but “snow patrol” is two; and modern compounds tend to be two separate words, so “bugfix” is only joined in technical environments,…
Re: Ask HN: How do you handle release notes for multiple audiences?
#45You've pretty much got the gist of it, the way we're going after the problem is producing internal notes rolled up from the code changes, and the main thing that changes as we move that communication from internal to external is frequency and delivery method.
We're still fairly early, but I think it's a mistake to think the contents of that communication should change. As soon as you get past the developers who wrote the code the primary thing people care about is customer benefit and how this work contextualizes into our goals, so we start there.
Internal comms comes out in internal channels (eg, Slack), and gets updated frequently (> 1x a week). As we bring that message out to customers we offer more self serve options (eg, hosted URL, embedded widget), and then only recommend pushing a notification once a month in the form of a recap.
(But you should still have a place that potential customers can see all the work your team is doing)
Would love to talk more on it, and thanks for brining this question up, very cool to see all the responses.
Re: Ask HN: How do you handle release notes for multiple audiences?
#46I automate one changelog per project using git-cliff and conventional commits: https://github.com/orhun/git-cliff https://www.conventionalcommits.org/en/v1.0.0/ This changelog is copied into the release on github, or wherever the release is announced.
While more automation certainly is useful, I find that auto-generating changelogs in this manner has a number of problems: Auto-genertaed changelogs lack business-aware context about what is important. You get a big list of new features, but which ones are the most important to stakeholders? You have a few breaking changes, which are likely to have the most widespread impact? Without being judicious about what inform…
I worked for one startup with one major customer who was really skeptic of investing further because of stability problems, feature delay problems, and lack of transparency. Along with a complete list of changes that gave them insight into how we prioritised between stability and feature development, I wrote a human summary of what this meant — experiments, summaries of statistics, summary of most important changes to business logic.
Writing personally to your stakeholders does not exclude being systematic, and vice versa.
> As a matter of personal taste, I think it looks lazy.
That’s funny, because I find the lack of automation to be the lazy choice. Forgetting to add to the changelog because the requirement is checked by humans, or because single commits fix things below some bar of noteworthiness that is entirely subjective and driven by lack of structure. Not writing commit messages worth putting in release notes (fix sht, asdasdasd, etc.)
> Changelogs are a unique opportunity to communicate something important, they're written once and read by many. with a list of commits, myself and all other readers must now put in the work to find out what's relevant - it's disrespectful of others' time.*
When I migrate software, I’m very interested in the complete picture. I’ll ask my AI agent to go over the links in the changelog and summaries for me what are the breaking changes and what manual steps do I need to take. Having them in human-readable form ahead of time would be nice.
Since git-cliff has different sections, I can skip changes to documentation. Because of SemVer, I know if there’s something breaking.
Re: Ask HN: How do you handle release notes for multiple audiences?
#47As per industry standards: v1.4.18 - "Bug fixes and performance improvements" v1.4.17 - "Bug fixes and performance improvements" v1.4.16 - "Bug fixes and performance improvements"
This should be illegal if auto-updates are enabled or eventual updates are forced. Not joking. Nowhere else in society do we allow such self-serving laziness and unethical negligence (looking at you, purposely destroying backwards compatibility of APIs) at a professional level. Most other professions have steep legal consequences if they hide their actions or inactions.
Re: Ask HN: How do you handle release notes for multiple audiences?
#48Earlier quoted context omitted.
While more automation certainly is useful, I find that auto-generating changelogs in this manner has a number of problems: Auto-genertaed changelogs lack business-aware context about what is important. You get a big list of new features, but which ones are the most important to stakeholders? You have a few breaking changes, which are likely to have the most widespread impact? Without being judicious about what inform…
> You get a big list of new features, but which ones are the most important to stakeholders? I worked for one startup with one major customer who was really skeptic of investing further because of stability problems, feature delay problems, and lack of transparency. Along with a complete list of changes that gave them insight into how we prioritised between stability and feature development, I wrote a human summary o…
> That’s funny, because I find the lack of automation to be the lazy choice.
Automation is cheap these days. Many automations make things that exceed human ability, but this isn't one of those cases. You'll get something good-enough, but not great. Perhaps that's what your organisation has time and budget for, in which case your use of automation makes sense, but if we're trying to make the best audience-tailored summaries of software releases with specific purpose, the strategy falls short.
> Forgetting to add to the changelog because the requirement is checked by humans,
Individual developers definitely can, which is why you must also have organizational process. If a valid changelog checked by a release manager is a requirement for a software release, it can't be forgotten.
> fix things below some bar of noteworthiness that is entirely subjective and driven by lack of structure. Not writing commit messages worth putting in release notes (fix sht, asdasdasd, etc.)
I'm curious about the implication of insignificant commits coming from a lack of structure. I think it's entirely normal to have single commits fix something innocuous. If there's a typo in one file, you wouldn't fix it as part of creating a feature, because that's work outside the scope of the feature. So it would have to be in its own commit, or alongside other similar refinements. And those examples are indeed unacceptable commit messages that would not make it through code review in any serious shop, but I get what you mean, and it's part of my point: developers are supposed to write commit messages for developers, and the needs of developers are different to the needs of people reading a changelog, so it's only natural that the text should be changed for the different audience.
> I’ll ask my AI agent to go over the links in the changelog and summaries for me what are the breaking changes and what manual steps do I need to take.
I really think this is backwards and exactly the thing I was advocating against. The changelog you have is so large and poorly-structured that you need to use an AI to summarise it for you, and gather the information that should have been in the changelog in the first place. If that needs to be done to make the changelog useful, clearly its original state is deficient?
Re: Ask HN: How do you handle release notes for multiple audiences?
#49No one read them so a single version is more than enough
Re: Ask HN: How do you handle release notes for multiple audiences?
#50Earlier quoted context omitted.
> You get a big list of new features, but which ones are the most important to stakeholders? I worked for one startup with one major customer who was really skeptic of investing further because of stability problems, feature delay problems, and lack of transparency. Along with a complete list of changes that gave them insight into how we prioritised between stability and feature development, I wrote a human summary o…
I like your idea of an additional human summary, that does definitely help. > That’s funny, because I find the lack of automation to be the lazy choice. Automation is cheap these days. Many automations make things that exceed human ability, but this isn't one of those cases. You'll get something good-enough, but not great. Perhaps that's what your organisation has time and budget for, in which case your use of automa…
If affirmation is cheap, why hire humans to sit and manually validate if a text file was updated? Maybe you have a lot of cheap labor or a lack of automation experts.
> The changelog you have is so large and poorly-structured that you need to use an AI to summarise it for you
https://terranix.org/news-2025-11-09_website_renewal.html
Not really that long and poorly structured, no.