discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

OpenSCAD and Google Season of Docs

TP
Torsten Paul
Sun, Apr 21, 2019 1:04 PM

We just applied to the new Google Season of Docs project
that was launched first time this year.

It's about connecting tech writers with open source projects
where Google provides a stipend for the tech writers to work
on documentation of selected open source projects.

For details see below, and if you know someone who might
be interested joining this effort, please spread the word.
Even if we end up not getting selected, it's a great to
see support for improving documentation of open source
projects.

Our landing page with the project ideas is:

https://www.openscad.org/gsod-2019.html

ciao,
Torsten.

About Google Season of Docs
https://developers.google.com/season-of-docs/docs/

The goal of Season of Docs is to provide a framework for
technical writers and open source projects to work together
towards the common goal of improving an open source project's
documentation. For technical writers who are new to open source,
the program provides an opportunity to gain experience in
contributing to open source projects. For technical writers
who're already working in open source, the program provides a
potentially new way of working together. Season of Docs also
gives open source projects an opportunity to engage more of 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 the open source project 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.

We just applied to the new Google Season of Docs project that was launched first time this year. It's about connecting tech writers with open source projects where Google provides a stipend for the tech writers to work on documentation of selected open source projects. For details see below, and if you know someone who might be interested joining this effort, please spread the word. Even if we end up not getting selected, it's a great to see support for improving documentation of open source projects. Our landing page with the project ideas is: https://www.openscad.org/gsod-2019.html ciao, Torsten. About Google Season of Docs https://developers.google.com/season-of-docs/docs/ The goal of Season of Docs is to provide a framework for technical writers and open source projects to work together towards the common goal of improving an open source project's documentation. For technical writers who are new to open source, the program provides an opportunity to gain experience in contributing to open source projects. For technical writers who're already working in open source, the program provides a potentially new way of working together. Season of Docs also gives open source projects an opportunity to engage more of 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 the open source project 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.
TP
Torsten Paul
Thu, May 2, 2019 2:56 PM

So here's a quick update...

OpenSCAD has been accepted to take part in this very first
instance of Google Season of Docs.

This is a great opportunity for extending/improving the
available documentation or covering new topics (like a
dedicated tutorial). But for this to be happening later
this year, we need to get the word out to people who might
be interested to work on one of the documentation projects.

Next steps in the timeline are:

    now: Discussion about projects already open

2019-05-29: Start of application period for tech writers
2019-06-28: Application deadline

OpenSCAD GSoD page:
https://www.openscad.org/gsod-2019.html

GSoD home:
https://developers.google.com/season-of-docs/

ciao,
Torsten.

So here's a quick update... OpenSCAD has been accepted to take part in this very first instance of Google Season of Docs. This is a great opportunity for extending/improving the available documentation or covering new topics (like a dedicated tutorial). But for this to be happening later this year, we need to get the word out to people who might be interested to work on one of the documentation projects. Next steps in the timeline are: now: Discussion about projects already open 2019-05-29: Start of application period for tech writers 2019-06-28: Application deadline OpenSCAD GSoD page: https://www.openscad.org/gsod-2019.html GSoD home: https://developers.google.com/season-of-docs/ ciao, Torsten.