Documentación de Sistemas

Documentación de Sistemas: La elaboración de la documentación es un proceso esencial para poder garantizar la calidad del software, lo cual requiere una adecuada asignación de recursos financieros, materiales, humanos y de tiempo, o sea, la calidad del proceso de elaboración de la documentación se traduce en calidad del software.
La Documentación de Sistema consiste en un conjunto de informaciónrelacionada a un sistema determinado que explica las características técnicas, la funcionabilidad del sistema, la parte lógica, los diagramas de flujos, los programas, la naturaleza, capacidades del sistema y cómo usarlo, en otras palabras.
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?

Objetivos de ladocumentación de sistemas
Definir detalladamente el sistema
Explicar las características técnicas y la operación de un sistema.
Mejorar la comunicación
Proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo y para enseñar a los usuarios como interactuar con el sistema y a los operandos como hacerlo funcionar.
Vinculo para la capacitación
Ayudar al entrenamiento del nuevopersonal dentro y fuera de la organización de sistemas.
Optimizar la gestión de mantenimiento
Ser de utilidad para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.
Fomentar la integración
Ayudar a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.
Proporcionar estabilidad al sistema
Asegurar que el sistema opere correctamente.
Minimizar elconsumo de recursos
Utilizar eficientemente los recursos que se dispongan.



Características de los Sistemas de Documentación
Deben ser aprobados, firmados y fechados por las personas apropiadas y autorizadas, ningún documento puede ser cambiado sin autorización.
El contenido de los mismos no puede ser ambiguo, el título, tipo y propósito deben estar establecidos claramente.
Deben ser legibles.Sencillez, definir las especificaciones de todos los materiales, procesos tecnológicos, control y de las actividades relacionadas con la investigación.
Seguridad, evitar errores.
Eficiencia y efectividad, asegurar que todo el personal relacionado con la investigación sepa qué hacer y cuándo hacerlo.
Los documentos deben estar donde se les necesita, usarse por quien los requiere sin modificaciones noautorizadas, y ser llenados veraz y oportunamente.

Documentación Manual: este tipo de documentación se efectúa manualmente. Puede documentarse en papel o en algún medio magnético como CD. Se puede contar con el apoyo de software para su confección, como un procesador de texto, planilla electrónica y programas graficado res.
Ventajas
Refleja historia.
Muestra la evolución de la documentación enel tiempo.
Más explicativa.
Se adecúa a la cultura de la organización.
No consume capacidad de procesamiento.
Desventajas
Consume mucho esfuerzo en construirla.
Documentación incompleta.
Poca disposición para entregar información.
Más lenta y sin actualizar.
Errores de escritura 


Documentación Automática: en este tipo de documentación, existe software que documentan. Pero estos software noestán disponibles para todas las plataformas, por lo que hay que revisar bien el ambiente en que se trabaja para ver si existe algún software de documentación compatible. Este tipo de documentación es muy útil para: 
Definir el plazo y costo de trabajos de mantención de software. Su utilización requiere de que el software a analizar haya sido desarrollado en base a alguna norma y, que esta norma hayasido respetada.
Apoyar labores de auditoría y control.

Ventajas
Es inmediata y está siempre actualizada.
Justo a lo requerido.
No se encuentra sujeta a la disposición del personal.
Desventajas
Consume recursos de Hardware.
No siempre disponible, pues no hay disponibilidad para todas las plataformas.
No es explicativa

Funciones de la documentación
La selección: de documentos a partir de...