Software release notes that highlight features added from the requested list, let users know that their feedback is valuable. A software release note, at its most basic, is outlining product changes or solutions from the last release. These changes can be bug fixes, new features, optimization efforts, or something else. While these sound like a lot to include in an internal release note, care should be taken to keep the release notes brief and informative.
There is no specific release notes format that works for all — organizations, even teams within organizations, have their own product release notes formats. Having said that, there are certain aspects that are usually present in release notes of all shapes and sizes. They are:. These fields can be completed in any program — even Microsoft word. But doing the process manually can take a long time and effort.
The headings of these sections and important updates need to be highlighted, as users might skim down to the features that matter to them. Thinking of the release note or product update as a blog post might help in crafting creative yet impactful headlines — in fact, the marketing team might be able to help.
Adding screenshots can simplify the process of visualizing the changes for users. A complex or significant change can be linked to a short video tutorial too.
The idea is to include essential information, but also to have a little fun with it. Most templates cover these, but it pays to note down some best practices. Using jargon is a big no while writing good release notes. Aiming to focus on the impact on the users instead of the internal implementation tends to provide best results. Each note should be a sentence or two long for maximum impact without going into a detailed explanation.
The most common way to start is with the version number and release date, which are present in any software release note template. For example, if they receive a customer question related to a specific topic. They easily can redirect them to the page, where users can find the answer. Generalized explanation, generalized explanation and then followed by a detailed description of how a new feature works.
Step 1: Explain what the new feature is all about. You no longer have to switch to Salesforce Classic to manage territory assignments on the Account page. You can now edit the Assigned Territories related list in Lightning Experience. Previously, the related list was read-only in Lightning Experience. You no longer have to [do X action] to perform [Y action]. You can now do [Z action]. Previously you were able to do only [Q action].
Step 3: Explain how to use the feature How: If your Account page layout includes the Assigned Territories related list, no setup is required. Click Assign Territories and assign to manage assignments. If your product is not that complicated and is not a platform with a big umbrella of sub tools, check out Sketch company. The layout is interesting. At the right side, you have a detailed description of all new features and bug fixes and on the left side, there are main big features descriptions.
And CTA. You can now use Smart Distribute to control the spacing in grids. You can easily adjust the vertical spacing between rows of layers, as well as the horizontal spacing between each layer in a row. It quickly aligns a selection of multiple layers into a neat grid, making it even easier to create and manage complex layouts. Again, we see a simple template: You can now do [X action]. You can easily do [Y action]. So, coming back to user-oriented release notes, we need to understand that we are writing our release notes for our target audience.
Salesforce writes their releases for people without technical backgrounds, for sales departments and marketers, entrepreneurs, founders, etc. The sketch is used by graphic designers and artists. Thus both Salesforce and Sketch use generic tone, very user-friendly, oriented for real people.
If your product is technical and your users are developers, then the opposite is a rule of thumb. The shorter, more technical, not visually appealing is better. Make a decision where you would like to post your release note. It can be on any public platform, such as newspapers, magazines, or app. When will the note be published? The release date and time of the note should be specified clearly. Timely release notes are essential because they will help you establish trust among your customers.
What to include in a release note? Make sure you include all the necessary information related to the product in the release note. Buying software products is now an ongoing process as you can count on the fact that you'll be sent product updates, bug fixes, new features, and more after your initial purchase.
Unfortunately, many companies don't use release notes to their full advantage. This is a huge missed opportunity. Great release notes should be written intentionally and not as afterthoughts. Release notes vary considerably depending on the software, company branding, and how they're distributed, but often include the following elements:. Release notes are important for a myriad of reasons.
Below, we discuss all the benefits associated with distributing release notes with your software products. The one factor that makes release notes documentation so important is the fact that they help people use your software product to its full potential.
Make your current users aware of your last developments, give updates on most-known bugs, and turn your existing users into champions. Everyone should be able to use your software just the way it was designed.
Release notes are incredibly beneficial to the software development and launch process because they:. This opportunity is key and you should be taking full advantage of it.
0コメント