Cómo escribir un manual de usuario

1. Subestimar la importancia del manual de usuario

El primer error que suele cometer quien tiene que escribir un manual de usuario o un manual de uso y mantenimiento de una máquina no tiene que ver tanto con el contenido como con la actitud. Hay quien lo considera una molestia, porque implica trabajo y costes adicionales, y hay quien lo considera superfluo porque «de todas formas, nadie lo lee».

¿Están justificadas estas consideraciones?

Es cierto que preparar un manual de instrucciones requiere tiempo y recursos, y también es cierto que el usuario no siempre lee las instrucciones desde la primera hasta la última palabra. Hay que recordar, sin embargo, que según la Directiva 2006/42/CE, también conocida como Directiva de Máquinas, el manual es parte integrante del producto y no un componente opcional o accesorio. Es un requisito para cumplir con los preceptos legales.

Sin embargo, la protección legal no debe ser la única razón para que una empresa cuide el contenido del manual que acompaña a sus productos.

Si tanto la información como las instrucciones son claras y comprensibles, se reducirán las consultas y las reclamaciones y, además, disminuirán los riesgos para el usuario, así como los daños y el mal funcionamiento. Como consecuencia, se reducen también los costes relacionados con la asistencia del cliente, con las sustituciones y con las posibles intervenciones.

2. Utilizar un lenguaje innecesariamente complejo

Uno de los errores más comunes tiene que ver con la elección de las palabras y de los términos. ¿Cuál es la diferencia? Las palabras pertenecen al vocabulario común, es decir, el que utilizamos habitualmente; mientras que los términos pertenecen a un vocabulario específico, que es propio de un producto y del sector al cual pertenece.

El error más común consiste en pensar que, al tratarse de un argumento complejo, las expresiones simples no son adecuadas. De hecho, precisamente porque los manuales suelen tratar temas complicados, es importante dar preferencia a un lenguaje que todos puedan entender.

Aunque parezca un consejo trivial, podemos echar mano del Apéndice de 1000 palabras básicas en español, una recopilación que recoge las palabras más utilizadas y comprendidas por la mayoría de los hablantes de la lengua española.

Por ejemplo, en lugar de «presumiblemente», que no está registrada en este apéndice, se puede utilizar «probablemente», que sí lo está.

Además de las palabras que pertenecen a un registro más alto, son también frecuentes expresiones cristalizadas, es decir, que usamos por costumbre. «Realizar un agujero» o «efectuar un corte» pueden sustituirse por «agujerear» y «cortar», que son más breves y directas.

¿Y en cuanto a la terminología?

En primer lugar, hay que preguntarse a quién está dirigido el manual. ¿Se trata de un usuario experto, por ejemplo un ingeniero, o un usuario principiante? Para el último caso, se explica el significado de los términos. Para ayudar a los usuarios menos experimentados, se puede crear un glosario, es decir, una lista de términos con sus correspondientes explicaciones.

El glosario puede ser desde una simple recopilación de términos acompañada de una breve definición, hasta una completa base de datos terminológica, en la que se explica cada concepto, se ilustra con dibujos o fotografías e incluso se traduce a todos los idiomas necesarios.

3. Utilizar sinónimos innecesarios

En contra de lo que podría pensarse, y de lo que nos enseñaron en la escuela, utilizar sinónimos es uno de los errores más comunes. «Dispositivo», «instrumento», «aparato», «artilugio», «máquina» o también «botón» y «tecla» se utilizan a menudo para evitar repeticiones.

Mientras que en un post o en un artículo los sinónimos enriquecen el texto, en un documento técnico crean ambigüedad. Si las instrucciones exigen el uso de la «llave Allen», esta llave debe llamarse así en todo el documento, sin utilizar «herramienta» y, en la siguiente frase, «instrumento» o similares, porque el usuario puede no entender a qué se refiere.

Analicemos el siguiente ejemplo:

