Documentación de Sistemas - Analisis de sistemas

Documentación de sistemas 

La documentación de sistemas es una materia e el area de información bastante util para miembros cuyos conocimientos sobre informática son bajos o para futuras modificaciones del mismo.

Visto desde cierto punto de vista podemos decir que es como una póliza de seguro, pues en el contiene todo relacionado al sistema que se desarrolla y/o se mejora y/o se comercializa. Entoces el documento engloba un conjunto de información que explica que es el sistema.

• que hace
• para quien 
• y como lo hace

a su vez este documento esta abalado en tres ámbitos importantes Legal, Teórico y Publicitario

Legal:  este documento debe tener desde un registro hasta concordancia con las leyes de la nacion donde se Desarrolla,mejora o comercializa

Teorico : debe tener Explicación teórica para todo los procesos y salidas del sistema asi como su diagraman y ejemplos de la codificación.

Publicitaria: debe ser de fecil comprecion para los niveles profecionales menos involucrados en la informatica, sin embargo el sistema de pertenecer a un objetivo de area profecional especifico debe aclarar la mayoria de las dudas que podrian surgir asi como costos e implementacion.

Características de la documentación de sistemas:

•  Pertinencia: los documentos que se proporcionan deben responder a lasnecesidades específicas de los utilizadores.
• Exhaustividad: deben proporcionarse al usuario todos los documentos querespondan a sus necesidades.
• Rapidez: los documentos pertinentes deben transmitirse al usuario interesadoinmediatamente después de su publicación.
• Economía: el coste de la Documentación debe ser mínimo

Estandarizacion:

Significa que los símbolos convencionales se usan en todos los diagramas de flujo para prescribir el sistema y que en la documentación se usen formas estandarizadas.

Estas normas de documentacion pueden variar mucho entre las instalaciones pero dentro de una empresa u organización de use un solo metodo Esto genera muchas ventajas en el area de procedimientos y documentacion  estandarizadas pues da una eficaz base de comunicacion y adiestramientos del personal reduciendo asi costos de almacenamientos  y demas.

1. Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas.
2. Es útil para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.
3. Ayuda a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.
4. Asegura que el sistema opere correctamente.
5. Se utilizan eficientemente los recursos que se dispongan.

Uso de La estandarizacion:

1. La documentación debe tener esta organizada y clara su informacion asi como rutulada.
2. Sus diagramas no pueden estar aglomerados y su escritura legible
3. Se debe documentar el sitema completamente
4. Incluir leyenda o explicación de los terminos utilizados
5. y conservar lo mas actualizado el documento

Tipos de manuales 

Dentro de la documentacion de sistema se encuentra una gran cantidad de docuemtos que aclaran tanto a los creadores, desarolladores ,comercializadores,implementadores / personal de mantenimiento  y usuarios finales. Caracteristicas y objetivos del sistema, aunque en muchos casos esta documentación se encuentra totalmente agrupada en un solo documento lo cierto es que la metodología correcta es tenerlos por separado y mas aun cuando el sistema tiene una forma de venderse o comercializar diferente o por etapas.

                                                             

Administrativo 

El objetivo de este manual  es transmitir la información del sistemas a la gerencia que usara el sistema y poder servir de fuente de consulta, una vez halla sido implementado. La informacion que contiene este documento es de alguna forma simplificada en caso de que la gerencia no maneje la terminologías científicas adecuadas al sistema, asi como especificar uso y objetivo del mismo. Este documento tiene el siguiente contenido y descripción general

1. Nombre del sistema
2. Describir el nombre del sistema a implantar en la empresa.
3. Equipo Encargado Del Sistema
4. Nombre del personal encargado del análisis y diseño del sistema.
5. Resumen Administrativo (costos, servicios y contrato)
6. Planteamiento del sistema ( responde al problema y solución mediante este sistema)
7. Dependencias y Requisitos 
8. Objetivos del Sistema
9. Entradas del Sistema 
10. Salidas del Sistema 
11. Diagramacion de sistemas ( de ser uso interno por la misma empresa responde todo sobre la codificación, diagramas de clases y estructuras de base de datos del sistema )
12. explicación de la faces del sistema: (de ser un sistema integral conformado por múltiples sistema este es explicado en cada una de las faces que puede resolver a su vez explica la metodología y pasos a seguir en el momento de implementacion del sistema)
13. plan de fechas a implementar

