Wiki Spaces
Documentation
Projects
Resources
Get Help from Others
Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack
OpenMRS is excited to be a mentoring organization for Google Season of Docs™ 2020!
Since 2007, we've enjoyed participating Google programs like Google Summer of Code and Google Code In. When Google introduced Google Season of Docs in 2019, we were excited to participate and became the only organization to work with three technical writers. This year, we're extremely excited about the projects and mentorship opportunities available. Documentation is critical for open-source projects like OpenMRS. Google Season of Docs is a great way to get to know our documentation, our code and improve your writing skills. At the same time, your contribution will help benefit people in developing countries who are on the front lines of the battle against HIV/AIDS, TB, Malaria, COVID-19 and other public health challenges. For a more detailed history of who we are and what we do, please see here.
This page is arranged as follows... |
---|
See here for more info on the full GSoD 2020 program timeline.
PASSED March 23, 2020 Season of Docs program announced
PASSED April 13, 2020 at 20:00 UTC Mentoring organizations can begin submitting applications to Google
PASSED May 4, 2020 at 20:00 UTC Deadline for organization applications
PASSED May 4 -May 10, 2020 Google program administrators review organization applications
PASSED May 11, 2020 at 12:00 Google publishes the list of accepted mentoring organizations
PASSED May 11 - June 8, 2020 Interested technical writers discuss project ideas with mentoring organizations
PASSED June 9, 2020 at 18:00 UTC Start of technical writer application period and
PASSED July 9, 2020 at 18:00 UTC Deadline for technical writer applications
PASSED July 9, 2020 - July 31, 2020 Proposal review period for organizations
PASSED July 31, 2020 at 20:00 UTC Deadline for project selections by organizations
PASSED July 31, 2020 - August 16, 2020 Proposal review period for Google
PASSED August 16, 2020 at 22:00 UTC Google announces the accepted technical writer projects
PASSED August 17 - September 13, 2020 Technical writers get to know mentors, get up to speed with the open source organization, and refine their projects in collaboration with mentors
PASSED September 14, 2020 Doc development officially begins
ONGOING September 14, 2020 - November 30, 2020 Technical writers work on their project with guidance from mentors
AWAITING November 30 - December 5, 2020 at 18:00 UTC Technical writers submit their final work products also known as final work products
AWAITING December 3 - 10, 2020 at 18:00 UTC Mentors submit their evaluations of the success of the projects and their experience working with the technical writers
AWAITING January 6, 2021 Google announces the results of Season of Docs 2020 for standard-length projects
AWAITING March 1 – 8, 2021 at 18:00 UTC Technical writers in long running projects, submit their project reports also known as final work products
AWAITING March 1 - 8, 2021 at 18:00 UTC Technical writers in long running projects submit their evaluations of the success and their experience working with mentors
AWAITING March 4 - 12, 2021 at 18:00 UTC Mentors in long-running projects submit their evaluations of the success of the projects and their experience working with technical writers
AWAITING March 15, 2021 Google adds the long-running projects to the results of Season of Docs 2020
AWAITING March 23, 2021 Season of Docs program announced
Project Name | Mentors | Wiki Page |
---|---|---|
Extend Existing Documentation for REST API with more Resources and Examples. | ||
Developing User Friendly Github Documentation for FHIR API | Developing User Friendly Documentation for FHIR API | |
Developing a Suite of Volunteer Guides | Developing a Suite of Volunteer Guides | |
Improving Documentation for new developers | Improving Documentation for new developers |
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.
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.
Technical writers must be:
After being accepted
The Google program administrators manage the program as a whole. This includes announcing when the program moves from one stage to another, providing the participant stipends via Payoneer, and announcing the program results.
Your responsibilities include the following:
Signup for An OpenMRS ID , if you don’t have one (It’s what you will use to communicate)
If you are new to OpenMRS, spend some time to understand OpenMRS community / Software / practices and its usages around the world , best place to start is our Wiki
Read Through the OpenMRS GSOD Page wiki page and more so Technical Writer’s Guide
If you have any question/s please use our official communication channels namely OpenMRS Talk, Telegram and IRC Channels
Be active on OpenMRS talk forum ,by discussing project ideas with The OpenMRS Community. Ask as many questions as possible, or share articles to do with your Project Ideas
Read through Hints on the Application / Acceptance Criteria
These are the responsibilities of the mentors within the open source organizations.
These are your responsibilities towards the technical writer that you're mentoring:
These are the responsibilities of the administrators within OpenMRS.
Important Links