El manual de usuario es un documento tcnico de un determinado sistema que intenta dar asistencia que sus usuarios.

Los manuales de usuario generalmente son includos a dispositivos electrnicos, hardware de computadora y aplicaciones. El manual de usuario puede venir tanto en forma de libro como en forma de documento digital, e incluso poder ser consultado por internet. En general, un manual de usuario debera poder ser entendido por cualquier usuario principiante, como as tambin serle til a usuarios avanzados. Un manual de usuario completo suele tener: * Un prefacio, con informacin sobre cmo usar el propio manual. * Un ndice. * Una gua rpida rpida sobre cmo usar las funciones principales del sistema. * Una seccin para la resolucin de problemas. * Una FAQ. * Informacin de contacto. * Un glosario.

Manual tcnico
Un manual tcnico es aquel que va dirigido a un pblico con conocimientos tcnicos sobre algn rea, mientras que, por ejemplo, un manual de usuario va dirigido a un pblico ms general, el cual no necesariamente debe tener conocimientos especficos en el rea de inters. En este caso el manual tcnico, debe incluir: 1. 2. 3. 1. Paradigma de programacin seleccionado y sus beneficios. Lenguaje de programacin seleccionado y sus beneficios frente a otros lenguajes. Estandarizacin de cdigo utilizada. Diseo del sistema.

Para el caso particular de la materia, ya entregaron el diseo del sistema, por lo que nada ms les queda entregar para este viernes junto con la programacin las primeras tres partes, las minutas (deben de ser 4) y el documento de seguimiento y control (programacin y manual tcnico). Deben de entregar un mnimo de 15 pginas en total. Un ejemplo del tercer punto lo pueden ver en el wiki de gelato , y debe estar reflejado en el software a entregar. Con respecto al manual de usuario, no les pondr ejemplo ni instrucciones ustedes estan capacitados para hacerlo.

Este documento contiene toda la informacin sobre los recursos utilizados por el proyecto, llevan una descripcin muy bien detallada sobre las caractersticas fsicas y tcnicas de cada elemento. Por ejemplo: caractersticas de procesadores, velocidad, dimensiones del equipo, garantas, soporte, proveedores y equipo adicional. Su extensin depende de la cantidad de recursos y equipo utilizado y generalmente se presenta en forma de fichas tcnicas en donde se describe en cada una las caractersticas de cada recurso. CONSIDERACIONES GENERALES PARA LA DOCUMENTACIN DE EL DESARROLLO DE APLICACIONES INFORMTICAS: 1. Toda documentacin que se genere para un proyecto especfico, que haya sido revisada y aprobada, debe poseer lo siguiente: A) Identificacin del documento Este documento debe incorporar la siguiente informacin: Logotipo de la organizacin. Nombre oficial de la organizacin. Denominacin y extensin. De corresponder a una unidad en particular debe anotarse el nombre de la misma. Lugar y fecha de elaboracin. Nmero de revisin (en su caso). Unidades responsables de su elaboracin, revisin y/o autorizacin. Clave de la forma. En primer trmino, las siglas de la organizacin, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por ltimo, el nmero de la forma. Entre las siglas y el nmero debe colocarse un guin o diagonal. (en su caso) B) Estructura del documento. 2. Por cada documento final deber entregarse copias al personal involucrado en el proyecto.

3. Una vez concluido el desarrollo de un sistema, considerando para esto los posibles cambios que se efecten durante la etapa de garanta de que lo cubre (si as fuera el caso), el usuario final del sistema debe recibir una versin actualizada final del documento manual tcnico. Estructura del documento MANUAL TCNICO 1. ndice Relacin de los captulos y pginas correspondientes que forman parte del documento 2. Introduccin. Se debe presentar una breve descripcin del sistema desarrollado, que contemple el mbito abarcado, cual es su funcin principal y un detalle de las funciones macros o partes que lo componen. Puede incluir un mensaje de la mxima autoridad de las reas comprendidas en el manual. 2.1. Objetivo general del sistema Se debe de describir el objetivo general del sistema. 2.2. Objetivos especficos Se deben describir brevemente los objetivos especficos que se cumplieron con el desarrollo del sistema. 3. Contenido tcnico 3.1. Definicin de reglas del negocio implementadas en el sistema desarrollado. 3.2. Diagramas de flujo de datos, junto con su respectivo diccionario de datos. 3.3. Controles de auditoria implementados en el sistema. 3.4. Descripcin de campos requeridos por pantalla con presentacin de pantallas. 3.5. Diagrama de navegacin del sistema. 3.6. Requerimientos de interfase con otros sistemas. 3.7. Modelo lgico de datos, diagrama entidad-relacin.

3.8. Modelo de datos fsico, junto con su respectivo diccionario de datos. 3.9. Matriz de procesos versus organizacin. 3.10. Matriz de programas versus entidades. 3.11. Plataforma de usuario. Aqu se describen los requerimientos mnimos que se deben tener tanto de hardware como de software para que el sistema se pueda instalar y ejecutar correctamente (en caso de que se considere necesario). 3.12. reas de aplicacin y/o alcance de los procedimientos. Esfera de accin que cubren los procedimientos 4. Responsables. Para iniciar los trabajos que conducen a la integracin de un manual, es indispensable prever que no queda diluida la responsabilidad de la conduccin de las acciones en diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo tcnico, al que se le debe encomendar la conduccin del proyecto en sus fases de diseo, implantacin y actualizacin. De esta manera se logra homogeneidad en el contenido y presentacin de la informacin. Por lo que respecta a las caractersticas del equipo tcnico, es conveniente que sea personal con un buen manejo de las relaciones humanas y que conozca a la organizacin en lo que concierne a sus objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organizacin puede nombrar a la persona que tenga los conocimientos y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede encargarlo al titular de el rea especfica. Asimismo, puede contratar los servicios de consultores externos. 4.1. Mapa de navegacin. muestra de forma grfica la interconexin entre cada una de las pantallas del sistema, lo que servira para saber como llegar a determinada parte de la aplicacin. En este se muestran los mens, submens y pantallas a las que nos lleva cada uno de ellos 4.2. Descripcin grfica del mapa de navegacin. En el anterior aparece de forma de diagrama de flujo y en esta seccin deber aparecer ya con las respectivas pantallas. 4.3. Describe paso a paso los procesos, as como pantallas, botones, cuadros de texto, etc., pero tambin se muestra el cdigo de cada rutina, pantalla, botn, etc. es decir, se muestra lo que hay detrs de la interfaz del usuario elaboracin Manual Tcnico