“A README acts as the front door to an API, offering consumers brief and sufficient information to get started. A full documentation is a place where consumers go to when they need to find information about any detail of the API. Having one doesn't mean you shouldn't have the other. But, having a README is, in my opinion, the very minimum you can do if you're serious about your API. And, at the very minimum, there are three elements I'd consider.”
#APIs #APIDocumentation #Markdown #TechnicalWriting #Git #DocsAsCode
https://apichangelog.substack.com/p/three-elements-of-a-good-api-readme
#APIs #APIDocumentation #Markdown #TechnicalWriting #Git #DocsAsCode
https://apichangelog.substack.com/p/three-elements-of-a-good-api-readme
Three Elements of a Good API README
Sometimes, offering an API README is enough. What are the elements that make it good?Bruno Pedro (The API Changelog)