API writing

Don't be scared. It's still writing! Nowadays, with so much advancement in technology, the one buzzword that keeps buzzing around is API.

Application Programmer Interface.

The technical definition for an API would be: A library containing interfaces, functions, classes, structures, etc. for building a software application. It is used by development team to interact with and extend the software.

If you are reading this for the first time, the technical definition is surely difficult for you to begin with. Let's understand this in a non-technical language.

How about a anatomy among a patient, the receptionist, and the doctor. If you are sick, you'll call the doctor's number, and speak to a receptionist in few simple instructional language. "I'm sick. This is my problem. I request an appointment with the doctor." As a response, the receptionist will fetch your old record, understand your existing illness, go through the doctor's schedule, and will offer you a time slot for your visit.

An API does something similar. It allows you to interact with a complex system to fetch the information you need without dealing with the internal complexities.

What is our role play? We, as technical writers, need to document the interface that is connecting multiple software. Currently, RESTful APIs are the most common and easy-to-use APIs in the market. There are many other Web-based and Platform-based API too.

Do not worry when the next time you are asked to work on a API project. You need to develop the documentation and not the API! So, relax! And, Good luck!