The 7 Deadly Sins of Documentation

Wednesday, November 01, 2017 - 4:00 pm4:45 pm

Chastity Blackwell, Yelp

Abstract: 

Documentation, or the lack of it, is often one of the biggest issues with working in tech. In most places, code has supremacy, and documentation ends up being an afterthought. Unfortunately, even in places where documentation is actually written, it’s often done quickly or poorly in the first place, not maintained, or not organized in a way that makes it easy to use. This talk will discuss the biggest problems surrounding creating, maintaining, and providing utility with documentation, and how to solve them.

Chastity Blackwell, Yelp

Chastity Blackwell took her first job as a system administrator in 1999 just to pay the bills until she could get a writing job. After 12 years working in infrastructure operations at the University of Illinois, she decided this might actually be a career, and was lured out to the Bay Area to work for a startup. She survived a yearlong stint as a manager before returning to the front lines as a Site Reliability Engineer at Yelp.

Open Access Media

USENIX is committed to Open Access to the research presented at our events. Papers and proceedings are freely available to everyone once the event begins. Any video, audio, and/or slides that are posted after the event are also free and open to everyone. Support USENIX and our commitment to Open Access.

BibTeX
@conference {207155,
author = {Chastity Blackwell},
title = {The 7 Deadly Sins of Documentation},
year = {2017},
address = {San Francisco, CA},
publisher = {USENIX Association},
month = oct
}

Presentation Video 

Presentation Audio