Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,300+ subscribers

Search results

Upcoming event:
I'm giving an API documentation workshop in Los Angeles, California, on January 23, 2020. Check it out on EventBrite.
Input needed:
I'm gathering data about trends in developer documentation for 2020. If you write docs for developers, please take this survey. (You can view the ongoing results here.)

API documentation workshop opportunity at the STC Summit

by Tom Johnson on Apr 7, 2016 •
categories: api-doc

If you're planning to go to the STC Summit this year, or you're looking to get more information on API documentation, check out my pre-conference Summit workshop. I'm teaching a half-day workshop on REST API documentation. This will take place Sunday, May 15 from 8:30am to noon.

During this 3.5 hours, I’ll teach you everything you need to know to document REST APIs. You’ll learn the essential sections of API reference topics, including how to document resources, endpoints, parameters, sample requests, and responses. I’ll teach you how to use Postman to test REST endpoints, how to use cURL on the command line, how to read and document JSON, and more.

STC Summit API documentation workshop

You don’t need a programming background to write REST API documentation. With some basic familiarity with HTML and an ability to understand simple command line syntax and JSON, you can document the most complicated REST APIs. Of course, to document sample applications in different languages, you’ll need more programming knowledge. But the beauty of REST APIs is that they’re language agnostic.

If you’re thinking of signing up for this pre-conference, be sure to do it before April 15 to guarantee a spot in the workshop. See more details about the API pre-conference workshop here.

follow us in feedly