Loading…
for API Strategy & Practice Conference 2017
Attending this event?
View analytic
Thursday, November 2 • 3:30pm - 3:50pm
Things I Wish People Told Me About Writing Docs - Taylor Barnett, Keen IO

Sign up or log in to save this to your schedule and see who's attending!

"Have you ever read a piece of API documentation and thought it was a mess? Maybe it was incomplete, badly organized, or in general just not great. There’s a good chance it was quickly thrown together by someone who had no idea what they were doing. In this talk, we will discuss the things Taylor wished she knew before starting to dive into the world of writing docs and developer focused content.

We will discuss how people actually read documentation, different types of docs and when they are appropriate, and docs navigation techniques using design principles. Also, we will learn more about the importance of focusing on language, including why naming matters and error messages as a form of documentation. Lastly, we will talk about tools and tactics to enable other team members to write documentation."

Speakers
avatar for Taylor Barnett

Taylor Barnett

Community Engineer, Keen IO
Taylor Barnett is a Community Engineer at Keen IO, an API platform that allows you to stream, compute, and visualize events from anything connected to the internet. She’s passionate about building great developer experiences with an emphasis on empathy and inclusion within docu... Read More →


Thursday November 2, 2017 3:30pm - 3:50pm
Broadway III/IV

Attendees (6)