Let's Talk API Documentation

Presented by

Panelists: Tom Johnson, Mark Wentowski, Kartik Balasubramanian ˘ Host: Scott Abel

About this talk

Join us for "Let's Talk API Docs," a dynamic talk show dedicated to the intricacies and best practices of documenting Application Programming Interfaces (APIs). Whether you're a developer, technical writer, or API enthusiast, this show offers valuable insights and discussions on a range of vital topics. Panelists for this show include: Tom Johnson (Senior Technical Writer at Google), Mark Wentowski (an veteran technical writing consultant with experience creating developer docs), and Kartik Balasubramanian (a London, England-based Director of Technical Documentation at financial technology firm, Beacon Platform). "Let's Talk API Docs" is a must-watch for developers, technical writers, and API enthusiasts, offering insights on crucial topics like: • Assessing autogenerated API documentation and its limits. • Tackling security in API docs, focusing on access control and privacy. • Tailoring API Docs to meet user needs. Challenges we'll explore include: • Standardizing API documentation. • Refining content models and search features. • Aligning docs with developer tasks. • Weighing design-first vs code-first approaches. • Implementing SEO in API documentation. Opportunities we'll discuss: • Innovating for better user experiences in documentation. • SEO strategies to make APIs more discoverable. • Creating developer-friendly documentation. • Using cognitive neuroscience for better design. Plus, we'll share top resources like classes, books, blogs, and insights from API Docs experts. Can’t make it? Register, and we’ll send you a link you can use to watch a recording when it’s convenient for you. Let's talk API Docs is brought to you by The Content Wrangler and is sponsored by Heretto, a powerful component content management system (CCMS) platform to deploy help and API documentation in a single portal designed to delight your customers.
Related topics:

More from this channel

Upcoming talks (79)
On-demand talks (658)
Subscribers (72943)
The Content Wrangler Channel covers the people, methods, tools and technologies designed to help you deliver the right information, to the right people, at the right time, on the right device, in the right format and language. Your content is your most valuable business asset. Let us show you how to manage it efficiently and effectively.