​En Qabiria expresamos todo nuestro apoyo a todas las personas que están enfrentándose en primera línea a la emergencia COVID-19 y a los que más sufren sus consecuencias. Además de seguir trabajando para ofrecer nuestros servicios de forma regular, estamos a disposición de clientes y proveedores para encontrar soluciones a cualquier dificultad que pueda surgir de la prolongada situación de emergencia.

12 errores a evitar si quieres escribir un manual de usuario

(1 Voto)
Etiquetado como :
12 errores a evitar si quieres escribir un manual de usuario

Artículo traducido al castellano por Gabriela Richarte.

A menudo, el primer error que comete quien escribe un manual de usuario, no tiene relación con el contenido, pero sí con la actitud con la que se encara. Algunos lo consideran un inconveniente porque significa más trabajo y un coste adicional; otros, lo considera algo superfluo porque, al final, "nadie lo lee".

¿Cómo se justifican estas actitudes? Ciertamente, la preparación de un manual requiere tiempo y recursos. También es cierto que no siempre leemos las instrucciones de la A a la Z. No nos olvidemos que el manual es una parte que integra el producto y no un componente facultativo o accesorio, además de que es un requisito de ley.

La protección desde el punto de vista legal no debe ser el único motivo por el que una empresa debe cuidar el contenido de un manual.

Si, tanto la información, como las instrucciones son claras y comprensibles, se reducirán los interrogantes y reclamos y, por lo tanto, disminuirán los riesgos para el usuario, los daños y el mal funcionamiento. Como consecuencia, se reducen los costos relacionados con la asistencia del cliente, con la sustitución y  las posibles intervenciones.

ERROR N. 1: subestimar la importancia del manual para el usuario en la propia actividad.

Veamos a continuación cuáles son las medidas para mejorar la calidad de los contenidos técnicos y evitar los errores más frecuentes.

Errores con el vocabulario

Uno de los errores más comunes, tiene que ver con la elección de palabras y 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, si el argumento es complejo, no existen expresiones simples. Como los manuales tienden a tratar temas que, en su mayoría, son complejos, es importante inclinarse por un lenguaje comprensible, fácil de seguir.

Podrá resultar un consejo muy sencillo, pero un recurso útil es recurrir a diccionarios o guías que recopilen palabras más utilizadas y comprensibles por la mayoría.

Por ejemplo, en lugar de "atisbar", se puede utilizar "contemplar" u "observar".

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 una observación" o "efectuar un análisis" pueden sustituirse con "observar" o "analizar".

ERROR N. 2: usar un lenguaje complejo por demás.

¿Cómo se gestiona 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? Si se trata de un principiante, entonces se explica el significado de los términos. Para ayudar a los usuarios expertos se puede crear un glosario, es decir, una lista de términos con su respectiva definición.

Contrario a lo que se suele pensar, el uso de sinónimos es uno de los errores más comunes. Tanto "dispositivo", "instrumento", "aparato", "máquina", "maquinaria", "herramienta" se podrían utilizar para evitar repeticiones.

Mientras que en un post o un artículo los sinónimos enriquecen el texto, en un documento técnico generan ambigüedad. Si las instrucciones prevén el uso de "tornillos", se conservará ese término para todo el manual y no se utilizará, por ejemplo "perno" o "remache" indistintamente porque esto confundiría al usuario.

Analicemos el siguiente ejemplo:

"Cómo configurar tu teléfono.
El aparato puede configurarse....[...] Para configurar el tel, se necesita...."

Se han utilizado "teléfono", "aparato", "tel": tres formas diferentes de referirse a la misma cosa. 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.

ERROR N. 3: usar sinónimos no necesarios.

También es importante usar la terminología oficial. "Fischer" y "Forbox", por ejemplo, indican la marca y no el producto. Se sustituyen por "tacos" y "pinza".

