If you’re teaching this material in a workshop, you can use the slides below. The slides are built with RevealJS, which means they’re pure HTML. As such, I store them in GitHub repositories that you can fork and then modify to suit your needs. The slides are divided into several groups:
Part I: Introduction to API Documentation
Part II: OpenAPI and Swagger
Part III: Non-reference Content in API Documentation
Publishing API Documentation
(This section wasn’t included directly during the workshop but rather as a supporting presentation.)
4/101 pages complete. Only 97 more pages to go...
If you would like to contribute back to say thank you for the API documentation course, click the Donate button below. Alternatively, to contribute content, such as a tutorial or a new section, contact me with your ideas. You can also submit a pull request in the GitHub repo to make your contribution. Even if you want to just fix a typo or add a sentence here and there, it's always welcome.
I'd Rather Be Writing Newsletter
Get new posts delivered straight to your inbox.