Zurück

Zurück zum Tagungsprogramm

Documenting API developer portals

  • Fachvortrag
  • Softwaredokumentation
  • 10. Juni
  • 09:30 AM (MESZ) - 10:30 AM (MESZ)
  • beendet
  • Swapnil Ogale

    Swapnil Ogale

    • Redocly

Inhalt

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.

 

In this talk, I will draw on my recent experience with documenting APIs and developer portals to provide a full picture of how they work and where they’re used.

Das lernen Sie

Key takeways:

a. Pain points around API documentation

b. How Developer Portals have evolved and how they effectively are the UI of APIs

c. Skills technical writers bring to API docs

d. Best practices around API dev portals

Vorkenntnisse

Basic understanding of API documentation

Referent:in

Swapnil Ogale

Swapnil Ogale

  • Redocly
Biografie

Swapnil is a Technical Writer with over 15 years of experience across a range of industries in Australia and globally. He currently works as a Technical Writer Advocate at Redocly. He initiated the Write the Docs community in Australia in 2016 and has been organising local meetups and the annual national conference. 

Swapnil loves travelling, reading, writing (yes, he writes outside his day job too), and is a foodie. While he is not doing any of that, he presents at technical meetups and conferences about various things around technical writing.

You can find out more about his passions on social media at LinkedIn (https://www.linkedin.com/in/swapnilogale/) and Twitter (https://twitter.com/swapnilogale).

zurück