Usuario:Tramullas/Taller/Documentación técnica
Documentación técnica es una expresión genérica utilizada para identificar a los diferentes tipos de productos de información creados para describir y explicar (en lenguaje técnico) el uso, la funcionalidad o la arquitectura de un producto, sistema o servicio.
Clases de documentación técnica.
[editar]Los tipos de documentación técnica pueden incluir:
- Manuales y guías de usuario.
- Tutoriales.
- Patentes.
- Especificaciones del artículo o de los componentes/materiales.
- Hojas de datos del artículo o de los componentes/materiales.
- Métodos de prueba.
- Estándares de fabricación.
- Requisitos del sistema.
- Arquitectura del sistema.
- Documentos y datos de diseño del sistema o producto, incluidos los necesarios para su desarrollo, prueba, fabricación, operación y mantenimiento.
Estandarización de la documentación técnica
[editar]Hasta inicios del siglo XX la documentación técnica no comenzó un desarrollo específico. Hay que esperar a la publicación de varias obras de referencia, en la década de 1910, para encontrar los primeros manuales orientados al escritor y a la escritura técnicos. Se acuña la noción de la escritura técnica (technical writing), por oposición a otros géneros, y del escritor técnico (technical writer).
Históricamente, la mayoría de los tipos de documentación técnica carecían de conformidad universal (estándares) en su formato, contenido y estructura. Se están desarrollando estándares para corregir esta carencia a través de organismos como la Organización Internacional de Normalización (ISO), que ha publicado estándares relacionados 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. Estos estándares están cubiertos por ICS 01.110. [1] La documentación técnica del producto no cubierta por ICS 01.110 se enumera en la siguiente subsección.
Desde la proliferación de las herramientas de software, y en particular de las aplicaciones y servicios disponbles a través de internet, se ha desarrollado ampliamente el campo de la escritura y documentación técnica, en principio muy relacionada con la elaboración de materiales de referencia y apoyo para la documentación de código y aplicaciones.
Generadores de documentación
[editar]Desde la década de 2010 han ido apareciendo un buen número de herramientas para la generación de documentación digital. (meter lo nuevo de gestores no cms)
Normas específicas por disciplina
[editar]Formatos para datos de origen
[editar]Arquitectura y escritura de la documentación
[editar]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 en lugar de) cómo se produce, publica o formatea la documentación.
Por ejemplo, el marco Diátaxis (que se usa principalmente en el campo de la documentación de software [8]) postula cuatro formas de documentación distintas, correspondientes a cuatro necesidades diferentes del usuario: tutoriales, guías prácticas, referencia y explicación.[9] Por el contrario, DITA establece 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]
Reglamento de dispositivos médicos de la UE
[editar]La regulación de dispositivos médicos de la UE establece el requerimiento de una documentación técnica para dispositivos médicos. El Anexo II, Documentación técnica, y el Anexo III, Documentación técnica sobre vigilancia posterior a la comercializació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, el etiquetado y las instrucciones, el diseño y la fabricación, los requisitos de seguridad y rendimiento, la 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 posterior a la comercialización
Ver también
[editar]- Sistema de gestión de documentos.
- Ingeniería de métodos.
- Comunicacion tecnica.
- Edición (proceso).
- Archivo técnico.
Referencias
[editar]- ↑ «01.110: Technical product documentation». International Organization for Standardization. Consultado el 10 June 2009.
- ↑ «ISO 15787:2001 Technical product documentation -- Heat-treated ferrous parts -- Presentation and indications». International Organization for Standardization. Consultado el 10 June 2009.
- ↑ «ISO 3098-0:1997 Technical product documentation -- Lettering -- Part 0: General requirements». International Organization for Standardization. Consultado el 10 June 2009.
- ↑ «ISO 10209-1:1992 Technical product documentation -- Vocabulary -- Part 1: Terms relating to technical drawings: general and types of drawings». International Organization for Standardization. Consultado el 10 June 2009.
- ↑ «ISO 2162-1:1993 Technical product documentation -- Springs -- Part 1: Simplified representation». International Organization for Standardization. Consultado el 10 June 2009.
- ↑ «ISO 5457:1999 Technical product documentation -- Sizes and layout of drawing sheets». International Organization for Standardization. Consultado el 10 June 2009.
- ↑ ISO6433 Technical product documentation. Part references, BSI British Standards, doi:10.3403/30203812, consultado el 16 de diciembre de 2020.
- ↑ «Partial list of Diátaxis documentation sets». Consultado el 10 April 2021.
- ↑ «Outline of Diátaxis documentation forms». Consultado el 10 April 2021.
- ↑ «RedHat Modular Documentation terms and definitions». Consultado el 11 April 2021.
[[Categoría:Comunicación técnica]] [[Categoría:Documentos]]