API writer
The API is an acronym for Application Programming Interface. API is often used in documentation, discussions or other communications in reference to all of the programming interfaces.
API Writer is an individual involved in writing documents targeted towards developers, system architects and designers. Some of the documents worked on by API Writer are:
- API Reference Guide
- Programmer's Guide
- Developer Manual
- Administration Manual
- Installation Guide
API Writer is expected to understand the code written by developers and extract the relevant information to be published in the document. There are not many standard procedure or templates used by API Writers.
Qualification
Usually, API writers possess a mix of programming and language abilities. It’s good to have programming background but again it’s not mandatory. Many API writers switch from programming or technical writing.
- Programming background (Knowledge of C, C++, Java, Assembly, etc.)
- Knowledge of tools like Doxygen, Javadoc, or FrameMaker
- Excellent communication and writing skills to interact with developers
Expert API/SDK writers can easily become Programming writers.
Resources
- API Writing Blog
- Yesterday API was just another acronym
- API Template
- Resources / Links for API Documentation
- Documenting Your First API