Skip to main content

Patch Notes and Changelogs

What Are Patch Notes Good For?​

Patch notes serve as a crucial tool for communication between developers and users, providing transparency and clear information about updates or changes to a product. Here’s how they help:

  • User Awareness: Patch notes inform users about the latest features, improvements, bug fixes, and any changes to the product.

  • Bug Fixes & Improvements: They help users understand when bugs or issues have been addressed, making it clear that the development team is actively working on improving the product.

  • New Features: Patch notes provide an opportunity to highlight newly introduced features or functionality that could enhance user experience.

  • Performance Enhancements: Users get insight into any optimization or performance upgrades that might improve the overall use of the app or product.

  • Transparency: Patch notes are an essential part of building trust with users, as they provide transparency on the development process, including what’s fixed, what’s new, and what’s been improved.

  • Change Tracking: Patch notes help developers and users track a product's evolution. They provide a historical record of what’s been changed across versions.

Overwolf Release Notes Feature

The Overwolf platform provides a release notes feature in the console, allowing developers to communicate updates effectively. For more information on how to use this feature, refer to the release note support on console.

Types of Patch Notes​

There are different types of patch notes based on the scope and audience. Understanding the different types helps you tailor the tone and content for your specific user base:

  • Major Patch Notes: These updates typically include significant new features, changes, or improvements. They might also involve breaking changes or major overhauls of existing functionality.

  • Minor Patch Notes: These updates are smaller and may focus on bug fixes, performance improvements, or slight feature enhancements. These don’t often have a big impact on the overall product.

  • Hotfix Patch Notes: Hotfixes are immediate, quick fixes for critical issues or bugs that need urgent attention. These are typically smaller, but they focus on fixing problems that may significantly affect the user experience or product stability.

  • Beta or Experimental Patch Notes: These notes are for updates in beta versions or experimental features that are being tested. These updates can be experimental, and the feedback is critical before the feature is fully rolled out.

  • Security Patch Notes: 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 Patch Notes​

To ensure patch 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 they're 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 patch notes logically. Start with a brief summary, followed by sections like new features, fixes, improvements, and known issues.

  • Focus on User Impact: Make sure to highlight how the changes will benefit users or how they may affect their experience with the app.

  • Use Bullet Points: Bullet points help to break up text, making the notes easier to scan.

  • Be Honest and Transparent: Don’t hide issues or downplay problems. If something was delayed or is still unresolved, mention it and assure users that it's being worked on.

  • Tone: Maintain a friendly, approachable tone. Remember, patch 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 patch notes: Users should have access to past updates whenever needed, not just when a patch 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.