Tipos de manuales

Tipos de manuales.
Desarrollo de Interfaces (2º Desarrollo de aplicaciones multiplataforma)

1. TIPOS DE MANUALES CICLO: 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 cuatro tipos: Manual de usuario. Guía de referencia. Guías rápidas. Manuales de instalación. Laura Folgado Galache | www.laurafolgado.es 2

3. MANUAL DE USUARIO 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. Gu ía de referencia 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. Guía rápida 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. Guía rápida 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. MANUALES DE INSTALACIÓ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. MANUALES DE CONFIGURACIÓ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. C RÉ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