Documentation is highly valued, frequently overlooked, and—critically—a means for establishing inclusive and accessible communities, yet incomplete, inaccurate, or outdated docs are a near-universally recognized barrier to developer productivity.
Join Andrew Chen, Erin McKean, and Aizhamal Nurmamat kyzy for an overview of research-backed documentation best practices and discover how to create the skeleton of a ready-to-deploy documentation website for your own open source project. You’ll leave having created a fully functional website, along with a skeleton information architecture, ready for you to update and easily deploy using Netlify.
This tutorial is sponsored by Google Cloud.
Andrew Chen is a program manager on the open source strategy team. Previously, he was a technical writer for Kubernetes. His focus is to improve documentation in the broader open source space.
Aizhamal Nurmamat kyzy is an open source program manager for Adecco@Google. She loves open source and contributes to Apache Beam, Apache Airflow, and CDAP. She supports building healthy open source communities and focuses on improving contributor experience, advocating for good documentation, and noncode contributions. She loves football (fan of Messi) and baking cakes for her friends and family.
Comments on this page are now closed.
For exhibition and sponsorship opportunities, email firstname.lastname@example.org
For information on trade opportunities with O'Reilly conferences, email email@example.com
View a complete list of OSCON contacts
©2019, O'Reilly Media, Inc. • (800) 889-8969 or (707) 827-7019 • Monday-Friday 7:30am-5pm PT • All trademarks and registered trademarks appearing on oreilly.com are the property of their respective owners. • firstname.lastname@example.org
FYI, here is a link to the slide deck: https://bit.ly/2JBcH2i
Will a video of this workshop be made available?