I know a lot of people who want to consume awesome API docs. Let’s talk about what it takes to get started writing them. I’m not talking about completing your API docs. I’m talking about just getting started, what does it take? For API documentation especially REST APIs, I’d advocate a reference-first approach. Like the […]
A Few of my Favorite Things for 2013
This year has been filled with interesting finds, discoveries, and productivity. Plus oxford commas! Here are my favorite things for 2013. The Hunger Games trilogy, because it’s like a window into a mind of a smart writer who writes with purpose. The Documentation chapter of the Developer Support Handbook has to be one of my […]
Documentation as Conversation with CSS
Three types of speech balloons: speech, thought, scream. I love to explore new ways of conveying technical information, and I’m interested in documentation as conversation. Last year I wanted to convey a “side note” on each page of a Sphinx site, as if the page were talking to you. I needed to let people know […]