API Documentation Best Practices
Presentation Abstract
API documentation is the number one reference for anyone implementing an API, that can profoundly influence the developer experience. In this presentation I explore the best practices for different components and aspects of API docs. Starting with an in-depth, research-based analysis of the needs of your target audience, I explain how to write references, examples, error messages, release notes, guides, and tutorials. I also explore aspects like layout, navigation, readability, usability, and personality. I help you think about ways to improve your API docs through analytics and feedback, and share ideas about extending your documentation into a full-fledged developer portal.
What can attendees expect to learn?
With the fast expansion of the API economy, technical writers who can write documentation for a developer audience are in high demand. The most essential component of any API provider’s developer communication is the API documentation. In this presentation I explore the latest research studies about how developers use API documentation, in order to provide a deep understanding of the best practices that follow. By the end of the presentation, my audience will have a thorough understanding of the different aspects of writing API docs, and they will be able to see how they can convert their technical writing experience to work for this specific market.
Meet the Presenter
Diána Lakatos is a Senior Technical Writer specialized in API documentation, topic-based authoring, and contextual help solutions. She writes, edits and reviews software documentation, website copy, user documents, and publications at Pronovix, a company building developer portals in Drupal. She also enjoys working as a Program Monitor for NHK World TV and Arirang TV.