Manual de usuario:

Este documento tiene un grado de tecnicismo variable dependiendo de el tipo de sistema y del objetivo del usuario. En lineas generales le da los conocimientos basicos para el correcto proceder del sistema asi como resolución de posibles problemas o preguntas. En caso de ser un manual avanzado explica mas a fondo muchos de sus procesos y pregusta que no estarían disponible por ejemplo para un usuario del sistema mas básico. El manual de usuario es un documento con un grado de lenguaje basico asi como una gran cantidad de ilustraciones como dibujos y foto-capturas del sistema para asi guiar de manera mas facil al usuario. La estructura general de este documento es asi

1. Una página de portada.
2. Una página de título.
3. Una página de derechos de autor.
4. Un prefacio, que contiene detalles de los documentos relacionados y la información sobre cómo navegar por la guía del usuario.
5. Una página de contenido.
6. Una guía sobre cómo utilizar el sistema ( puede ser básico o avanzado altamente ilustrada)
7. Una sección de solución de problemas que detalla los posibles errores o problemas ( con solución)
8. Una sección de preguntas frecuentes.
9. Contactos de la empresa ( web, teléfono y dirección)
10. Un Glosario y, para documentos más grandes, un Índice.

Manuales de referencias:

Los manuales de usuario deben contener dentro de su estructura un manual de referencia pero a menudo estos documento suele proporcionarse por separado. En el se encuentra detalles las cualidades del sistema y su uso, los informes de error generados y las situaciones en que surgen esos errores.

Manual de captación:

Este documento tiene con finalidad explicar los procesos de captacion y tratameinto de la data Afin de explicar y justificar reportes y valores finales dentro del sistema. Por otra parte en caso de ser un sistema amplio y especializado este documento contiene la información para recursos  humanos de como debe tener el perfil laboral un usuario final para minimisar los niveles de inducion y errores en procesos. este documento Detalla lo sigueintes datos

objetivo
Diagrama General Del Sistema (modulos y reportes )
Diagramas De Pantalla ( explicando la ruta, tipos de datos y  formato de captura de los datos )

Nivel de conocimientos académicos necesaria para cada parte del sistema

Manual de Desarrollo

Este manual es privado para la empresa que creo el sistema. En el contiene información Avanzada sobre todo el sistema pero desde el punto de creación, mejoras y cambios  y por ultimo departamentos y personal encargados en el desarrollo del mismo.

Este manual tiene una estructura variable pero mantiene una estandarizacion clara y continual a la de la empresa pero puede diferir mucho de los documentos anteriores pues en el contiene informacion detallada y en lenguaje tecnico sobre el sistema. Este documento mas que una estructura responde en su contenido preguntas sobre el sistema a un nivel tecnico para facilitar los procesos de desarrollo futuros en caso de cambio de personal que desarrollo originalmente el sistema. en orden segun la logica seria asi:

• Objetivos del sistema 
• Datos tecnicos sobre lenguaje , plataforma de desarrollo y plataforma final
• Esturctura y formato de almasenamientos
• formatos y estructura de salidas de datos
• normativas, estandares y formas de diceño del entorno grafico
• diagrama de capas del sistema 
• diagramas de clases:

1.  explicando razón de la clase y uso,
2.   metodos, 
3. metodos tipados
4.  ,sobrecargas
5.  retornos
6.  asi como conexiones entre otras clases  y otras capas del sistema

• diagrama y estructura de datos
•  entradas y salidas externas al sistema
• plan de implentacion 
• plan de soporte y servicio
• Actualizaciones y sietmas satelites 
• ordenacion de ultimas actualizaciones y verciones
• manual de errores