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




I'd Rather Be Writing Podcast Feed show

Summary: 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 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. For more API documentation recordings, see Video recordings of API doc workshops. I also rendered this video as a standalone audio file in case you prefer it this way: Listen to this post: You can download the MP3 file, subscribe in iTunes, or listen with Stitcher. var contents=new Array() contents[0]=' Sponsored message:Over 40,000 API developers use SwaggerHub to design and document APIs with Swagger (OpenAPI). Learn how SwaggerHub can help improve your team’s API documentation workflow. Get started for free.' contents[1]=' Sponsored message:SwaggerHub was built by the team behind Swagger to help organizations collaborate on their API design and documentation from one centralized platform. Find out why SwaggerHub is the platform for design and documenting APIs with Swagger. Get started for free.' contents[2]=' Sponsored message:SwaggerHub brings together all the power of the open source Swagger tooling into one integrated platform for designing and documenting APIs with Swagger (OpenAPI). Get started for free.' contents[3]=' Sponsored message:SwaggerHub is an integrated API design and documentation platform, built for teams to drive consistency and discipline across the API development workflow. Get started for free.' contents[4]=' Sponsored message:Documenting APIs with Swagger? SwaggerHub lets you generate API documentation that’s securely hosted and fully interactive. Import an existing Swagger definition, or start a new API project from right within your browser, no setup required. Get started for free.' var i=0 //variable used to contain controlled random number var random //while all of array elements haven't been cycled thru while (i