EspañolSER Blog Casos de éxito y Soluciones
Documentación técnica
Creación, archivado, períodos de conservación y mucho más
La documentación técnica es un concepto que engloba todos los documentos de un producto concreto que los fabricantes facilitan con fines informativos. Esta proporciona información, por ejemplo, sobre cómo las empresas ponen en marcha, revisan, limpian o reparan el equipo técnico o una máquina. También está vinculada a normas y requisitos legales. Los equipos técnicos y las máquinas solo funcionan si la documentación correspondiente es adecuada y está completa.
En este artículo, te mostramos cómo crear, archivar y almacenar documentos técnicos, y analizamos software diseñado para ayudarte a cumplir con las normas y procesos importantes.
¿Qué es la documentación técnica?
La documentación técnica es un conjunto de documentos que proporciona un fabricante para un producto, sistema o proceso técnico. «Documentación del producto» es sinónimo de «documentación técnica». Contiene toda la información que necesitan los usuarios y otras partes interesadas en el producto técnico para utilizarlo de forma segura y evaluar los riesgos adecuadamente, desde el diseño del producto hasta su fabricación y funcionamiento.
Organización de la documentación técnica
La documentación técnica no es una recopilación de documentos sueltos. Toda la información de uso técnicamente relevante se organiza y recopila para el grupo objetivo correspondiente, utilizando una terminología coherente y precisa. La terminología estandariza los requisitos de la documentación técnica en todos los documentos: define la estructura de la documentación, el diseño del documento y los procesos editoriales.
Dicho de otra forma: la documentación técnica sigue una norma común: clara, comprensible, coherente y traducible.
Tipos de documentación técnica
En general, la documentación técnica se divide en interna y externa.
Documentación técnica interna
A través de la documentación técnica interna, los fabricantes cumplen el requisito legal de facilitar documentación. Comienza con el desarrollo inicial de un producto y termina tras el período de conservación. A nivel interno, las empresas documentan todos los conocimientos relacionados con un producto.
Por ejemplo, la documentación técnica interna consiste en documentos relevantes para el desarrollo (continuado) o las pruebas de un producto. Recoge todas las versiones de un producto a lo largo de su ciclo de vida o instrucciones sobre cómo el equipo de IT ha resuelto los problemas técnicos hasta la fecha.
Documentación técnica externa
La documentación técnica externa incluye toda la información que un fabricante proporciona fuera de su organización. Por ejemplo, el fabricante proporciona a los usuarios finales instrucciones de funcionamiento, instalación, mantenimiento y reparación, así como especificaciones técnicas y fichas técnicas.
Elementos de la documentación técnica
Qué documentos técnicos forman parte de la documentación depende de a qué producto, sistema o proceso hagan referencia. Hay varios tipos de documentación. Según el contenido, lo ideal para documentarlo puede ser una imagen, un texto o un dibujo. También es importante que el formato elegido comunique el contenido con claridad y precisión,
el cual puede incluir, por ejemplo:
-
Introducción y descripción del producto
-
Instrucciones de uso e instalación
-
Información de seguridad y advertencias
-
Dibujos y esquemas técnicos
-
Evaluaciones de riesgos
-
Informes de registros y pruebas
-
Manual de emergencia y ayuda en línea
-
Normas utilizadas
Elaboración de documentación técnica
Un redactor técnico suele ser el encargado de crear la documentación técnica, procediendo paso a paso.
Análisis de necesidades y requisitos
La forma en la que un redactor técnico crea los documentos viene determinada por las normas legales, por los requisitos de las partes interesadas, como clientes y usuarios, y por las necesidades del propio producto. Con necesidades nos referimos a la documentación necesaria para proporcionar información completa y comprensible sobre el producto.
Por ejemplo, para montar un mueble se necesitan unas instrucciones de montaje. En cambio, para los equipos industriales, se necesitan unas complejas instrucciones de instalación y mantenimiento. Teniendo en cuenta todas las necesidades, el redactor técnico planifica el contenido, es decir, qué documentos pertenecen a la documentación técnica.
Investigación y aplicación
Los redactores técnicos, antes de empezar a escribir, estudian el contenido. Obtienen la información de diversas fuentes: desarrolladores, ingenieros o jefes de producto apoyan el proceso editorial, ya sea con aportaciones técnicas o validando el contenido.
Por ejemplo, el desarrollador proporciona información para programar un proceso de software, que luego el redactor técnico prepara a nivel textual y visual con un diseñador gráfico. Después, el programador comprueba de nuevo si la información se ha presentado correctamente.
A las empresas también les gusta que los usuarios finales revisen el desarrollo de la información en términos de usabilidad, lo que ayuda a las compañías a asegurarse de que las personas que en última instancia trabajan con la documentación técnica la entienden.
Publicación y actualizaciones
Una vez validado el resultado del trabajo, los directivos, como por ejemplo los jefes de producto, revisan de nuevo los documentos técnicos. Si toda la información es correcta, los aprueban y se publican.
La documentación técnica no suele ser algo estático. Sus redactores siempre añaden documentación adicional cuando hay algún cambio relacionado con el producto, ya sea una nueva actualización del software, un error detectado o un complemento.
Raffinerie Heide: Flexible processes & secure documentation
How Raffinerie Heide uses Doxis to manage information and processes, stay demonstrably compliant and improve business process efficiency.
Read nowCumplimiento normativo y aspectos legales
La documentación técnica es obligatoria para los fabricantes. También protege contra los riesgos de responsabilidad que puedan surgir en relación con un producto, es decir, la documentación técnica es parte de un producto y, por lo tanto, también parte de la responsabilidad de dicho producto.
O, dicho de otro modo, la documentación técnica es la prueba de que el fabricante ha cumplido todos los requisitos legales. Por eso los productos técnicos (como un dispositivo o un producto médico basado en software) solo pueden aparecer en el mercado cuando su documentación técnica está disponible. Esta es la base para garantizar que un producto es seguro y cumple todos los requisitos legales.
Cumplir con las normativas legales
En la Unión Europea, todos los productos comercializados tienen que llevar el marcado CE, si la directiva correspondiente lo exige. Es el caso, por ejemplo, de la Directiva relativa a las máquinas.
En general, el requisito de marcado CE se aplica a los productos que entran en el ámbito de aplicación de la directiva europea sobre salud, seguridad, compatibilidad electromagnética y protección medioambiental. Para estos productos, el fabricante está obligado a cumplir los objetivos de protección exigidos y a realizar un análisis de riesgos. Una empresa solo puede emitir una declaración de conformidad cuando se hayan cumplido los objetivos de protección y los riesgos se ajusten a las normas armonizadas de la UE.
Cuestiones de responsabilidad y responsabilidad del producto
Con la declaración de conformidad UE/CE, una empresa confirma que el producto cumple con las normas y directivas legales. En la mayoría de los casos es el propio fabricante, el importador o un distribuidor el que declara esta conformidad, por lo que la persona que introduce el producto en el mercado es la responsable de dicho producto.
Las reclamaciones por daños u otras cuestiones relativas a la responsabilidad surgen cuando no se cumplen los requisitos específicos de seguridad del producto o los elementos contractuales.
Normas importantes
Para garantizar que los documentos técnicos sean comprensibles y que la información se registre de conformidad con la ley, hay que respetar las normas pertinentes. Las normas más conocidas para la documentación técnica son:
-
IEC/IEEE 82079-1: proporciona información sobre los requisitos generales de la documentación técnica.
-
EN 82079-1: describe lo que hay que tener en cuenta al crear manuales de usuario.
-
ANSI Z535.6: regula cómo presentar las advertencias y los avisos de seguridad.
-
EN ISO 17100: explica a qué hay que prestar atención cuando se traduce documentación técnica y da consejos sobre el software de traducción a utilizar.
Períodos de conservación y archivado a largo plazo
El objeto de la documentación técnica no es solo el contenido de los documentos: cada documento individual es asimismo parte de la documentación técnica. Las empresas tienen que registrar cómo y dónde gestionan y archivan los documentos,
ya que estos forman parte del archivado a largo plazo. Los períodos de conservación habituales de los archivos a largo plazo son de entre seis y diez años. El período de conservación de la documentación técnica es de diez años. Durante este tiempo, las empresas guardan la documentación técnica en un archivo.
Durante el proceso de archivado, ten en cuenta lo siguiente: hay que garantizar en todo momento que los documentos se almacenan a prueba de auditorías y que se puede acceder a ellos rápidamente.
Desafíos que supone la documentación técnica
Los proyectos de documentación técnica son complejos, ya que regulan los aspectos legales, documentan los procesos de los productos, proporcionan información a los usuarios y operadores, y sirven de base para que un producto pueda comercializarse. Además, la documentación técnica sigue desarrollándose a medida que va pasando el tiempo, porque, a diferencia de lo que ocurría pasado, un producto ya no se crea y se mantiene tal cual para siempre. Los productos evolucionan, y su documentación, también.
La internacionalización de las empresas también es un reto para la documentación técnica: no basta con crear documentos en un solo idioma. Los redactores técnicos traducen la documentación a todas las lenguas de los países en los que se vende un producto.
En líneas generales, estos son los retos que supone la documentación técnica:
-
Cumplir siempre los requisitos legales, en constante cambio.
-
Traducir documentos a todos los idiomas necesarios.
-
Mantener una actualización constante.
-
Crear contenidos intuitivos.
-
Archivado a largo plazo a prueba de auditorías, durante al menos diez años.
Archivar documentos técnicos en Doxis
Los procesos estandarizados pueden ayudar a las empresas a superar estos retos. La gestión de la documentación técnica es un proceso tedioso para las empresas. Sin embargo, unos procesos eficientes como parte de un sistema de gestión documental (DMS) pueden automatizar y acelerar las actividades laborales y los procesos de archivado.
¿Qué es Doxis?
Doxis es una plataforma de servicios de contenido que integra documentos, procesos empresariales, colaboración y mucho más. Como DMS, Doxis gestiona la información en todos los sistemas. Por ejemplo, Doxis mejora tu sistema de gestión de información de producto (PIM) archivando documentos relevantes relacionados con los productos.
Doxis también dispone de integraciones que conectan ambos programas de software sin disrupción entre canales. Doxis funciona en segundo plano cuando utilizas tu PIM, y acelera los procesos.
Archivar documentos técnicos paso a paso en Doxis
Hola, Doxi, ¿cómo funciona Doxis como software para documentación técnica?
-
Organiza tus documentos: Doxis almacena los documentos en la carpeta de producto correspondiente y contextualizados.
-
Hace que tus procesos sean transparentes: el control de versiones garantiza que todas las versiones anteriores se conservan cuando actualizas tus documentos.
-
Proporciona estructuras de carpetas comprensibles: las estructuras de carpetas preconfiguradas muestran en qué idiomas están disponibles los documentos técnicos.
-
Trabaja para ti: Doxis activa flujos de trabajo cuando, por ejemplo, faltan traducciones.
-
Proporciona un acceso más rápido: todas las personas autorizadas pueden acceder a los documentos de manera rápida y sencilla. Esto acelera las búsquedas y las respuestas para las partes interesadas, como los clientes.
-
Archivos a largo plazo: Doxis almacena la información independientemente del formato, lo que permite archivarla a largo plazo.
-
Mejora la precisión de los procesos: utilizar un DMS moderno y estandarizado garantiza que sigues los estándares de cumplimiento.
Documentación técnica sin fisuras con Doxis
La documentación técnica recoge todo lo que constituye un producto desde el punto de vista técnico, desde su diseño hasta su funcionamiento. Con las instrucciones de uso, las instrucciones de montaje, otra información de uso y la información de seguridad, las empresas dejan claro interna y externamente que han cumplido los requisitos de uso.
La documentación técnica proporciona así una base legal para comercializar el producto, así como información completa para todos los que están en contacto con dicho producto. Con Doxis, puedes gestionar tus documentos técnicos de forma segura y eficaz, desde su desarrollo hasta su eliminación una vez transcurrido el período de conservación.