Pauta para hacer diseos lgicos y fsicos

Por Omar E. Vega (2008)

Introduccin
La presente es una pauta para hacer diseos lgicos y fsicos. El documento tiene un
enfoque prctico y no est asociado con metodologas formales, sino que refleja lo que
se hace en la prctica profesional. Debido a la ambigedad presente en las fuentes de
informacin, sta pauta de diseo lgico y fsico pretende hacer un detalle preciso y
completo de lo que debe incluir tanto el diseo lgico como fsico.
El documento ser usado como gua para preparar la documentacin en los talleres de
bases de datos e Internet.

Sobre la presentacin del diseo

Debe quedar claro que el diseo lgico y fsico son dos documentos diferentes, cada
uno de los cuales se evaluar por separado. Ambos tienen temas en comn pero difieren
en el grado de profundidad y estn orientados a pblicos diferentes.
Aquellos trabajos que no hagan la distincin entre diseos lgicos y fsicos sern
penalizados.

Definiciones
Diseo lgico
Un diseo lgico es un conjunto de documentos que definen las funciones y
comportamiento de un sistema de informacin. Corresponde a lo que se llama una
ingeniera bsica del sistema en la ingeniera general. El diseo lgico traduce los
casos de uso creados en el levantamiento de requerimientos en un conjunto de
funciones detalladas. El diseo lgico es independiente de la tecnologa. El diseo
lgico refina, organiza y detalla la solucin de negocios (levantamiento) y define
formalmente las reglas y polticas especficas del sistema en particular.
El diseo lgico se convierte en parte en la especificacin funcional que se usa como
dato de entrada para hacer un diseo fsico, por lo tanto se debe completar el primero
antes de hacer el segundo. Este diagrama refleja esa relacin.

Caracterstica principal del diseo lgico: Se trata de un diseo general de un sistema de

informacin que puede ser implementado sobre cualquier plataforma. Vale decir, el
mismo sistema puede construirse para que funcione en distintos computadores, sistemas
de informacin, marcas de administradores de bases de datos y niveles tecnolgicos
diversos. Debido a esto, el diseo lgico debe ser flexible, objetivo que se cumple
definiendo las funciones en forma abstracta.
Los lectores de los diseos lgicos son los analistas de sistema (que preparan diseos
fsicos), jefes de proyecto y los especialistas que usarn los sistemas en las empresas.
Nota: es importante no confundir un diseo lgico o fsico con un diagrama particular
que genere un software, tal como los que produce Data Architect por ejemplo. Si bien
ese tipo de herramientas ayudan a crear documentos que se incluyen en diseos lgicos
y fsicos, ellas NO GENERAN la documentacin de diseo en forma automtica. En
otras palabras, presentar slo un diagrama cmo un diseo se considerar un trabajo
incompleto.

Diseo fsico
Un diseo fsico es un conjunto de escritos y diagramas que documentan las
instrucciones para construir fsicamente un sistema de informacin. Su objetivo es servir
como planos para la programacin y debe contener tambin las instrucciones para
montar y operar el software sobre equipos reales. Es equivalente a lo que en ingeniera
general se conoce como la ingeniera de detalle de un proyecto y sus lectores sern
principalmente gente especializa en informtica: analistas, programadores,
administradores de bases de datos, jefes de proyectos e ingenieros de sistemas.

Como ingeniera de detalle, el diseo fsico deber documentar por separado cada
mdulo de programa, cada pantalla y cada procedimiento que se implemente, como
tambin la forma en la cual ser implementado el proyecto.

Estructura general de los documentos de diseo

La siguiente es una estructura general del documento que los alumnos debern entregar
en la presente etapa del proyecto. Su objetivo es guiarlos para crear documentos
completos y facilitar la evaluacin de sus trabajos. No pretende ser una gua exhaustiva,
sino solamente detallar lo necesario para los proyectos presentes.
Estructura del diseo lgico:
Un diseo lgico est orientado a ser ledo y validado por gente que entiende del
negocio de la empresa. Por lo tanto, no debe contener detalles tcnicos de la
implementacin, que estas personas pueden no entender.
Introduccin:
Breve introduccin al sistema (no a la empresa) y a su funcionamiento.
Funciones del sistema:
Cada funcin del sistema implementa una actividad definida en el
levantamiento. Ejemplo de funciones son: ingreso de datos para alumnos, consulta de
estado de pago de un cliente, creacin de un perfil de usuario, emisin de listado de
deudores, respaldo mensual, etc. Las funciones pueden contener subfunciones que
hagan tareas especficas, tales como el clculo del rut de un digito verificador o la
creacin de un cliente en las bases de datos.
Para todo el sistema:
Diagrama de sistema.
Use diagramas de entrada y salida de datos. Este diagrama debiera
describir la jerarqua e interaccin de las principales funciones del sistema.
Ejemplos:
a) usando en concepto de caja negra de entradas y salidas

b) usando una descomposicin jerrquica:

El nivel de detalle debe ser bajo, pero debe dar una visin completa del sistema.
Para cada funcin:
Descripcin de funcin: nombre y descripcin de la accin de cada funcin.
Ejemplos de funciones: creacin de perfil de usuario, modificacin de tabla de
proveedores.

