Post History

Source: https://writers.stackexchange.com/a/47400
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/

First of all, let’s make it clear, what API means. API stands for Application Programming Interface. API is a set of tools, communication protocols, and subroutine definitions for building software. Generally speaking, API is a kind of communication channel that allows two separate programs to communicate. How does it work? API is also a part of your daily life. For example, you need to turn on your TV from a distance. You press the ON/OFF button on remote control and the TV turns on. This is how API works. Radio/infrared waves through which a remote control communicates with a TV set act as an API in this case. APIs can be divided into three groups:

- Software API 
- SCPI (Hardware API)
- WebAPI

Technical writers develop documentation that includes instructions about how to effectively use a hardware (SCPIs), web-API, or software API. Usually, API documentation contains all the information required to work with the API; it also contains details about classes, functions, arguments, and the like, supported by examples and tutorials. API documentation is usually created by means of regular tools and editors.

More information why this documentation matters is here: [What is API Documentation](https://medium.com/technical-writing-is-easy/what-is-api-documentation-fdc3f8bedb6f)

Original score: 3