Jump to content

API writer

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Paulmnguyen (talk | contribs) at 04:42, 21 July 2010 (→Qualifications: copy edit). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

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.

Overview

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 of America generally follow The Chicago Manual of Style for grammar and punctuation.

Product

API writers produce documents that include:

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

API technical process

This is one of the most important challenges faced by technical writers or whoever is interested in moving to API documentation. The writing and evaluation criteria varies between organizations. It is usually most beneficial for API writers to possess a broad and thorough knowledge of programming structure and syntax, while also being adequately capable of understanding the workings of a particular given application with a greater level of detail related to the specific classes or interfaces from which its usefulness derives.

60% of the tasks encountered in the writing process involve analyzing, planning, and understanding the code/functions, while the remaining 40% of time would typically be spent actually writing and reviewing implementations. Hence, a very solid understanding of the process is of key importance to API writers as they frequent between planning and implementation phases. 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. Finally, API writers may also be at least partly responsible for authoring product documentation outlining and specifying things like included program content, methods of implementation, and many other relevant details.

Qualifications

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.

Resources

Books

See also

Technical writing
Retrieved from "https://en.wikipedia.org/w/index.php?title=API_writer&oldid=374617592"