Sinónimo de documentación
Documentación de referencia de la APILa documentación de referencia de la API proporciona información detallada sobre una función u objeto en Node.js. Esta documentación indica qué argumentos acepta un método, el valor de retorno de ese método y qué errores pueden estar relacionados con ese método. También indica qué métodos están disponibles para las diferentes versiones de Node.js.
Características de ES6La sección de ES6 describe los tres grupos de características de ES6, y detalla qué características están activadas por defecto en Node.js, junto con enlaces explicativos. También muestra cómo encontrar la versión de V8 que viene con una versión particular de Node.js.
Marco documental
Los redactores técnicos y los comunicadores corporativos son profesionales cuyo campo y trabajo es la documentación. Lo ideal es que los redactores técnicos tengan experiencia tanto en la materia como en la redacción, la gestión de contenidos y la arquitectura de la información. Los redactores técnicos suelen colaborar con expertos en la materia (PYMES), como ingenieros, expertos técnicos, profesionales de la medicina, etc., para definir y luego crear documentación que satisfaga las necesidades del usuario. Las comunicaciones corporativas incluyen otros tipos de documentación escrita, por ejemplo:
Un tipo común de documento de software escrito en la industria de la simulación es el SDF. Cuando se desarrolla software para un simulador, que puede ir desde dispositivos de aviónica integrados hasta bases de datos de terrenos en 3D pasando por sistemas completos de control de movimiento, el ingeniero lleva un cuaderno en el que se detalla el desarrollo “la construcción” del proyecto o módulo. El documento puede ser una página wiki, un documento de MS Word u otro entorno. Debe contener una sección de requisitos, una sección de interfaz para detallar la interfaz de comunicación del software. A menudo se utiliza una sección de notas para detallar la prueba de concepto, y luego hacer un seguimiento de los errores y las mejoras. Por último, una sección de pruebas para documentar cómo se ha probado el software. Esto documenta la conformidad con los requisitos del cliente. El resultado es una descripción detallada de cómo está diseñado el software, cómo construirlo e instalarlo en el dispositivo de destino, y cualquier defecto conocido y solución. Este documento de construcción permite a los futuros desarrolladores y mantenedores ponerse al día con el software de manera oportuna, y también proporciona una hoja de ruta para modificar el código o buscar errores.
Documentación de la investigación
Cuando desarrolle módulos para que los utilicen otros desarrolladores, puede seguir un flujo de trabajo que ayude a garantizar una experiencia fiable y coherente para los desarrolladores que utilicen el módulo. Este tema describe los pasos de alto nivel de ese flujo de trabajo.
Cuando desarrolle módulos para publicarlos para que otros los usen, puede ayudar a garantizar que sus módulos sean más fáciles de usar para otros desarrolladores siguiendo las convenciones del repositorio descritas en este tema.
El desarrollador de un módulo utiliza cada parte del número de versión de un módulo para señalar la estabilidad de la versión y la compatibilidad con versiones anteriores. Para cada nueva versión, el número de versión de un módulo refleja específicamente la naturaleza de los cambios del módulo desde la versión anterior.
Generador de documentación
La gestión de ganchos introducida en 2020 está destinada en gran medida a los desarrolladores de paquetes. Sin embargo, la mayoría de los ganchos disponibles también pueden ser útiles para los autores de documentos. Actualmente, la documentación está dividida en varios documentos:
El nuevo mecanismo de marcas introducido en 2022 ofrece muchas marcas arbitrarias independientes y resuelve los problemas con las marcas heredadas de LaTeX (disponibles a través de \markbox y \markright). El mecanismo antiguo sigue estando disponible para que las clases que lo utilizan sigan funcionando sin necesidad de actualizaciones.
Hay mucha documentación en otros idiomas además del inglés. Los grupos de usuarios de TeX de los respectivos países mantienen listas de libros y otros recursos en otros idiomas. Nosotros conocemos los siguientes: