Un escritor de API es un escritor técnico que escribe documentos que describen una interfaz de programación de aplicaciones (API). El público principal incluye programadores, desarrolladores, arquitectos de sistemas y diseñadores de sistemas.
Una API es una biblioteca que consta de interfaces, funciones, clases , estructuras, enumeraciones, etc. para crear una aplicación de software. Los desarrolladores la utilizan para interactuar con el software y ampliarlo. Una API para un lenguaje de programación o sistema determinado puede constar de construcciones definidas por el sistema y por el usuario. A medida que aumenta la cantidad y la complejidad de estas construcciones, resulta muy tedioso para los desarrolladores recordar todas las funciones y los parámetros definidos. Por lo tanto, los escritores de API desempeñan un papel clave en la creación de aplicaciones de software .
Debido a la temática técnica, los escritores de API deben comprender el código fuente de la aplicación lo suficiente como para extraer la información que requieren los documentos de API. Los escritores de API suelen utilizar herramientas que extraen la documentación del software colocada por los programadores en el código fuente de manera estructurada, preservando las relaciones entre los comentarios y las construcciones de programación que documentan.
Los redactores de API también deben comprender el producto de software y documentar las nuevas características o cambios como parte del nuevo lanzamiento del software. El cronograma de lanzamientos de software varía de una organización a otra. Los redactores de API deben comprender bien el ciclo de vida del software e integrarse en el ciclo de vida del desarrollo de sistemas (SDLC).
Los escritores de API en los Estados Unidos generalmente siguen el Manual de estilo de Chicago para gramática y puntuación . [ cita requerida ]
Los escritores de API generalmente poseen una combinación de habilidades de programación y lenguaje; muchos escritores de API tienen experiencia en programación o redacción técnica .
Los escritores expertos en API/ kits de desarrollo de software (SDK) pueden convertirse fácilmente en escritores de programación .
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 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: