Como redactar manuales de usuario

Lo principal que se debe tener en cuenta al desarrollar un manual de usuario es: Escribirlo para que lo entienda hasta un niño de 6 años. Si, prácticamente escribirlo “For Dummies”.

Y no se trata de menospreciar a los usuarios, pero al aprender algo nuevo, TODOS somos “dummies”.
El manual de usuario es muy importante, casi tanto como lo es la aplicación misma y al redactarlo debemos ponernos en los zapatos de los usuarios “newbies”, que no conocen ni pizca del sistema, como si no supieramos ni abrir la aplicación.
El manual de usuario debe estar estructurado y detallado. La forma más sencilla es dividirlo por módulos (tal y como la aplicación) y ordenarlo por funciones (primero debes dar de alta un cliente para poder consultarlo y luego modificarlo, etc).
Otro punto clave es el lenguaje: Este debe ser claro, conciso y natural, nada de palabras de programación ni complicadas, mucho menos rimbombantes. Se debe “hablar natural”, como si le explicaras a un sobrino pequeño pero con cariño, nunca con condescendencia.
Se deben combinar tanto la narrativa como la esquematización y sobre todo las imágenes. Cuantimás imagenes descriptivas y adecuadas al caso implementemos, mejor. Claro que estas deben estar referenciadas y con una nota al pie.
El proceso puede ser arduo y fatigoso, pero trae grandes recompensas, un manual de usuario bien escrito y que sirva de referencia te puede ahorrar horas de capacitación.
Nos debemos asegurar que se explique como funciona el sistema, que datos se deben capturar (entradas), una breve descripción de lo que hace el sistema (proceso) y los datos que arroja (salida), todo en un lenguaje natural y fluido, sin meternos en detalles.
No nos olvidemos de los errores (para un usuario, cualquier ventana de advertencia es un “error del sistema”, también cualquier comportamiento no esperado). Debemos especificar una sección especial para tratar “En caso de error…”.
Todo es muy importante, pero ¿cómo comenzar? Un buen comienzo es listar las funciones del sistema. Luego ordenarlas cronológicamente, según el usuario las tenga que utilizar en el sistema.
Posteriormente describirmos cada función brevemente y detallamos las entradas, y salidas, especificando las verificaciones y validaciones pertinentes.
Para las entradas, salidas y verificaciones es recomendable apoyarnos con viñetas.
Una vez efectuados estos pasos, seguiremos complementandolos con imágenes, con sus referencias y notas al pie de lo que se traten. Luego, si es necesario, con un sencillo editor de imágenes (presente en cualquier ofimática) podemos manipular las imágenes para resaltar funciones, íconos y botones necesarios.
Una vez que tengamos este avance todo es mucho más sencillo, nos proponemos revisar el orden, efectuar correcciones necesarias, etc.
El manual debe servir de referencia, por lo que un buen indice es escencial. Además, incluir un “FAQ” y una sección (o el manual entero!) a modo de “Como hacer para…”.
Pues bien, por último solo me queda recordar que nunca se nos debe olvidar la perspectiva: Debemos escribirlo para las personas que los van utilizar muy seguido y que no tienen conocimientos avanzados, no para otro desarrollador o para uno mismo.

Related Posts

Cotización de un proyecto

¿Cuantas veces no nos hemos roto la cabeza cotizando? Cotizar es una de los problemas más comunes para los ingenieros de software ¿Cuánto voy a cobrar? es una pregunta muy popular. Existen varias respuestas, varios enfoques, pero primordialmente se debe conocer: Cuanto te cuesta operar Cuanto quieres ganar El primer paso es obtener un costeo […]

Read More

Como reconocer a un experto

Los expertos son fáciles de reconocer, siempre van un paso adelante. Comúnmente los expertos se adelantan, tienen suficiente experiencia para guiarte aunque aun no sepas bien hacia adónde, a veces a tal grado que parece que te estan leyendo la mente y exclamas “Brujo! ¿Cómo lo supo?” No es magia, no hay truco, es camino […]

Read More

Leave a Reply

Your email address will not be published. Required fields are marked *

Busca en el blog aqui

Herramientas Útiles

Suscribete al blog

Recibe en tu correo las últimas publicaciones

Publicidad

Sígueme en Twitter