Fueling innovative software
July 15-18, 2019
Portland, OR

Zero to docs: Hands-on documentation workshop (sponsored by Google Cloud)

Andrew Chen (Google), Erin McKean (Google | Wordnik), Aizhamal Nurmamat kyzy (Adecco@Google)
9:00am–12:30pm Tuesday, July 16, 2019
Sponsored
 Location: D135/136
Average rating: *....
(1.00, 1 rating)

Who is this presentation for?

  • Anyone who wants to help their community adopt, use, and contribute to their open source projects

Description

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.

Prerequisite knowledge

  • A working knowledge of Linux, the command line, and Git

What you'll learn

  • Learn why documentation is a critical resource for your community and what information your community members need along every step of the journey from the casual user to contributor
  • Understand how to quickly and easily build a great-looking, usable Hugo-based documentation website
Photo of Andrew Chen

Andrew Chen

Google

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.

Photo of Erin McKean

Erin McKean

Google | Wordnik

Erin McKean is the founder of the newly not-for-profit Wordnik.com, the world’s biggest online dictionary, and developer relations program manager at Google. Previously, she was the editor-in-chief of American Dictionaries for Oxford University Press. Before JavaScript, she dabbled in HyperCard, Perl, and Omnimark. (If you’ve ever written anything in Omnimark, she’ll buy you a drink.) Erin’s the author of the Weird and Wonderful Words books, the best-selling novel The Secret Lives of Dresses, and, most recently, The Hundred Dresses, a field guide to dresses. She blogs at Dressaday.com. When you meet her, please tell her your favorite word.

Photo of Aizhamal Nurmamat kyzy

Aizhamal Nurmamat kyzy

Adecco@Google

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.

Comments

Picture of Andrew Chen
Andrew Chen | Program Manager of Open Source Strategy
07/19/2019 2:37am PDT

FYI, here is a link to the slide deck: https://bit.ly/2JBcH2i

Ian Cowley |
07/18/2019 9:12pm PDT

Will a video of this workshop be made available?