Getting Started with APIs and API Documentation
- Workshop
- Software Documentation
-
Jordan Stanchev
- SAP Labs Bulgaria
Contents
In this workshop, you will learn how to start fast and easy with API documentation as a technical writer. No previous experience is required.
I will explain what an API is and explore the different types of API documentation you can write, including API reference documentation and developer guides. Through practical examples, I'll demonstrate various tools and approaches for working with APIs. Together, we'll access and interact with public APIs firsthand, giving you hands-on experience in writing documentation about real-world APIs.
By the end of this workshop, you'll have the foundational knowledge and practical skills to confidently begin your API documentation journey.
Takeaways
Participants will understand what APIs are, identify common API documentation deliverables, and learn what elements are essential to document for any API.
Prior knowledge
No previous experience is required.