A release note refers to the technical documentation produced and distributed alongside the launch of a new software product or a product update (e.g., recent changes, feature enhancements, or bug fixes). It very briefly describes a new product or succinctly details specific changes included in a product update.<\/p>\n
The job of drafting these frequently falls on product managers. The primary target audience is the product user, but a release note can also be used internally.<\/p>\n
While a release note provides relevant information about a new product or product update, it\u2019s not a substitute for a user guide or other in-depth product documentation.<\/p>\n
For many companies, release notes are an undervalued, perfunctory activity performed during a product launch or update.<\/p>\n
\u201cRelease notes have become the product-update equivalent of Terms & Conditions and Privacy Policy statements. They\u2019re written so poorly, with such little regard for the actual human being who must read them, that we\u2019ve all learned to just ignore them.\u201d<\/em><\/p>\n (Read How to Write Release Notes Your Users Will Read<\/a> on the ProductPlan Blog.)<\/p>\n In truth, however, release notes can play a vital role in the overall product experience<\/a> because they provide a valuable opportunity to communicate with customers and your broader market. When done well, they have the potential to nurture engagement and increase customer loyalty.<\/p>\n While there\u2019s no standard format for release notes, they should adhere to your own company standards. Release notes for a brand-new product might be slightly more descriptive than for bug fixes and feature enhancements. As with any other product-related documentation, consistency is key.<\/p>\n In general, they contain a variation of the following:<\/p>\n A brief overview of the product, feature update, or bug fix.<\/p>\n What\u2019s new in the release.<\/p>\n Short description of the bug or enhancement.<\/p>\n Steps followed when the bug was discovered.<\/p>\n Brief description of modifications made to fix the bug.<\/p>\n List of specific actions needed by users or functionality impacted by the changes.<\/p>\n List of specific changes required to administer the software.<\/p>\n Notes about software or hardware installation, upgrades, product documentation, etc.<\/p>\n Company and product disclaimers.<\/p>\n Contact information for support requests.<\/p>\n Keep these best practices in mind:<\/p>\n 1. Use Plain Language: <\/strong>Eliminate technical jargon and overly complex language.<\/p>\n 3. Be Customer-Centric: <\/strong>Make it obvious and easy for users to zero in on what\u2019s of interest to them (e.g., fixes, improvements, new features).<\/p>\n 4. Include Relevant Links: <\/strong>Keep release notes to high-level information, but include links to more detailed information (e.g., user guide, video tutorial, etc.).<\/p>\n 5. Let Your Brand and Personality Shine: <\/strong>Seize the opportunity to create a meaningful interaction with your user base.<\/p>\n Related terms: User Experience<\/a> \/\u00a0Product Ops<\/a> \/\u00a0Release Plan<\/a> \/\u00a0UX Designer<\/a> \/\u00a0Customer Empathy<\/a> \/\u00a0Product Manager<\/a><\/strong><\/em><\/p>\nWhat Should Be Included in Release Notes?<\/h2>\n
Header<\/h4>\n
\n
Overview<\/h4>\n
Purpose<\/h4>\n
Issue Summary<\/h4>\n
Steps to Reproduce<\/h4>\n
Resolution<\/h4>\n
End-User Impact<\/h4>\n
Support Impacts<\/h4>\n
Notes<\/h4>\n
Disclaimers<\/h4>\n
Contact<\/h4>\n
How to Craft Engaging Release Notes<\/h2>\n
2. Keep It Short: <\/strong>Use descriptions that are concise and quickly digestible.<\/h4>\n