Season of Docs - Fostering open source collaboration with technical writers


(Suthagar Kailayapathy) #1

Hi all,

Season of Docs


Google announced a new program called “Season of Docs” - Fostering open source collaboration with technical writers.

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.

For more information: https://developers.google.com/season-of-docs/docs/

Example Project Ideas: https://developers.google.com/season-of-docs/docs/project-ideas

Timeline

  • Program announcement : March 11, 2019
  • Organization applications : April 2, 2019 at 20:00 UTC
  • Organizations announced : April 30, 2019 at 12:00 UTC
  • Technical writer applications : May 29, 2019 at 18:00 UTC
  • Technical writing projects announced : July 30, 2019 at 18:00 UTC
  • Doc development : September 2, 2019
  • Project finalization and evaluation : November 25 - 29, 2019 at 18:00 UTC

Since we participate in Google Summer of Code, and Google Code-in usually, it would be another opportunity for OpenMRS to improve the technical writing and documentation inside the community. So please be aware of the timeline, and let’s plan to apply for “Season of Docs” also :slight_smile:

Cc: @burke @dkayiwa @c.antwi @jennifer @jwnasambu @irenyak1

Thanks.


Documentation Forum 2019-03-12
Google Season of Docs (GSoD) - 2019 Documentation project Ideas.
Google Season of Docs (GSoD) - Ideas
(CLIFF GITA) #2

thanks for this @suthagar23 it will greatly contribute to improving the community documentation :+1:


(Cynthia Antwi) #3

@suthagar23 This is a wonderful opportunity which we can discuss in our Documentation Forum meeting scheduled this afternoon at 1pm UTC

How do I get involved in preparing the proposal?


(Suthagar Kailayapathy) #4

We need to assign one potential community mentor as Admin for the program, and need to prepare a proposal like GSoC. I didn’t go through it detail to get more information, so better to assign some one to take lead on this :smiley:


(CLIFF GITA) #5

@suthagar23 i will work with the lead person on this


(Jennifer Antilla) #6

@suthagar23, thanks for sharing this - it’s a great idea! It looks like it’s a little bit different from GSoC in that there will be a technical writer working with our organization admin and mentors on a project.

It looks like one of the first steps (in addition to identifying an admin) is to come up with project ideas.


(Juliet Wamalwa) #7

It was consented in today’s call we meet tomorrow at 10am EAT to come up with a proposal to be submitted to google. All interested members are welcome.


(Jennifer Antilla) #8

I’d like to go back to this before too much more time passes. Back in December, @jwnasambu volunteered to lead our efforts to update our documentation. Based on that, it seems to make sense that @jwnasambu would play a key role, such as admin (if you are willing!), with Season of Docs.

Even though this is a little different in some respects to GSoC and GCI, it might be helpful to have someone who is familiar with those ropes be “on call” if any questions come up around anything related to the Google side of things.

What do others think?


(Irene Nyakate) #9

Hello @jennifer I was also thinking that @jwnasambu could be a good pick for this as an admin that is if she is not applying as a tech writer. It’s like from their guidelines , one person takes up one role, no overlapping.

That said, Sorry I missed the meeting I learnt of it late. What transpired, is there a way forward?

We need to brainstorm on the project ideas because we have slightly over a month to the deadline.