Deben evitarse los coloquialismos: se puede decir "coordinable" si estás hablando con amigos, pero en un manual es más correcto escribir "puede coordinarse con".

En el ejemplo anterior hay una abreviación: "tel". En lenguaje técnico, a menudo se usan formas abreviadas, como siglas o acrónimos. Resultan útiles porque economizan espacio y agiliza la lectura, pero deben ser utilizados con coherencia.

Si un editor técnico decide utilizar abreviaciones, debería explicar el significado tan solo la primera vez que aparece y, luego, utilizarla a lo largo del documento.

Por ejemplo: "El teléfono a configurar (en adelante tel)" ¡Atención! La abreviación se escribe siempre de la misma forma: si has utilizado "tel", no utilices luego "TEL" Además, si el manual posee muchas abreviaciones, es útil crear una lista que las reúna y explique su significado. El usuario podrá consultarlo en caso de duda.

ERROR N. 4: utilizar coloquialismos o abreviaturas técnicas sin su explicación.

Nivel estilístico

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

Regla Forma de evitar Forma sugerida
Utiliza la forma activa en lugar de la pasiva. El cable de la antena debe estar conectado al enchufe. Conecte el cable de la antena al enchufe.
  El software se utiliza para controlar los movimientos de la máquina. El software controla los movimientos de las máquinas.
Mejor utiliza el modo indicativo en lugar de modos verbales más complejos como el subjuntivo. Evita el condicional. Si el dispositivo tiene defectos de fábrica, póngase en contacto con el servicio de atención al cliente. Si el dispositivo presenta defectos de fábrica, contacta con el servicio de atención al cliente.
Reemplaza las formas nominales por las formas verbales. El usuario tiene la posibilidad de ejercer el derecho de desestimiento. El usuario puede devolver el producto.
Utiliza expresiones directas. Evita dejar caer el instrumento. No deje caer el instrumento
Elije expresiones breves. es una forma de transmitir
velará por el control
transmite
controla

ERROR N. 5: utilizar un estilo inútilmente complejo y redundante.

Números y unidades de medida.

Se encuentran entre los elementos más frecuentes en los manuales técnicos, pero hay mucha confusión en la manera correcta de escribirlos. Por ejemplo, no es correcto escribir:

  • 10kg
  • 200 Km
  • 25ºC
  • 10 mc


Las formas correctas son:

  • 10 kg
  • 200 km
  • 20 °C
  • 10 m3

Es decir, se requiere un espacio entre el número y la unidad de medida. que va escrita de manera estándar.

En caso de duda, puede consultar el Sistema internacional de Unidades, más conocido como SIU, que reúne las normas de escritura de medidas y símbolos.

ERROR N. 6: escribir unidades de medida de forma incorrecta o sin seguir la normativa.

Los números y unidades de medida, además, deben adaptarse al público destinatario. A menudo sucede que vemos documentos técnicos traducidos en ingles, en el que el separador de miles y decimales se utiliza según la normativa española. 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 trescientos noventa mil.... o 390 coma...?

Además, si hablamos de miles, debemos también subrayar que existe una diferencia entre el inglés americano y el británico. En inglés americano, "billion" corresponde a mil millones del español (es decir, 1.000.000.000 o 10 a la novena potencia), mientras que en inglés británico, indica un número más grande, es decir "un millón de millones" (1.000.000.000.000 o 10 elevado a la 12 potencia).

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, y el sistema americano.

Tomemos como ejemplo las medidas de longitud: mientras que nosotros utilizamos los centímetros y sus respectivos múltiplos, el sistema británico y el estadounidense utilizan, por ejemplo, las pulgadas y los pies. una pulgada (símbolo: in) corresponde a 2,54 centímetros, mientras que un pie (ft), corresponde a 30,50 centímetros. 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 tener en cuenta estas diferencias tanto para que el usuario comprenda, como para evitar márgenes de errores si no está bien expresada la unidad de medida.

ERROR N. 7: no adaptar las cifras al mercado de destino.

