Tecnicas de documentacion Sistemas Informaticos

TEMA 1.3. TÉCNICAS DE DOCUMENTACIÓN

EJERCICIO
Formar equipos de 5 integrantes, leer y elaborar un mapa mental sobre el tema, este deberá ser
entregado al terminar la clase en una página de papel bond con los nombres de los integrantes.
Ponderación 20% del 1º examen teórico.
1.3.1 RECOGIDA Y DOCUMENTACIÓN DE LA INFORMACIÓN
Es necesario contar con técnicas adecuadas para realizar la fase de diseñoy para tener documentado todo el proceso.
Por otro lado, la documentación constituye un problema porque en ocasiones los estándares para realizarla se
implantan después de que se llevó a cabo el proceso de desarrollo, además, documentar requiere de tiempo y de
recursos, lo cual provoca que se realice mantenimiento al sistema sin contar con la documentación adecuada.
Generalmente la documentaciónse realiza hasta que se concluye el desarrollo del sistema y en ocasiones con
premura para cumplir con el tiempo estimado. Esto puede tener como consecuencia una calidad pobre en la
documentación, y afecta después la operación y el mantenimiento del sistema.
La documentación de un sistema debe proporcionar un panorama del mismo, especificar los procedimientos que se
llevan a cabo y la forma deoperarlo. Además de esta documentación, la cual con mayor frecuencia se dirige al usuario,
debe documentarse y detallarse la estructura de archivos y programas con el objetivo de que pueda realizarse un
mantenimiento adecuado.
Se documenta el software y los procedimientos para que estén codificados en un formato que pueda ser fácilmente
accedido por los usuarios.
El acceso a los procedimientos esnecesario para la nueva gente que aprende el sistema y como un recordatorio para
aquellos que usan el programa con poca frecuencia.
La documentación garantiza la continuidad del mantenimiento de las aplicaciones.
Se debe asignar un responsable de administrar la documentación.
Al elaborar y actualizar la documentación, el encargado de esta actividad debe seguir los estándares establecidos para
talfin.
Al estandarizar la documentación del sistema, se logran varias ventajas tales como:
 Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas.
 Es útil para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.
 Ayuda a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.
 Asegura que el sistema operecorrectamente.
 Se utilizan eficientemente los recursos que se dispongan
La documentación consistente y bien conservada acortará la cantidad de horas requerida por las nuevas gentes que
aprendan el sistema antes de realizar el mantenimiento.
Requisitos básicos de la documentación:
a. Debe ser rotulada con claridad y bien organizada.
b. Los diagramas deberán ser claros, no aglomerados y la escrituramanuscrita deberá ser legible.
c. La documentación deberá ser completa.
d. Se incluirá una leyenda o explicación de los términos utilizados.
e. La documentación siempre se conserva actualizada.
f. Asegúrese de que los estándares sean completos, actualizados, documentados y legibles.
1.3.2 MANUALES EN PAPEL Y EN LINEA.
Un buen manual será usado repetidamente como referencia. Como tal, necesita estarorganizado en una forma lógica,
dándole mucho cuidado a las circunstancias que podrían pedir el uso del manual.
Los manuales impresos son importantes pues proporcionan una ayuda rápida cuando se les necesita. Deben tener un
índice bien claro y específico para que la búsqueda sea rápida. El lenguaje en que se redacten debe ser fácil de

entender y se deben considerar la mayoría de los casos de posibleserrores o preguntas frecuentes que los usuarios
puedan tener.
Al hacer los manuales en línea, especialmente el manual de usuario, se convierten en una herramienta poderosa que
apoya a los usuarios en el momento que lo deseen. Nos da la ventaja de que no necesitamos gastar papel para la
impresión, se puede consultar cada vez que se quiera, en forma rápida y varios usuarios a la vez. Algo que no...