Starting in September, the STC Arizona Chapter is hosting a webinar series for Application Programming Interface (API) documentation designed for technical communicators and students who want to learn more about documenting APIs. The course will focus primarily on Representational State Transfer (REST) APIs.
- Title: API Documentation 101
- Where: Online (Zoom meetings)
- When: September and October 2019 (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 10 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 | September 4, 7:00–9:00 PM
- Lesson 2: Using an API like a developer | September 11, 7:00–9:00 PM
- Lesson 3: Documenting API endpoints | September 18, 7:00–9:00 PM
- Lesson 4: OpenAPI Spec and Swagger | September 25, 7:00–9:00 PM
- Lesson 5: Testing API docs | October 2, 7:00–9:00 PM
- Lesson 6: Conceptual topics an API docs | October 9, 7:00–9:00 PM
- Lesson 7: Documenting code | October 16, 7:00–9:00 PM
- Lesson 8: Publishing your API documentation | October 23, 7:00–9:00 PM
- Lesson 9: Getting an API documentation job and thriving | October 30, 7:00–9:00 PM
Note: The registration fee covers all nine webinars in the series. Registration fees are used to cover STC Arizona Chapter operating expenses.
Registration fees are as follows:
- Students: $49
- STC members: $89
- Nonmembers: $129