And last, people should be able to read your company’s tone out of the release notes.Ī good release note has a bold header that doesn’t only say „update no 10,” a simple but explanatory body that sounds humanlike, and a simple description of the necessary confirmation.Ĭreating a release note release in Jira is not a tough process, though it includes some detail. Third, they should be grouped logically and not randomly. Second, the release notes should be short. What are the 5 major points which must be part of release notes template?įirst, you should have a simple language that is easy to understand. I hope I could have been a help for you to get a better understanding of the best practices for creating software releases and how to announce them. Writing and designing release notes is one of those things that seem unnecessary, but have actually a huge impact.Īlso, preparing them might feel like a burden, they’re actually pretty simple. But I can show you a good example:Īlso, though it’s not the most comprehensive and doesn’t have a search button, Microsoft managed to offer some sort of categorization to make it easier to find what you need. There’s nothing much I can add to this header. Release Notes can be sent to users via an email address or a group of addresses. And yes, social media is a valid place to make such announcements. Yes, people do open the release emails, as long as they are engaging. Let the users or clients know about all the necessary steps to take. Something was different in the previous versions, but now that there could have been changes made to the Reclaim Policy or the Security Policy, people might have to confirm some configurations. But don’t forget to make sure that people read from a person’s perspective, not a robotic script. State the previous problems about functions and how you solved it – aka, set expectations. What has changed? Only bug fixes, or did you completely change the functions? Trust me, people search for this kind of information and they care. Don’t just go and write ”App Update Notes – Version 2.14” or ”Performance Improvements,” instead, try „In memory of our old version…” ( just an idea) You are very welcome to be a bit more fun and creative in your headers. Let’s make a list of all the necessary elements of a good release note template: A collaborative method is frequently used as part of the product launch process. To ensure that they are written on time, product managers may need a push from the support or marketing teams.Ī technical writer or any other member of the product, development, or test team can create product release notes. The release notes are the result of a collaborative effort.īefore marketing and support can create them, they may need a hand-off or a demo of the update. PS: I will give more examples below, right after I clarify two more important things: Who should prepare release notes? I personally get pretty excited when I get the „ClikcUpdates” email from ClickUp. But that’s not because they’re not important, it’s because they are horribly written. I hear you saying „Aye, no one ever reads the product release notes,” and you are right. □ People want to know if the crashes have been handled or the bug fixes have been handled. □ It acts as a knowledge base of what has changed since the previous release, what is up-to-date in the current release, and what is to come in the future releases. But let me tell you, I am going to show you a few companies that really care about the structure of the text and the design. I don’t know many people who consider the future release notes as a priority. If all your customers are not besties with the Customer Success Manager, or they don’t go to the same bingo club with the Account Manager, they probably won’t know what has been updated on your product or what is going to change in the upcoming version.
0 Comments
Leave a Reply. |