Adobe Robohelp

Get new posts delivered straight to your inbox.

Subscriber count: 3,220

Adobe Robohelp

Introduction to API documentation: Interview with Scot Marvin

Jun 16, 2014 • api-doc, podcasts

Intro to API documentation, a podcast with Scot Marvin

Length: 30 min.

Download MP3 (right-click and select Save As)

In this podcast, I talk with Scot Marvin, an API technical writer based in Oregon, about some introductory topics with API documentation. Topics covered in the podcast include the following:

  • The prevalence of APIs 15 years ago compared to today
  • The definition of an API
  • What technical writers are responsible to document with APIs
  • Where technical writers get information about the requests, parameters, and other technical details with APIs
  • Whether technical writers get info from the API code or from other sources, such as specs
  • The difference between reading versus writing code
  • Documentation beyond the reference API that tech writers create
  • The difference between an SDK and API
  • Some paths people take that lead them to doing API documentation
  • Whether tech writers are at a disadvantage without a dev background when creating API doc
  • What format the response of an API usually delivered in (JSON, XML)
  • How a REST API differs from a Java API
  • How does SOAP differ from REST
  • Examples of some good sample API doc sites, and why
  • The amount of continual study and learning needed to thrive in API doc space

For more information about Scott, see his Twitter handle scotmarvin or his website scotmarvin.com.

Add a review for the "I'd Rather Be Writing" podcast in iTunes

If you like this podcast, please add a review for the podcast in iTunes. Just click this link, and then launch iTunes. Find and subscribe to the podcast in iTunes. On the Ratings and Reviews section, add a rating and optionally a review. This will help increase the visibility of the podcast in iTunes.

You can help support my podcast by reviewing it in iTunes.
You can help support my podcast by reviewing it in iTunes.


Get new posts delivered straight to your inbox.

Subscriber count: 3,220

About Tom Johnson

Tom Johnson

I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.