{"id":791,"date":"2019-04-25T19:43:03","date_gmt":"2019-04-25T19:43:03","guid":{"rendered":"http:\/\/www.smart-bricks.net\/?p=791"},"modified":"2019-04-28T22:23:11","modified_gmt":"2019-04-28T22:23:11","slug":"google-launches-season-of-docs-program-to-improve-open-source-documentation","status":"publish","type":"post","link":"http:\/\/www.smart-bricks.net\/index.php\/2019\/04\/25\/google-launches-season-of-docs-program-to-improve-open-source-documentation\/","title":{"rendered":"Google Launches “Season of Docs” Program to Improve Open Source Documentation"},"content":{"rendered":"\n

Google has launched Season of Docs<\/a>,\n a program which aims to improve documentation for open source projects.\n It will do this by building a mentoring relationship between open \nsource contributors and technical writers, helping to create stronger \nand more comprehensive documentation for various open source \ntechnologies.<\/p>\n\n\n\n

The motivation for Season of Docs comes from the Open Source Survey<\/a>,\n which demonstrated that good documentation is lacking for many open \nsource projects. Google believes that this is because the creation of \ndocumentation is hard, and so in turn have created this program to \nimprove it.<\/p>\n\n\n\n

Potential participants for the program will fall into one of two \ncategories, either a mentor organization, or technical writer, both of \nwhich will work together to produce documentation. Google explains:<\/p>\n\n\n\n

During Season of Docs, technical writers will spend a few months \nworking closely with open source communities. Each writer works with \ntheir chosen open source project. The writers bring their expertise to \nthe projects\u2019 documentation while at the same time learning about open \nsource and new technologies.<\/p><\/blockquote>\n\n\n\n

Initially, technical writers will undertake an exploration phase \nduring which they can find projects that they may be interested in. \nAfter doing so they can discuss their ideas with the corresponding \norganizations. Following this, there is an application phase, which if \nsuccessful, will mean the writer can start to work on the documentation \nwhilst working closely with their mentor.<\/p>\n\n\n\n

Just like with technical writers, mentoring organizations will also \ngo through an application phase. During this, they will also be required\n to find their mentors, who will work closely with technical writers. If\n the organization’s application is accepted, they will be then \nresponsible for selecting technical writing projects from the pool of \ntechnical writer applicants.<\/p>\n\n\n\n

In terms of work done, the project may involve creating entirely new \ndocumentation, improving on what\u2019s already there, or better documenting \nthe open source contribution process:<\/p>\n\n\n\n

Together, we raise public awareness of open source docs, of technical\n writing, and of how we can work together to the benefit of the global \nopen source community.<\/p><\/blockquote>\n\n\n\n

In order for a mentoring organization to be eligible, they must be \nactively running an open source project, whereas a technical writer must\n only be able to demonstrate prior technical writing experience. \nTechnical writers will also receive a stipend for work done, calculated \nbased on the location.<\/p>\n\n\n\n

Google has set out a timeline<\/a>\n for the program, with mentoring organization submissions starting in \nApril, and technical writer submissions starting in May. More \ninformation can be found on the website<\/a>, including steps on how to get involved in the project yourself and frequently asked questions.<\/p>\n","protected":false},"excerpt":{"rendered":"

Google has launched Season of Docs, a program which aims to improve documentation for open source projects. It will do this by building a mentoring relationship between open source contributors and technical writers, helping to create stronger and more comprehensive documentation for various open source technologies. The motivation for Season of Docs comes from the… Read More »Google Launches “Season of Docs” Program to Improve Open Source Documentation<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[26],"_links":{"self":[{"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/posts\/791"}],"collection":[{"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/comments?post=791"}],"version-history":[{"count":1,"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/posts\/791\/revisions"}],"predecessor-version":[{"id":792,"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/posts\/791\/revisions\/792"}],"wp:attachment":[{"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/media?parent=791"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/categories?post=791"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.smart-bricks.net\/index.php\/wp-json\/wp\/v2\/tags?post=791"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}