Cómo presentar las instrucciones

Para facilitar la comprensión de las instrucciones, la información debe presentarse de forma clara y ordenada.

Los conceptos fundamentales son dos:

  • cada frase debe expresar un único concepto
  • las instrucciones deben presentarse en orden lógico y temporal en el que deben ser ejecutadas

Por ejemplo. La frase "el tornillo debe insertarse en el orificio previamente perforado en la pared con una broca de 5 mm" contiene una secuencia de acciones que no está correctamente ordenada según la forma en la que debe ser ejecutada.

Para lograr que sea más clara, podemos reescribirla de esta manera:

"Instrumentos necesarios:

  • un taladro
  • una broca de 5 mm para hormigón armado
  • un tornillo de 5 mm.

Procedimiento

  1. realiza un perforación en la pared;
  2. introduce el tornillo en el agujero"

Además de reescribir la oración, utilizamos dos tipos de listas: una lista viñeta y otra numérica ¿Cuál es la diferencia? La lista viñeta introduce una lista de elementos o ítems, mientras que la numérica indica el orden en el cual deben ser realizadas las acciones. Utiliza las listas para exponer información y describir las acciones de manera ordenada.

ERROR N. 8: no escribir las instrucciones en el orden lógico en el que deben ser realizadas.

Mejorar la escritura con lenguaje controlado

El lenguaje controlado es un sistema de lenguas naturales que utilizan un pequeño número de reglas sintáctico-estadísticas. 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 reduce la ambigüedad.

Los más conocidos son:

¿Cómo se estructuran?

Tanto el Español Técnico Simplificado como el Simplified Technical English se estructuran 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, un máximo de 25-30
  • cada frase debe expresar un único concepto
  • escribe siempre la misma frase para expresar el mismo concepto
  • utiliza la forma activa en lugar de la pasiva
  • no utilices modos verbales que resulten difíciles de comprender, como el subjuntivo. Evita el condicional
  • no omitas el sujeto, los artículos o los adjetivos demostrativos
  • no utilices pronombres, repite el nombre
  • no utilices sinónimos, repite la palabra o el término
  • no utilices expresiones idiomáticas

Si las sugerencias anteriores te resultan complejas o muy rígidas; o no tienes los recursos necesarios para adoptarlos o para recurrir a ayuda de expertos, no te preocupes: no es necesario aplicarlos todos. Estos principios pueden ser utilizados como una base para crear reglas y preparar una lista con terminología oficial o con palabras preferidas/a evitar. Los lenguajes controlados han sido desarrollados para mejorar la comunicación escrita en un ámbito técnico y, ciertamente, para que sean más amigables de traducir. Gracias a su coherencia, nos permiten reducir tiempo y costo de traducción. Ni hablar si el texto será luego traducido por medio de traducción automática.

Si quieres profundizar sobre este tema, en nuestro blog econtrarás los post "Eficacia y ahorro en palabras sencillas: el lenguaje controlado" y Entrevista a Daniela Zambrini (artículo en italiano), miembro de STEMG desde 2014, un grupo de trabajo que se encarga del mantenimiento de ASD-STE100.

ERROR N. 9: no aprovechar las posibilidades que los lenguajes controlados nos ofrecen.

Ayuda al usuario a encontrar información

Un manual no es un libro y el usuario no suele leerlo de corrido. ¿Cuántas veces compramos un producto y buscamos 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 ultimo 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:

  • un índice;
  • una lista de abreviaciones;
  • un índice de figuras y tablas;
  • una lista con palabras clave en órden alfabético;
  • lista de los componentes y su respectiva leyenda;
  • un glosario que recoja los términos técnicos y los explique.

Todos estos elementos permiten encontrar fácilmente lo que estamos buscando. En el mercado existen diversos softwares para la creación y gestión de manuales. Son herramientas que permiten superar los límites impuestos por Word o de InDesign y que facilitan enormemente la gestión de los contenidos y las actualizaciones.

