You may have heard of the Google Summer of Code<\/a> before – this is a similar program but applies specifically to documentation.\u00a0 The goal of the Google Season of Docs<\/a> is<\/p>\n To provide a framework for technical writers and Open Source projects to work together towards the common goal of improving an Open Source project’s documentation.<\/p>\n<\/blockquote>\n For technical writers who are new to Open Source, this presents an opportunity to make your first contributions and get started with supporting an Open Source project. For technical writers who might already be contributing in Open Source, the program could be a new way of working together, or an opportunity to explore new projects.\u00a0<\/p>\n The program brings together technical writers with an Open Source community for a period of a few months, bringing their writing expertise to the project’s documentation while learning about the project, community and technology behind it.<\/p>\n Together, we raise public awareness of Open Source documentation, of technical writing, and of how we can work together to the benefit of the global Open Source community.<\/p>\n The Education Team are excited to be proposing three projects for consideration by the Google Season of Docs team.\u00a0 All three projects are key to helping our users – whether developers, end-users or marketers – better understand how to work with Mautic.\u00a0 Read more about the project proposals below, and if you’re interested in learning more do join the Education Team channel on Slack<\/a>!<\/p>\n Create a Developers Portal for the Mautic Community<\/p>\n Refactor the existing Developer Documentation at https:\/\/developer.mautic.org<\/a> to provide an improved user experience and create a more user-friendly portal for developers.<\/p>\n Mautic is the world\u2019s first Open Source Marketing Automation platform. Launched in 2014, it has grown from strength to strength and has a thriving community of contributors from around the world.\u00a0 Learn more about Mautic<\/a> and Marketing Automation<\/a>. Spin up a sandbox<\/a> or check out the Github repo<\/a>.<\/p>\n The Mautic Community Developer Documentation<\/a> has typically existed in isolation from the end-user documentation and has focused largely on the REST API.\u00a0 It is currently using Slate<\/a> and can be found on Github<\/a>.\u00a0\u00a0<\/p>\n The Product Team would like to implement a more user-friendly approach by creating a developers portal which will signpost people to the relevant resources, whether they need help creating a theme, using the API, or writing their first plugin.<\/p>\n This project will refactor the Developer Documentation to implement these ideas in collaboration with the project mentor and wider Product Team.\u00a0<\/p>\n Depending on available skills and time, the project could also involve refactoring the API to facilitate OpenAPI\/Swagger based documentation and deploying a new platform for the API documentation.<\/p>\n You can read more about the proposal on the Trello card here<\/a>.<\/p>\n Dennis Ameling – Email<\/a> Slack<\/a> Forums<\/a> Github<\/a> Review and update the End-User documentation for Mautic<\/p>\n Review and update existing documentation, including updated instructions and rich media (video tutorials, screen captures etc).<\/p>\n The Mautic Community recently re-platformed the end-user documentation which can be found at https:\/\/docs.mautic.org<\/a>.<\/p>\n The documentation has been somewhat neglected over the past two years, and some resources are out of date, need revising, and could be greatly improved with more effective use of rich media.<\/p>\n The Education Team would like to conduct a thorough review of the documentation and systematically work through a programme of updating and improving the resources available.<\/p>\n When this is complete, there will also be a translation project kicked off to empower community members for whom English is not their first language to translate the documentation into other languages.<\/p>\n You can read more about the proposal on the Trello card here<\/a>.\u00a0<\/p>\n Norman Pracht – Email<\/a> Slack<\/a> Forums<\/a> Github<\/a> Create resources for the newly created Mautic Community Knowledgebase<\/p>\n Write a series of how-to tutorials and guides which will help Mautic users be more effective with setting up, configuring and using the application.<\/p>\n The Mautic Community is in the process of launching a knowledgebase which will live at https:\/\/kb.mautic.org<\/a>. The purpose of the knowledgebase is to be a central repository for tutorials, how-to guides and best practices on topics related to Mautic – whether directly (e.g. how to do things in Mautic) or indirectly (e.g. more general marketing strategies).<\/p>\n See this Trello card<\/a> for an explanation of what sits in the documentation, and what sits in the knowledgebase.<\/p>\n We have identified a number of tutorials and resources that should be included<\/a> in the knowledgebase. This project will focus on writing those tutorials and creating supporting content – e.g. videos, images etc – in collaboration with the Education Team.<\/p>\n Leon Oltmanns – Email<\/a> Slack<\/a> Forums<\/a> Github<\/a> We are excited to be proposing three projects for the Google Season of Docs project, and look forward to welcoming new contributors to help us improve our documentation resources.<\/p>\n","protected":false},"author":2,"featured_media":17285,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"publish_to_discourse":"","publish_post_category":"","wpdc_auto_publish_overridden":"","wpdc_topic_tags":"","wpdc_pin_topic":"","wpdc_pin_until":"","discourse_post_id":"","discourse_permalink":"","wpdc_publishing_response":"","wpdc_publishing_error":"","footnotes":""},"categories":[1493],"tags":[1281,939,1127,1294,1295],"class_list":["post-16644","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-community-news","tag-documentation","tag-google","tag-opensource","tag-seasonofdocs","tag-writethedocs"],"acf":[],"_links":{"self":[{"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/posts\/16644","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/comments?post=16644"}],"version-history":[{"count":1,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/posts\/16644\/revisions"}],"predecessor-version":[{"id":17108,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/posts\/16644\/revisions\/17108"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/media\/17285"}],"wp:attachment":[{"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/media?parent=16644"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/categories?post=16644"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mautic.org\/wp-json\/wp\/v2\/tags?post=16644"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
Project proposals<\/h2>\n
Developer documentation<\/h3>\n
Project name<\/h4>\n
Project description<\/h4>\n
Background<\/h4>\n
Related material<\/h4>\n
\n
Project Mentors:<\/h4>\n
\nNorman Pracht – Email<\/a> Slack<\/a> Forums<\/a> Github<\/a><\/p>\nEnd-user documentation<\/h3>\n
Project name<\/h4>\n
Project description<\/h4>\n
Background<\/h4>\n
Related material<\/h4>\n
\n
Project mentors:<\/h4>\n
\nRuth Cheesley – Email<\/a> Slack<\/a> Forums<\/a> Github<\/a><\/p>\nKnowledgebase<\/h3>\n
Project name<\/h4>\n
Project description<\/h4>\n
Background<\/h4>\n
Related material<\/h4>\n
\n
Project mentors:<\/h4>\n
\nKevin Rundle – Email<\/a> Slack<\/a> Forums<\/a> Github<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"