tekom - conferences

Documenting API developer portals

  • Presentation
  • Software Documentation
  • 10. June
  • 09:30 - 10:30 o'clock (CET)
  • | Online
  •  Swapnil Ogale

    Swapnil Ogale

    • Redocly

Takeaways

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.

Content

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

Prior knowledge

Basic understanding of API documentation

Speaker

 Swapnil Ogale

Swapnil Ogale

  • Redocly
Biography

Technical Writer, Community Wrangler, and Professional Speaker.