{"id":173,"date":"2020-03-15T11:10:30","date_gmt":"2020-03-15T15:10:30","guid":{"rendered":"https:\/\/robsteiner.net\/pro\/?p=173"},"modified":"2020-03-15T11:10:30","modified_gmt":"2020-03-15T15:10:30","slug":"what-are-software-release-notes","status":"publish","type":"post","link":"https:\/\/robsteiner.net\/pro\/2020\/03\/15\/what-are-software-release-notes\/","title":{"rendered":"What are software release notes?"},"content":{"rendered":"\n<p>Release notes tell customers what changed between, say, App 1.0 and App 2.0. At minimum, software release notes should have the following:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>A list of new features and the value they add to the app.<\/li><li>Known issues (bugs) and workarounds. <\/li><li>If for App 2.0, give a status on the known issues listed in App 1.0&#8217;s release notes. Were they fixed or do they still exist? If they still exist, are there any new workarounds?<\/li><\/ul>\n\n\n\n<p>Release notes should <strong><em>not<\/em><\/strong> include future features or promises that a bug will be fixed in the next release. How can a customer use a future feature, and what if the bug doesn&#8217;t get fixed in the next release?<\/p>\n\n\n\n<p>Think of release notes like the ingredients list on a box of Cheerios: you won&#8217;t find ingredients they plan to add next year.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Release notes tell customers what changed between, say, App 1.0 and App 2.0. At minimum, software release notes should have the following: A list of new features and the value they add to the app. Known issues (bugs) and workarounds. If for App 2.0, give a status on the known issues listed in App 1.0&#8217;s &hellip; <a href=\"https:\/\/robsteiner.net\/pro\/2020\/03\/15\/what-are-software-release-notes\/\" class=\"more-link\">Continue reading <span class=\"screen-reader-text\">What are software release notes?<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6,4],"tags":[],"class_list":["post-173","post","type-post","status-publish","format-standard","hentry","category-release-notes","category-technical-writer","without-featured-image"],"_links":{"self":[{"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/posts\/173","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/comments?post=173"}],"version-history":[{"count":2,"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/posts\/173\/revisions"}],"predecessor-version":[{"id":178,"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/posts\/173\/revisions\/178"}],"wp:attachment":[{"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/media?parent=173"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/categories?post=173"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/robsteiner.net\/pro\/wp-json\/wp\/v2\/tags?post=173"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}