Search results

Course slides

Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers

If you're an engineer, please take this quick survey focused on engineers who write documentation. This will help me better understand trends in this space. You can see the ongoing results here.

These slides correspond to API workshops that I give. For the most part, the slide groups mirror the same sections in the course. Most sections have slides, but not all because not all material can be covered during a one-day workshop.

Part I: Introduction to API Documentation

Part II: Using an API like a developer

Part III: Documenting API endpoints

Part IV: OpenAPI and Swagger

Part VI: Non-reference Content in API Documentation

Part VII: Publishing API Documentation

Part VIII: Getting a job in API Documentation

5% Complete

5/110 pages complete. Only 105 more pages to go.


Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.