En pocas líneas se utiliza «llave Allen», «herramienta» y «llave»: tres formas diferentes de referirse al mismo elemento. Cuando existe más de un término parar referirse a un objeto, incluso si todos son correctos, es indispensable elegir uno y conservarlo a lo largo de todo el texto.

4. Utilizar lenguaje de jerga o abreviaturas técnicas sin explicación

Otro error que hay que evitar es el uso de lenguaje de jerga o de abreviaturas técnicas que se dan sin ninguna explicación. Es importante utilizar la terminología oficial. «Black & Decker», por ejemplo, indica la marca y no el producto. No debería utilizarse en lugar de «taladro».

Deben evitarse los coloquialismos: se puede decir «enganchar» hablando con los amigos, pero en un manual es más correcto escribir «conectar».

En el ejemplo citado en el apartado anterior, podrían aparecer también abreviaturas: Por ejemplo, si queremos mencionar la «IMU» en nuestro texto, debería explicitarse que estas letras corresponden a las siglas en inglés de «Unidad de medición inercial» [«Inertial measurement unit»]. En el lenguaje técnico se suelen utilizar formas abreviadas, como las siglas o los acrónimos. Son útiles porque ahorran espacio y agilizan la lectura, pero hay que utilizarlos de forma sistemática.

Si un redactor técnico decide utilizar una abreviatura, debe explicar su significado la primera vez que aparezca y luego utilizarla en todo el documento.

Por ejemplo: «Unidad de medición inercial» y, a partir de ahí, ya se podría referir en cada ocasión como «IMU», indicando preferiblemente que las siglas corresponden a las siglas en inglés.

Advertencia La abreviatura debe escribirse siempre de la misma manera: no se puede decir «IMU» y luego cambiar las siglas al español: «UMI». Además, si el manual posee muchas abreviaturas, es útil crear una lista que las recopile y explique su significado. El usuario podrá consultarla en caso de duda.

5. Utilizar un estilo redundante

La siguiente tabla muestra los errores más frecuentes y las sugerencias para escribir frases más directas y comprensibles.

Regla	Forma que debemos evitar	Forma aconsejada
Utiliza la forma activa, no la pasiva.	El cable de la antena debe estar conectado al enchufe.	Conecte el cable de la antena al enchufe.
	El software es utilizado para controlar los movimientos de la máquina.	El software controla los movimientos de la máquina.
Dale preferencia al indicativo frente a modos verbales más complejos como el subjuntivo o el condicional.	Si el aparato presentase defectos de fabricación, póngase en contacto con el servicio de atención al cliente.	Si el aparato presenta defectos de fabricación, póngase en contacto con el servicio de atención al cliente.
Sustituye las formas nominales por formas verbales.	El usuario tiene la posibilidad de hacer uso del derecho de devolución.	El usuario puede devolver el producto.
Utiliza expresiones directas.	Evite dejar que caiga el instrumento.	No deje caer el instrumento.
Elige expresiones cortas.	es capaz de transmitir procede a comprobar	transmite comprueba

6. Escribir incorrectamente las unidades de medida

Las unidades de medida son uno de los elementos más comunes en los manuales técnicos, pero hay mucha confusión sobre la forma correcta de escribirlas. Por ejemplo, no es correcto escribir:

Las formas correctas son:

Es decir, debe haber un espacio entre el número y la unidad de medida, y la unidad de medida debe escribirse según la norma internacional correspondiente.

En caso de duda, puedes consultar el Sistema Internacional de Unidades, también conocido como SI, que recoge las normas de escritura de las unidades de medida y sus símbolos.

7. No adaptar las cifras al mercado de destino

Los números y las unidades de medida, además, deben adaptarse al público destinatario. A menudo sucede que vemos documentos técnicos traducidos a español, en el que el separador de miles y decimales se utiliza según la normativa inglesa. Esto es incorrecto. En inglés, los números decimales se separan con un punto y los miles con coma.

