---
title: "Crash course in API documentation – a one-hour video"
date: 2019-05-16
description: "I mentioned in my STC Summit slide links post that I recorded my “Intro to API documentation” presentation using the on-board mic on my laptop, and that STC let..."
canonical_url: https://idratherbewriting.com/blog/crash-course-in-api-documentation/index.html
---

> For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

# Crash course in API documentation – a one-hour video

> If you want a condensed, one-hour version of what I cover in my API documentation workshop, check out this crash-course video.

I mentioned in my [STC Summit slide links post](https://idratherbewriting.com/blog/my-slide-links-times-stc-summit/#apidoc) that I recorded my “Intro to API documentation” presentation using the on-board mic on my laptop, and that STC let me post it on my blog. The sound in the recording isn’t great, but if you’re interested, the video is available below. Someone who recently watched the video wrote me to say,

> Btw, the one hour crash course was great. I just watched it. This will be my go-to-link to send people interested in the space. It’s a lot of content for a beginner, but its variety and your talking more holistically about the workflow/mindset made it a great introduction. Bravo!

In this introductory presentation, I explore Sendgrid as a good example of API docs.

[Video: Video](https://www.youtube.com/embed/5pzhtrrtkXY)

For more API documentation recordings, see [Video recordings of API doc workshops](https://idratherbewriting.com/learnapidoc/docapis_course_videos.html).

I also rendered this video as a standalone audio file in case you prefer it this way:

**Listen here:**

[Audio](https://www.podtrac.com/pts/redirect.mp3/s3.us-west-1.wasabisys.com/idbwmedia.com/podcasts/api_docs_crash_course.mp3)

[![](https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/apple_podcasts.png)](https://itunes.apple.com/us/podcast/id-rather-be-writing-podcast/id277365275) [![](https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/watchonyoutubeblack.png)](https://www.youtube.com/@idratherbewriting) [![](https://s3.us-west-1.wasabisys.com/idbwmedia.com/images/spotify.png)](https://open.spotify.com/show/4HeOZfPGMMfViOhVS40QBD)