Cómo escribir el manual de usuario de un programa (En 6 Pasos)
El manual de usuario de un programa es tan importante como el programa mismo. El manual de usuario es vital para aprender tanto las técnicas básicas como las avanzadas de un programa o aplicación. Los manuales son generalmente cortos, pero si hacen falta más detalles pueden ser mucho más largos. El tamaño de un manual dependerá exclusivamente del tipo de programa y de cuánto detalle debe tener. Los usuarios apreciarán un manual con información que se pueda encontrar fácilmente y que sea concisa, con suficiente detalle como para evitar confusiones.
Paso 1
Escribe un esquema del manual. Esto te dará un plan a seguir. Los puntos a incluir en el esquema serían el proceso de instalación, las aplicaciones del programa, las descripciones de los menús, las tareas comunes, las funciones avanzadas, y la sección de solución de problemas. También incluye subsecciones en tu diseño para tareas específicas tales como crear un nuevo archivo, guardar e imprimir archivos.
Paso 2
Detalla el proceso de instalación, incluyendo los requisitos del ordenador. Proporciona los requisitos antes de la instalación principal, así los usuarios pueden preparar su ordenador. Describe incluso los pasos más básicos para los principiantes en informática. Estos pasos podrían ser “haz doble clic en el archivo de instalación” o “inserta el CD en la unidad de CD ROM”. Los pasos típicos de una instalación suponen explicar las opciones de instalación, como una instalación típica en oposición a una instalación avanzada, llevar al usuario paso por paso a través de cada pantalla IGU (Interfaz Gráfica de Usuario) con la que se encuentre, registrar el programa e introducir cualquier el código o números de serie, y cómo acceder al programa una vez instalado para verificar que la instalación está correcta.
Paso 3
Haz una descripción detallada de las aplicaciones del programa. Incluye para qué se necesita el programa y cómo se puede obtener beneficio del mismo. Por ejemplo, si el programa trata de contabilidad, explica cómo hace más sencillas las tareas contables normales. Aclara cuáles son las funciones más importantes para el usuario final. Esto le dará una idea al usuario de qué funciones intentará aprender primero. Por ejemplo, en un programa de creación musical, dile al usuario cuántas 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 descripción de las características avanzadas, que hacen a éste un programa diferente de otros que haya en el mercado. Por ejemplo, tu programa quizás sea capaz de generar más informes o de admitir más tipos de archivos, que cualquier otro programa disponible en el momento.
Paso 4
Explica cómo navegar por los menús. Explica cada punto de los menús disponibles. Cualquier cosa que no pueda explicarse en una o dos frases, deberá incluirse en la sección de Tareas Comunes del manual. Estas tareas podrían incluir el cambio de letra y de colores, cómo imprimir diferentes formatos y tipo de archivos, y cómo organizar los archivos y la información.
Paso 5
Escribe una sección separada para las funciones avanzadas y características adicionales. Aquí es donde debes entrar en detalles. Por ejemplo, un manual de usuario para Microsoft Excel incluiría información acerca de cómo crear informes, vínculos y macros. Las características adicionales incluirán funciones que el usuario quizás no espere. Por ejemplo, un programa de creación musical podría traer un reproductor de música incorporado. Tómate tiempo para explicar cualquier extra que venga con tu programa, o las aplicaciones únicas del mismo.
Paso 6
Incluye sugerencias para la solución de problemas. Explica el significado de cada error que el usuario pueda encontrar, cómo resolver el problema, y cómo prevenirlo en el futuro. Este es también el lugar donde debes incluir los datos de contacto y la información de atención al cliente.
