TIPOS DE

MANUALES
C IC L O : D e s a rrol l o d e Ap l i c a c i o ne s M u l ti p l a ta form a
MÓD U LO: D e s a rro llo d e In te r fa ces

L AU R A F O L G AD O G AL A C H E | W W W. L AU R AF O L G A D O . E S
INTRODUCCIÓN

• Los manuales se utilizan para usuarios que desconocen la programación de la

aplicación.
• Se crean en papel o formato electrónico (incluidos con la aplicación).
• Pueden descargarse de los sitios web del programa.
• Hay cinco tipos:
– Manual de usuario.
– Guía de referencia.
– Guías rápidas.
– Manuales de instalación.
– Manuales de configuración.

Laura Folgado Galache | www.laurafolgado.es 2

• Portada. MANUAL DE
• Página de título y página de copyright. USUARIO
• Prólogo
– Detalles de los documentos relacionados.
– Información sobre navegación del manual.
• Páginas de contenidos: incluye índice.
• Una guía de funciones básicas de la
aplicación.
• Una sección de solución de problemas:
problemas y posibles soluciones.
• Una sección FAQ (Frequently Asked
Questions).
• Donde encontrar más ayuda para uso de la
aplicación (normalmente es una web).
• Un glosario y un índice.
Laura Folgado Galache | www.laurafolgado.es 3
• Para usuarios experimentados. GUÍA DE
REFERENCIA

• Incluye mensajes de error y cómo

recuperarse de ellos.

• Ejemplos:
– Guía con sintaxis, palabras
reservadas, etc. de un lenguaje de
programación para usar un IDE.
– Guía con comandos para usar una
aplicación en modo comando.

Laura Folgado Galache | www.laurafolgado.es 4

• Visión genérica y uso rápido de la
aplicación. GUÍA RÁPIDA

• Ideal en casos como:

– Aplicación que requiere una sola
configuración para que esté operativa.
– Aplicación con funcionalidad limitada:
si tiene un número determinado de
tareas.
– Aplicación con documentación
extensa: la guía rápida muestra las
tareas principales.
– Usuarios que no pueden dedicar
mucho tiempo a formación.
Laura Folgado Galache | www.laurafolgado.es 5
• Cómo crear una guía rápida:
GUÍA RÁPIDA
– Si la aplicación incluye información
extensa, primero debemos
desarrollar ésta y luego la guía
rápida.
– Se pueden utilizar plantillas.
– Siempre deben tenerse presentes
los aspectos:
• Contraste: entre títulos y textos.
• Repetición: logotipos, colores…
• Alineación: simetría entre párrafos,
etc.
• Proximidad: agrupar objetos
interrelacionados.
Laura Folgado Galache | www.laurafolgado.es 6
• Para administradores de sistemas y MANUALES DE
usuarios con privilegios de instalación. I N S TA L A C I Ó N

• Incluyen:
– Descripción de los archios de la
aplicación.
– Sistema operativo para el que está
diseñada.
– Requisitos de hardware mínimos.
– Modificación de variables de entorno, etc.

• No suele ser necesario en caso de

utilizar programas de instalación.

Laura Folgado Galache | www.laurafolgado.es 7

• En aplicaciones con procesos MANUALES DE
complejos de configuración (cliente- CONFIGURACIÓN
servidor, bases de datos, etc.).

• Deben indicarse los archivos y

variables a modificar, los posibles
errores, etc.

• Puede haber:
– Configuración predeterminada: para
usuarios con pocos conocimientos.
– Configuración personalizada: para
usuarios con conocimientos
avanzados.
Laura Folgado Galache | www.laurafolgado.es 8
ESTRUCTURA DE UN MANUAL

• Dato identificativo (del documento). • Mensajes de error y resolución de

• Tabla de contenidos. problemas.

• Lista de ilustraciones. • Glosario.

• Introducción. • Fuentes de información relacionadas.

• Información de uso de la • Elementos de navegación.

documentación. • Índice
• Procedimientos.
• Información de los comandos.

Laura Folgado Galache | www.laurafolgado.es 9

CRÉDITOS

• Los contenidos de esta presentación han sido extraídos de los Materiales Formativos
de FP Online, propiedad del Ministerio de Educación, Cultura y Deporte.
• Su uso está restringido a fines exclusivamente relacionados con ofertas de enseñanza
de Formación Profesional.
• El aviso legal de estos contenidos puede ser consultado en el siguiente enlace:
Aviso legal.

Laura Folgado Galache | www.laurafolgado.es 10