Search results

Webinar: Let's talk API docs: a discussion about issues impacting documentation for APIs

by Tom Johnson on Dec 3, 2023
categories: api-doc • podcast-guest

I recently participated in a webinar called Let's Talk API Docs with Scott Abel, Mark Wentowski, and Kartik Balasubramanian on December 13 at 8am PST. The panel discussion covered a wide array of topics, such as limitations of autogenerated API documentation, security in API docs, tailoring documentation to user needs. We also discussed challenges such as standardizing API documentation as well as opportunities for improving the developer experience.

After signing into Brighttalk, you can watch the recording here.

Let's talk API docs webinar

Here’s the description:

Let’s Talk API Docs

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.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.

© 2024 Tom Johnson