{"id":4692,"date":"2023-08-10T06:59:00","date_gmt":"2023-08-10T10:59:00","guid":{"rendered":"https:\/\/canny.io\/blog\/?p=4692"},"modified":"2024-11-01T20:31:51","modified_gmt":"2024-11-02T00:31:51","slug":"release-notes","status":"publish","type":"post","link":"https:\/\/canny.io\/blog\/release-notes\/","title":{"rendered":"Why do you need release notes? (featuring great examples and templates)"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">When you improve your product, remember to tell the world about it! Otherwise, people may not&nbsp;notice.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">One of the best ways to do that is through product announcements. There are a few different types of&nbsp;them.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>A release note<\/strong> is a document that outlines the changes made to a product. Release notes update your users, teammates, and stakeholders on your product development&nbsp;progress.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Changelogs <\/strong>are more technical documents that dive deeper into the changes. They\u2019re primarily for developers to keep track of&nbsp;progress.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">We\u2019ll cover different types of product release notes and changelogs, their importance, and best practices. We\u2019ll also showcase some examples and templates, discuss <a href=\"https:\/\/canny.io\/features\/product-changelog\" target=\"_blank\" rel=\"noreferrer noopener\"><u>changelog management tools,<\/u><\/a> and help you get the most out of your feature&nbsp;announcements.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">If you\u2019ve never published release notes or want to improve your product documentation, follow&nbsp;along.&nbsp;<\/p>\n\n\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Release notes vs changelogs<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">First off, let\u2019s go over some&nbsp;definitions.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">What are release&nbsp;notes?<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">As mentioned, <strong>release notes<\/strong> are basically your product announcements. The target audience is users, so release notes explain changes in plain language, omitting the technical jargon and details. The main purpose is to explain the effect on the&nbsp;user.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">A <strong>changelog<\/strong> is a file, an article, or a webpage that lists all notable changes to your app, site, etc. Changelogs focus on the technical aspects of the changes, such as new features, bug fixes, code refactoring, and API modifications. They often contain references to specific commits or code changes in the version control&nbsp;system.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Historically, changelogs were for developers. Here\u2019s a typical changelog entry from Facebook on&nbsp;GitHub.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1600\" height=\"880\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/facebook-react-changelog.avif\" alt=\"Facebook React changelog\" class=\"wp-image-8168\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/facebook-react-changelog.avif 1600w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/facebook-react-changelog-768x422.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/facebook-react-changelog-1536x845.avif 1536w\" sizes=\"auto, (max-width: 1600px) 100vw, 1600px\" \/><figcaption class=\"wp-element-caption\"><em><a href=\"https:\/\/github.com\/facebook\/react\/blob\/main\/CHANGELOG.md\" target=\"_blank\" rel=\"noreferrer noopener\">Source<\/a><\/em><\/figcaption><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">Some people refer to changelogs as release notes. And others make a distinction between these two&nbsp;terms.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Canny\u2019s Changelog tool blurs the lines between release notes and&nbsp;changelogs.<\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p class=\"wp-block-paragraph\">\u201cComing from the product development world, we saw the need for better product announcements. Users want to know what\u2019s new and improved in your product. And we needed an easy tool that helps us do that. So we created our own tool \u2013 for us and other SaaS companies out there. It brings customer feedback and product announcements&nbsp;together.\u201d<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Andrew Rasmussen, co-founder at Canny<\/p>\n<\/blockquote>\n\n\n\n<p class=\"wp-block-paragraph\">Whatever you call your product announcements, it\u2019s important to have them. Here\u2019s&nbsp;why.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Why do you need product announcements?<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Changelogs and software release notes are important&nbsp;for:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Documenting your&nbsp;work<\/li>\n\n\n\n<li>Educating your&nbsp;customers<\/li>\n\n\n\n<li>Keeping your products&nbsp;updated<\/li>\n\n\n\n<li>Positioning yourself as&nbsp;transparent<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Here\u2019s more about each of those&nbsp;reasons.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">They document your work<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">At its core, release notes help your team stay organized. When you have release notes, you can quickly reference them to see what was changed in the past and&nbsp;how.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You\u2019ll also minimize the back and forth with your team through release&nbsp;notes.&nbsp;<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Not every project involves all team members. So, release notes are a great way to keep uninvolved teams informed. They\u2019ll learn about changes as soon as you publish your release&nbsp;notes.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">They educate your users<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">New feature adoption is a common problem for a product manager. Many users crave efficiency but are still hesitant to try new&nbsp;things.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Release notes help push them in that direction. They break down the new feature, guide users through it, and remind them how your tool works. A good release note is a free&nbsp;teacher.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Release notes are also an opportunity to link to additional help docs and remind users where they can find support&nbsp;resources.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">They make the product feel fresh<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">When people use a product, they like to see it evolve. Right now, for example, AI is all the rage. Many tools are adding AI components to their software. And at this point, users are almost expecting&nbsp;it.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">If you decide to add AI to your tool, you\u2019d want your users to know about it, right? There\u2019s no point in putting in all the hard work if no one notices. You want your users to know and use these new&nbsp;features.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Especially if your product uses a subscription model, people want to see it updated. Consumer demands change, and your product needs to measure&nbsp;up.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">From minor design improvements to major feature enhancements, your tool will go through many iterations. So let your users know about it. Show your progress and invite your users to join you on this&nbsp;journey.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Release notes are a great way to do&nbsp;that.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">They help you be transparent<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Similar to the previous point, release notes help you keep your customers around. Here\u2019s&nbsp;how.<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>A user submits a feature&nbsp;request<\/li>\n\n\n\n<li>That feature idea makes it to the product roadmap<\/li>\n\n\n\n<li>They automatically subscribe to the progress of that&nbsp;feature<\/li>\n\n\n\n<li>You build that feature and publish a release notes&nbsp;entry<\/li>\n\n\n\n<li>They get an auto-notification about it (if you\u2019re using Canny\u2019s&nbsp;Changelog)<\/li>\n<\/ol>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Bonus<\/strong>: they can see other updates in your release notes&nbsp;too.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">This shows that you listen to your users. That\u2019ll help them trust that you\u2019re improving your&nbsp;product.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">People love seeing the \u201cbehind the scenes\u201d and \u201chow it\u2019s done\u201d content. Release notes can shed light on your \u201cbackstage\u201d software release&nbsp;processes.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Types of product announcements entries<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Overall, release notes are pretty standard and straightforward. Depending on the nature of your new release, you can borrow certain parts from each release note entry (which is what we did with Canny\u2019s&nbsp;Changelog).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">There are a few types of posts you\u2019d add to your release notes. Let\u2019s discuss each&nbsp;one.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Major update announcement<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Intended audience<\/strong>: users, leads, team members,&nbsp;shareholders<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">When you\u2019re adding a major new feature, make sure to give this announcement the attention it&nbsp;deserves.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">These release notes can be longer and include more details, such&nbsp;as:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Before and after screenshots and screen&nbsp;recordings<\/li>\n\n\n\n<li>Clear explanation of the&nbsp;change<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Note<\/strong>: Give users some time to get used to the change too. Many tools keep the old (legacy) version available for some time for this exact&nbsp;reason.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Non-major update announcement<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Intended audience<\/strong>: current users, team&nbsp;members<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can keep it simple when adding or fixing something less groundbreaking. Make sure to explain why you did it( we often show how many upvotes we got on <a href=\"https:\/\/feedback.canny.io\/\" target=\"_blank\" rel=\"noreferrer noopener\"><u>our Canny board<\/u><\/a>, for&nbsp;example).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Explain what changed, but don\u2019t go too deep into the technical details. Instead, link out to help guides and additional&nbsp;resources.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Bug fixes<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Intended audience<\/strong>: developers, current&nbsp;users<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Bug fixes are a great example of non-major feature enhancements. You don\u2019t want to draw too much attention to the fact that you had bug reports. But let\u2019s be real \u2013 every software has them. And showing that you\u2019re working on them makes you look transparent and&nbsp;trustworthy.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Security updates<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Intended audience<\/strong>: current&nbsp;users<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">While very important, security updates fall under the category of non-major updates. They showcase your organization as responsible and&nbsp;reliable.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Very few people want to read lengthy descriptions of your security updates. So it\u2019s even more important to keep these&nbsp;short.&nbsp;<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Changelogs<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Intended audience<\/strong>:&nbsp;developers<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">A standard changelog is detailed and technical. It usually&nbsp;includes:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Version&nbsp;number<\/li>\n\n\n\n<li>Release&nbsp;date<\/li>\n\n\n\n<li>Description of the latest release or a fixed&nbsp;bug<\/li>\n\n\n\n<li>Compatibility with previous&nbsp;versions<\/li>\n\n\n\n<li>User&nbsp;impact<\/li>\n\n\n\n<li>Manual for future&nbsp;use<\/li>\n\n\n\n<li>Screenshots and&nbsp;links<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Developers use changelogs to schedule upgrades, troubleshoot issues, and stay updated about the latest software&nbsp;developments.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Version control system logs<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Intended audience<\/strong>:&nbsp;developers<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">There are a few terms that people use interchangeably to describe these&nbsp;updates:&nbsp;<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Version control system&nbsp;logs&nbsp;<\/li>\n\n\n\n<li>Commit&nbsp;logs<\/li>\n\n\n\n<li>Revision&nbsp;history<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">These are records that keep track of changes made to a project or set of files over time in a version control system&nbsp;(VCS).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">A common example is <a href=\"https:\/\/www.youtube.com\/watch?v=w3jLJU7DT5E\" target=\"_blank\" rel=\"noreferrer noopener\"><u>GitHub<\/u><\/a>. Developers use it to share code, work on projects together, and manage and track code&nbsp;changes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Github logs are visible to the public. This is a space where developers can collaborate and share ideas \u2013&nbsp;kind of like social media for&nbsp;coding.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Version control system logs usually include the following&nbsp;information:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Commit ID: a unique identifier for each change or commit made in the VCS. Typically, it\u2019s a hexadecimal string, such as a SHA-1&nbsp;hash.<\/li>\n\n\n\n<li>Author<\/li>\n\n\n\n<li>Date and&nbsp;time<\/li>\n\n\n\n<li>Commit message: a descriptive message that summarizes the purpose or nature of the changes made in the&nbsp;commit<\/li>\n\n\n\n<li>Changes: a detailed listing of the modified, added, or deleted files in the commit + specific changes made to each file. This may include line-by-line differences or a unified diff&nbsp;format.<\/li>\n\n\n\n<li>Branch or tag. Branches are different lines of development. Tags indicate specific points in the version history&nbsp;\u2013 releases or milestones for&nbsp;instance.<\/li>\n\n\n\n<li>Merge information: if the commit involves merging changes from multiple branches, the log will contain information about the branches&nbsp;involved.<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">A project\u2019s version control logs are crucial to tracking and understanding its&nbsp;history.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Developers&nbsp;can:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Find the record of all&nbsp;changes<\/li>\n\n\n\n<li>Review and revert to previous&nbsp;versions<\/li>\n\n\n\n<li>Figure out who made specific&nbsp;changes<\/li>\n\n\n\n<li>Understand the evolution of the codebase over&nbsp;time<\/li>\n\n\n\n<li>Coordinate work and&nbsp;collaborate<\/li>\n\n\n\n<li>Resolve conflicts when merging changes from multiple&nbsp;sources<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">If you\u2019re looking for more inspiration and ideas, BroadInstitute provides great sample changelogs. <a href=\"https:\/\/broadinstitute.github.io\/warp\/docs\/contribution\/contribute_to_warp\/changelog_style\" target=\"_blank\" rel=\"noreferrer noopener\"><u>Check them out&nbsp;here<\/u><\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Product update formats<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Different companies use different formats for their product announcements. Depending on your product and audience, you can pick a format that works best for you. It\u2019s important to choose a format and stick with it. We\u2019ll explain why consistency is so important later in the article. First, let\u2019s walk through the various&nbsp;formats.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Text files<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">This is the simplest and most common format for a software release note. You can simply create a text document that lists the changes in reverse chronological order (put the newest releases at the&nbsp;top).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Each entry should include the version number, a brief description of the change, and any relevant&nbsp;details.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">This format is easy to create and read for most&nbsp;users.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1338\" height=\"974\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/text-file-changelog.avif\" alt=\"\" class=\"wp-image-8170\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/text-file-changelog.avif 1338w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/text-file-changelog-768x559.avif 768w\" sizes=\"auto, (max-width: 1338px) 100vw, 1338px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"has-text-align-center wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Changelog format<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">If you prefer a more technical approach, you can follow a typical changelog format. You can include categories&nbsp;like:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Added<\/li>\n\n\n\n<li>Changed<\/li>\n\n\n\n<li>Fixed<\/li>\n\n\n\n<li>Removed<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">This format is particularly useful for developers and technical users who want a quick overview of the changes in each&nbsp;category.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1068\" height=\"1202\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/standard-changelog-entries.avif\" alt=\"Standard changelog \/ release notes.\" class=\"wp-image-8171\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/standard-changelog-entries.avif 1068w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/standard-changelog-entries-768x864.avif 768w\" sizes=\"auto, (max-width: 1068px) 100vw, 1068px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">With a changelog tool, you can also create HTML files for&nbsp;example.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Markdown<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown is a lightweight markup language that helps you format text quickly and easily. You can write release notes in Markdown and easily convert them into HTML or other&nbsp;formats.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">If you\u2019re hosting your updates on a platform like GitHub, you\u2019ll likely use the Markdown&nbsp;format.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1070\" height=\"774\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/markdown-release-notes.avif\" alt=\"Markdown release notes\" class=\"wp-image-8172\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/markdown-release-notes.avif 1070w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/markdown-release-notes-768x556.avif 768w\" sizes=\"auto, (max-width: 1070px) 100vw, 1070px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"has-text-align-center wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>HTML<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">HTML provides a bit more flexibility with styling and layout. You can include links, images, and other multimedia elements, making your release notes more visually&nbsp;appealing.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1066\" height=\"1018\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/html-release-notes.png\" alt=\"HTML release notes\" class=\"wp-image-8173\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/html-release-notes.png 1066w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/html-release-notes-768x733.avif 768w\" sizes=\"auto, (max-width: 1066px) 100vw, 1066px\" \/><\/figure>\n<\/div>\n\n\n<h3 class=\"wp-block-heading\"><strong>PDF<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">PDF is a good option if you need to share your updates with external stakeholders or use them in official statements. The layout and formatting stay consistent, and it looks&nbsp;presentable.&nbsp;<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">PDF is easy to read, print, and share across&nbsp;teams.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>What to include<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Depending on the format you choose, consider including the following elements to make your announcements more&nbsp;engaging.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Bullet points<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">You can create a series of bullet points, each bullet representing a specific product change or a&nbsp;feature.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">If you\u2019re looking for a concise and skimmable format, this is it. It gets straight to the&nbsp;point.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1072\" height=\"772\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/bullet-point-release-notes.avif\" alt=\"Bullet point release notes\" class=\"wp-image-8174\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/bullet-point-release-notes.avif 1072w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/bullet-point-release-notes-768x553.avif 768w\" sizes=\"auto, (max-width: 1072px) 100vw, 1072px\" \/><\/figure>\n<\/div>\n\n\n<h3 class=\"wp-block-heading\"><strong>Visuals<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">We recommend combining some written descriptions with visuals like screenshots and GIFs. They break up the text, help visual learners, and tell a story better than words&nbsp;can.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">With screenshots, we recommend drawing readers\u2019 attention to the part that you\u2019re talking about. You can add boxes around the most important parts and\/or blur the irrelevant parts of the page. Here\u2019s an&nbsp;example.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1206\" height=\"1246\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-release-notes.avif\" alt=\"Canny release notes example\" class=\"wp-image-8175\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-release-notes.avif 1206w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-release-notes-768x793.avif 768w\" sizes=\"auto, (max-width: 1206px) 100vw, 1206px\" \/><\/figure>\n<\/div>\n\n\n<h3 class=\"wp-block-heading\"><strong>Videos<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Creating a quick video walkthrough can make your feature update even easier to understand. Some people are visual learners, so they\u2019d enjoy seeing rather than&nbsp;reading.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1510\" height=\"1184\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/helpscout-video-release-notes.avif\" alt=\"HelpScout video release notes\" class=\"wp-image-8176\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/helpscout-video-release-notes.avif 1510w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/helpscout-video-release-notes-768x602.avif 768w\" sizes=\"auto, (max-width: 1510px) 100vw, 1510px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/www.helpscout.com\/blog\/release-notes-july-2023\/\" target=\"_blank\" rel=\"noreferrer noopener\"><\/a><\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Generating release notes<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">There are a number of ways to generate release&nbsp;notes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>1. Version Control System (VCS)&nbsp;history<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Version control systems like Git allow you to generate release notes based on commit histories. For instance, you can extract commit information using the git log command with specific formatting options, such as dates, authors, and&nbsp;changes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>2. Commit&nbsp;messages<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Encourage your developers to write clear and informative commit messages describing each commit\u2019s changes. Following a consistent format, such as the changelog format, can be&nbsp;helpful.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>3. Integration with issue tracking&nbsp;systems<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can automatically create release notes by connecting issues and pull requests to versions or milestones in your issue tracker. You can use tools like Jira or GitHub for&nbsp;that.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>4. Manual&nbsp;changelog<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can manually keep track of the changes you make to each version. You\u2019d need to maintain a separate file where you add entries for each release, including the added features, changes, and bug&nbsp;fixes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>5. Automated&nbsp;tools<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can generate a structured and formatted changelog with these tools. They analyze your commit history, tags, and metadata. Some popular changelog generation tools&nbsp;include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Conventional&nbsp;commits<\/strong><\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">This tool follows the conventional commit message format and generates&nbsp;changelogs.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>GitHub Changelog&nbsp;Generator<\/strong><\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">This tool is designed to generate changelogs for GitHub&nbsp;repositories.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Keep a&nbsp;Changelog<\/strong><\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">This <a href=\"https:\/\/keepachangelog.com\/en\/1.0.0\/\" target=\"_blank\" rel=\"noreferrer noopener\"><u>project<\/u><\/a> provides guidelines and a tool-agnostic format for writing changelogs. It also offers a Python library called towncrier for generating&nbsp;changelogs.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>6. Canny\u2019s&nbsp;Changelog<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Canny\u2019s Changelog is different. It\u2019s designed so that everyone, even non-developers,&nbsp;can:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Add&nbsp;entries<\/li>\n\n\n\n<li>Easily understand&nbsp;it<\/li>\n\n\n\n<li>Quickly find what they\u2019re looking&nbsp;for<\/li>\n\n\n\n<li>Sort the&nbsp;entries<\/li>\n\n\n\n<li>Find more&nbsp;information<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">It\u2019s much more visual and concise than most other changelogs. And it looks like a newsfeed, not a developer&nbsp;portal.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1600\" height=\"1279\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-changelog.avif\" alt=\"Canny's changelog\" class=\"wp-image-8177\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-changelog.avif 1600w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-changelog-768x614.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-changelog-1536x1228.avif 1536w\" sizes=\"auto, (max-width: 1600px) 100vw, 1600px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/canny.io\/features\/product-changelog\" target=\"_blank\" rel=\"noreferrer noopener\">Canny\u2019s Changelog<\/a> is available on all plans! Here&#8217;s what our clients say about it.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<center><iframe loading=\"lazy\" width=\"650\" height=\"315\" align=\"centre\" src=\"https:\/\/www.youtube.com\/embed\/N9WYyT239Wo?si=6cMUNJCl9MzHcf-B\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" allowfullscreen=\"\"><\/iframe><\/center>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Our changelog lets you easily tie your feature requests with product updates and notify your&nbsp;users.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Best practices for release notes<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Here are a few more guidelines to make sure you publish engaging and effective release notes. Follow these tips if you\u2019d like your release notes to be an asset instead of a&nbsp;burden.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Make them clear &amp; concise<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">It takes time to find the time, energy, and motivation to read long texts. It\u2019s even more true when it comes to technical&nbsp;language.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">If you want your release notes to be a truly useful source of information, make them as straightforward as possible. Answer the following&nbsp;questions:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>What was the&nbsp;problem?<\/li>\n\n\n\n<li>What&nbsp;changed?<\/li>\n\n\n\n<li>Why does it&nbsp;matter?<\/li>\n\n\n\n<li>How does it affect the&nbsp;user?<\/li>\n\n\n\n<li>Where can they learn&nbsp;more?<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Simplify your language, keep sentences short, and break up the long&nbsp;paragraphs.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">As a general rule, stick to only relevant information. It\u2019s easy to get very involved and start describing the whole history of your tool. But leave that for another&nbsp;day.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>Remember<\/strong>: even if your product is technical, you might have non-technical users. So try to make it interesting and valuable for them as&nbsp;well.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Post consistently<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Some changes might be more significant than others. Still, try to publish most of your updates as release notes. People appreciate your updates \u2013 they\u2019ll feel like they\u2019re with you on your journey. They also get a sense that you\u2019re constantly&nbsp;improving.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">This will also keep you accountable. Knowing your users expect consistent updates will make you hit your deadlines more&nbsp;often.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Format consistently<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Also, keep the format of your release notes consistent. Here\u2019s an example from <a href=\"http:\/\/keepachangelog.com\/en\/1.0.0\/\" target=\"_blank\" rel=\"noreferrer noopener\"><u>Keepachangelog<\/u><\/a>:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Added new&nbsp;features<\/li>\n\n\n\n<li>Changed for changes in existing&nbsp;functionality<\/li>\n\n\n\n<li>Deprecated for soon-to-be-removed&nbsp;features<\/li>\n\n\n\n<li>Removed for now removed&nbsp;features<\/li>\n\n\n\n<li>Fixed for any bug&nbsp;fixes<\/li>\n\n\n\n<li>Security in case of&nbsp;vulnerabilities<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Use a variety of formatting to make your release notes entries even easier on the&nbsp;eye.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Headings help break down the text and logically group the changes. So does white&nbsp;space.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Text formatting (bold, underlined, italics) highlights the most essential parts and helps readers skim the text. Bulleted and numbered lists have a similar&nbsp;effect.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Follow reverse chronological order<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Always publish the latest changes at the top \u2013 that\u2019s the most relevant information for your users. They can scroll down to see your historical progress&nbsp;too.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Use visuals<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Often, it\u2019s easier to show than to describe something. Visuals like screenshots, GIFs, and videos can help here. Moreover, they\u2019ll familiarize your users with the new features quicker. Next time they log in, they\u2019ll remember the visual and know how to use the new&nbsp;feature.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1168\" height=\"1406\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/visual-release-note.avif\" alt=\"Canny's changelog example using visuals\" class=\"wp-image-8178\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/visual-release-note.avif 1168w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/visual-release-note-768x924.avif 768w\" sizes=\"auto, (max-width: 1168px) 100vw, 1168px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">Visuals also break up the text and make reading easier and more&nbsp;enjoyable.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Insert links<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">We keep repeating that release notes need to be short. But what if you\u2019ve released a major change and need to explain it in&nbsp;detail?<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">That\u2019s where you insert links to in-depth help articles and additional&nbsp;documentation.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">You can also use your release notes to keep your users engaged. While they\u2019re hooked, don\u2019t let them get away. Link to related resources and keep them on your site&nbsp;longer!<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Avoid confusion<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">We can\u2019t stress this enough: make it simple. Here are some tips to help you do&nbsp;that:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Stay away from confusing date formats (we recommend sticking to YYYY-MM-DD&nbsp;format)<\/li>\n\n\n\n<li>List <a href=\"https:\/\/keepachangelog.com\/en\/1.0.0\/\" target=\"_blank\" rel=\"noreferrer noopener\"><u>deprecations<\/u><\/a>, removals, and any breaking&nbsp;changes<\/li>\n\n\n\n<li>Document <strong>only<\/strong> noteworthy&nbsp;differences<\/li>\n\n\n\n<li>Don\u2019t list commit log&nbsp;diffs<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Involve other departments<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">If you\u2019re using Canny for your product announcements, your users will get automatic notifications when a new changelog is&nbsp;published.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Still, you can amplify the message further. Involve your <a href=\"https:\/\/canny.io\/blog\/what-is-product-marketing\/\" data-wpil-monitor-id=\"50\">product marketing<\/a> team \u2013 they can help spread the&nbsp;word.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Release notes and changelog examples<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Now that you know what makes good release notes and changelogs, let\u2019s illustrate it with&nbsp;examples.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Many of our clients use Canny\u2019s Changelog tool. They find it easy to keep users up-to-date in one central&nbsp;location.<\/p>\n\n\n\n<blockquote class=\"wp-block-quote is-layout-flow wp-block-quote-is-layout-flow\">\n<p class=\"wp-block-paragraph\">\u201cWhen we built our Changelog, we wanted it to be more than your typical list of changes. We created a tool that helps you close your customer feedback&nbsp;loop.\u201d<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Sarah Hum, co-founder at Canny<\/p>\n<\/blockquote>\n\n\n\n<p class=\"wp-block-paragraph\">When a new changelog entry is published, everyone who submitted, upvoted, or commented on this request gets an automatic notification. That includes current users and prospects. And this really makes the sales job&nbsp;easier.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Imagine this: a lead previously requested a feature and didn\u2019t convert because it didn\u2019t exist. Now they\u2019re getting a notification that this feature is shipped. If that feature was a real dealbreaker to them, they might reconsider buying from you&nbsp;now.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Your current users will also find out about the new feature right away and will be able to try it&nbsp;out.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Canny\u2019s changelog empowers you to follow our advice above, including custom&nbsp;formatting.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Here\u2019s what it looks&nbsp;like.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/agencyanalytics.canny.io\/changelog\">AgencyAnalytics keeps their updates<\/a> brief and to the point. When they introduce new features, they include visuals to keep it engaging and break up the text. See some examples of great release notes&nbsp;below.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/agency-analytics-changelog.avif\" alt=\"AgencyAnalytics using Canny's changelog\" class=\"wp-image-8179\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/agency-analytics-changelog.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/agency-analytics-changelog-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/agency-analytics-changelog-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">We love <a href=\"https:\/\/clickup.canny.io\/changelog\" target=\"_blank\" rel=\"noreferrer noopener\">ClickUp\u2019s<\/a> use of emojis and links \u2013 it keeps the readers engaged and curious to learn more. Notice how they link out to release notes and more information. They don\u2019t clutter their changelog entry with&nbsp;it.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-1.avif\" alt=\"ClickUp using Canny's changelog\" class=\"wp-image-8180\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-1.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-1-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-1-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-2.avif\" alt=\"ClickUp using Canny's changelog\" class=\"wp-image-8181\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-2.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-2-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/clickup-release-notes-2-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/commentsold.canny.io\/changelog\" target=\"_blank\" rel=\"noreferrer noopener\">CommentSold&#8217;s changelog entries<\/a> are typically longer, but they&#8217;re still easy to read and understand. It&#8217;s a great example of a more detailed but still digestible changelog. They walk you through the steps you need to take, and text styling (bold text in this instance) makes it easier to read.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/commentsold-changelog-entry.avif\" alt=\"CommentSold's changelog entries\" class=\"wp-image-8182\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/commentsold-changelog-entry.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/commentsold-changelog-entry-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/commentsold-changelog-entry-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/hiveteams.canny.io\/changelog\" target=\"_blank\" rel=\"noreferrer noopener\">Hive is great at telling a story in their changelog<\/a>. Here&#8217;s what wasn&#8217;t working, how we fixed it, and how it works now. We love how they show a screenshot of a feature request that led to the development of this feature.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/hive-release-note.avif\" alt=\"Hive using Canny's changelog\" class=\"wp-image-8183\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/hive-release-note.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/hive-release-note-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/hive-release-note-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/respond.canny.io\/changelog\" target=\"_blank\" rel=\"noreferrer noopener\">Respond.io<\/a> is another example of a short and highly visual changelog.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/respond-changelog.avif\" alt=\"Respond.io's using Canny's release notes\" class=\"wp-image-8184\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/respond-changelog.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/respond-changelog-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/respond-changelog-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">GitHub&#8217;s changelog is another great example. They also have a <a href=\"https:\/\/twitter.com\/ghchangelog\" target=\"_blank\" rel=\"noreferrer noopener\">separate Twitter account<\/a> and an <a href=\"https:\/\/github.blog\/changelog\/feed\/\" target=\"_blank\" rel=\"noreferrer noopener\">RSS feed<\/a> for users to follow along the journey. It&#8217;s important to be where your users are!<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1600\" height=\"867\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/github-changelog.avif\" alt=\"GitHub's changelog\" class=\"wp-image-8185\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/github-changelog.avif 1600w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/github-changelog-768x416.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/github-changelog-1536x832.avif 1536w\" sizes=\"auto, (max-width: 1600px) 100vw, 1600px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">We use our own changelog too!<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1600\" height=\"1491\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-slack-release-note.avif\" alt=\"\" class=\"wp-image-8186\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-slack-release-note.avif 1600w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-slack-release-note-768x716.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/canny-slack-release-note-1536x1431.avif 1536w\" sizes=\"auto, (max-width: 1600px) 100vw, 1600px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">Sometimes, it&#8217;s still hard to get going. That&#8217;s why we&#8217;ve prepared some templates \u2013 check out the next section.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Release notes and changelog templates<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">If you&#8217;re inspired to get started or amplify your changelog (and we hope you are!), <a href=\"https:\/\/go.canny.io\/changelog-template\" target=\"_blank\" rel=\"noreferrer noopener\">check out these templates<\/a>. They&#8217;ll give you prompts for your release notes, changelog entries, and some examples to spark that initial motivation.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Here is a release notes template for a bug fix.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/release-note-bug-fix-template.avif\" alt=\"Bug fix changelog release notes template\" class=\"wp-image-8187\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/release-note-bug-fix-template.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/release-note-bug-fix-template-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/release-note-bug-fix-template-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">And another release notes template to announce a new feature.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1236\" height=\"1600\" src=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/new-feature-release-note-template.avif\" alt=\"New feature changelog release notes template\" class=\"wp-image-8188\" style=\"width:650px\" srcset=\"https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/new-feature-release-note-template.avif 1236w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/new-feature-release-note-template-768x994.avif 768w, https:\/\/canny.io\/blog\/wp-content\/uploads\/2023\/08\/new-feature-release-note-template-1187x1536.avif 1187w\" sizes=\"auto, (max-width: 1236px) 100vw, 1236px\" \/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">To get these + more editable templates, <a href=\"https:\/\/go.canny.io\/changelog-template\" target=\"_blank\" rel=\"noreferrer noopener\">download our free Changelog templates right here<\/a>!<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<div class=\"hs-cta-embed hs-cta-simple-placeholder hs-cta-embed-160917338143\"\n  style=\"max-width:650px; margin: 0 auto;\" data-hubspot-wrapper-cta-id=\"160917338143\">\n  <a href=\"https:\/\/cta-service-cms2.hubspot.com\/web-interactives\/public\/v1\/track\/redirect?encryptedPayload=AVxigLKbaPRbOPwgie3vdGj59DSPydAeGKuPsmm1Q0LdZ8jGgqPmjIABKmIw4xeTEzhD5VIY3zjvWR8Ym0%2BZmZuyzKA3QfqhkV5fmr%2FBxV7JfnnhbEw%3D&#038;webInteractiveContentId=160917338143&#038;portalId=5705808\" target=\"_blank\" rel=\"noopener\" crossorigin=\"anonymous\">\n    <img decoding=\"async\" alt=\"Changelog templates\" loading=\"lazy\" src=\"https:\/\/no-cache.hubspot.com\/cta\/default\/5705808\/interactive-160917338143.png\" style=\"height: 100%; width: 100%; object-fit: fill\"\n      onerror=\"this.style.display='none'\" \/>\n  <\/a>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Why product announcements are important<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">There&#8217;s no better way to keep all your stakeholders involved, engaged, and updated than through release notes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/canny.io\/blog\/announce-product-updates-features\/\" data-wpil-monitor-id=\"56\">Product update announcements<\/a> don\u2019t need to be a hassle. With a changelog tool like Canny, you can keep track of all your progress and delight your customers at the same time.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><a href=\"https:\/\/canny.io\/request-demo\" target=\"_blank\" rel=\"noreferrer noopener\">Book a free Canny demo<\/a> and see how easy it is!<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<div class=\"hs-cta-embed hs-cta-embed-122984161548\" style=\"max-width:650px; margin: 0 auto; data-hubspot-wrapper-cta-id=\"122984161548\">\n  <link rel=\"stylesheet\" href=\"https:\/\/js.hscta.com\/embeddable_cta_placeholder_v1.css\">\n  <div class=\"hs-cta-loading-dot__container\">\n     <div class=\"hs-cta-loading-dot\"><\/div>\n     <div class=\"hs-cta-loading-dot\"><\/div>\n     <div class=\"hs-cta-loading-dot\"><\/div>\n  <\/div>\n  <div class=\"hs-cta-embed__skeleton\"><\/div>\n  <picture>\n    <source srcset=\"data:image\/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==\" media=\"(max-width: 480px)\" \/>\n    <img decoding=\"async\" alt=\"Get a free walkthrough\" loading=\"lazy\" src=\"https:\/\/no-cache.hubspot.com\/cta\/default\/5705808\/interactive-122984161548.png\" style=\"height: 100%; width: 100%; object-fit: fill\" onerror=\"this.style.display='none'\" \/>\n  <\/picture>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>When you improve your product, tell the world about it! One of the best ways is product announcements. Here&#8217;s your guide to release notes + examples &#038; templates!<\/p>\n","protected":false},"author":26,"featured_media":4694,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"content-type":"","_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[9,7],"tags":[33,247,74,246,249,62,248,117,245,251,250,15,10,252,253,244,243,25],"class_list":["post-4692","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-canny-best-practices","category-product-management","tag-advice","tag-best-practices","tag-changelog","tag-changelog-templates","tag-changelogs","tag-feedback-management","tag-format","tag-founder","tag-product-announcement","tag-product-announcements","tag-product-announcements-entries","tag-product-management","tag-product-manager","tag-product-update","tag-product-updates","tag-release-note","tag-release-notes","tag-saas"],"aioseo_notices":[],"modified_by":"Eric Hoppe","_links":{"self":[{"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/posts\/4692","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/users\/26"}],"replies":[{"embeddable":true,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/comments?post=4692"}],"version-history":[{"count":27,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/posts\/4692\/revisions"}],"predecessor-version":[{"id":8189,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/posts\/4692\/revisions\/8189"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/media\/4694"}],"wp:attachment":[{"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/media?parent=4692"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/categories?post=4692"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/canny.io\/blog\/wp-json\/wp\/v2\/tags?post=4692"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}