Cmo escribir el manual de usuario de un programa

El manual de usuario de un programa es tan importante como el programa mismo. El manual de usuario es vital para aprender tanto las tcnicas bsicas como las avanzadas de un programa o aplicacin. Los manuales son generalmente cortos, pero si hacen falta ms detalles pueden ser mucho ms largos. El tamao de un manual depender exclusivamente del tipo de programa y de cunto detalle debe tener. Los usuarios apreciarn un manual con informacin que se pueda encontrar fcilmente y que sea concisa, con suficiente detalle como para evitar confusiones.

Instrucciones
1.

1
Escribe un esquema del manual. Esto te dar un plan a seguir. Los puntos a incluir en el esquema seran el proceso de instalacin, las aplicaciones del programa, las descripciones de los mens, las tareas comunes, las funciones avanzadas, y la seccin de solucin de problemas.

2.

Detalla el proceso de instalacin, incluye ordenador los requisitos. Proporciona los requisitos antes de la instalacin principal, as los usuarios pueden preparar su ordenador. Describe incluso los pasos ms bsicos para los principiantes en informtica. Estos pasos podran ser haz doble clic en el archivo de instalacin o inserta el CD en la unidad de CD ROM. Los pasos tpicos de una instalacin suponen explicar las opciones de instalacin, como una instalacin tpica en oposicin a una instalacin avanzada, llevar al usuario paso por paso a travs de cada pantalla IGU (Interfaz Grfica de Usuario) con la que se encuentre, registrar el programa e introducir cualquier cdigo o nmeros de serie, y cmo acceder al programa una vez instalado para verificar que la instalacin est correcta.

3.

Haz una descripcin detallada de las aplicaciones del programa. Incluye para qu el usuario necesita el programa y cmo puede obtener beneficio del mismo. Por ejemplo, si el programa trata de contabilidad, explica cmo el programa hace ms sencillas las tareas contables normales. Aclara cules son las funciones ms importantes para el usuario final. Esto le dar una idea al usuario de qu funciones intentar aprender primero. Por ejemplo, en un programa de creacin musical, dile al usuario cuntas pistas puede grabar en una sola vez, todos los sonidos y ritmos que tenga, y en qu formatos puede guardar los archivos. Incluye una breve descripcin de las caractersticas avanzadas, que hacen de ste un programa diferente de otros que haya en el mercado. A decir, tu programa quizs sea capaz de generar ms informes o de admitir ms tipos de archivos, que cualquier otro programa disponible en el momento.

4.

Explica cmo navegar por los mens. Explica cada punto de los mens disponibles. Cualquier cosa que no pueda explicarse en una o dos frases, deber incluirse en la seccin de Tareas Comunes del manual. Estas tareas podran incluir el cambio de letra y de colores, cmo imprimir diferentes formatos y tipo de archivos, y cmo organizar los archivos y la informacin.

5.

Escribe una seccin separada para las funciones avanzadas y caractersticas adicionales. Aqu es donde debes entrar en detalles. Por ejemplo, un manual de usuario para Microsoft Excel incluira informacin acerca de cmo crear informes, vnculos y macros. Las caractersticas adicionales incluirn funciones que el usuario quizs no espere. Por ejemplo, un programa de creacin musical podra traer un reproductor de msica incorporado. Tmate tiempo para explicar cualquier extra que venga con tu programa, o las aplicaciones nicas del programa.

6.

Incluye sugerencias para solucin de problemas. Explica el significado de cada error que el usuario pueda encontrar, cmo resolver el problema, y cmo prevenirlo en el futuro. Este es tambin el lugar donde incluir los datos de contacto y la informacin de atencin al cliente.

Cmo escribir un manual para un usuario?

Escribir un manual para los usuarios generalmente es algo que se pasa por alto en las etapas de desarrollo de un producto. Existen comunicadores tcnicos y escritores cuyo trabajo especfico es crear manuales para usuarios. No obstante, muchas compaas renuncian a contratar dichos escritores y fuerzan a los ingenieros de productos a escribir los manuales. Aunque puede ser complicado escribir un manual para usuarios efectivo, estas simples instrucciones te pueden permitir escribir un manual para usuarios bsico.

Instrucciones
1.

1
Conoce bien el producto para el que ests escribiendo el manual. Es importante utilizar el producto tanto como se pueda y anotar tus primeras impresiones conforme lo utilizas. Es particularmente importante anotar cosas que complican el uso del producto.

2.

2
Analiza a tu pblico. Este puede ser el paso ms importante en la creacin de un manual. Quieres saber quin leer y usar tu documento. Analiza rasgos como conocimiento previo, edad y familiaridad con el producto.

3.

3
Realiza un resumen de los procesos ms importantes involucrados en el uso del producto. Estos procesos sern los que querrs incluir en el documento. Es imposible documentar todos los posibles escenarios, por lo que es necesario que escojas los ms importantes para el usuario final.

4.

4 5

Documenta los procesos con el producto enfrente de ti. Prueba tus instrucciones para asegurarte que funcionan y que tienen sentido.

5.

Prueba la funcionalidad de tu manual. Trata de encontrar tantos usuarios finales de tu producto como puedes y pdeles que se conduzcan por varios de los procesos que has documentado en tu manual.

6.

6
Haz los cambios necesarios basados en las pruebas de uso. El usuario final es el "rey" en el proceso de creacin de manuales. Si existe un consenso entre los usuarios para modificar las formulaciones, haz los cambios.