Elaborado por C.P.

María Beatriz Abrach

Documentación de Sistemas

El objetivo del presente documento es sistematizar y puntualizar los conceptos

más importantes que el alumno deberá manejar en cuanto a la documentación de
sistemas.
La Documentación de sistemas consiste en un conjunto de información
relacionada a un sistema determinado que explica las características técnicas, la
funcionabilidad del sistema, los diagramas de flujos, los programas, las 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.
Aunque todos los participantes de los proyectos de sistemas son conscientes de
la importancia de la documentación, muchas veces no se le da el protagonismo que se
merece, asignando tiempo y recursos a su construcción en el plan de proyecto. Por un
lado, los sistemas se construyen y modifican en forma rápida, para seguir el ritmo de
la dinámica de la organización, sin invertir tiempo en la documentación de los cambios.
Por otro, los participantes de los proyectos de sistemas conocen a fondo el proyecto y
no necesitan documentación durante la construcción y se olvidan de los futuros
operadores y administradores de esos sistemas.
Muchas organizaciones tienen lo que se conoce como un "programa de
documentación", el cual consiste en una política formal cuya documentación se
muestra como algo que debe prepararse en forma rutinaria para nuevo sistema o
modificación en programas y archivos de sistemas existentes, pero no siempre se
exige que se cumpla realmente en la práctica.
Toda documentación que se relacione con un sistema, ya sea manual o por
computadora, sencillo o complejo debe reunir los siguientes requisitos básicos:
• Debe ser rotulada con claridad y bien organizada, con secciones
claramente indicadas, estructuradas en carpetas e incluir un índice.
• Los diagramas deberán ser claros, no aglomerados y la escritura
manuscrita deberá ser legible.
• La documentación deberá ser completa.
• Se incluirá una leyenda o explicación de los términos utilizados.
• La documentación siempre se conserva actualizada.
La documentación adecuada y completa, de una aplicación que se desea
implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier

Material de estudio elaborado por C.P. María Beatriz Abrach

sistema de información, sin embargo, frecuentemente es la parte a la cual se dedica el
menor tiempo y se le presta menos atención.
La documentación permite entender un sistema a quien lo vaya a usar para
realizar mantenimiento, para permitir auditorias del mismo y para enseñar a los
usuarios como interactuar con él y a los operadores y administradores como hacerlo
funcionar.
La documentación tiene una gran importancia dentro de una empresa, ya que
ayuda a eliminar la posible dependencia que se pueda formar entre el proyecto
realizado, y el ejecutor de éste. Para que toda aplicación tecnológica y todo servicio
informático quede adecuadamente documentado, es necesario exigirle a quien lo
diseñe y/o desarrolle (puede ser personal interno o un proveedor) que entregue dicha
documentación obtenida a través del desarrollo del proyecto, de manera que otras
personas relacionadas o autorizadas por la empresa accedan a los conocimientos
necesarios para corregir errores, hacer ajustes, etc. La oposición que entregan los
técnicos a la realización del proceso de documentación, se basa principalmente en los
costos en que se incurre para su construcción y en el mayor plazo de entrega. Pero
estas justificaciones no son posibles de sustentar en la realidad, ya que el mayor costo
en que se incurre para documentar se recupera con creces en el futuro, especialmente
cuando se ve enfrentado a un error del sistema o tener que efectuarle mantenimiento.
La documentación puede llevarse adelante en forma manual o en forma
automática, utilizando software especial. Este último tipo de documentación no está
disponible para todas las plataformas. Estas dos formas de documentación no son
incompatibles entre sí, por lo que puede usarse una combinación de ambas.
Ventajas y desventajas de la documentación manual:
1. Ventajas:
a. Refleja historia.
b. Muestra la evolución de la documentación en el tiempo.
c. Más explicativa.
d. Se adecúa a la cultura de la organización.
2. Desventajas
a. Consume mucho esfuerzo en construirla.
b. Documentación incompleta, por el trabajo que implica reunir toda la
información.
c. Más lenta y sin actualizar.
d. Errores de escritura
Ventajas y desventajas de la documentación automática

