Share

cover art for Introduction to API documentation - Recording from Los Angeles API documentation workshop

I'd Rather Be Writing

Introduction to API documentation - Recording from Los Angeles API documentation workshop

In January I gave an , and I recorded the first section of the workshop. This section provides an introduction to APIs, including an overview of APIs, the API doc market, info about API popularity, how to submit requests through Postman, and other trends. The recording is available as both a video/audio or standalone audio.

More episodes

View all episodes

  • Webinar recording: How Trends in API Documentation Differ from other Tech Comm Trends

    59:01
    I recently gave a webinar on trends in developer docs to the STC Washington DC chapter on March 12, 2020. In this presentation, I presented the results and analysis of my . A recording and audio file is available below.
  • Podcast: How Paligo is filling a niche in the CCMS market for complex documentation, with Anders Svensson

    51:35
    I recently chatted with Anders Svensson about how Paligo, a cloud-based CCMS, is filling a niche in the CCMS market for complex documentation needs. Complex documentation refers to documentation with multiple product variants, versions, languages, audiences, and more. In these scenarios, content re-use and scalability become more challenging. Paligo is filling a need for documentation teams that have grown beyond their help authoring tools and need the more robust support that a component content management system (CCMS) offers but without the price tag and implementation timeline.
  • Podcast with Andrew Davis: Hiring API doc writers -- an inside look at fixing broken processes

    55:11
    I recently chatted with , a recruiter for API documentation positions in the San Francisco Bay area, about why it's so difficult to hire technical writers for developer documentation roles. Andrew has more experience and knowledge with developer doc jobs, companies, and recruiting processes than nearly anyone else in the tech comm industry. He actually helped me find my first dev doc job when I transitioned to California years ago. Andrew's company is called . In this interview, Andrew provides an inside look at fixing broken processes around hiring.
  • From API docs to developer portals

    32:29
    One comment I often hear from API workshop participants and other readers is that they want a more advanced API course. I've been thinking about what that more advanced course would involve, in addition to what might be involved in leveling up at my work, and I've come to a realization that I need to transition more from to . Developer portal strategies includes API documentation but also encompasses broader concerns as well, not too different from content strategy.
  • Podcast: API Design and Usability with Arnaud Lauret (API Handyman)

    54:39
    Arnaud Lauret, also known as the API Handyman, recently published a book called . In this podcast, I chat with Arnaud about his book, specifically exploring best practices for designing web APIs and focusing on the roles technical writers can play.
  • Podcast: Dealing with Project Overload -- Strategies to Manage Overflowing Documentation Tasks

    20:07
    In this podcast, I talk about how to deal with project overload, specifically covering strategies to manage tasks. Scrum is one framework for dealing with project work by allowing you to limit the work you have before you in a more systematic way. I also explain the importance of focusing on a project to build up flow and momentum, without always context switching.
  • Podcast: 10 myths about API documentation

    31:53
    In this podcast, I debunk 10 myths about API documentation. For example, some myths are that only engineers can write API docs, or that you have to write API docs by deciphering an engineer's source code. In this podcast, I go through these myths one by one with discussion and analysis.
  • Recording of Tech Comm Trends Presentation (STC Puget Sound chapter)

    01:26:50
    I recently gave a presentation on technical communication trends to the STC Puget Sound Chapter in Seattle, Washington, on May 21, 2019. This is one of the better presentations on trends I've given and culminates a lot of research and other iterations on this topic during the past year. You can view a recording of the presentation, check out the slides, grab the audio file, and see other details here.