Hispanopedia WikiLa 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 .
Clases de documentación técnica
Las clases de documentación técnica pueden incluir:
- patentes
- Especificaciones del artículo o de los componentes/materiales
- fichas técnicas 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, incluidos los necesarios para el desarrollo, las pruebas, la fabricación, la operación y el mantenimiento del sistema.
Estandarización de la documentación técnica
Históricamente, la mayoría de las clases de documentación técnica carecían de conformidad universal (estándares) en cuanto a formato, contenido y estructura. Se están desarrollando estándares para subsanar esta deficiencia a través de organismos como la Organización Internacional de Normalización (ISO), que ha publicado estándares relativos a las reglas para la preparación de guías de usuario, manuales, especificaciones de producto, etc., para la documentación técnica de productos. Estos estándares están cubiertos por la norma ICS 01.110. [ 1 ] La documentación técnica de productos no cubierta por la norma ICS 01.110 se enumera en la subsección siguiente.
Específico de la disciplina
Reglamento de Dispositivos Médicos de la UE
Según el Reglamento de Dispositivos Médicos de la UE, también se requiere documentación técnica para los 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 la documentación técnica para un dispositivo médico . Esto incluye, por ejemplo, información sobre las especificaciones 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; así como información de la vigilancia posterior a la comercialización .
Formatos para los datos de origen
Arquitectura y tipado de la documentación
Algunos sistemas de documentación se ocupan de los tipos o formatos generales de documentación que constituyen un conjunto de documentos, así como (o en lugar de) 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 ] ) propone cuatro formas de documentación distintas, que corresponden a cuatro necesidades diferentes del usuario: tutoriales , guías prácticas , referencias y explicaciones . [ 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 Red Hat utiliza tres "módulos": Concepto , Procedimiento y Referencia . [ 10 ]
Véase también
Citas
- ↑ "01.110: Documentación técnica del producto" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 15787:2001 Documentación técnica del producto - Piezas ferrosas tratadas térmicamente - Presentación e indicaciones" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 3098-0:1997 Documentación técnica del producto - Rotulación - Parte 0: Requisitos generales" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 10209-1:1992 Documentación técnica de productos - Vocabulario - Parte 1: Términos relacionados con dibujos técnicos: generalidades y tipos de dibujos" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 2162-1:1993 Documentación técnica de productos - Muelles - Parte 1: Representación simplificada" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 5457:1999 Documentación técnica del producto - Tamaños y disposición de las hojas de dibujo" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ ISO6433 Documentación técnica del producto. Referencias de las partes , BSI British Standards, doi : 10.3403/30203812 , hdl : 20.500.12259/288139 , consultado el 16 de diciembre de 2020.
- ↑ "Lista parcial de conjuntos de documentación de Diátaxis" . Consultado el 10 de abril de 2021 .
- ↑ "Esquema de los formularios de documentación de Diátaxis" . Archivado del original el 16 de abril de 2021. Recuperado el 10 de abril de 2021 .
- ↑ "Términos y definiciones de la documentación modular de Red Hat" . Consultado el 11 de abril de 2021 .
- Documentos
- Comunicación técnica