{"id":550,"date":"2007-05-30T06:48:31","date_gmt":"2007-05-30T14:48:31","guid":{"rendered":"http:\/\/www.vtiger.com\/blogs\/2007\/05\/30\/v503-my-experience-with-writing-release-notes\/"},"modified":"2007-05-30T06:48:31","modified_gmt":"2007-05-30T14:48:31","slug":"v503-my-experience-with-writing-release-notes","status":"publish","type":"post","link":"https:\/\/two.vtiger.com\/blog\/archives\/v503-my-experience-with-writing-release-notes\/","title":{"rendered":"v5.0.3: My Experience with Writing Release Notes"},"content":{"rendered":"<p>Currently I am preparing final draft for the vtiger CRM 5.0.3 release notes. This time I am trying to make it more lucid and end-user friendly, so that our community will get a better visibility on our product and take a quick decision on vtiger.<\/p>\n<p>I would like to share some of my personal experiences during this exercise.<\/p>\n<p><strong>Boilerplate for standard content:<\/strong><\/p>\n<ul>\n<li>I have a boilerplate for writing release notes. Place holders for there for filling the data.<\/li>\n<li>Once data starts coming in, I update the respective section. It is easy to fill introduction, downloads, upgrade instructions, since there will not be much changes from release to release.<\/li>\n<\/ul>\n<p><strong>Filling the Fixed Issues\/Known Issues sections:<br \/>\n<\/strong><\/p>\n<ul>\n<li>When we have releases often, it is easy to update the latest 10 to 20 issues in a short duration.<\/li>\n<li>If the release happens after a long duration, (in v5.0.3 we have crossed 1000 mark and last release happened almost 7 months back), it is very hard to segregate issues into small chunks.<\/li>\n<li>Segregation of issues in to small chunks requires a lot of time than expected.<\/li>\n<li>Identifying issues that have much impact on users, testing those issues in the latest build, etc.. This process is one of the major tasks in preparation of the release notes.<\/li>\n<li>Once it is clear, start real-time testing in the latest build. If there are any confusion don&#8217;t hesitate to contact concerned tester\/developer.<\/li>\n<li>Keeping end-user perspective is another important area. Particularly, when releasing end-user products, it is very essential to keep the message short and lucid, since end-users will have limited time to take a decision on using the product.<\/li>\n<li>Any wrong information published will have much impact on team reputation. Hence very careful, while presenting the information.<\/li>\n<\/ul>\n<p><strong>Learning:<\/strong><\/p>\n<ul>\n<li>It is always better to start release notes from DAY ONE of the active development than giving it an after thought. I am not sure how many\u00a0 writers follow this rule.<\/li>\n<li>Have a continuous coordination between testers &amp; developers to understand the nature of the issue and impact on end-user experience. Otherwise, release notes will send wrong signals to your target audience.<\/li>\n<\/ul>\n<p>Finally, we will have a printer friendly (PDF) release notes for v5.0.3, which will be published during release. All our past release notes are archived at: [link removed]<\/p>\n<p>\nCheers,<br \/>\nGopal<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Currently I am preparing final draft for the vtiger CRM 5.0.3 release notes. This time I am trying to make it more lucid and end-user friendly, so that our community will get a better visibility on our product and take a quick decision on vtiger. I would like to share some of my personal experiences&hellip;&nbsp;<a href=\"https:\/\/two.vtiger.com\/blog\/archives\/v503-my-experience-with-writing-release-notes\/\" class=\"\" rel=\"bookmark\">.<span class=\"screen-reader-text\">v5.0.3: My Experience with Writing Release Notes<\/span><\/a><\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_eb_attr":"","neve_meta_sidebar":"","neve_meta_container":"","neve_meta_enable_content_width":"","neve_meta_content_width":0,"neve_meta_title_alignment":"","neve_meta_author_avatar":"","neve_post_elements_order":"","neve_meta_disable_header":"","neve_meta_disable_footer":"","neve_meta_disable_title":"","neve_meta_reading_time":"","_themeisle_gutenberg_block_has_review":false,"_ti_tpc_template_sync":false,"_ti_tpc_template_id":"","footnotes":""},"categories":[3],"tags":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v21.4 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>v5.0.3: My Experience with Writing Release Notes - Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"v5.0.3: My Experience with Writing Release Notes - Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates\" \/>\n<meta property=\"og:description\" content=\"Currently I am preparing final draft for the vtiger CRM 5.0.3 release notes. This time I am trying to make it more lucid and end-user friendly, so that our community will get a better visibility on our product and take a quick decision on vtiger. I would like to share some of my personal experiences&hellip;&nbsp;.v5.0.3: My Experience with Writing Release Notes\" \/>\n<meta property=\"og:url\" content=\"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/\" \/>\n<meta property=\"og:site_name\" content=\"Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates\" \/>\n<meta property=\"og:image\" content=\"https:\/\/two.vtiger.com\/blog\/wp-content\/uploads\/2023\/02\/vtiger-logo-only.png\" \/>\n\t<meta property=\"og:image:width\" content=\"490\" \/>\n\t<meta property=\"og:image:height\" content=\"399\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Gopal\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"v5.0.3: My Experience with Writing Release Notes - Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/","og_locale":"en_US","og_type":"article","og_title":"v5.0.3: My Experience with Writing Release Notes - Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates","og_description":"Currently I am preparing final draft for the vtiger CRM 5.0.3 release notes. This time I am trying to make it more lucid and end-user friendly, so that our community will get a better visibility on our product and take a quick decision on vtiger. I would like to share some of my personal experiences&hellip;&nbsp;.v5.0.3: My Experience with Writing Release Notes","og_url":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/","og_site_name":"Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates","og_image":[{"width":490,"height":399,"url":"https:\/\/two.vtiger.com\/blog\/wp-content\/uploads\/2023\/02\/vtiger-logo-only.png","type":"image\/png"}],"author":"Gopal","twitter_card":"summary_large_image","schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/#article","isPartOf":{"@id":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/"},"author":{"name":"Gopal","@id":"https:\/\/two.vtiger.com\/blog\/#\/schema\/person\/aefdc037cf66d5d53e0107b9aad1fbe5"},"headline":"v5.0.3: My Experience with Writing Release Notes","dateModified":"2007-05-30T14:48:31+00:00","mainEntityOfPage":{"@id":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/"},"wordCount":385,"commentCount":4,"publisher":{"@id":"https:\/\/two.vtiger.com\/blog\/#organization"},"articleSection":["All"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/","url":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/","name":"v5.0.3: My Experience with Writing Release Notes - Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates","isPartOf":{"@id":"https:\/\/two.vtiger.com\/blog\/#website"},"dateModified":"2007-05-30T14:48:31+00:00","breadcrumb":{"@id":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/two.vtiger.com\/blog\/v503-my-experience-with-writing-release-notes\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/two.vtiger.com\/blog\/"},{"@type":"ListItem","position":2,"name":"v5.0.3: My Experience with Writing Release Notes"}]},{"@type":"WebSite","@id":"https:\/\/two.vtiger.com\/blog\/#website","url":"https:\/\/two.vtiger.com\/blog\/","name":"Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates","description":"","publisher":{"@id":"https:\/\/two.vtiger.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/two.vtiger.com\/blog\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/two.vtiger.com\/blog\/#organization","name":"Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates","url":"https:\/\/two.vtiger.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/two.vtiger.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/two.vtiger.com\/blog\/wp-content\/uploads\/2023\/02\/vtiger-logo-only.png","contentUrl":"https:\/\/two.vtiger.com\/blog\/wp-content\/uploads\/2023\/02\/vtiger-logo-only.png","width":490,"height":399,"caption":"Vtiger CRM Blog - Latest CRM Topics, Tips, Insights and Updates"},"image":{"@id":"https:\/\/two.vtiger.com\/blog\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/two.vtiger.com\/blog\/#\/schema\/person\/aefdc037cf66d5d53e0107b9aad1fbe5","name":"Gopal","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/two.vtiger.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/a02451622ea93c2d5efbf17ce5f24090?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/a02451622ea93c2d5efbf17ce5f24090?s=96&d=mm&r=g","caption":"Gopal"},"url":"https:\/\/two.vtiger.com\/blog\/author\/gopal\/"}]}},"_links":{"self":[{"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/posts\/550"}],"collection":[{"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/comments?post=550"}],"version-history":[{"count":0,"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/posts\/550\/revisions"}],"wp:attachment":[{"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/media?parent=550"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/categories?post=550"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/two.vtiger.com\/blog\/wp-json\/wp\/v2\/tags?post=550"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}