MANUAL DE USUARIO

1. Define quién es el usuario. Para escribir un manual de usuario exitoso, debes desarrollar un perfil de tu usuario, ya sea de manera formal, creando un perfil escrito, o de manera informal, tomándote el tiempo de realizar suposiciones razonables acerca de las características del usuario.

 

 

 

 

 

 

 

 

 

 

 

2. Escribe para ayudar a las necesidades del usuario de una manera tal que este lo pueda entender.

A menos que el usuario tenga antecedentes técnicos, es posible que sea mejor evitar el lenguaje muy técnico para lograr explicaciones más claras y simples.

 

 

 

 

 

 

 

 

 

 

 

3. Explica el problema que el usuario intenta resolver y luego presenta una solución para dicho problema. 

Ofrecer una característica del producto como una solución a un problema común funciona bien cuando se promociona el producto, pero una vez que el usuario lo tenga, debe saber cómo utilizar dicha característica. 

 

 

 

 

 

 

 

 

 

 

4. Incluye la portada y las carátulas adecuadas. 

Deberás incluir una portada para cualquier guía de usuario mayor a una hoja de referencia así como una carátula para cualquier manual que cubra más que la superficie de una hoja de papel doblada (4 o más páginas de largo).

 

 

 

 

 

 

 

 

 

5. Pon referencias a las documentaciones relacionadas en el prefacio.

 Si la documentación de usuario es más que un solo manual, coloca aquí las referencias a los demás documentos, con sus números de versiones correspondientes.

 

 

 

 

 

 

 

 

 

 

 

 

6. Si el manual excede las 10 páginas, incluye un índice de contenidos.

 

 

 

 

 

 

 

 

 

 

 

7. Pon las instrucciones o los procedimientos y los materiales de consulta en el cuerpo del manual. 

En la mayoría de los casos, los procedimientos y los materiales de consulta tienen sus propias secciones, aunque dentro de una sección puedes indicarle al usuario que consulte un contenido específico de la otra.

 

 

 

 

 

 

 

 

 

 

8. Usa imágenes gráficas para respaldar al texto cuando sea necesario. 

Las imágenes gráficas o las capturas de pantalla pueden ilustrar algunos puntos en el manual mejor que un texto, en especial si se trata de procedimientos complejos en los cuales el usuario necesite una confirmación visual de que esté llevando a cabo los pasos correctamente. 

 

 

 

 

 

 

 

 

 

 

 

 

9. Elige algunas fuentes legibles.

 Aunque las computadoras permiten utilizar muchas fuentes diferentes, el objetivo de un manual de usuario es ser fácilmente legible.

 

 

 

 

 

 

 

 

 

 

10. Piensa bien la distribución. 

Una vez que hayas elegido las fuentes del manual de usuario, deberás decidir dónde colocas cada cosa en las páginas.

 

 

 

 

 

 

 

 

 

 

 

11. Elige el tipo de encuadernación para el manual de usuario. 

Si el manual de usuario tiene más de 4 páginas, será necesario unir las páginas de algún modo. 

 

 

 

 

 

 

 

 

 

 

 

12. Diseña una plantilla de documento para tu manual de usuario. 

Muchos procesadores de texto y programas de autoedición ofrecen la posibilidad de crear plantillas de documentos para los manuales de usuario, así que a medida que escribas, el texto se mostrará automáticamente en la fuente que hayas elegido para la parte del manual en la que estés trabajando (de hecho, este artículo fue escrito inicialmente utilizando una plantilla de Microsoft Word).