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 library consisting of interfaces, functions, classes, structures, enumerations, etc. for building a software application. It is used by developers to interact with and extend the software. An API for a given programming language or 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. API writers often use tooling that extracts software documentation placed by programmers in the source code in a structured manner, preserving the relationships between the comments and the programming constructs they document.
API writers must also understand the software 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. API writers need to understand the software life cycle well and integrate themselves into the systems development life cycle (SDLC).
API writers in the United States generally follow The Chicago Manual of Style for grammar and punctuation.[citation needed]
API writers typically possess a mix of programming and language skills; many API writers have backgrounds in programming or technical writing.
Expert API/software development kit (SDK) writers can easily become programming writers.
El proceso de escritura de API generalmente se divide entre el análisis y la comprensión del código fuente , la planificación, la escritura y la revisión. A menudo, las etapas de análisis, planificación y escritura no ocurren de manera estrictamente lineal.
Los criterios de redacción y evaluación varían entre las distintas organizaciones. Algunos de los documentos de API más eficaces son escritos por personas que son lo suficientemente capaces de comprender el funcionamiento de una aplicación en particular, de modo que puedan relacionar el software con los usuarios o los diversos componentes con el propósito general del programa. Los redactores de API también pueden ser responsables de redactar la documentación del producto para el usuario final .
Si bien la documentación de referencia se puede generar automáticamente para garantizar su integridad, la documentación que ayuda a los desarrolladores a comenzar debe ser escrita por un escritor de API profesional y revisada por expertos en la materia. [1] Esto ayuda a garantizar que los desarrolladores comprendan los conceptos clave y puedan comenzar rápidamente.
Los escritores de API producen documentos que incluyen: