{"id":1700,"date":"2011-05-17T06:40:56","date_gmt":"2011-05-17T13:40:56","guid":{"rendered":"http:\/\/blog.mozilla.org\/sumo\/?p=1700"},"modified":"2011-05-17T06:40:56","modified_gmt":"2011-05-17T13:40:56","slug":"documentation-process","status":"publish","type":"post","link":"https:\/\/blog.mozilla.org\/sumo\/2011\/05\/17\/documentation-process\/","title":{"rendered":"Documentation Process"},"content":{"rendered":"<p><video width=\"420\" height=\"236\" controls preload=\"none\" poster=\"http:\/\/a.images.blip.tv\/MichaelVerdi-DocumentationProcess327.jpg\"><source src=\"http:\/\/blip.tv\/file\/get\/MichaelVerdi-DocumentationProcess763.m4v\" type=\"video\/mp4\"><source src=\"http:\/\/blip.tv\/file\/get\/MichaelVerdi-DocumentationProcess205.webm\" type=\"video\/webm\"><source src=\"http:\/\/blip.tv\/file\/get\/MichaelVerdi-DocumentationProcess384.ogv\" type=\"video\/ogg\"><embed src=\"http:\/\/a.blip.tv\/api.swf#hrl1grvPLQA\" type=\"application\/x-shockwave-flash\" width=\"420\" height=\"267\" allowscriptaccess=\"always\" allowfullscreen=\"true\"><\/embed><\/video><\/p>\n<p>HOLY COW! This is a long (12 minutes) explanation of the new SUMO documentation process. Here&#8217;s the short version:<\/p>\n<p>Six week schedule. The first four weeks, we&#8217;ll be drafting articles based on the Aurora release and localizing articles for the Beta release. During the last two weeks Aurora becomes Beta, Beta becomes the new release and we&#8217;ll finalize the docs we drafted in the first four weeks. Rinse and repeat. We&#8217;ll use the <b><a href=\"\/Support\/Article_Tracking\" title=\"Support\/Article Tracking\">Article Tracking<\/a><\/b> page to organize everything.<\/p>\n<h2>Long version<\/h2>\n<h3>Example schedule: Weeks 1 &#8211; 4<\/h3>\n<p><b>Release = Fx 6, Beta = Fx 7, Aurora = Fx 8, Nightly = Fx 9<\/b><\/p>\n<ul>\n<li><b>Localize Fx 7<\/b>: Once the articles are finalized, there will be four weeks to localize before release. We&#8217;ll have marked revisions as ready for localization so they&#8217;ll show up on Localization dashboards. Also, Localizers can keep abreast of what changes are happening by following the <a href=\"\/Support\/Article_Tracking\" title=\"Support\/Article Tracking\">Article Tracking<\/a> page.\n<ul>\n<li><b>Note<\/b>: In the two weeks previous to this we may have also made updates based on feedback from the Fx 6 release that will also be included in this batch of articles to localize.\n<\/li>\n<\/ul>\n<\/li>\n<li><b>Draft Fx 8<\/b>: We&#8217;ll have four weeks to draft new articles and updates to existing articles. We&#8217;ll be working from the <a href=\"\/Support\/Article_Tracking\" title=\"Support\/Article Tracking\">Article Tracking<\/a> page which we&#8217;ll have been updating since the previous documentation cycle.<\/li>\n<li><b>Track Fx 9<\/b>: This release will be on the Nightly channel. We&#8217;ll follow the <a href=\"\/Features\/Release_Tracking\" title=\"Features\/Release Tracking\">Release Tracking<\/a> page to identify which changes and additions will need documentation. Articles that will need to be updated or proposals for new articles should be added to the <a href=\"\/Support\/Article_Tracking\" title=\"Support\/Article Tracking\">Article Tracking<\/a> page along with links to the appropriate feature page and general notes about what will need to be documented. The details of this should be discussed in the Article&#8217;s forum thread also linked from this page. The tracking of Firefox 9 features is an ongoing process that will continue through it&#8217;s Beta phase but after it moves to Aurora the main changes should only be the possible removal of a feature.<\/li>\n<li><b>Archive<\/b>: Since Firefox and our documentation will be changing as new versions are released, we&#8217;ll use this time to evaluate whether there are any articles that are:\n<ul>\n<li>Obsolete because Firefox has changed\n<\/li>\n<li>Obsolete because they get so few views as to not be of concern to the vast majority of Firefox users.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3>Example schedule: Weeks 5 &amp; 6<\/h3>\n<p><b>Release = Fx 7, Beta = Fx 8, Aurora = Fx 9, Nightly = Fx 10<\/b><\/p>\n<ul>\n<li><b>Update Fx 7<\/b>: Firefox 7 will have been released so, if necessary, we&#8217;ll be able to go back and make adjustments to our documentation based on feedback from the support forums and live chat. <\/li>\n<li><b>Finalize Fx 8<\/b>: Once the release moves to the Beta channel, we&#8217;ll have two weeks to finalize these articles that were drafted. During this time we&#8217;ll:\n<ul>\n<li>Add screenshots and screencasts if necessary\n<\/li>\n<li>Review and approve the articles\n<\/li>\n<li>Mark the final Fx8 revision as Ready for Localization<\/li>\n<\/ul>\n<\/li>\n<li><b>Begin Tracking Fx 10<\/b>: This release will now be on the Nightly channel.\n<\/li>\n<\/ul>\n<p>More details, including information about the Article Archive and Ready for Localization features are on the <a href=\"https:\/\/wiki.mozilla.org\/Support\/Goals\/2011Q2\/KB_Doc_Policies\">Mozilla wiki<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>HOLY COW! This is a long (12 minutes) explanation of the new SUMO documentation process. Here&#8217;s the short version: Six week schedule. The first four weeks, we&#8217;ll be drafting articles &hellip; <a class=\"go\" href=\"https:\/\/blog.mozilla.org\/sumo\/2011\/05\/17\/documentation-process\/\">Read more<\/a><\/p>\n","protected":false},"author":186,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[898,220],"tags":[],"_links":{"self":[{"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/posts\/1700"}],"collection":[{"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/users\/186"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/comments?post=1700"}],"version-history":[{"count":0,"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/posts\/1700\/revisions"}],"wp:attachment":[{"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/media?parent=1700"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/categories?post=1700"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.mozilla.org\/sumo\/wp-json\/wp\/v2\/tags?post=1700"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}