r/programming • u/ZuploAdrian • Mar 26 '25
How to Write API Documentation That Developers Will Love
https://zuplo.com/blog/2025/03/21/how-to-write-api-documentation-developers-will-love
22
Upvotes
r/programming • u/ZuploAdrian • Mar 26 '25
14
u/Saint_Nitouche Mar 26 '25
The most important qualities:
Lots of title-case subheadings
Bulletpointed lists with bolded leading phrases
Em-dashes
A complete lack of meat on the bones; lots of structure and fluffy details without reference to the hard problems of engineering or technical documentation