Mastering API Documentation Workshop for Technical Writers
Mastering API Documentation Workshop for Technical Writers
An in-depth, instructor-led online course blending theory and practical application
Mark Wentowski knows a lot about Application Programming Interface (API) documentation. He’s an API Documentation Specialist with over a dozen years of experience producing global, web-based, developer-to-developer documentation for web services, libraries, and other software products.
In his new online, instructor-led course, Mastering API Documentation, he teaches technical communicators (and others who document or need to understand APIs) through six 90-minute classes. The class meets six times from October 3, 2024, through December 19, 2024.
Save $250 off the cost of Mastering API Documentation when you use discount code — TCW — at checkout.
Course Overview
This online course offers in-depth training on API documentation, blending theory, and practical application.
Key features include:
Instructor-Led Sessions: Gain insights into various aspects of APIs and documentation with live demonstrations, such as making API calls and documenting APIs.
Hands-On Assignments: Complete assignments between sessions to reinforce learning and apply new skills.
Final Project: Create and submit an API documentation portal for peer review.
Final Quiz: Test your understanding with a comprehensive quiz at the end of the course.
Certificate of Completion: Students may obtain a certificate of completion from the instructor after completing the course.
By the course's conclusion, participants will master API documentation principles, tools, and best practices. They will create clear, industry-standard documentation and be capable of collaborating effectively with developers.
Class Schedule:
Foundations and Setup — October 3, 2024 (10:00 am - 11:30 am PT) — Lays the groundwork with an overview of the course, REST API basics, API documentation fundamentals, and a tour of the development environment.
Interacting With APIs — October 17, 2024 (10:00 am - 11:30 am PT) — Will help you gain proficiency with essential API testing tools and solidly understand OpenAPI fundamentals.
OpenAPI Deep Dive — October 31, 2024 (10:00 am - 11:30 am PT) — Insights into the specifics of OpenAPI, including parameters, API responses, filtering and sorting results, and JSON schema.
Design and User Flows — November 14, 2024 (10:00 am - 11:30 am PT) — Techniques for gathering and refining source material from diverse resources and effectively charting API flows.
API Reference, Concepts, and Onboarding (Class 5 of 6) — December 05, 2024 (10:00 am - 11:30 am PT) — Create thorough API references, clearly explain key concepts, and provide practical guidance for users starting with APIs.
Error-Handling, Code Samples, Recipes (Class 6 of 6) — December 19, 2024 (10:00 am - 11:30 am PT) — Master the creation of detailed guides, including handling common error scenarios and offering practical, tested code samples.
Course Pricing, Payments, and Registration Discount
The registration fee for Mastering API Documentation is $1,499,99 USD. However, you can save $250 by registering by September 15, 2024. Use The Content Wrangler discount code TCW at checkout to take advantage of the discounted price.
Related reading:
Challenges Creating Exceptional Developer Experiences with API Docs
A Taxonomy of Knowledge Types For API Reference Documentation
Enabling Efficient Access To Relevant Content In API Documentation
Developers Often Use Self-Directed Learning To Put APIs To Work
A Taxonomy of Knowledge Types For API Reference Documentation