Over a million developers have joined DZone.

Is API Documentation a Waste of Time?

DZone's Guide to

Is API Documentation a Waste of Time?

· DevOps Zone ·
Free Resource

Easily enforce open source policies in real time and reduce MTTRs from six weeks to six seconds with the Sonatype Nexus Platform. See for yourself - Free Vulnerability Scanner. 

Application Programming Interface (API) documentation is a subset of Software Documentation. It is often embedded within the source code. API documentation is written in plain language which describes the functionality and usage of a particular type or method or variable.

I've evaluated many open source projects and realized that APIs are often not documented well. It is important for the community to know what the reasons behind this.

To try to find the reason behind the lack of API documentation, I created a survey. You can find it here.

We appreciate your time and effort. Your participation is highly valuable.

Thanks in advance!

Automate open source governance at scale across the entire software supply chain with the Nexus Platform. Learn more.


Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}