TechCommNZ Webinar - Documenting API developer portals
APIs do not have an interface, right? Most of it is code (actually all of it) that allows business and users to do some incredible stuff across their products.
So, what is it that is keeping them from using these APIs to their fullest potential? You guessed it. Good documentation. Documentation that provides a complete picture of how APIs work, the context behind using these APIs, troubleshooting, understanding error messages, and some real examples of how to use the APIs. This session provides an insight on how to and what to document with APIs.
You will learn:
- Why is documentation crucial for APIs?
- What to consider when documenting APIs?
- How to go about documenting APIs?
- Some examples on best practices for API developer portals
Date and time
The webinar will be held on Friday 16 October 2020 from 11:00am - 12 noon NZDT, (09:00am - 10:00 am AEDT).
Note: If you are unable to join us on the day, don't worry. A recording of the webinar and related information will be available to download from our website within a couple of days.
The costs for this webinar are:
- TechCommNZ members - $30 plus GST
- TechCommNZ student members - free
- Affiliate members incl ASTC and NZATD - $50 plus GST
- Non-members - $150 plus GST. Sign up as a member and, once approved, you can register at member rates.
Please register through the website so that we can send you details about accessing the webinar session.
About the presenter
Swapnil Ogale is a Technical Writer with close to 14 years of experience across a range of industries in Australia. He also moonlights on remote writing projects, providing expertise on technical documentation for startups and niche organisations. In his last two roles, Swapnil was exposed (pun intended) to some industry-defining APIs and he lived to tell the tale of how critical the documentation of these APIs was for these projects.
Swapnil initiated the Write the Docs community in Australia in 2016 and organises the Melbourne meetups and the annual conference.
He is fortunate enough to live in one of the world’s most liveable cities – Melbourne, Australia. While not thinking about documentation, you can find him travelling, feeling the crisp air in his face riding a bicycle, or building a mini library by visiting bookshops and book-fairs.