Redocly - Google Season of Docs

Summary

When Google announced the Season of Docs 2021, I led Redocly’s effort on submitting a proposal for our open source projects, Redoc and OpenAPI cli. The proposal was accepted by Google, and we hired two technical writers to work on our products.

I managed the administrative part of the project on behalf of Redocly, and also assisted and mentored technical writers contributing to our open source documentation.

Our project had a successful outcome which I captured in our case study.

Project scope

  • Work as a communication liaison between Google and Redocly on all matters related to Season of Docs 2021 program.
  • Work with technical writers and the open source community around promotion, setting expectations and deliverables for the program.
  • Mentor technical writers working on Redocly open-source projects (Redoc and OpenAPI cli).

Key learnings and deliverables

I have previously been a participant in the Google Season of Docs 2019, but this was an opportunity to mentor other technical writers working on open source documetnation.

The project was successfully completed in November 2021.

Over the last 5 months, I learnt:

  • The project management side of open source documentation.
  • Hiring, training and mentoring technical writers for the projects.
  • Keeping open source documentation efforts sustainable over long term.

Project link: https://redoc.ly/gsod-casestudy/

Nifty tech tag lists from Wouter Beeftink