Por un mejor manual

If you want them to RTFM, make a better FM.

Si querés que lean el maldito manual, mejorá el maldito manual.

Cuando lo viejo conocido no funciona, ¡instrucciones!

Los manuales son textos que toman como punto de partida que el usuario no sabe realizar determinadas operaciones o no conoce ciertos procesos y, por ello, la necesidad de enseñárselos mediante instrucciones claras, directas y simples. Esto no significa que el usuario-lector es para el redactor técnico una tabla rasa. Por ejemplo, en el caso de un manual de un procesador de texto, se puede partir de que el usuario tiene los conocimientos básicos de manejo de PC. En pocas palabras, lo viejo conocido no se explica, no es necesario reflejarlo en el manual.

Así unas instrucciones como estas serían absurdas e innecesarias en el manual de un procesador de texto.

1. Enchufe la PC.
2. Enciéndala.
3. Inicie procesadordetexto.exe.

Esto es válido salvo que un paso del procedimiento conocido haya cambiado tanto que se vuelva necesario alertar al usuario del cambio.

Un claro ejemplo es el de Laboratorios Richet S.A., que incorporó un blíster de seguridad a sus comprimidos. Se trata de un blíster que, por el material de que está hecho, no se puede abrir haciendo presión. Esto permite proteger a los niños de un consumo accidental de medicamentos y, en consecuencia, de posibles intoxicaciones.

Un cambio tan importante en la manera de sacar el comprimido de un blíster requirió que el laboratorio incluyera un tarjetón grueso y llamativo con las instrucciones correspondientes. Éstas (hoy inusuales) serán necesarias hasta que todos los laboratorios utilicen blísteres de seguridad y la forma de abrirlos se convierta entonces en lo viejo conocido.

Instrucciones para extraer un comprimido de VR Servicios de Escritura

Sobre los textos instructivos

«[Los textos instructivos] persiguen dirigir el comportamiento del lector proporcionando las informaciones necesarias para llevar a cabo una tarea, sea ésta de la naturaleza que sea. Tales instrucciones se plantean de manera lineal y no jerarquizada, ordenadas por argumentos de naturaleza exclusivamente temporal».

José M. Bustos Gisbert, La construcción de textos en español, Salamanca, Ediciones Universidad de Salamanca, 1996.

Curiosidades: instrucciones para defecar

La foto de esta entrada circula en páginas web de humor y bromas como ejemplo de una ridícula guía de instrucciones. El cartel, escrito en inglés, enseña el procedimiento para defecar o evacuar el intestino (eso es bowel).

 

Si estas instrucciones son reales, caben tres preguntas:

1. ¿Quién las escribió?
2. ¿A quién van dirigidas?
3. ¿Dónde está colocado el cartel (es decir, cuál es el contexto)?

Para responder las dos primeras, podemos guiarnos por cierta información que figura al pie del afiche. Abajo a la derecha se pueden observar un pequeño dibujo y unas letras algo desleídas (pixeladas por la baja calidad de la imagen): el logo de un hospital de Singapur, el Khoo Teck Puat Hospital (KTPH). Entendemos, entonces, que los destinatarios son pacientes.

Queda la incógnita del contexto. ¿Dónde está ubicado el cartel: en la puerta de un baño, en un consultorio, en un pasillo del hospital? En otras palabras, ¿valida el contexto este texto, lo hace pertinente y adecuado?

Todo es posible. Por eso, si algún lector de este blog visita alguna vez el Hospital Khoo Teck Puat en Singapur y ve el cartel, por favor, tenga la gentileza de escribirnos y develar la incógnita.

A Strategic Guide to Technical Communication, de Heather y Roger Graves

San Valentín o de cómo cuidar a la persona amada

El 14 de febrero, muchas personas en el mundo festejan el día de los enamorados. Las páginas de tarjetas virtuales gratuitas se saturan; suben las ventas en bombonerías y florerías, y las empresas de desayunos a domicilio no paran de atender pedidos. Pero existen muchas maneras de cuidar a la persona amada. Una muy importante es velar por su seguridad.

Todos los manuales nos enseñan a usar un producto; indican cómo operarlo y, más importante, cómo no. Si bien la tendencia actual es crear productos cada vez más intuitivos y amigables al usuario, siguen existiendo los peligros del mal uso y, para prevenirlos, están los manuales y sus advertencias. Es necesario tomar y hacer tomar conciencia de la gravedad de enchufar un artefacto, desarmarlo o simplemente usarlo sin haber leído previamente el manual: es posible que pongamos la vida en peligro.

En este sentido, formar conciencia es un gesto de amor. Algo para pensar este 14 de febrero cuando el aire se llene de corazones.

Distintos tipos de advertencias

Las advertencias, generalmente enmarcadas en un cuadro y con una tipografía diferente del resto del texto del manual, son recomendaciones o consejos que la empresa fabricante le da al lector-usuario para que opere el producto o realice un determinado procedimiento de manera correcta y segura.


Advertencias comunes
Sirven para recomendar al lector-usuario la mejor manera de uso, aquella que le permite sacarle mayor provecho al producto o al procedimiento.

Ejemplo: «Agítese bien antes de usar».


Advertencias sobre riesgo de vida
Sirven para avisar sobre algún tipo de riesgo en el que peligra la vida del usuario o de otras personas o peligra su integridad física. Son las más importantes.

Ejemplo de un manual del propietario de un scooter Honda:

Peligro: Si el lector no sigue las instrucciones, perderá la vida o se lesionará gravemente. 
Advertencia: Si el lector no sigue las instrucciones, podrá perder la vida o lesionarse gravemente.
Precaución: Si el lector no sigue las instrucciones, podrá lesionarse.

En este caso, la empresa fabricante debió evaluar los posibles daños y riesgos y clasificarlos. Solo así fue posible advertir del riesgo al lector-usuario de una manera franca y clara.

La información y la buena redacción son cruciales cuando la vida está en peligro.

Entrevista a Björn Dahlborn, doctor de textos

«Hay que darse cuenta: el usuario no quiere leer todo.»

En el norte de Europa, en Suecia, a orillas del lago Vänern, se encuentra la ciudad de Karlstad. Allí hay un hombre que se dedica a curar. Pero sus pacientes no son personas, mucho menos animales. Björn Dahlborn es TextDoktorn, es decir, cura textos.

¿Cómo surgió la idea de curar textos?
Como está explicado en mi sitio web (http://www.textdoktorn.se/Spanish/index.htm), tengo un examen de consultor de lengua. Ese programa universitario fue iniciado para proveer a las autoridades suecas de expertos lingüísticos para mejorar la comunicación con los ciudadanos, y evitar así la lengua burocrática y los errores comunes de escritura.

Muy inspirador.
Por eso, he consagrado mi vida profesional a la misión de simplificar textos, no solamente para los lectores, sino también para los autores.

Sé que tiene experiencia en corregir y redactar manuales. ¿Por qué se destaca un buen manual?
Un buen manual facilita la búsqueda de información pertinente: incluye una tabla de materias con subtítulos claros y un buen índice. Los términos tienen que estar bien explicados y la lengua, lo más simple posible.

Como autor, hay que darse cuenta de que el usuario no quiere leer todo, busca información muy específica. Y frecuentemente ya está un poco irritado... Si el equipo funciona sin problemas, el manual no se necesita.