Material de estudio elaborado por C.P. María Beatriz Abrach

 1. Ventajas
a. Es inmediata y está siempre actualizada.
b. Justo a lo requerido.
c. No se encuentra sujeta a la disposición del personal.
2. Desventajas
a. Consume recursos de Hardware.
b. No siempre disponible, pues no hay disponibilidad para todas las
plataformas.
c. No es explicativa
d. Costo, es un software que debe adquirirse
¿Qué debe documentarse?
Debemos tener presente que para que la documentación se realice
efectivamente desde el inicio del proyecto, no debe ser una tarea más del proyecto,
sino el resultado del desarrollo del mismo. Se debe documentar, a través de los
papeles de trabajo que se generan como consecuencia del desarrollo del proyecto.
Para que la documentación de sistemas tenga sentido, debe pensarse en el
contexto de una metodología de desarrollo, por lo que se deberán generar diferentes
documentos en cada etapa de sistemas, en función de la metodología aplicada.
Ejemplos de documentación de sistemas:
1) Utilizando la Metodología Estructurada
Etapa Documentación Tareas
Definición de • Diagnóstico de la situación y Detección de objetivos y límites
requerimientos necesidad del sistema del sistema y su interacción con
(se incluye • Declaración de Objetivos el ambiente
dentro del • Diagrama de Contexto En base a entrevistas con
análisis) • Lista de Requerimientos usuarios
• Glosario
• Diagrama de Gantt del
proyecto (preliminar)
Análisis • Diagrama de Flujo de Datos Relevamiento de la situación
(sistema actual) actual.
• Diagrama Entidad Relación Formalización de objetivos,
(sistema actual) independiente de la naturaleza
• Diccionario de Datos (sistema de la tecnología a aplicar y de
actual) cualquier cuestión de
• Diagrama de Gantt del implantación.
proyecto (actualización)
Diseño • Diagrama de Flujo de Datos Determinación de entidades,
• Especificación de procesos con atributos e interrelaciones
• Diagrama Entidad Relación Determinación de procesos
• Diccionario de Datos Elección del entorno tecnológico
• Diagrama de Transición de Establecimiento de la

Material de estudio elaborado por C.P. María Beatriz Abrach

 Estados arquitectura de la aplicación
• Diagrama de hardware Diseño de Interfaces de
• Justificación del entorno usuarios y procesos
tecnológico
• Modelo de Tareas: Diagrama
de Fronteras
• Modelo de implantación de
programas: Diagrama
estructurado
• Interfaces de usuario:
Prototipos de pantallas y
reportes
• Base de datos: estructura
• Diagrama de Gantt del
proyecto (actualización)
Desarrollo (se • Normas de programación y Implementación
incluye dentro estándares de nomenclatura Creación base de datos
del diseño) • Esquema definitivo de la Codificación e integración de
Base de Datos módulos
• Código fuente (con
documentación incorporada)
• Diagrama de Gantt del
proyecto (definitivo)
Implementación • Código fuente definitivo (con Pruebas unitarias
y control documentación incorporada) Pruebas de Integración
• Documentación sobre las Carga de tablas de
pruebas realizadas configuración
• Manual de Usuario Migración de Datos e instalación
• Pautas para migración de Capacitación si corresponde
datos
• Manual de administración y
soporte técnico
• Descripción general para el
usuario no informático
2) Utilizando Orientación a objetos
Etapa Documentación Tareas
Inicio (análisis) •Diagnóstico de la situación y Detección de objetivos y
necesidad del sistema límites del sistema y su
Aspectos funcionales: interacción con el ambiente
• Declaración de propósitos Despliegue tentativo
• Diagrama de Contexto Planificación de las iteraciones
• Listas de casos de uso y en que se irá construyendo el
actores, con diagramas de sistema
casos de uso Formalización de requisitos de
• Glosario escalabilidad, disponibilidad,
Aspectos Tecnológicos: seguridad, mantenimiento y
• Diagrama de despliegue desempeño
tentativo
• Diagrama de Gantt del
proyecto
Elaboración Aspectos funcionales Descripción detallada de los
(diseño) • Diagrama de la base de datos casos de uso más