ERROR N. 10: no estructurar la información de forma lógica y ordenada.

Aspecto gráfico y elementos visuales

En un manual, el contenido no es lo único importante: hay que prestarle mucha importancia también a los gráficos. Es muy probable que no se lea en una oficina, sino en lugares mal equipados o con poca iluminación. Los títulos, negritas, párrafos suficientemente espaciados y notas en los márgenes facilitan la lectura.

Para facilitar el trabajo del usuario, no olvides introducir elementos visuales que apoyen el texto. Imágenes, diseño, tablas y pictogramas llaman la atención, facilitan la comprensión, permiten escribir menos y, en definitiva, ahorran el costo 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: con apenas un vistazo, la distancia entre la parte inferior del reposacabeza y la espalda del niño debe ser de dos centímetros.

Las figuras y tablas deben estar numeradas y deben estar acompañadas de una leyenda. Deben estar siempre actualizadas. si una revisión del texto incluye la imágen, deben ser modificadas en consecuencia.

ERROR N. 11: utilizar imágenes o ilustraciones de mala calidad o poco claras.

En los manuales multilingües, si la imagen contiene texto, también debe ser traducido. Para profundizar más sobre este tema, te recomendamos que leas nuestro post "Cómo traducir texto dentro de una imagen".

¿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 estas cuestiones. Una vez que el producto está en el mercado, se pueden recibir informes y quejas de parte de los clientes. Estas observaciones resultan muy útiles y deberían utilizarse para mejorar el contenido del manual.

La traducción

La directiva2006/42/CE, también conocida como "Directiva de máquinas", establece que "toda máquina deberá ir acompañada de un manual de instrucciones en la lengua o lenguas oficiales del estado miembro en el que se comercialice".

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 costos asociados a la asistencia.

Muchas empresas cometen el error de ahorrar en costos de traducción: a menudo se piensa que es suficiente traducir el manual en 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 debes traducir un manual:

  • confíale el trabajo a un traductor profesional, especializado en tu sector
  • adapta el contenido a los estándares del mercado de destino: no utilices los centímetros si el país utiliza pulgadas
  • haz que las secciones sean fácilmente identificables en los diferentes idiomas
  • para identificar el idioma, no utilices la bandera (son un símbolo de la nacionalidad y no identifican la lengua), sino que recurre al código ISO 639, una norma internacional de clasificación (el español por ejemplo, se identifica con "es" o "esp"; el inglés con "en" o "eng")

ERROR N. 12: no planifiques la traducción del manual desde el primer borrador.

A modo de conclusión

  • Simpleza, claridad y coherencia son las palabras clave para la correcta redacción de un manual.
  • El objetivo es que el usuario logre utilizar el producto en el menor tiempo posible: pon imágenes y dibujos para facilitar la comprensión y elementos como el índice, índice de abreviaturas y lista de palabras clave para facilitar la consulta.
  • Recuerda que el usuario no tiene la misma formación que quien escribe el manual: no des nada por sentado.
  • Ponte en el lugar del usuario y trata de anticipar sus dudas
  • Procura que la traducción sea leal al original.
  • Un manual bien escrito permite reducir costos relacionados con la asistencia al usuario y reclamos.

Lecturas recomendadas

SI NECESITAS UN TRADUCTOR PARA TU MANUAL DE USUARIO, CONTÁCTANOS SIN COMPROMISO

Qabiria white logo

Creemos en el incremento de la productividad mediante el uso creativo de la tecnología.

Últimas noticias

Contacto

Qabiria Studio SLNE
Carrer Lleida, 3 1-2
08912 Badalona
(Barcelona)
ESPAÑA

+34 675 800 826

qabiria

Envíanos un mensaje

Recibe nuestro boletín

¿Quieres leer los artículos y novedades de Qabiria directamente en tu bandeja de entrada?