• inglés: 15.10 - español: 15,10
• inglés: 10,000 - español: 10.000.

La confusión puede aumentar si por el contexto no se puede determinar el orden de magnitud y la cifra tiene tres decimales:

390,142

¿Significa eso trescientos noventa mil... o 390 coma...?

Las unidades de medida deben convertirse al sistema utilizado en el mercado al cual el manual está destinado. Existen otros sistemas que no utilizan la subdivisión decimal, como el sistema imperial británico de unidades de medida, utilizado en Reino Unido, en Canadá, Australia y también en Filipinas, entre otros, o el sistema americano.

Tomemos como ejemplo las medidas de longitud: mientras que nosotros utilizamos el sistema métrico, con centímetros y sus múltiplos o submúltiplos, los sistemas británico y estadounidense utilizan el sistema imperial, con pulgadas y pies. una pulgada (símbolo: in) corresponde a 2,54 cm, mientras que un pie (ft), corresponde a 30,50 cm. En este caso, los valores son iguales entre ambos sistemas. Sin embargo, si nos centramos en las medidas de capacidad, vemos que un galón (Imp gal) corresponde a 4,54 l en el sistema británico, mientras que en el americano a 3,78.

Es importante conocer estas diferencias, tanto para que el usuario pueda entender los datos comunicados, como para que el hecho de no adaptar correctamente una unidad de medida pueda dar lugar a graves errores.

8. No escribir las instrucciones en el orden lógico en el que deben ejecutarse

Para facilitar la comprensión de las instrucciones y, por tanto, permitir que el usuario sea inmediatamente operativo, la información debe presentarse de forma clara y ordenada.

Los conceptos fundamentales son dos:

• cada frase debe expresar un solo concepto,
• las instrucciones se deben dar en el orden lógico y temporal en el que tienen que llevarse a cabo.

Esta frase contiene varios datos y la secuencia de acciones no refleja el orden en que deben realizarse. Podemos expresarlo de forma más clara:

Además de reescribir la frase, hemos dispuesto la información de forma ordenada mediante listas: una lista con viñetas y otra numérica La lista con viñetas introduce una lista de elementos o ítems, mientras que la numérica indica el orden en el cual deben ser realizadas las acciones.

9. No mejorar la redacción con lenguajes controlados

Los lenguajes controlados son lenguajes naturales que utilizan un número reducido de reglas sintácticas y estilísticas, así como de vocabulario. Se han desarrollado con el objetivo de simplificar y estandarizar la redacción de documentos técnicos, para mejorar la legibilidad y la comprensibilidad de textos, al mismo tiempo que reducen la ambigüedad.

Los más conocidos son:

