La documentación técnica es un término genérico para las clases de información creadas para describir (en lenguaje técnico ) el uso, la funcionalidad o la arquitectura de un producto, sistema o servicio.
Las clases de documentación técnica pueden incluir:
Históricamente, la mayoría de las clases de documentación técnica carecían de una conformidad universal (normas) en cuanto a formato, contenido y estructura. Se están elaborando normas para solucionar este problema a través de organismos como la Organización Internacional de Normalización (ISO), que ha publicado normas relacionadas con las reglas para la preparación de guías de usuario, manuales, especificaciones de productos, etc. para la documentación técnica de productos. Estas normas están contempladas en la norma ICS 01.110. [1] La documentación técnica de productos no contemplada en la norma ICS 01.110 se enumera en la subsección siguiente.
También se requiere una documentación técnica para los dispositivos médicos de acuerdo con la reglamentación de dispositivos médicos de la UE . El Anexo II, Documentación técnica, y el Anexo III, Documentación técnica sobre la vigilancia poscomercialización, del reglamento describen el contenido de una documentación técnica para un dispositivo médico . Esto incluye, por ejemplo, información sobre la especificación del dispositivo, etiquetado e instrucciones, diseño y fabricación, requisitos de seguridad y rendimiento, gestión de riesgos y la validación y verificación del dispositivo, incluida la evaluación clínica; y también información de la vigilancia poscomercialización .
Algunos sistemas de documentación se ocupan de los tipos o formas generales de documentación que constituyen un conjunto de documentación, así como (o más bien) de cómo se produce, publica o formatea la documentación.
Por ejemplo, el marco Diátaxis (que se utiliza principalmente en el campo de la documentación de software [8] ) postula cuatro formas de documentación distintas, correspondientes a cuatro necesidades de usuario diferentes: tutoriales , guías prácticas , referencia y explicación . [9] Por el contrario, DITA afirma cinco "tipos de temas" diferentes: Tarea , Concepto , Referencia , Entrada de glosario y Solución de problemas , mientras que el sistema de Documentación modular de RedHat utiliza tres "módulos": Concepto , Procedimiento y Referencia . [10]