Un manual de
usuario completo suele tener:
* Un prefacio, con información sobre cómo usar el propio
manual.
* Un índice.
* Una guía rápida rápida sobre cómo usar las funciones
principales del sistema.
* Una sección para la resolución de problemas.
* Información de contacto.
* Un glosario.
El manual del usuario contiene los siguientes aspectos:
Introducción, aspectos que
introducen al usuario tales como:
a. Identificación del
software expresando su nombre comercial y el problema que resuelve.
b. Panorámica de los
elementos componentes (subsistemas) describiendo de forma general las
características básicas de cada uno de ellos, así como exponiendo a grandes rasgos
la información que es necesario suministrar al software y los resultados que
serán obtenidos.
c. Organización y
estructura del documento y breve descripción del contenido del manual.
d. Forma de usar el manual.
Generalidades, brinda
información general al usuario tales como:
a. Información sobre el
producto del software, indicando quien diseñó, desarrolló y documentó el
software.
b. Forma de como contactar
con el productor, brindando además la información que el usuario debe tener en
caso de detectar errores en el software.
·
Versión del producto.
·
Lugar de producción y modelo de la
computadora.
·
Tipo de monitor, tipo de tarjeta gráfica.
·
Versión del sistema operativo.
c. Información sobre la
facilidad de obtener ayuda o asesoría técnica.
Iniciación, consta de la
siguiente información:
a. Comienzo. Pasos iniciales
para dar inicio a la utilización del software, por ejemplo el procesamiento de
la información antes del tratamiento automatizado, el procedimiento de
carga, etc.
b. Modo de ayuda, descripción
de como se puede obtener ayuda referente a la utilización del software.
c. Documentación de
referencia. Recomendación en caso necesario de la consulta de cualquier
material impreso que posibilite completar los conocimientos de los métodos,
algoritmos, etc. utilizados en el software.
Utilización, muestra
instrucciones precisas sobre como usar las opciones o comandos que brinda
el software.
Para el caso de los comandos debe incluirse:
a. Propósito, orden, sintaxis
y posibles parámetros y valores implícitos.
b. Relación de comandos y su
descripción.
Para el caso de las opciones debe incluirse:
a. Diálogos que se establecen
o mensajes informativos.
b. Exposición de las
pantallas de entrada y salida de información asociadas a las diferentes
opciones.
Tratamiento de los errores, describe los posibles casos para las cuales pueda fallar
cualquiera de los comandos del software.
Recuperación de los fallos, muestra las formas en que son tratados estos casos y que
puedan presentarse en la utilización de la aplicación, como se evitan o se
recupera el software ante los mismos.
Apéndices, brinda
información adicional que se requiere suministrar al usuario. Esta puede ser:
a. Relación de los mensajes
de error.
b. Relación de todas las
abreviaturas.