Material de estudio elaborado por C.P. María Beatriz Abrach

 • Modelo de casos de uso más importantes. Priorización de
importantes: lista y los mismos.
descripción de casos de uso, Determinación de las clases
con sus diagramas de de análisis (parcial), a partir
actividades, de interacción o de los participantes de los
de estado, si corresponde casos de uso descriptos.
• Diagrama de clases Descripción de su
conceptual (parcial), comportamiento.
esquemático y con Determinación de las
responsabilidades interfaces de usuario para
Aspectos no funcionales: cada caso de uso descripto.
• Justificación del entorno Establecimiento de la
tecnológico arquitectura de la aplicación.
• Prototipos de pantallas y Determinación de las clases
reportes de arquitectura más
• Diagrama de componentes importantes.
mostrando la arquitectura Diseño de la base de datos.
• Prioridades de los casos de Determinación de las normas
uso descriptos de programación y estándares
• Normas de programación y de nomenclatura
estándares de nomenclatura
Construcción Aspectos funcionales Descripción detallada de los
(desarrollo) • Modelo de casos de uso para casos de uso restantes.
los restantes: lista y Priorización de los mismos.
descripción de casos de uso, Determinación de las clases
con sus diagramas de de análisis restantes, a partir
actividades, de interacción o de los participantes de los
de estado, si corresponde casos de uso descriptos.
• Diagrama de clases completo Descripción de su
• Diagramas de comportamiento.
comportamiento en los casos Determinación del resto de
necesarios: de estados y de las clases de arquitectura y
interacción descripción del
• Código fuente (con comportamiento.
documentación Diseño de las interfaces de
incorporada) usuario.
• Documentación sobre Creación de la base de datos.
pruebas realizadas Codificación.
• Esquema definitivo de la base Realización de pruebas
de datos parciales y de integración.
Aspectos no funcionales:
• Prioridades de los casos de
uso restantes
• Prototipos de las interfaces
de usuario
• Diagrama de despliegue y
componentes definitivo
Transición Manual de Usuario Pruebas de sistema y de
(Implementación) • Pautas para migración de aceptación
datos Cargas de tablas de
• Manual de administración y configuración
soporte técnico Migración de Datos
• Descripción general para el Afinación

Material de estudio elaborado por C.P. María Beatriz Abrach

 usuario no informático
• Actualización de toda la
documentación que sea
necesario actualizar
3) Utilizando Metodologías ágiles: debe tenerse presente que las etapas de Análisis,
Diseño e Implementación se realizan en cada sprint.
Etapa Documentación Tareas
Análisis (en cada • Lista de requerimientos Definición de requerimientos
sprint) funcionales del proyecto, a desarrollar y entregar en el
priorizados. sprint (sub etapa del
• Construcción de User Stories proyecto)
de los requerimientos a
encarar
Diseño • Definición entorno tecnológico Desarrollo de las User’s
• Diseño de interfases de Stories definidas.
usuario
• Diseño de base de datos
• Código fuente con
documentación
• Diseño casos de prueba
Implementación • Lista de comprobación de Pruebas de aceptación de los
demo del sprint entregables del sprint.
Implementación.
Priorización de los
requerimientos pendientes
para hacer el lanzamiento del
siguiente sprint.

Conclusión:
Habiendo dejado constancia de la importancia de la documentación de los
proyectos de sistemas, se debe tener presente al seleccionar la modalidad con la que
se realizará, que nunca los costos de tenerla deberán superar al beneficio que podría
reportarle a la organización. Y para que esta elección sea exitosa, deberá tenerse en
consideración la cultura de la organización.

Material de estudio elaborado por C.P. María Beatriz Abrach