chrischinchilla

2 min read - Posted 23 Apr 19

Google's Season of Docs - Fostering open source collaboration with technical writers

Kauri is passionate about improving developer documentation and experience. At the moment we are working to do this in the Ethereum and Web3 space, in the longer term future we hope to do the same with other open source technologies. We do this with our content platform and helping fund and mentor project documentation improvements. For example, until April 30th we are helping fund documentation improvements to ENS and Plasma Group (components) as part of the Ethereal hackathon.

Google recently announced the "Season of Docs" program where they hope to bring organisations looking to improve their documentation together with writers, and provide a framework to help facilitate this relationship.

As we know that many Web3 projects struggle with the time for documentation, but also with the time for managing community contributions. Following a similar pattern to our involvement with Ethereal, we hope to help projects in our ecosystem looking for documentation improvements by managing task descriptions, mentoring contributors, and helping get contributions ready for merging.

Here are some of the tasks we aim to help as part of Season of Docs, but hope to confirm more:

Watch this post for updates to our involvement with Season of Docs and how to get involved.

Created with Sketch.Content is"CC-BY-SA 4.0" licensed
Article On-chain
0 Comments
Related Articles
Documentation structure

Documentation structure applies to your documentation as a whole, and to each page. Lets start at the top and work down. There are different types of documentation your project might need. The terms I use to describe them below are just the terms I use, and others use different terms. The explanation of what they are is more important than what you decide to call them is up to you. Documentation types Getting started A Getting started guide is often a starting point with your project. It should

Chris Ward

14 Nov 19

Language and understandable writing

I appreciate that not everyone who writes documentation is a native English speaker, or even if they are, may not understand the best way to write clearly and concisely. Many native English speakers had our last grammar lesson more than 20 years ago, and have learnt the tips and tricks we now use as professional writers recently. There are three important things to remember to justify the time and effort of making your writing more understandable: English is often a default language for technica

Chris Ward

18 Nov 19