Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Resources

Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Introduction

Welcome to Season of Docs!

Season of Docs icon

Fostering open source collaboration with technical writers

Current phase:
Program announced. See timeline.

The goals of Season of Docs are to give technical writers an opportunity to gain experience in contributing to open source projects, and to give open source projects an opportunity to engage the technical writing community.

During the program, technical writers spend a few months working closely with an open source community. They bring their technical writing expertise to the project's documentation, and at the same time learn about open source and new technologies.

The open source projects work with the technical writers to improve the project's documentation and processes. Together they may choose to build a new documentation set, or redesign the existing docs, or improve and document the open source community's contribution procedures and onboarding experience.

Together, we raise public awareness of open source docs, of technical writing, and of how we can work together to the benefit of the global open source community.

How does it work?

Here's the high-level workflow of the Season of Docs program:

  • Open source organizations apply to be mentor organizations in this year's Season of Docs. They may submit a list of documentation project ideas with their applications.

  • Technical writers explore the list of participating organizations and choose the projects that interest them. A technical writer may contact the relevant organizations to discuss their ideas. The technical writer then writes up a project proposal and submits it to Season of Docs.

  • The organizations confirm the technical writing projects that they want to mentor.

  • The accepted technical writers spend a few months working with mentors from the open source organizations to complete their projects.

  • At the end of the program, the Google program administrators announce the projects that finished successfully.

The timeline shows the details of the steps involved and the key dates.

Participants and roles

Below are the primary groups of people who take part in Season of Docs and the role each group plays in the program:

  • Organization administrators are members of the participating open source organizations who act as the principal Season of Docs contact for their organization. The organization administrators submit the organization’s application to take part in Season of Docs, manage the mentors within their organizations, make sure the technical writing projects stay on track, handle the paperwork, and manage the distribution of the mentor stipend. See the administrator guide and responsibilities

  • Open source mentors are members of the participating open source organizations who’re accepted as mentors for this year’s Season of Docs. The mentors work closely with the technical writers to help ensure a successful project. See the mentor guide and responsibilities.

  • Technical writers are technical writers worldwide who’re accepted to take part in this year’s Season of Docs. Applicants must be able to demonstrate prior technical writing experience by submitting role descriptions and work samples. See the technical writer guide and responsibilities.

  • Google program administrators are program managers within Google who run the Season of Docs program.

Project Ideas

Project NameMentorWiki Page
Create Github Documentation for REST API

Developing Document templates for all OMRS content

Review and Refactor existing Wiki to be more User profile driven

Next steps

  • Join the announcement mailing list at season-of-docs-announce to stay informed about when applications open and other important program events.
  • Check the timeline for important dates and milestones.
  • Get started by registering as a participant, whether you're a technical writer or a member of an open source project.
  • Read the FAQ if you have any questions.
  • Contact us if you need more help or want to join the discussions.


Important Links



  • No labels