Release notes
Why release notes matter
Release notes are more than just a list of changes, they’re a direct line of communication between you and your users. When done well, they help users understand what’s new, what’s fixed, and what’s coming next. Here's why every app should use them:
- **Keep users informed—let users know what’s changed, improved, or added in each version of your app.
- **Build trust through transparency—show that you’re actively maintaining and improving your product.
- Reduce confusion—clarify bugs, fixes, and performance improvements to reduce unnecessary support tickets.
- Highlight progress—demonstrate that your app is evolving and responding to feedback.
- Track changes over time—maintain a visible history of how your app has developed across versions.
Overwolf Release Notes Feature
The Overwolf platform provides a release notes feature in the Developers Console, allowing developers to communicate updates effectively. This tool allows developers to publish version-specific release notes that are visible directly in the app store and is integrated into the release management workflow, making it easy to include update information as part of the submission and publishing process.
Types of release notes
Not all updates are created equal. Release notes can vary depending on the scope of the release and what kind of changes were made. Here are the most common types:
- Major releases—typically include significant new features, changes, or improvements. They might also involve breaking changes or major overhauls of existing functionality.
- Minor releases—updates focus on bug fixes, performance improvements, or small feature enhancements. They don’t often have a big impact on the overall product.
- Hotfix releases—notifications about fixes for critical issues or bugs that need urgent attention. They are typically smaller, but they focus on fixing problems that may significantly affect the user experience or product stability.
- Beta or Experimental releases—updates in beta versions or experimental features that are being tested and typically require user feedback which is critical before the feature is fully rolled out.
- Security releases—These updates address security vulnerabilities within the app or product. Security patches are usually considered high-priority and should be clearly communicated to users.
Best practices for writing release notes
To ensure release notes are clear, concise, and user-friendly, consider these best practices:
- Version Number/Date—always include the version number or release date so users know exactly which update the user is reading about.
- Be clear and concise—avoid jargon or overly technical terms unless your audience is developers. Use plain language that anyone can understand.
- Structure—organize the release notes logically by starting with a brief summary, followed by sections like new features, fixes, improvements, and known issues.
- Focus on user impact—highlight how the changes will benefit users or how they may affect their experience with the app.
- Use bullet points—use to break up long amounts of text and it makes the notes easier to scan.
- Be honest and transparent—don’t hide issues or downplay problems. If something is delayed or unresolved, mention it and assure users that it's being worked on.
- Tone—maintain a friendly, approachable tone. Release notes are a way to keep users informed, and a positive tone can make users feel more engaged and confident in the product.
Accessibility and Visibility
- Allow users to view previous release notes—users should have access to past updates whenever needed, not just when a release note pops up.
- Highlight the most prominent change—choose the most important feature, promotion, or change in that release and present it with a visual hero banner. This approach ensures users quickly grasp the most crucial information without needing to read through all the details.