• Author / Uploaded
• Alejandro Perdomo

Citation preview

UNIDAD 4 -Documentación de Sistemas 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. -Manuales Durante el desarrollo de un sistema, desde su concepción hasta su puesta en marcha se ha generado gran cantidad de documentos, que en muchas ocasiones se han visto modificados por documentos posteriores debido a cambios en el sistema. Para evitar confusiones en las revisiones de la documentación se desarrollan diferentes tipos de documentos dirigidos a las personas que trabajarán con el sistema y para facilitar el mantenimiento del mismo. La documentación de un sistema debe ser marcada adecuadamente, bien organizada actualizada y completa; todos los términos utilizados deben explicarse. La documentación se hará disponible a todos los usuarios dc acuerdo a sus necesidades. -Detalles para su Elaboración El estilo de redacción de los manuales de documentación debe ser:       

Concreto. Ser preciso y definir los términos utilizados. Utilizar párrafos cortos. Utilizar títulos y subtítulos. Utilizar formas activas en lugar de pasivas. No emplear frases largas que presenten hechos distintos. No hacer referencia a una información solamente con el número de referencia.

-Manual del Sistema y Manual de Usuario Manual del Sistema 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 silo expuesto en él satisface los requerimientos del propio sistema. Una vez lograda la aprobación, se estará en condiciones de iniciar el desarrollo del Sistema propuesto e ir integrando el resto de la documentación. 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. Debe contener:  

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: Compendio de lo puntos que se describen en el manual, el cual tiene como propósito permitir a los altos ejecutivos enterarse en forma somera de la propuesta del sistema. Planteamiento: Este punto tiene como finalidad registrar los antecedentes que servirán de partida al desarrollo del análisis del sistema. Objetivos Del Sistema: Aquí se dejarán establecidos los objetivos que debe cubrir el sistema, en forma clara y precisa para evitar errores de interpretación. Entradas Del Sistema (Información A Captar): Debe quedar especificado en este punto, los documentos fuentes que inician las operaciones del sistema así como la información detallada de aquellos conceptos que serán los datos a captar por el sistema. Salidas Del Sistema (Resultados A Obtener): En este punto, solamente se describirán los resultados de mayor importancia obtenidos a través de todo el proceso. Diagramación General Del Sistema: Es la representación gráfica de las fases del Sistema y su flujo a través de las dependencias que intervienen en el mismo, aunque en forma generalizada. Explicaciones De Las Fases Del Sistema: Este punto se encuentra relacionado con el anterior ya que lo que se muestra gráficamente, ahora se describe en forma genérica, explicando los procesos que se llevan a cabo en cada dependencia sin profundizar en detalles técnicos o específicos. Consideraciones Generales Del Nuevo Sistema: En este punto se deberá señalar las ventajas, desventajas, y principales diferencias del nuevo sistema con el anterior, tales cómo seguridad, disminución de costo, ahorro de tiempo, flexibilidad, confiabilidad y otros.

Manual del 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. Objetivos del Manual de Usuario:      

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. Debe contener:

 



Diagrama general del sistema: Muestra en forma condensada el flujo general de la información y de las actividades que se realizan en el sistema. Diagrama particular detallado: Presentar gráficamente todos los pasos que se efectúen dentro del departamento usuario a quien está dirigido este manual. Deben especificarse los archivos de entrada, salida, los resultados, revisiones y procesos manuales. Explicación Genérica De Las Fases Del Sistema: En este punto se explica en forma específica y detallada todas las operaciones que aparecen representadas en forma gráfica en el diagrama particular.

 

Instalación Del Sistema: La instalación del sistema proporciona detalles completos sobre la forma de instalar el sistema en un ambiente particular. Iniciación Al Uso Del Sistema: En este punto se explica cómo iniciarse en el sistema y cómo se pueden utilizar sus cualidades comunes. Esta documentación debe decir al usuario cómo salir de un problema cuando las cosas funcionan mal.