Season of Docs/2019

Google Season of Docs is a program to foster collaboration between open source projects and technical writers. The main part of the 2019 Season of Docs will run for three months, from September to November 2019, but the application period for technical writers ends on 30 June 2019.

'Please make sure to read through the information and application materials on the GSoD'19 website and this page before'' sending questions or completing a proposal for a project. Most of the questions you have will be answered in one of these two places.'''

You can interact with the admins and other technical writers who are proposing projects on our Zulip GSoD'19 stream.

2019 Timeline

 * April 2 – April 23: organizational application period
 * April 23 – April 29: Google reviews and approves organizations
 * [Current] April 30 – July 30: Technical writer exploration and application
 * July 30: Technical writing projects announced
 * August 1 – September 1: Community bonding
 * September 2 – December 6: Docs development through project finalization
 * December 10: Results announced

Potential technical writing projects for 2019 season
https://developers.google.com/season-of-docs/docs/project-ideas

Technical Documentation


 * Find examples and create templates for genres of technical writing on Wikimedia projects (Ex. How-tos, Walk-throughs, User-Guides, etc). Use your templates to revise and improve existing documentation and to stand as an example for others in the future. (Document on this page: https://www.mediawiki.org/wiki/Techincal_documention_templates_and_suggestions)
 * Identify a Wikimedia technical project in need of technical documentation or improvement to technical documentation. Create a proposal that outlines how you would improve this area of technical documentation content.

Evaluate and recommend


 * Help others understand how to suggest improvements to technical documentation and how to contribute to improving technical documentation.
 * Evaluate, iterate, and test this draft process proposal: https://www.mediawiki.org/wiki/Technical_documentation_prioritization
 * Document your experience on-boarding as a technical writer on Wikimedia projects. What did you need to know? What tools did you need? How and where are things documented? How do you work with others and test your documentation and processes?
 * Research and propose a content strategy for a technical documentation content collection for a Wikimedia project.
 * Suggest a technical documentation project that covers evaluating current knowledge assets and content collections. Provide suggestions for improvements.

Audience research and user experience


 * Research audiences that uses Mediawiki / Wikitech technical documentation. Who is using the technical documentation? How and why do they use it? Create a set of personas for the kinds of technical collaborators who are using our research and users we will want to reach out to. Provide a set of recommendations for creating technical documentation and resources for a variety of users. The report can discuss intersections (ways to reach out to a wider audience). It can also discuss recommendations to reach out to smaller segments.

Create resources for staff and volunteers
 * Create a set of short video walkthroughs and tutorials to help onboard new technical collaborators. (Ex. How to get started with Phabricator for Wikimedia technical projects. How to XYZ)
 * Curate and promote technical documentation tasks for hackathons and other developer events. Explore outstanding technical documentation tasks in Phabricator. Create technical documentation tasks that can be completed in a short time frame at hackathons and developer events. Create onboarding/quickstart documentation that new collaborators can use guide them through the process of improving and creating technical documentation.

Creating a viable and valuable proposal
We wanted to share some recommendations and tips for you to think about when preparing your proposal.

Pre-reading
Make sure to read the guides available to you on the Season of Docs website. Pay careful attention to the section on "Creating your application" https://developers.google.com/season-of-docs/docs/tech-writer-application-hints

Is Google Season of Docs right for you?
Before creating and submitting a proposal, please consider thoughtfully whether this program is right for you. GSoD is for technical writers who would like to learn more about how to participate and contribute to open source projects and for open source projects in need of technical writers with at least some prior experience.

If you already have a lot of experience working in open source, this may not be the right program for you. You may still apply, but consider areas of open source that you still want to learn about and explore.

If you do not have any prior experience as a technical writer (as a student, volunteer or as a professional), this may not be the right program for you. We are looking for individuals with demonstrated experience contributing to and working on technical writing projects.

We welcome all proposals, and we want to be realistic with potential technical writers about the viability of those proposals. This year, we are only able to work with one technical writer. There will be some competition.

Solid technical writing is very important to the success of our open source projects, and we have a long-term commitment to make it priority. There will be many future opportunities to contribute to technical documentation projects in the future, whether through GSoD or other initiatives.

Tips

 * Browse the suggested technical writing projects and think about what might work for you. Many of these are not very detailed, yet, because we want to make sure that the project you propose fits your skill set, challenges you, and also creates a valuable contribution to our open source project.
 * Communicate with us, if you have questions or ideas. We will do our best to help guide you in the right direction. As we select candidates for our projects, we will be thinking a lot about the kinds of communications we had during the proposal projects.
 * Check, double check, and triple check your grammar and style. This is important for your proposal, you project, and in your interactions with us and community members.
 * Unless some information you wish to share with us is truly private, we prefer to work out in the open. Please make sure your questions are asked publicly in the |GSoD'19 Zulip chat, so that project admins and participants can have the opportunity to answer and benefit from your questions and thoughts.

Contact Methods
Please feel free to reach out to us with questions. We like to work in the open and together with our community. Following are the best methods to reach us with questions and for official announcements.


 * 1) Zulip - https://wikimedia.zulipchat.com/#narrow/stream/195601-gsod19 (PLEASE NOTE: Zulip is the best way to contact Wikimedia's Google Season of code admins.)
 * 2) Google Group - technical-documentation@wikimedia.org

Organizational application
Additional information used as part of our application process with Google: https://www.mediawiki.org/wiki/Season_of_Docs_(2019)/admins/organizational_application