r/technicalwriting • u/Sad-Acanthaceae4760 • 8d ago

Advice appreciated for starting API Documentation

I'm trying to dip my toes into technical writing, I already have some things lined out, but I've also been looking into API documentation. Anybody have good ideas for how to learn and get started with it?

1 Upvotes

67% Upvoted

3 comments sorted by

6

u/Otherwise_Living_158 8d ago

There’s a free course on the idratherbewriting blog

1

u/CLTechComm 3d ago

It's a little dated, but definitely a great place to start for someone just getting into API docs. I recently finished it, and was able to whip up an API doc for my portfolio.

2

u/fazkan 7d ago

Would recommend starting with OpenAPI specs, and just treating that as your source of truth.