El documento describe la importancia de la documentación de sistemas y diferentes tipos de documentación, incluyendo manuales de usuario e informes finales. Explica que la documentación de sistemas proporciona información sobre qué hacen los sistemas, cómo funcionan y para quién, y es esencial para el mantenimiento, auditoría y uso del sistema. También cubre el proceso de desarrollo de manuales de usuario, incluyendo la identificación de usuarios y módulos, y la capacitación de usuarios.

1. Universidad Politécnica Territorial Andrés Eloy Blanco
Programa Nacional de Formación en Informática
Ing. Lissette Torrealba
Unidad VIII
Manuales e informe final
Objetivo de la Unidad:
Desarrollar la documentación de sistemas como el conjunto de información que indica qué hacen los sistemas,
cómo lo hacen y para quién lo hacen.
Definición
Documentación del sistema
La documentación de sistemas es el conjunto de información que nos dice qué hacen los sistemas, cómo lo
hacen y para quién lo hacen. La documentación consiste en material que explica las características técnicas y la
operación de un sistema. Es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para
mantenerlo, para permitir auditoria del sistema y para enseñar a los usuarios como interactuar con el sistema y a
los operandos como hacerlo funcionar.
Existen varios tipos de documentación. La de programas, que explica la lógica de un programa e incluye
descripciones, diagramas de flujo, listados de programas y otros documentos; la del usuarios en forma general
la naturaleza y capacidades del sistema y cómo usarlo.
Importancia de la Documentación del sistema
La documentación de un sistema es esencial para proporcionar entendimiento de un a quien lo vaya a usar para
mantenerlo, para permitir auditorias del mismo y para enseñar a los usuarios como interactuar con él y a los
operadores y administradores como hacerlo funciona.
Introducción
La documentación del software impregna el ciclo de vida del mismo. Es la parte más visible de su proceso. Sin
ella, no se puede dar mantenimiento al software, los usuarios no pueden entrenar y prácticamente no pueden
utilizar el software, los desarrolladores nuevos tendrían que reinventar la rueda en el desarrollo del software.
La documentación del software es su manifestación más importante.Es la guía para el laberinto del software.
Los manuales de usuario final facilitan la interacción de dicho usuario con la computadora. Un manual de
capacitación es un ejemplo de un manual orientado al usuario. Reduce el tiempo de aprendizaje para el uso
productivo del software, ahorrando al usuario final muchísimo dinero. Los documentos del usuario final
también pueden ser un manual de referencia, que detalle el funcionamiento del sistema, o una guía para
administradores de sistema, que detalle la forma de operary dar mantenimiento al sistema.

2. Universidad Politécnica Territorial Andrés Eloy Blanco
Programa Nacional de Formación en Informática
Ing. Lissette Torrealba
Tipos de Documentación del sistema
Manual De Usuario
Expone los procesos que el usuario puede realizar con el sistema implantado. Para lograr esto, es necesario que
se detallen todas y cada una de las características que tienen los programas y la forma de acceder e introducir
información. Permite a los usuarios conocer el detalle de qué actividades ellos deberán desarrollar para la
consecución de los objetivos del sistema. Reúne la información, normas y documentación necesaria para que el
usuario conozca y utilice adecuadamente la aplicación desarrollada.
Objetivos
Que el usuario conozca cómo preparar los datos de entrada.
Que el usuario aprenda a obtener los resultados y los datos de salida.
Servir como manual de aprendizaje.
Servir como manual de referencia.
Definir las funciones que debe realizar el usuario.
Informar al usuario de la respuesta a cada mensaje de error.
Pasos a seguir para definir como desarrollar el manual de usuario.
Identificar los usuarios del sistema: personal que se relacionará con el sistema.
Definir los diferentes tipos de usuarios: se presentan los diferentes tipos de usuarios que usarían el sistema.
Ejemplo: usuarios directos, indirectos.
Definir los módulos en que cada usuario participará: Se describen los módulos o procesos que se ejecutarán por
cada usuario en forma narrativa breve y clara.
Importancia Del Manual De Usuario
El Manual de Usuario facilita el conocimiento de:
Los documentos a los que se pueden dar entrada por computadora.
Los formatos de los documentos.
Las operaciones que utiliza de entrada y salida de los datos.
El orden del tratamiento de la computadora con los datos introducidos.
El momento en que se debe solicitar una operación deseada.
Los resultados de las operaciones realizadas a partir de los datos introducidos.
Al elaborar el Manual de Usuario, hay que tener en cuenta a quién va dirigido es decir, el manual puede ser
manejado desde el director de empresa hasta el introductor de datos. Por consiguiente, debe redactarse de forma
clara y sencilla para que lo entienda cualquier tipo de usuario.

3. Universidad Politécnica Territorial Andrés Eloy Blanco
Programa Nacional de Formación en Informática
Ing. Lissette Torrealba
Ejemplo de Manual de Usuario de un sistema de Estadística

4. Universidad Politécnica Territorial Andrés Eloy Blanco
Programa Nacional de Formación en Informática
Ing. Lissette Torrealba
Formación a los Usuarios
Preparación de la Formación
1. Diseñe la capacitación para los distintos niveles de usuarios.
2. Reproducción del material a utilizar en la capacitación.
3. Preparación de todo el material que será utilizado en las capacitaciones, esto incluirá los manuales de
usuario.
4. Preparación de los grupos a capacitar. El personal usuario del sistema, será dividido en grupos de
acuerdo a los niveles de acceso para que la capacitación sea impartida de acuerdo a lo que cada usuario
necesita

5. Universidad Politécnica Territorial Andrés Eloy Blanco
Programa Nacional de Formación en Informática
Ing. Lissette Torrealba
Plan de Formación
Esta actividad permite la formación del personal en las opciones a las que tendrán acceso dentro del sistema.
Los tópicos que formarán parte de esta capacitación son los siguientes:
Tema Actividades Recursos Personal
involucrado
Fecha/Tiempo
Presentación
/Bienvenida
 Presentación del taller,
a cargo del equipo
investigador,
exposición de objetivos.
Video Beam
Computadora
Todos los usuarios
del sistema
dd/mm/aa;
hh:mm:ss
Iniciación en el
uso del
software xxxxx
 Acceso alsoftware:
Iniciar Sesion
 Opciones de cada
módulo del sistema
 Uso de los paneles de
opciones
 Salir del software
Video Beam
Computadora
Manual de
Usuario
Sistema
Todos los usuarios
del sistema
Utilización de
SI xxx:
Módulo xxxx
(Por cada
módulo )
 Registro xxxx
 Actualización xxxx
 Eliminar xxxx
 Consultar xxxx
Personal
Involucrado con las
opciones de
Administrador por
ejemplo
Utilización de
SI xxx:
Módulo
Reporte
 Reportes en Lotes
 Reportes
parametrizados
Todos los usuarios
del sistema
Utilización de
SI XXX:
Módulo
AYUDA
 Contenidos de ayuda
de los módulos
 Acceso alsitio web
 Acerca de SI
Todos los usuarios
del sistema
Actividad a Realizar
Realiza el plan de Formación y Manual de Usuario de tu sistema propuesto en PSTII