Claves para redactar un manual técnico (Parte I)

¿Cuántas veces has leído un manual? ¿Te parecen aburridos, los entiendes?
Seguro que te resulta familiar ese momento en el que te pones a usar una aplicación y no sabes por dónde empezar. Seguro que antes de buscar el manual de uso o cualquier tipo de ayuda comienzas a “cacharrear” tú mismo, muchas veces sin saber ni a dónde quieres llegar. Pero nada, no ves la manera de comenzar, o no encuentras la forma de ejecutar una funcionalidad que necesitas. Vale, te dices, ahora sí tengo que leer la ¿temida? ayuda. Y entonces buscas el manual, cruzando los dedos para que no sea un imposible de entender.
Esta es una situación muy cotidiana y, si la analizamos juntos, es un poco absurda. Cualquier manual de ayuda debería ser lo suficientemente amigable como para que cumpla con su cometido, nos ayude. El problema es que muchas veces quien lo redacta no tiene muy claro cómo estructurarlo o está tan involucrado en el proceso de desarrollo que olvida que quien va a leer el manual no está familiarizado con la aplicación, o que si lo está no la conoce tan a fondo.
Como en otra infinidad de sectores, el de la redacción técnica dispone de numerosas reglas para facilitar la comprensión de los manuales. Veamos algún ejemplo que así se entenderá mejor.

La repetición

En la redacción literaria siempre huimos de repetir palabras en la misma frase e incluso en frases cercanas. En cambio, en la redacción técnica la repetición es una táctica bien empleada y ayuda al lector a comprender mejor lo que está leyendo. No buscamos sinónimos y no es un problema decir dos veces seguidas lo mismo si es necesario hacerlo.

No recomendado
Para dar de alta un usuario pincha en el botón “Crear usuario” y después haz clic en la opción “Nuevo”.

Recomendado
Para dar de alta un usuario haz clic en el botón “Crear usuario” y después haz clic en la opción “Nuevo”.

Pronombres

En la línea de lo anterior, la repetición, también es habitual el uso de pronombres en lugar de repetir la misma palabra dos veces. En la redacción técnica los pronombres pueden aportan confusión si no queda claro a qué sustituyen.

No recomendado
Escanea el producto y etiquétalo. A continuación muévelo a la línea de empaquetado para formar paquetes de 10 unidades. Luego lleva estos a la línea de salida.

Recomendado
Escanea el producto y etiquétalo. A continuación muévelo a la línea de empaquetado para formar paquetes de 10 unidades. Luego lleva los paquetes a la línea de salida.

NOTA: En este caso el pronombre “estos” podría referirse a los paquetes o a los productos.

Dividir el contendido

Los manuales técnicos, más si cabe los de software, están pensados para guiar al usuario en una serie de tareas a realizar. Una muy buena práctica es tratar, en la medida de lo posible, de transformar párrafos en listas de pasos a seguir.

No recomendado
Para finalizar la fase de empaquetado escanea el producto y etiquétalo. A continuación muévelo a la línea de empaquetado para formar paquetes de 10 unidades. Luego lleva los paquetes a la línea de salida.

Recomendado
Fase de empaquetado
1. Escanea el producto y etiquétalo.
2. Mueve el producto a la línea de empaquetado.
3. Forma paquetes de 10 unidades.
4. Lleva los paquetes de 10 unidades a la línea de salida.

Estos son solo algunos ejemplos de “normas” de redacción técnica. En futuras entradas te iremos contando otras buenas prácticas, con ejemplos incluidos.

About the author: iaparicio

Tienes un comentario to “Claves para redactar un manual técnico (Parte I)”

Puedes responde o Trackback this post.

    Responder

    Tu email no será publicado.