A Primer On API Documentation

🗓️ Events
1

I am excited to announce that I will be speaking at DevFest Ibadan 2022 about “A Primer on API Documentation” on 3rd December, 2022.
This session targets technical writers and developers looking to transition into technical writing. A good developer should have basic documentation skills, whether they want to take writing as a career.

What good is an API without proper documentation? We will be talking about the “why” and “how” of API documentation.

  • Why is API documentation important(generally and in open-source)?
  • A proper API documentation structure(must-haves, do’s, and don’t).
  • Easy Publishing tools for API docs.

Advanced

  • Introduction to Open API
  • Open API Spec Editing and Publishing Tools
1 Like
2

Hi @roxie-dev
How did it go? Is the talk available for replay?
Thanks!
Xavier.

3

Hi @xavier.gutierrez , I didnt get a recording but my slide can help. A Primer on API Documentation - Google Slides

It went amazing by the way.

1 Like
4

Congratulations and thank you for sharing!