Batsify
I am a french who love coding the hard way (no AI), worked for a lot of startups until saturation, hope for a come back of social values instead of monetization of the poorest. Toots in 🇬🇧, please be indulgent.
Are you French? Take a look at my profile on Chapril: @batsify@pouet.chapril.org
Interesting article on API documentation best practices.
The author focuses on web APIs, but I think this article applies to classic APIs (those in our packages or that we generate ourselves for other teams).
In short, it's always advisable to provide two types of documentation: the specifications (the "what") and the API documentation (the "how").
https://inkwright.inc/blog/your-api-reference-is-not-your-api-documentation
I loved this article. It's something that resonates with me personally and in my professional life.
<< Neither decision involves asking the person using the software. The adding is driven by business metrics. The removing is driven by engineering metrics. The user is in neither equation. >>
I recommend reading: