-
Notifications
You must be signed in to change notification settings - Fork 171
Season of Docs Ideas 2021
Here we collate potential Good Docs Project tasks for a senior technical writer to tackle under the banner of the Google's Season of Docs program.
We aim to create “best practice templates and writing instructions for documenting open source software”.
- In 2019 we kicked off The Good Docs Project, and release our first set of doctype templates.
- In 2020:
- We matured our project processes,
- We matured our community,
- We refine our templates, and have been extracting our learnings into a "template for templates", which we call our base template. This is to be used to help template authors write excellent templates.
- Within Season of Docs 2021, we developed an Information Architecture Guide.
- In 2021 we hope to:
- Refine our base template.
- Incorporate new templates and refine existing ones.
- Incorporate related material, such as Google's Doc Audit Checklist.
The proposed tasks we aim to address under Season of Docs are covered in our Season of Docs 2021 Proposal
For the sponsored Season of Docs 2021 writer position, we're looking to select:
- Someone who has been working as a senior technical writer, with a cross section of technical writing experience.
- Someone who gets involved, (think do-ocracy).
- Someone humble, who is quick to share credit with the team around them.
- Someone curious, who collaborates with others to research and refine ideas.
- Preferably someone with open source experience.
If you just starting in your tech writing career, and are looking for a paid spot, then I suggest looking at one of the other Season of Docs projects rather than this one.
We want to build our depth of senior tech writer experience. Most of us contribute in our spare time. If the possibility of great docs excites you, and you think you can help, then please join us.
If you use our templates in other Season of Docs projects, then please share your experiences and suggested improvements.
We have a little space for junior and aspiring tech writing volunteers, but our capacity to mentor is limited by our access to senior writers.
Feel free to reach out to us via our email list, or directly on slack, introducing yourself and noting what you'd like to get involved in.
Here we have collected some background reading and links to blogs, and brain dumps of ideas we have collated to date.
- The Good Docs Project webpage.
- Our current templates. These are a starting point - which we know can be improved.
- Our issue tracker.