2. Herramientas de
Documentación de Software
Actividad de Aprendizaje 9 Manuales
Maria Helena Parra Cárdenas.
John Fredy Rodriguez Moreno.
Jean Paul Rodríguez Baquero
4. Manual Administrativo
• Sirve como punto de partida al Sistema propuesto, ya
que será función de la gerencia, de acuerdo con los
usuarios de dicho sistema, determinar si lo expuesto en
él satisface los requerimientos del propio sistema.
• El manual tiene como finalidad el permitir a la alta
gerencia tener la información necesaria y suficiente
sobre un sistema en particular y servir como fuente de
consulta una vez que el Sistema ha sido implantado.
5. Manual Administrativo
Contenido
• Nombre del sistema.
• Describir el nombre del sistema a implantar en la
empresa.
• Equipo Encargado Del Sistema.
• Nombre del personal encargado del análisis y diseño del
sistema.
• Resumen Administrativo.
6. Manual Administrativo
Contenido del Resumen Administrativo
Este punto tiene como finalidad registrar
los antecedentes que servirán de partida al
desarrollo del análisis del sistema.
Planteamiento
Se debe mencionar:
Dependencia que requirió el trabajo.
Objetivos del sistema.
Entradas del sistema (información a captar).
Salidas del sistema (resultados A obtener).
Diagramación general del sistema.
Explicaciones de las fases del sistema.
Requerimientos del sistema.
Estimación de la fecha probable de
implementación del sistema.
Consideraciones generales del nuevo
sistema.
7. Manual de Usuario
Expone los procesos que el usuario puede realizar con el
sistema implantado.
• Reúne la información, normas y
documentación necesaria para
que el usuario conozca y utilice
adecuadamente la aplicación
desarrollada.
8. Manual de Usuario
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.
Importancia Del Manual De Usuario
Pasos a seguir para definir como desarrollar
el manual de usuario.
•
•
El Manual de Usuario facilita el conocimiento de:
•
•
•
•
•
•
•
Los documentos a los que se puede 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.
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.
9. Manual de Usuario
Contenido
• Diagrama general del sistema.
• Diagrama particular detallado.
• Explicación genérica de las
fases del sistema.
• Iniciación al uso del sistema
• Manual de referencia.
• Caducidad de documento
fuente Y destino final.
10. Manual de Captación
Permite tener una clara visión del proceso
de Captación de los datos fuentes previo al
procesamiento electrónico de los mismos.
11. Manual de Captación
Objetivos
• Documentar al usuario a cerca del recorrido
a través de las pantallas del sistema.
• Conocer la forma cómo el usuario puede
utilizar el equipo necesario para la ejecución
del sistema.
12. Manual de Captación
Contenido
• Diagrama general del sistema
• Diagramas de pantalla:
Puntos a documentar en una pantalla
Uso del equipo
Entrenamiento del software de la aplicación
Explicación del software utilizado en complemento al
sistema.
Situaciones anormales
Entregas al computador
Caducidad de documentos fuentes
