←back to thread

69 points mtlynch | 1 comments | | HN request time: 0s | source
Show context
lapcat ◴[] No.44379396[source]
> In contrast to release notes, which aim to be exhaustive, release announcements include only the most impactful changes.

No, don't do this. Provide release notes, not release "announcements". Exhaustive is good; exhaustive is helpful to the reader. Let them know their "little" bug is fixed. Or maybe if you accidentally introduced a new bug with your change, or affected the user's workflow in some way, the reader can figure that out too.

The entire blog post is about how to corrupt release notes with marketing.

You don't have to sell your software to someone who is already using it. That's just annoying.

As an indie developer, my users say that they appreciate my exhaustive release notes.

I remember back when I worked for someone else, my boss always changed "fixed a crash" to "fixed a rare crash" in the release notes (whether or not that was accurate) LOL. Keep management and marketing away from the release notes if possible.

replies(4): >>44379572 #>>44379604 #>>44379668 #>>44379815 #
mtlynch ◴[] No.44379604[source]
Thanks for reading, Jeff!

>> In contrast to release notes, which aim to be exhaustive, release announcements include only the most impactful changes.

>No, don't do this. Provide release notes, not release "announcements". Exhaustive is good; exhaustive is helpful to the reader. Let them know their "little" bug is fixed. Or maybe if you accidentally introduced a new bug with your change, or affected the user's workflow in some way, the reader can figure that out too.

They're not mutually exclusive. You can publish both release notes and a release announcement.

>You don't have to sell your software to someone who is already using it. That's just annoying.

I really disagree. I'm guessing you mean "sell" as in "manipulate" but I see it as "get users excited."

Of the software products I use and pay for, I appreciate it so much more when the vendor takes time to write a release announcement with care and focus on user needs. When I receive release announcements from Tailscale or Fly.io, I don't think, "Oh, boy, they're just trying to sell me something." I think it's cool that they're putting in the effort to showcase their work.

When vendors just publish a terse changelog, it feels like they don't care much about me and couldn't be bothered to present their work to me in a more accessible way.

replies(2): >>44379727 #>>44391873 #
1. saxelsen ◴[] No.44391873[source]
The company I work at is at a sufficient size that we publish changes internally to other teams.

We have the concept of Release Announcements that are a quick attention grabber headline, followed on by Tasting Notes that explain in detail what changed and additional release notes.

That way the people who just want to understand the primary changes and those who want the details are happy.