Consejos para la redacción de manuales

En el marco de mi trabajo como traductor técnico, he leído muchos miles de manuales de instrucciones de todo tipo de máquinas, en varios idiomas diferentes. Estos consejos no solo le ayudarán a redactar un manual claro y conciso, también le permitirán mucho dinero de euros en traducciones.

1) Escriba frases cortas y sencillas

Esta es la recomendación más importante que se puede dar. Los beneficios que se derivan de ella son múltiples:

el usuario comprenderá mejor el contenido;
menor posibilidad de errores de redacción;
el manual será más fácil de traducir;
la traducción a otros idiomas probablemente será más barata, especialmente si se traducen varios manuales parecidos, dado que las herramientas de traducción utilizadas por los traductores profesionales detectan las frases similares.

2) Complemente la información con símbolos

Los símbolos son una ayuda preciosa para clarificar las instrucciones, especialmente en el caso de advertencias de seguridad. Lo ideal es utilizar siempre los símbolos definidos por la Organización Internacional de Normalización (ISO). ¿Sabía que el catálogo de la ISO incluye 3940 símbolos diferentes?

3) Incluya muchas ilustraciones, bien referenciadas

Una imagen vale más que mil palabras. Por ejemplo, los manuales de Ikea no tienen texto y la mayoría de usuarios está muy satisfecho con ellos. Naturalmente, para máquinas complejas, como por ejemplo, una bomba de una refinería de petróleo, es completamente imposible lograr un manual con solo imágenes. En cualquier caso, las ilustraciones casi siempre son necesarias y siempre son una ayuda inestimable.

4) Utilice la terminología estándar para espeficiar los niveles de peligro

No es lo mismo una señal de peligro que una de advertencia o una de atención. Las normas ISO 3864 y ANSI Z535.4 definen diferentes niveles de peligro usando terminología específica. Si bien las normas no son de obligado cumplimiento, seguirlas es más que recomendable.

5) Automatización y referencias

Los procesadores de texto y otras herramientas de edición incluyen numerosas herramientas para facilitar las referencias (enlaces internos) en el texto. Por ejemplo, Microsoft Word permite insertar una tabla de contenido (índice) simplemente identificando cuáles son los capítulos. Esto supone la gran ventaja que si cambiamos el nombre de un capítulo o el número de páginas, el índice se actualizará automáticamente. Ídem para referencias a otros capítulos o ilustraciones. Esto parece trivial, pero cuando los documentos son de gran tamaño y son editados por varias personas, es una ayuda inestimable.

6) No pierda nunca los archivos editables

¡Estos archivos (MS Word, inDesign, etc.) son muy valiosos! En caso de actualización o traducción del manual original, los archivos editables son insustituibles. En innumerables casos me han pedido que traduzca manuales a partir de archivos pdf no editables. Esto siempre implica más costes, tanto de traducción como de edición gráfica.

7) Incluya siempre la fecha y el historial de cambios

No solo es útil y evita muchos problemas, además es necesario si su organización cuenta con certificaciones de calidad como ISO 9001 u otras.