Entradas:
o Pantalla de entrada a la funcin
o interfaces de entrada (ej: recepcin de datos de otros sistemas),
o tablas de parmetros,
o tablas de entrada.

Salidas:
o listados,
o interfaces de salida (ej: envo de datos a otros sistemas)
o pantallas asociadas.
o tablas de salida.

Caso de uso asociados: debe tener un diagrama del caso de uso que esta funcin
implementa.

Subfunciones: cada funcin invocada desde sta debe ser descrita.

Otras funciones y sistemas:

Diagrama y/o descripciones de funcionamiento:

Si la funcin tiene cambios de estado, su comportamiento debe ser descrito con
el diagrama adecuado. Ejemplo: los balances tienen cambios de estados, fechas
de cierre, etc. Otro ejemplo es el manejo de estados en cuentas corrientes.

Detalles (frmulas, criterios, etc.)

Diagramas de entidad-relacin de bases de datos:

Se debe incluir los diagramas entidad-relacin de la base de datos del sistema y
acompaar de una descripcin detallada.
rboles de navegacin de pantallas:
Debe existir un rbol general de navegacin en la interfaz del sistema
(pantallas).
Transacciones:
Detalle de las transacciones del sistema. Cada transaccin debe ser descrita y asociada
con las funciones que la implementan, detallando los procesos y tablas y otros
elementos asociados a la misma.
Procesos del sistema:
Procesos diarios
Procesos mensuales
Mantenimiento de sistema
Respaldo de informacin y programas del sistema
Otros procesos
Estructura del diseo fsico:
Un diseo fsico est orientado a los especialistas de informtica que construirn el
sistema.
Introduccin:
Breve introduccin al sistema orientado a especialistas en desarrollo, bases de
datos e ingeniera de sistemas.
Diagrama general del sistema:
Similar al incluido en diseo lgico pero con mayor nivel de detalle y
especificaciones tcnicas.

Detalle de mdulos:
Cada funcin del diseo lgico se convierte en uno o ms mdulos que sern
programados. El detalle del mdulo debe contener las instrucciones detalladas para la
programacin.
Cada mdulo debe tener al menos:
Entradas: pantallas, archivos de parmetros, programas que lo invocan, etc. Cada
uno de esos elementos debe ser descrito en detalle.
Salidas: pantallas, listados, datos generados en base de datos, etc.
Funcionamiento interno, acompaados de diagramas de flujo, pseudo-cdigo
(ver anexo), frmulas, diagramas de secuencias y toda documentacin necesaria
para entender la construccin del mdulo.
Transacciones implementadas en el mdulo.
Diseo fsico de base de datos:
Se debe incluir un diseo fsico detallado de la base de datos. Esto no significa crear un
diagrama nico, sino que generar todos los diagramas que muestren el diseo fsico en
forma completa y clara. El diseo fsico de la base de datos debe ser acompaado de
descripciones tcnicas legibles, orientadas a la implementacin.
Procedimientos implementados en base de datos:
Los procedimientos implementados directamente en la base de datos deben
documentarse uno a uno. Es importante destacar los parmetros de entrada, de salida y
su funcionamiento. No se debe mostrar la lgica de programacin, sino descripciones de
las mismas. Si es necesario incluir detalles del funcionamiento debe usarse pseudocdigo (ver anexo).
Diagrama de implementacin del sistema:
Se debe detallar en que equipos, arquitectura de redes y software (sistema operativo,
software adicional) se montar el sistema.
Instalacin del sistema:
Se debe declarar la manera de instalar el sistema en las instalaciones del cliente.
Detallar los pasos de instalacin de l o los programas, migracin de bases de datos,
sitios web y otros elementos necesarios para que la implementacin funcione.
Carga de datos:
Debe existir una descripcin de la manera como el sistema capturar la informacin
existente en la empresa y la verter en las bases de datos, con el fin de hacer que el
sistema funcione. Este paso suele ser acompaado del desarrollo de programas que
automticamente cargan datos en el sistema, los cuales tambin deben ser descritos en
detalle.
Operacin del sistema:
Se debe describir como se operar el sistema. Por ejemplo, como se crean nuevas
cuentas de clientes, como se hacen los respaldos, los cierres de mes y la manera generar
de operarlo.

Anexo: Pseudo-cdigo
En general, no se debe incluir piezas de software en la documentacin. No es vlido
incluir pantallas tomadas desde sistemas ya programados, y cdigo fuente en javascript,
Visual Basic u otros lenguajes de programacin.
Sin embargo, en algunas situaciones es necesario describir algoritmos con el nivel de
detalle necesario para que el programador los entienda y programe sin cometer errores.
En esos casos se puede usar diagramas de flujo o pseudo-cdigo.
Pseudo-cdigo es simplemente una manera de especificar algoritmos usando lenguaje
comn. Por ejemplo el siguienteSecuencia de instrucciones:
Instruccin1
Instruccin2
Instruccin3
Instruccinn

Decisin
si P entonces
Instrucciones1
si no
Instrucciones2
fin si

Ciclo

Instrucciones
mientras P hacer
Instrucciones
fin mientras

Ejemplo de algoritmos en pseudocdigo:

Algoritmo para calcular una potencia:
funcin
//Este algoritmo calcula an (con a y n, naturales)

mientras
hacer
si
es impar entonces
fin si
fin mientras
devolver
fin funcin