Internamente
Los redactores técnicos trabajan con un procesador de textos, una herramienta DITA o un sistema S1000D.
Glosario
¿Qué es la documentación técnica?
Los documentos que explican cómo funciona un producto y cómo instalarlo, usarlo, mantenerlo, repararlo y fabricarlo.
A lo largo de la vida de un producto.
Algunos documentos se quedan con el fabricante. Los demás acompañan al producto.
La documentación técnica a lo largo de la vida de un producto
-
Diseñar y fabricar
- Planos y modelos 3D
- Lista de materiales
- Procedimientos operativos estándar
- Instrucciones de trabajo
-
Demostrar la conformidad
- Expediente técnico
- Evaluación de riesgos
- Declaración UE de conformidad
-
Instalar y utilizar
- Manual de instalación
- Manual de usuario o de operador
- Guía de inicio rápido
- Instrucciones de seguridad
-
Mantener y reparar
- Manual de mantenimiento
- Guía de resolución de problemas
- Catálogo ilustrado de piezas
- Boletines de servicio
-
Formar a las personas
- Cursos de formación
- Ayudas de trabajo
- Animaciones y vistas 3D
En la legislación de la UE, un sentido más estricto.
El expediente que conserva un fabricante para demostrar que un producto es conforme. Ese expediente es para las autoridades, no para los usuarios.
Más detalles
En la legislación de productos de la UE, el término también tiene un sentido más estricto: el expediente que conserva un fabricante para demostrar que un producto es conforme, con sus datos de diseño, su evaluación de riesgos y sus informes de ensayo. Para las máquinas, el anexo IV del Reglamento de Máquinas fija su contenido.
Los tipos principales. Y quién los lee.
| Documento | Lector | Qué cubre |
|---|---|---|
| Manual de usuario o de operador (instrucciones de uso) | Operadores y usuarios finales | Uso previsto, mandos, funcionamiento seguro, limpieza y averías sencillas |
| Manual de instalación | Instaladores e integradores | Transporte, elevación, montaje, conexión y puesta en marcha |
| Manual de mantenimiento y reparación | Técnicos de mantenimiento | Inspecciones e intervalos, desmontaje e instalación, ajustes y pruebas |
| Instrucciones de trabajo | Operarios y montadores | Cómo hacer una tarea, paso a paso, en el puesto de trabajo |
| Catálogo ilustrado de piezas | Técnicos y compradores de repuestos | Vistas explosionadas y listas de piezas para identificar y pedir piezas |
| Material de formación | Alumnos y formadores | Cursos, ejercicios y animaciones basados en la documentación |
| Expediente técnico | El fabricante y las autoridades | Datos de diseño, evaluación de riesgos e informes de ensayo que demuestran la conformidad |
Las normas que le dan forma.
- IEC/IEEE 82079-1:2019 Elaboración de la información para el uso (instrucciones de uso) de los productos. La norma internacional general para las instrucciones, del contenido y la estructura a la redacción y la presentación.
- ISO 20607:2019 Los principios de redacción del manual de instrucciones de las máquinas.
- S1000D La especificación internacional para publicaciones técnicas modulares en el sector aeroespacial y de defensa, basada en módulos de datos XML. ¿Qué es S1000D?
- ASD-STE100 Simplified Technical English Un lenguaje controlado, con un diccionario y reglas de redacción que hacen inequívocos los textos de mantenimiento en inglés. La edición 9 se publicó en enero de 2025.
- ATA iSpec 2200 La norma que usan las aerolíneas y los fabricantes de aeronaves para la documentación de mantenimiento.
- DITA Una norma XML de OASIS para documentación basada en temas, habitual en software y electrónica.
- Legislación de productos En la UE, el Reglamento de Máquinas (UE) 2023/1230 y otras normas de producto fijan lo que deben contener las instrucciones y en qué idioma.
Cómo es una buena página de manual.
Un encabezado de tarea, una advertencia, una figura, las herramientas y piezas, y después los pasos.
- 1Encabezado de tarea: número, título, a qué se aplica, herramientas y software
- 2Aviso de seguridad, antes del primer paso
- 3Figura generada a partir del modelo 3D, con números de referencia
- 4Tabla de herramientas y piezas, con cantidades
- 5Pasos numerados de desmontaje e instalación, con una precaución donde corresponde
- 6Pie de página con el número de documento, la revisión y la fecha
- Escrita para la tarea del lector, no para la estructura del producto.
- Una acción por paso, en imperativo, con un elemento visual para cada paso.
- Advertencias colocadas antes del paso al que se refieren.
- El mismo término para la misma cosa, idealmente de un vocabulario controlado.
- Una versión aprobada y vigente, fácil de encontrar donde se hace el trabajo.
- Actualizada con cada cambio de ingeniería.
Internamente, como servicio o con software.
Como servicio
TwinWorks redacta manuales de instalación, uso y mantenimiento, procedimientos y catálogos ilustrados de repuestos a partir de tus fuentes de ingeniería y de entrevistas con tus expertos, que aprueban el resultado.
Ver los servicios de redacción técnicaCon software
TwinWorks es un software de publicaciones técnicas asistido por IA que prepara borradores listos para revisión a partir de manuales vinculados y datos de ingeniería analizados; los expertos editan, revisan, aprueban, versionan y publican documentación web y PDF.
Ver el software de publicaciones técnicasPreguntas
¿Qué es la documentación técnica?
La documentación técnica es el conjunto de documentos que explican cómo funciona un producto y cómo instalarlo, usarlo, mantenerlo, repararlo y fabricarlo: manuales de usuario y de operador, manuales de instalación, manuales de mantenimiento, instrucciones de trabajo, catálogos de piezas y material de formación. La elaboran redactores técnicos a partir de los datos de ingeniería y del conocimiento de los expertos, y para muchos productos la exige la ley, por ejemplo el Reglamento de Máquinas de la UE.
¿Cuáles son los tipos de documentación técnica?
Los tipos principales son los manuales de usuario y de operador, los manuales de instalación, los manuales de mantenimiento y reparación, las instrucciones de trabajo, los catálogos ilustrados de piezas, las guías de resolución de problemas y el material de formación, además del expediente técnico interno que demuestra la conformidad de un producto.
¿Cuál es la diferencia entre documentación técnica y documentación de usuario?
La documentación de usuario es la parte de la documentación técnica escrita para los usuarios finales, como el manual de usuario y la guía de inicio rápido. La documentación técnica también incluye documentos para instaladores, técnicos de mantenimiento, equipos de producción y autoridades.
¿Qué norma se aplica a las instrucciones de uso?
La IEC/IEEE 82079-1 es la norma internacional general para las instrucciones de uso de los productos. Las reglas sectoriales la complementan, como S1000D y ATA iSpec 2200 en el sector aeroespacial, y leyes como el Reglamento de Máquinas de la UE fijan lo que deben contener las instrucciones.
¿Quién redacta la documentación técnica?
Los redactores técnicos, que trabajan con los ingenieros y los expertos de campo que aportan y comprueban los datos. Muchos fabricantes también subcontratan parte del trabajo a servicios de redacción técnica.
Parte de una estructura probada
Plantillas gratuitas de manuales de usuario, SOP, instrucciones de trabajo, instrucciones de montaje y listas de materiales, listas para rellenar.
Actualizado