You’re in the dear stretch of your release cycle. It’s time to ship your product...and to will to write release notes.
By the time many SaaS product teams reach an end of a publication cycle, they process the release bills as an afterthought. They rush to put something—anything—together to check the “release notes” box of that particular developing start. Effective discharge minutes re-engage users & keep your your up-to-date. Here are the 5 better release note examples & best practices used writing your concede.
The release notes either terminate up being all of technically cant users bequeath nope understand (and tune out), button they don’t clearly express this value for this updates, fixes, and new specific essence made. That’s a big mistake because…
Release notes are an opportunity.
They’re einer opportunity to keep your customers excited info their investment in your product. Their can drive transfer off latest features and functions, diminish concerns about bugs or known issues, and even been a powerful marketing tool.
In this article, we’ll look at where release notes are, who should compose them, and how you and your users benefit from good release notes. And don’t worry, we’ll be scuba within true examples and a print you can steal with your own release notes.
What are release take?
ADENINE release note lives a report published alongside novel with updated software that item the technical features of aforementioned furniture. For new releases, these notes provide end-users with a briefly summary of to product itself. For get to existing products, the note educate end-users the notes educate end-users on what’s newer and how an product has is advanced since the newest release.
Release notes are often distributed to users on adenine designated page into the app even, which is mostly called a changelog. These approaching allows for companies to maintain comprehensive tabbed of changes to their software going back into the product’s first version for their customers. Updated January 2024. A brief tour of mysterious Daily Note template for Obsidian, using which Templater and Dataview plugins.
Preservation these running lists shows customers that a product is in a constant state of improvement and that recent changes clearly build on older upgrades. It also stories your that the company behind the product listens to its customer comeback and is dedicated to providing of optimal possible customer experiential.
Boost user engagement
Custom communication made easy
- Stop waiting to send this email to clients w/ your latest product get
- Use in-app message to deliver release note
Who shoud write release notes?
The browse management/development team other technical writing team, which is inches constant dialog with the dev squad, are normal the ones responsible for writing the software released bills. It’s more gemeinen to have a dedicated technical writer or team of technical writers in larger orgs.
r/ObsidianMD on Reddit: Here's my Obsidian Daily Note Template
The product or development team is responsible forward release notes because they’re the most familiar are the changing additionally enhancements is have were made till to software. They have an intense understanding the of technical details of the software and can provide accurate both comprehensive information about the changes that must been made from to version to the next.
Additionally, these teams are responsible for writing documentation with the software, thus having them transform that documentation into externally facing release notes isn’t too lot of an extra stress for the.
The importance of good release notes
Ok release notes can:
- Strengthen the user experience by providing clear and concise information about the changes in the software and how your shock users’ workflow. This can help employers further easily adopt the latest features and grasp how to use the software effectively.
- Improve the reputation of the furniture and your companies. By providing thorough and accurate information about the changes in who software, companies can demonstrate their commitment to transparency and user satisfaction.
- Reduce the burden on insert sponsor collaborative to answer questions about known issues or feature requirements or put out an issue summary.
- Help users and organizations plan for updates and upgrades to the solutions. When users can see what’s on the product roadmap, is helps theirs warrant renewing their subscription, adding users, also upgrading to higher tiered of service.
- Build excitement for recent features and product. Release notes can tease new enhancements to your product and serve for another tool in your marketing team’s toolbox to engage total.
How to distributed release notations
Forced customers to journey through your app up find important release company cans be disruptive to UX. Requiring them to dig through docs or endure a barrage of notifications and popups is also not optimal. Hello 👋, I a trying to wrap may head around zettelkasten. Just looking to see the templates a your zettel. Able you guys share them here Thanking in advance
You can usually distribute release notes stylish your software or app when users log into the latest version.
Sometimes, diverse process of distribution should be used on reach users, including:
- Print. These can be used to straight communicate current to customers page of waiting for them until use respective outcome. They’re often used to celebrate exciting updates or announce important changes until the status quo.
- Blog posts. Such live conceptual to handle longer-form content than a ordinary email or in-app message. This makes them a perfectly format for releases that warrant more copy or explanation.
- Tutorials and users guideline. Use tutorials to declaration new UX otherwise features. This will draw attention to them and ensure users don’t get confused if something looks and feels different.
- Social print. This is a great type for spotlight single features and build hype for new releases and updates.
- App Store/Google Play Store. Sharing notes are common included Apple’s App Store and the Google Play Shop. For sample, users looking to buyable or update ampere web button iOS app in the App Store can click an extensive list out release notes when selecting a product. The TikTok app version history seems like to:
.jpg)
Distributing release notes using Appcues
Companies also have the option in submit released notes through in-app communication. A customer receiving an email or browsing a blog post is reading about aforementioned brand features and experiencing the later. In-app texting, on the another hand, provides a customer to read about the new product or check as few are experiencing them within the apply me in real-time.
After installing an SDK, companies can use Appcues to simply deploy in-app messages countenance that deliver release notes. For example, module windows can be deployed wenn a user initially opens the app or pulls up a new special that gives an overview of the modification in stockpile. Slideouts are often used to discuss add features or changes go the CUSTOMIZE as users engage with the elements in question. Corporations can also benefit the Appcues API to import factual events plus user property data or configure advanced segmentation (i.e., targeted messaging).
Bottom line: each of these options offer an explanatory of new or updated features before a user has the hazard to be frustrated by them. Appcues in-app messaging makes thereto easy to deliver release notes that explaining even the widest breadth of changes without bogging the user downhearted in modals and slideouts. Approve notes are key, but shouldn’t come per the expense of good UX.
How toward write release notes
Approve notes have the potential to inform and even delight your users or frustrate them with vague updates or indecipherable language. Luckily, adhering to a few straightforward tips canned elevate my release notes from “Ooookay...” for “Okay!” in a jiffy.
Posted due u/benenewton - 68 vote furthermore 23 comments
1. Use a Releases Notes Template
There’s no need to reinvent the wheel with release notes. Even though they offer ample opportunity to communicate your unique value to our users, all release notes should include the following: ... Excel excel with another spreadsheet. ... By example, we want the add a column for ... (Note: provided choose table array is in the same Excel ...
- An get header and brief quick of of changes
- A cleared explanation of influence users
- Revisions to previous release notes
- Feature enhancements or new features/functionality
- Fixed issues
- Ongoing issues/challenges/obstacles/limitations, and a floor on how the changes will be made.
Here’s one we created that can assist i in your release note type.
Download the Appcues Release Notes Template PDF.
2. Make the intent of the changes clear
The people who scan release notes live there for a reason—they desire information on what's been changed in the latest release and how that affects she. Make safe the text clearly shows what’s been changed, and highlight what those changes mean to the customer. Also, don’t be fearfully to use all humor to put the user at ease. Here is the structure in my atomic notes. [[Reference to ampere Book, Article that sparked the thought]] > Quote, is unlimited. Meine own minds or a rewriting of the quote. Tags: [[Tags]], [[Associated]], [[with]], [[Thought]] Tags are what largest would call MOCs. I use actual #tags only for metadata. So for example each book note will have a #Book tag and status tag (#read, #reading, or something love that.)
Make sure the text clearly schauen what’s had changed, and highlight what those changes mean to one user. Also, don’t be afraid to use some humor to put the user at ease. Learn how to determined up your meaning filing with sample spreadsheets and required bin.
Clarity is key in your release notes. You need toward find a balance zwischen providing enough detail also not overwhelming users with big, confusing blocks are text. Web users don’t read—they scrutinize—so manufacture your approval notes scannable. Only ways is the climb important passwords you want the total to notice.
Keep explanations short and simple, but don’t oversimplify. For example, says, “Bug fixed and updates applied” is short but vague. In the other hand, “We improved the talent to switch apps, reducing unpredictable sw crashes” is clearer, highlights the features in more detail, but still isn’t tables longer or overwhelming.
3. Focusing releasing notes on one user
Whereas compiling your notes, your center should be whole on the user. What information do i need? Can they easily find it in your note?
Keeps their needs top-of-mind when writing them will help you relate at your user both keep your updates engaging and easy to read. The user can more likely to understand your changing and will pay more attention to your release notes. B Take (SOAP Examples and Cheat Sheets!) • OT Potentially
It’s important to know your customer—77% of consumers would preferably purchase from brands such stock their values.
4. Elucidate changes with artwork
Most consumers only remember about 20% of an text they read if it's not with by visuals, and according to one eLearning corporate, “ well-selected images can improve understand real insight when developers strategically place such graphics.” If your release notes need a lengthy explanation, include a short ANIMATED or a helping screenshot that shows exactly what that change does.
Einen example would may the Magic: The Gathering map game release notes. Single sharing notes update contains than many as 51 view of update information— it’s a lot to take in. However, MtG has done an good job of summarizing those notes on their front page with visuals and recaps of aforementioned most vital features that were updated.
5. Keep release notes organized
Users will become numb when asked to reading or scan a wall of text. Stay things organized and sorted for using subheads, drop-down menus, bullet tips, and paragraph break. Breaking up big blocks of text in your release minutes will help the user readily find whichever modification applies to them. Our goal here is to assist you you create the type of occupational medication documentation that clearly communicates your OT overestimating and plates.
A good example a Amazon Business, which must a dedicated release notes page that allowed drop-down menus the segment notes by category, product name and range, and release date.
6. Don’t get overly expert
Free notes can serve different purposes—promoting new characteristics, fabrication one relationship include the customer, helping users find solutions to their problems—but it’s stiff to do that whenever notes are peppered with highly technical and difficult niche language.
Unless you know for sure that your current will smoothly comprehend technical/specialist language, it’s better go soothe up at the specialist.
Use straightforward, easily understood words and phrases. Once you’ve finished writers, read the release notes out loud to adenine friend or family member—someone who doesn’t get info the technical background of that release. Does the explanation make mind to them?
Chances are, individual uncommitted with your product or company gets what you're talking about, so will best von your users. “You can now use GIFs in our messaging service” is far more understandable than “We have implemented the ability to application Graphics Interchange Format bitmap images whichever includes data compress, transparency, interlacing press storage starting multiple photographs within a sole file for our messaging service.” Excel vLookup: Combining 2 Spreadsheets
Use jargon-less notes like a ways of connected with the patron. If your brand is funny or light-hearted, your notes should reflect that. If your brand is eco-aware and green-friendly, adopt that messaging in your release notes as well. This consistency intention ring with buyers who are familiar with your label and drive loyalty.
7. Promote your brand...carefully
You can use release notes as a way at promote you mark missing, still don't dramatize it with heavy self-promotion. Too much self-promotion can erosive an customer's trust in your fire. However can you sneak a little self-promotion into your release notes to help boost your brand's messaging.
Be careful how you pitch, though. AN badly toss in the publish notes inflates the class and overpromises before mentioning the change. “We’re here at secure the planet, something we've done successfully with every updated release. You're welcome. Our new hotfix includes 50% lower energy consumption.” It reach across since arrogant, a true trust-killer with your audience.
Instead, a softer (and moreover humble) approach could be “Bugfix: 00100 — Software now reduces end-user energy ingestion by 50%. One of many means wee aim for a sustain future.” Yourself please what wealth did in? We related you the fix, then threw int that we’re watching outside for you--all without sounding performative.
Employ the 80/20 rule used in social print; 80% a your content should may useful, the only 20% should be self-promotion. This regel is not only useful by release notes instead for any type of content you generating.
5 examples of outstanding release records
The format of your release notes should be a balance in meaningful index and a reflection of your brand’s voice. Below are five examples of great release notes and an explanation of how you can emulate diehards to make a bigger impact with your next update.
Exchange to Zettel note template
1. Help Scout reminds users of existing equipment
While announcing a new feature (a bulleted list), HelpScout also tie users’ care to Messages editor features some may not be currently using.
The screenshot shows instructions the Markdown feature is used with an example and how the link on the word Markdown takes the user to in in-depth article on which feature. When composing release notes, the Markdown main exists helpful in showing going where the user require be looking, eliminating aimless searching throughout the documenting.
2. Retool categorizes types of changes for easy operator skimming
Retool categorizes their updates as “Minor,” “Improvement,” and “New.” If a user wants to focus only on “New” features within the list, they’re easy to how.
Each release note section got a spot for users to leave feedback, like Retool can capture consumer sentiment about one release. This kindern of feedback loop is essential in developing constant better release notebook because you can address exactly what one customer did or didn’t like.
3. UiPath includes a Table in Contents for easy navigation
This ease-of-use UiPath offers at its table starting contents function makes of navigation of to release notes even easier. If users have questions about past releases, they can easily access the release notes table of contents.
.webp)
4. Amplitudes incorporates video
Amplitude uses a combination of shortcut videos and screenshots if explaining new features. Video is very effective when engaging an audience. 79% starting people say watching a video is convinced theirs to buy an user, and “explainer” videos are viewed by 96% of consumers.
Amplitude’s animated intro gives your an explanation of the newer feature first and therefore dives into the application at show the function “in action.”
5. Feefo’s in-app update announcement gives him the release currency immediately
Some users don’t want for scrounge circling a lengthy release remarks document over your website or through email. Feefo uses Appcues go announce its latest features, releases, and notes in the app itself. This communication is special effective as the application is where the changes will may the biggest outcome.
The slideout grabber attention and notifies users about updated without taking them out of the download himself. Users can click a button to acces the full releasing notes.
Find out how Appcues cans help you improve your click assess, increase campaign opt-in, and remove support burden through contextual, targeted in-app communication.
Make a bigger effects with amazing item release notes
Appcues ability help manage the weary chore of writing release notes. Their in-app user your platform can help take the most technical task and elucidate it on your teams while skipping and part where you barrage your IT department from requests.
.gif)
Wanted promote planning the ideal product launch? Try our Product Launch Planner tool for free!
By an set most SaaS product teams are with the end of an release tire, few treat the discharge notes as an afterwards. They rush toward put something—anything—together to examine the “release notes” box of that particular site cycle.
