Development Services for Startups

When Good Enough
is Not an Option

Development and Quality Assurance Resources

The ABC of API Documentation

What is API Documentation?

API stands for application programming interface. It is an interface used by programmers to work with (or interface with) an application. In today’s world of ever specialized applications, standalone software is extremely rare. Developing complete solutions requires working with applications from other parties. To successfully do this, programmers require well written API documentation. API documentation is also required to develop applications on platforms provided by companies such as Google, Intuit, Sun, and etc.

API documentation is writing about software code. Having a technical background helps. Today, however, companies don’t always have the luxury of hiring writers with technical backgrounds, so “nonā€technical” writers are being asked to help out with API documentation. For writers without technical backgrounds, API documentation is often technical and mysterious – a cause for instant stress. This white paper will try to demystify API documentation to help writers get started with writing API documentation.