API World has ended
Back To Schedule
Tuesday, September 16 • 4:00pm - 4:40pm
TALK: Documenting API's: Sample Code and More

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Sample code and documentation are important when engaging a developer audience, but what are the guidelines? How can you maintain consistent tone across languages, platforms, and levels of developer experience? How do you create a small set of samples that will allow a VB6 developer to consume your newest products, but still have your legacy SOAP API be approachable to a newly-minted Rails developer? Supportability matters too - we'll talk about creating a single set of sample code style guidelines that can apply to that wide range of languages and frameworks. We'll compare some leading developer documentation sites and discuss strategies for keeping documentation and sample code content consistent, comprehensive, and concise.

avatar for Anya Settler

Anya Settler

Developer Relations, Avalara
Anya Stettler works for Avalara (www.avalara.com), documenting and supporting their diverse sales tax calculation and compliance APIs. Over the past three years, she has driven a colossal documentation shift from hard-copy developer documentation to an ever-improving self-service... Read More →

Tuesday September 16, 2014 4:00pm - 4:40pm PDT
Hotel Kabuki

Attendees (0)