Resumen de los pasos para la documentación de sistemas

1. UNIVERSIDAD GRAN MARISCAL DE AYACUCHO
FACULTAD DE INGENIERIA
INGENIERIA EN INFORMÁTICA
NUCLEO BOLÍVAR
BACHILLER:
PROFESOR: Charlis de Assis
Jose Molina. C.I 18.828.964

2.  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
PRINCIPAL FUNCIÓN
 Enseñar a los usuarios como interactuar con el sistema y a
los operadores como hacerlo funcionar.

3. Existen varios tipos de documentación:
DOCUMENTACION DE PROGRAMAS:
Es aquella que explica la lógica de un programa e incluye descripciones, diagramas
de flujo, listados de programas y otros documentos
OJO.-
Para que el mantenimiento de una aplicación informática sea lo más fácil
posible, es conveniente disponer de toda su documentación, esto es, de todos
los documentos que se han ido generando en todas las etapas anteriores: ERS,
algoritmos, códigos fuentes, manuales de usuario, etc. A todo este tipo de
documentación se le considera externa. Además, existe otro tipo de
documentación llamada interna.
La documentación interna de un programa son los comentarios que el
programador puede escribir en el código fuente de un programa.

4. DOCUMENTACION DE USUARIO:
La del usuarios en forma general la naturaleza y capacidades del sistema y
cómo usarlo.
Como por ejemplo: 3. Manual de aprendizaje o tutorial
· Conocimiento del usuario  Guía de aprendizaje o autoformación
de las
· Conocimiento profundo del producto
funcionalidades básicas del sistema
 Documentación interactiva de
SEGÚN AL TIPO DE USUARIO:
iniciación al
1. Guías de referencia producto
 Dirigido a Tecnicos
 Referencias exhaustivas de las capacidades del sistemas
2. Guías de usuarios.-
 Acceso amplio y poco profundo a las funcionalidades del
sistema
 Comportamiento del usuario (secuencias, acciones)
para conseguir sus objetivos

5. La importancia de la documentación bien podría ser comparada con la importancia
de la existencia de una Póliza de Seguro; mientras todo va bien no existe la
precaución de confirmar si nuestra Póliza de Seguros está o no vigente.
La documentación adecuada y completa, de una aplicación que se desea
implantar, mantener y actualizar en forma satisfactoria, es esencial en
cualquier Sistema de Información, sin embargo, frecuentemente es la parte a
la cual se dedica l menor tiempo y se le presta menos atención.
Siempre se debe documentar un sistema como si estuviera a punto de irse
a Siberia el siguiente mes, para nunca volver. Si la documentación del
sistema es incompleta el diseñador continuamente estará involucrado y no
podrá moverse a otra asignación.

6.  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.

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

8. Pasos a seguir para definir como desarrollar el manual de usuario:
1.-Identificar los usuarios del sistema: personal que se
relacionará con el sistema.
2.- Definir los diferentes tipo de usuarios: se presentan los
diferentes tipos de usuarios que usarían el sistema. Ejemplo:
usuarios directos, indirectos
3.- 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. IMPORTANCIA:
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.
 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 la empresa hasta el introductor de datos.
Por consiguiente, debe redactarse de forma clara y sencilla
para que lo entienda cualquier tipo de usuario.

10. CONTENIDO DEL MANUAL DE USUARIO.-
Diagrama general del sistema
Diagrama particular detallado.
Explicación Genérica De Las Fases Del Sistema
Instalación Del Sistema
Iniciación Al Uso Del Sistema

11.  La palabra auditoría viene del latín auditorius y de esta proviene
auditor, que tiene la virtud de oir y revisar cuentas, pero debe estar
encaminado a un objetivo específico que es el de evaluar la eficiencia y
eficacia con que se está operando para que, por medio del señalamiento
de cursos alternativos de acción, se tomen decisiones que permitan
corregir los errores, en caso de que existan, o bien mejorar la forma de
actuación.
 La verificación de controles en el procesamiento de la información,
desarrollo de sistemas e instalación con el objetivo de evaluar su
efectividad y presentar recomendaciones a la Gerencia.
 El examen y evaluación de los procesos del Area de Procesamiento
automático de Datos (PAD) y de la utilización de los recursos que en
ellos intervienen, para llegar a establecer el grado de eficiencia,
efectividad

12. PRINCIPALES OBJETIVOS:
 Buscar una mejor relación costo-beneficio de los sistemas
automáticos computarizados diseñados e implantados por el PAD.
 Incrementar la satisfacción de los usuarios de los sistemas
computarizados
 Asegurar una mayor integridad, confidencialidad y confiabilidad de la
información mediante la recomendación de seguridades y controles
 Seguridad de personal, datos, hardware, software e instalaciones
 Apoyo de función informática a las metas y objetivos de la
organización
 Minimizar existencias de riesgos en el uso de Tecnología de
información

13. Fin de la sesión.