Tech Writing 101 for SREs

Thursday, 2017, August 31 - 09:0012:30

Lisa Carey and Betsy Beyer, Google

Abstract: 

From post-mortems to operations manuals to code comments, writing things down for others is an unavoidable part of the life of an SRE.

In this workshop, you’ll learn writing principles to help you present technical information from two experienced Google technical writers - and each other! Through a series of pair-work exercises you’ll work through a variety of topics to improve the clarity, readability, and effectiveness of your writing, and possibly think about a toothbrush like you’ve never thought about one before. If you've never before taken any technical writing training, this workshop is perfect for you. If you've taken technical writing training, this class will serve as a great refresher.

There is a small amount of pre-reading (https://goo.gl/ssAALV) for participants in this workshop (~30 minutes of reading about basic technical writing concepts).

The workshop runs for two hours with a short break.

Lisa Carey, Google

Lisa Carey is a Technical Writer for Google Cloud Platform in Dublin. She has written documentation for many technologies including Protocol Buffers, gRPC, and Cloud APIs, and regularly runs writing workshops for Google engineers. She holds degrees from Trinity College Dublin.

Betsy (Adrienne) Beyer, Google

Betsy Beyer is a Technical Writer for Google Site Reliability Engineering in NYC. She has previously written documentation for Google Datacenters and Hardware Operations teams. Before moving to New York, Betsy was a lecturer on technical writing at Stanford University. She holds degrees from Stanford and Tulane.

BibTeX
@conference {205500,
author = {Lisa Carey and Betsy (Adrienne) Beyer},
title = {Tech Writing 101 for SREs},
year = {2017},
address = {Dublin},
publisher = {{USENIX} Association},
month = aug,
}