World Library  
Flag as Inappropriate
Email this Article

API writer

Article Id: WHEBN0020607333
Reproduction Date:

Title: API writer  
Author: World Heritage Encyclopedia
Language: English
Subject: Software documentation, Application programming interfaces, Application programming interface
Publisher: World Heritage Encyclopedia

API writer

An API writer is a technical writer who writes documents that describe an application programming interface (API). The primary audience includes programmers, developers, system architects, and system designers.


An API is a basic library consisting of interfaces, functions, classes, structures, enumerations, etc. for building a software application. It is used by development teams to interact with and extend the software. An API for a given programming language and system may consist of system-defined and user-defined constructs. As the number and complexity of these constructs increases, it becomes very tedious for developers to remember all of the functions and the parameters defined. Hence, the API writers play a key role in building software applications.

Due to the technical subject matter, API writers must understand application source code enough to extract the information that API documents require. Some common tools used by API writers include computer software that extracts documentation placed by programmers in the source code in a structured manner, preserving the relationships between those comments and the programming constructs they document.

API writers must also understand the software platform/product and document the new features or changes as part of the new software release. The schedule of software releases varies from organization to organization. The writers need to understand the software life cycle well and integrate themselves into the Systems Development Life Cycle.

API writers in the United States generally follow The Chicago Manual of Style for grammar and punctuation.


API writers typically possess a mix of programming and language skills; many API writers have backgrounds in programming or technical writing.

Expert API/SDK writers can easily become programming writers.

API writing process

About 60% of the time spent in the writing process consists of analyzing and understanding the source code and planning the document(s). The remaining 40% of the time would typically be spent writing and reviewing the document(s). It is often the case that the analytical, planning, and writing stages do not occur in a strictly linear fashion.

A good foundation of a variety of programming skills is well-complemented by an ability to communicate effectively, especially when the writer seeks to develop a fluent level of understanding with developers.

This process is one of the most important challenges faced by end-user product documentation.


API writers produce documents that include:

  • API Reference Guides
  • Programmers' Guides
  • Developer Manuals
  • Administration Manuals
  • Installation Guides


  • Documenting APIs: Writing Developer Documentation for Java APIs and SDKs

See also

External links

Technical writing
This article was sourced from Creative Commons Attribution-ShareAlike License; additional terms may apply. World Heritage Encyclopedia content is assembled from numerous content providers, Open Access Publishing, and in compliance with The Fair Access to Science and Technology Research Act (FASTR), Wikimedia Foundation, Inc., Public Library of Science, The Encyclopedia of Life, Open Book Publishers (OBP), PubMed, U.S. National Library of Medicine, National Center for Biotechnology Information, U.S. National Library of Medicine, National Institutes of Health (NIH), U.S. Department of Health & Human Services, and, which sources content from all federal, state, local, tribal, and territorial government publication portals (.gov, .mil, .edu). Funding for and content contributors is made possible from the U.S. Congress, E-Government Act of 2002.
Crowd sourced content that is contributed to World Heritage Encyclopedia is peer reviewed and edited by our editorial staff to ensure quality scholarly research articles.
By using this site, you agree to the Terms of Use and Privacy Policy. World Heritage Encyclopedia™ is a registered trademark of the World Public Library Association, a non-profit organization.

Copyright © World Library Foundation. All rights reserved. eBooks from World eBook Library are sponsored by the World Library Foundation,
a 501c(4) Member's Support Non-Profit Organization, and is NOT affiliated with any governmental agency or department.