API Documentation 101
The STC Arizona Chapter is hosting a series of application programming interface (API) documentation webinars for technical communicators and students who want to learn more about documenting APIs.
The course will focus primarily on Representational State Transfer (REST) APIs.
Registration is closed for this event.
- Title: API Documentation 101
- Where: Online (Zoom meetings)
- When: April-September (see dates and times below)
- Presenter: Alan Vickers
The “textbook” for the course is Tom Johnson’s (outstanding) Documenting APIs, a Guide for Technical Writers. Tom developed the free, self-paced course specifically for technical communicators (thanks, Tom!).
Anyone can take the online course for free, and if you’re comfortable with the technology and concepts, you should be able to get through it okay. The API Documentation 101 course is for those who prefer to collaborate and learn in a “classroom” setting.
We’ll cover the course material in six webinars. Before each webinar, you’ll read the sections in the API documentation course, complete all activities, and be prepared to discuss the content during the webinar.
Lessons and dates are as follows (subject to change):
- Lesson 1: Introduction to REST APIs | April 25, 7:00–9:00 PM
- Lesson 2: Using a REST API like a developer | May 30, 7:00–9:00 PM
- Lesson 3: Documenting API reference topics and Testing your API documentation | June 27, 7:00–9:00 PM
- Lesson 4: Documenting non-reference sections | July 12, 7:00–8:00 PM
- Lesson 5: Open API specification and Swagger Part 1 (through step 8 and special guest Millie Hartnett) | July 25, 7:00–9:00
- Lesson 6: Open API specification and Swagger Part 2 (through More about YAML) | August 9, 7:00–8:00
- Lessons 7, 8, and 9: Publishing your API documentation | Documenting native library APIs |Getting a job in API documentation | Discuss our plan for building the API website August 29, 7:00–9:00
- Phase 1 website meeting: September 5, 7:00–8:00
- Phase 2 website meeting: September 13, 7:00–8:00
- Phase 3 website meeting: September 19, 7:00–8:00
- Final course meeting: September 26, 7:00–9:00