Writing really good technical documentation and guides for APIs and SDKs is NOT easy. Any tips out there?

Updated on Mar 05, 2019 ・1 min read

Any tips or sources on how-to writing really good documentation and guides for external APIs and SDKs?

Here are some resources I've found:


I'm not as experienced as the resources you listed but I've seen my share of docs. One big recommendation I can make is to take time to write really good examples. There's nothing worse than a full detailed documentation with no examples. The documentation needs to be very pragmatic as well, so keep that in mind in the future!


Well I would suggest you look at the OpenAPI specification you can look at my experience in working with APIs and documentation in my recent article here Diving into OpenAPI

Classic DEV Post from Oct 16 '18

Who is hiring? (As of October 2018)

Members of the dev.to community sharing open job opportunities at their companies.

Co-founder at Svrf

Sore eyes?

dev.to now has dark mode.

Go to the "misc" section of your settings and select night theme ❤️

(There is also a pink mode)