Este documento describe cinco tipos de manuales comúnmente usados para documentar aplicaciones de software: manuales de usuario, guías de referencia, guías rápidas, manuales de instalación y manuales de configuración. Explica los propósitos y contenidos típicos de cada tipo de manual.

1. TIPOS DE
MANUALESCICLO: Desarrollo de Aplicaciones Multiplataforma
MÓDULO: Desarrollo de Interfaces
LAURA FOLGADO GALACHE | WWW.LAURAFOLGADO.ES

2. 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

3. M A N U A L D E
U S U A R I O
• Portada.
• Página de título y página de copyright.
• 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

4. G U Í A D E
R E F E R E N C I A
• Para usuarios experimentados.
• 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

5. G U Í A R Á P I D A
• Visión genérica y uso rápido de la
aplicación.
• 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

6. G U Í A R Á P I D A
• Cómo crear una 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

7. M A N U A L E S D E
I N S TA L A C I Ó N
• Para administradores de sistemas y
usuarios con privilegios de instalació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

8. M A N U A L E S D E
C O N F I G U R A C I Ó N
• En aplicaciones con procesos
complejos de configuración (cliente-
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

9. ESTRUCTURA DE UN MANUAL
• Dato identificativo (del documento).
• Tabla de contenidos.
• Lista de ilustraciones.
• Introducción.
• Información de uso de la
documentación.
• Procedimientos.
• Información de los comandos.
• Mensajes de error y resolución de
problemas.
• Glosario.
• Fuentes de información relacionadas.
• Elementos de navegación.
• Índice
Laura Folgado Galache | www.laurafolgado.es 9

10. 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