• la especificación ASD-STE100, o [inglés técnico simplificado] (http://www.asd-ste100.org/), utilizada en la industria aeroespacial;
• el Italiano Técnico Simplificado (ITS), desarrollado por Com\&Tec, la Asociación Italiana para la Comunicación Técnica,
• el Español Técnico Simplificado (ETS) para el español,
• el Français Rationalisé para el francés.

¿Cómo se estructuran los lenguajes controlados?

Tanto el español técnico simplificado como el inglés técnico simplificado están estructurados en dos secciones:

• las instrucciones lingüísticas,
• el diccionario.

Las instrucciones lingüísticas describen las reglas gramaticales, sintácticas y estilísticas de la lengua, mientras que el vocabulario recoge un número reducido de voces que pueden ser utilizadas para escribir un texto.

¿Cuáles son las reglas de los lenguajes controlados?

Cada lenguaje controlado tiene sus propias reglas, pero pueden tener principios en común:

• una frase debe contener un número limitado de palabras, 25-30 como máximo,
• cada frase debe expresar un solo concepto,
• escribe siempre la misma frase para expresar el mismo concepto,
• utiliza la forma activa y no la pasiva,
• no utilices modos verbales de difícil interpretación como el subjuntivo o el condicional, dale prioridad al indicativo,
• no omitas el sujeto, los artículos ni los adjetivos demostrativos,
• no uses pronombres, repite el nombre,
• no utilices sinónimos, repite la palabra o el término,
• no utilices frases hechas.

Si las indicaciones son complejas o rígidas, si no hay recursos para adoptar el lenguaje controlado en su totalidad o si no es posible recurrir a expertos externos, no es necesario aplicarlo todo.

Podemos tomar ejemplo de los principios y crear normas de redacción para la empresa y preparar listas con la terminología oficial o las palabras que se deben preferir o evitar.

Los lenguajes controlados se desarrollaron no solo para mejorar la comunicación escrita en ámbitos técnicos, sino también para aumentar la traducibilidad de los textos. Gracias a la coherencia que subyace en las elecciones lingüísticas y a la simplificación de las estructuras, podemos reducir el tiempo y los costes de traducción. Son además especialmente aconsejables para la redacción de textos que vayan a ser traducidos mediante sistemas de traducción automática.

Si quieres saber más sobre este tema, en nuestro blog puedes encontrar el post «El lenguaje controlado» con una entrevista a Daniela Zambrini, associate member de STEMG desde 2014, el grupo de trabajo encargado del mantenimiento de la especificación ASD-STE100.

10. No estructurar la información de forma lógica y ordenada

Un manual no es un libro. El usuario medio no suele leerlo desde la primera hasta la última página.

¿Cuántas veces compramos un producto e intentamos hacerlo funcionar sin recurrir al manual de instrucciones? En un momento dado, nos damos cuenta de que no estamos capacitados y empezamos a «navegar» por el manual, buscando información que nos sea útil. Quizás logremos ensamblarlo, pero no sabemos qué es ese último componente que nos quedó sin ubicar, y lo que es peor, no sabemos ni cómo se llama.

A menos que las instrucciones sean de dos páginas, es útil que el manual incluya:

• un resumen,
• una lista de abreviaturas,
• un índice de figuras y tablas,
• una lista de palabras clave en orden alfabético,
• el despiece con los componentes y la leyenda,
• un glosario que recoja los términos técnicos y los explique.

Todos estos elementos permiten al usuario encontrar fácilmente lo que busca.

Quien trabaja en el campo de los manuales y la escritura técnica utiliza (o debería utilizar) un software especial para la creación y gestión de documentos técnicos y manuales. Estas herramientas superan las limitaciones de Word o de InDesign y facilitan la gestión de contenidos y las actualizaciones.

Se agrupan bajo el acrónimo CCMS, que se corresponde con Component Content Management System y hace referencia a su función principal: la posibilidad de estructurar el contenido de forma granular, por componentes, en lugar de a nivel de documento.

Por ejemplo, si los manuales de usuario y de mantenimiento de diferentes máquinas o productos comparten las mismas advertencias de seguridad o notas de limpieza, el software CCMS le permite crear ese contenido común una vez y reutilizarlo tantas veces como sea necesario.

Estos sistemas suelen utilizar formatos estándar para crear información estructurada. Los dos estándares más conocidos son:

• DITA (Darwin Information Typing Architecture) y
• DocBook

pero también hay otros sectoriales, como SCORM para la creación de contenidos de formación o S1000D para el sector de defensa y aeroespacial.

11. Utilizar ilustraciones de baja calidad o poco claras

En un manual no solo es importante el contenido, sino también el aspecto gráfico y la información visual. Ten en cuenta que lo más probable es que el manual no se lea en un escritorio, sino en puestos de trabajo incómodos, con poca luz o en espacios reducidos.

Los títulos, las negritas, los párrafos suficientemente espaciados y las notas en los márgenes de las páginas facilitan la lectura, al igual que los elementos visuales que apoyan el texto. Las imágenes, los dibujos, los despieces, las tablas y los pictogramas atraen la atención, facilitan la comprensión, permiten escribir menos y, por tanto, ahorran costes de traducción.

Observa esta imagen del manual de instrucciones de un asiento para el automóvil:

Fuente: https://www.chicco.it/content/dam/chicco/it/pdf/in-viaggio/seggiolini-auto/8058664079445/youniverse-manuale-istruzioni.pdf

La imagen es clara: A simple vista, está claro que la distancia entre la parte inferior del reposacabezas y el hombro del niño debe ser de dos centímetros.

Las figuras y las tablas deben estar numeradas y deben estar acompañadas de una leyenda. Además, deben estar siempre actualizadas: si una revisión del texto incluye la imagen, esta debe modificarse en consecuencia.

En los manuales multilingües, si las imágenes contienen texto, este también debe traducirse. Para saber más sobre este tema puedes leer nuestro post «Cómo traducir el texto contenido en las imágenes».

¿Cómo verificar si un manual es comprensible?

Los autores de manuales a menudo son expertos en el campo y pueden dar por sentado aspectos que no son obvios para el usuario. Una forma de verificar si el contenido es claro, es hacérselo leer a alguien que no conoce el producto y, sobre todo, hacerlo seguir el procedimiento.

Sin embargo, no siempre es posible predecir todas las incidencias. Una vez que el producto está en el mercado, se pueden recibir informes y quejas por parte de los clientes. Estas observaciones resultan muy útiles y deberían utilizarse para mejorar el contenido del manual.

12. No planificar la traducción del manual a partir del primer borrador

La Directiva de Máquinas establece que «Toda máquina debe ir acompañada de su manual de instrucciones. (...)El manual de instrucciones deberá estar redactado en la lengua o lenguas oficiales comunitarias del Estado miembro donde se comercialice y/o se ponga en servicio la máquina».

Poner la documentación técnica a disposición en los idiomas de los mercados a los que se dirige no solo es una obligación real, sino que también permite que el producto llegue de manera eficaz al cliente, y no menos importante, reducir los costes asociados a la asistencia.

Muchas empresas cometen el error de ahorrar en costes relacionados con la traducción: a menudo se piensa que es suficiente traducir el manual a inglés, o que es mejor que la traducción sea realizada por un empleado que, si bien es un experto en el sector, no posee las cualidades necesarias de un traductor especializado.

Cuando tengas que traducir un manual:

• lee nuestra entrada 3 sencillos pasos para elegir un proveedor de servicios lingüísticos;
• escribe contenidos originales teniendo en cuenta que habrá que traducirlos;
• poner a una persona a disposición del proveedor de la traducción para resolver cualquier duda.

6 conceptos para concluir

1. Simplicidad, claridad y coherencia son las palabras clave para escribir un manual.
2. El deseo del usuario es utilizar el producto lo antes posible: inserta imágenes y dibujos para facilitar la comprensión y elementos como el índice de contenidos, el índice de abreviaturas y la lista de palabras clave para facilitar la consulta.
3. Recuerda que el usuario no tiene la misma formación que quien escribe el manual: no des nada por sentado.
4. Ponte en el lugar del usuario e intenta anticiparte a sus preguntas.
5. Cuida las traducciones como el original.
6. Un manual bien redactado te permite reducir los costes asociados a las solicitudes de asistencia y a las reclamaciones.

Lecturas recomendadas

• Norma IEC 82079-1:2012 «Preparation of instructions for use -- Structuring, content and presentation General principles and detailed requirements» (Preparación de instrucciones para su uso – Estructura, contenido y presentación), disponible previo pago en la web de la UNI, el organismo de normalización italiano.
• Especificación ASD-STE100 (Simplified Technical English).
• Italiano Técnico Simplificado, de Ilaria Gobbi.
• Guía de español técnico simplificado. Un lenguaje controlado para la redacción de manuales técnicos en español, de Ilaria Gobbi.