Mitos sobre la Arquitectura de Software

En este post me refiero por Arquitectura específicamente a la Arquitectura de Solución. La que se diseña para la construcción de un producto de software.

Mito 1: La arquitectura de un sistema es Documentación

Típicamente la palabra documentación trae una carga negativa de juicios que nos llevan a pensar que es algo repetitivo, que se hace posteriormente para cumplir, que agrega poco valor en general. Bajo esa definición de documentación la arquitectura definitivamente no lo es. La arquitectura se enfoca en diseñar efectivamente la solución a construir y en mucho menor grado en la posterior formalización de estos diseños. Diseñar la arquitectura de la solución en etapas tempranas acorta los tiempos de construcción, evita el retrabajo, mejora la mantenibilidad del sistema resultante y sienta bases sólidas para cumplir los atributos de calidad que el negocio requiere.

Construirías una casa si ver antes la maqueta y los planos?.

Mito 2: Sólo aplica para sistemas grandes y complejos

Antes de poner un bloque debes saber dónde se deben poner bloques y con qué objetivo, esto aplica independientemente de si construirás una pared, una casa o un edificio. Lo que suele ocurrir es que para sistemas muy pequeños la arquitectura es obvia o tradicional, mientras que para sistemas grandes hay muchas alternativas a considerar. En un sistema grande la arquitectura es difícil de comprender y asimilar en su totalidad. Todo sistema independientemente de su tamaño requiere una arquitectura, en muchos casos vale reutilizar una conocida.

Para un sistema web en el que sólo haces login y llenas dos formularios, definirías típicamente una arquitectura de este estilo; una capa de interfaz, una capa de acceso a repositorio, algún componente de fachada entre estas capas, algunos objetos de negocio en los que viaja la información y excepciones para el manejo de errores. Podríamos pintar un par de diagramas de clase y un diagrama de secuencia con la interacción de los componentes. A eso le agregamos una selección de tecnología a usar y Voila! tenemos una arquitectura hecha en 5 minutos para un sistema que se programa en medio día. Necesitábamos una arquitectura? por supuesto que si!.

He escuchado muchas veces decir "nosotros no necesitamos arquitectura porque todos los sistemas los hacemos igual y son sencillos"... ahh entonces reutilizan siempre la misma arquitectura que ya tienen diseñada y todos la conocen bien. Tienen un activo de conocimiento intangible y no se han dado cuenta.

Mito 3: La arquitectura no tiene nada que ver con el negocio

La arquitectura debe diseñarse justamente para garantizar que la solución de cumplimiento a las necesidades de negocio. En un proceso formal partes por definir metas para la arquitectura en función de una norma como ISO-9126 de atributos de calidad de software. Seguridad, rendimiento, tolerancia a fallas, etc, etc... son atributos de calidad que se establecen dadas las necesidades del negocio, de la arquitectura de la solución depende lograr o no su cumplimiento y por lo tanto que el negocio cuente con la herramienta adecuada.

Definiciones como la del SEI (http://www.sei.cmu.edu/architecture/index.cfm) que establece en su formato de arquitectura los Stakeholder's Viewpoints, definen estrategias para acercar el documento de arquitectura a los involucrados del negocio, definiendo la trazabilidad entre las expectativas de estos y el diseño planteado para cumplirla.

La tendencia es que cada vez más la arquitectura es visible al negocio. Así como los planos y maquetas en ingeniería civil son de mucho interés para quien solicita la construcción de una casa. Aprendamos de la madurez de la ingeniería civil y sus 2000 años de ventaja sobre la ingeniería de software, construirían su casa sin comprender antes la arquitectura planteada? definitivamente no.

Mito 4: la arquitectura es necesaria o no según la tecnología a utilizar o el conocimiento del equipo sobre la tecnología que aplica

La arquitectura parte de un diseño agnóstico a la tecnología, que puede ser implementado y desplegado en diversas tecnologías y plataformas según lo que mejor se adecue a la necesidad o los skills con que el equipo cuente. No hay tecnologías que requieran o no arquitecturas, lo que ocurre es que algunas establecen en mayor o menor grado una arquitectura de referencia, incluso las herramientas de construcción te pueden llevar de la mano a implementar un estilo arquitectónico particular.

Si se desea construir una solución mantenible y en base a mejores prácticas el diseño debe hacerse haciendo uso de los elementos del estilo arquitectónico que la tecnología propone, aprovechando sus capacidades.

El diseño de la solución en función de las necesidades del negocio siempre es necesario. La arquitectura debe proponer estrategias claras para cubrir los atributos de calidad esperados del sistema y las expectativas del negocio, apalancándose en las fortalezas que plantea la tecnología utilizada.

Mito 5: Es un documento complejo que sólo consume el propio arquitecto

El diseño de arquitectura tiene implicaciones directas en presupuesto, en costos de operación del procesos de negocio que soporta o automatiza, en la agilidad y efectividad que tendrán sus operarios, en la capacidad de aprovechar ese activo en futuros retos de negocio o nuevos productos. También otros impactos más técnicos como la mantenibilidad a futuro, la convivencia con otros elemento de la plataforma tecnológica o la capacidad que el equipo actual tenga para hacerse cargo de su mantenimiento.

Es de gran utilidad la analogía con la ingeniería civil en este punto. Al construir un edificio los que solicitan la obra y que luego usarán el edificio desean estar involucrados en entender el diseño que se seguirá. Maquetas y planos son herramientas efectivas de comunicación entre los arquitectos e ingenieros y quienes contratan labora. Estar involucrados en estos diseños garantizará que la obra cubra las expectativas.

Es necesario entender la construcción de sistemas de software como ingeniería, son obras en las que se invierten grandes cantidades de dinero y producen un activo que será utilizado por años. Según métricas conocidas más del 60% del costo de un sistema durante todo su ciclo de vida se produce después que es puesto en producción y este costo depende en gran medida de la arquitectura que se haya diseñado.

En resumen…
1) La Arquitectura de Software no es opcional, puede ser más o menos compleja.
2) Es de gran valor ($$) que los responsables del negocio que solicitan la construcción de un producto de software se involucren en la evaluación de su arquitectura.

El Proyecto y el Producto

Veo una constante confusión en los equipos de desarrollos de software y en general en las disciplinas de TI entre el proyecto y el producto. No tener estas distinciones claras y no saber separar estos dos contextos tiene un impacto directo en la mantenibilidad, en costos, al verse reflejada en la documentación de los sistemas y de las organizaciones.

Una analogía que me ha ayudado a explicar este fenómeno, como casi siempre tomada de la ingeniería civil. Imaginen que van a una ciudad y para ubicarse piden el mapa de vías. La expectativa esta clara para todos, puede ir de un plan en papel a un GPS, con mayor o menor información asociada es en el fondo lo mismo, una imagen de todas las calles, vías y avenidas en una determinada región. Imaginen por un momento que en vez de recibir esto les dan la documentación de todos los proyectos de ingeniería civil realizados sobre la vialidad de la ciudad durante los últimos 40 años; el proyecto de construcción de un puente, el de asfaltado de una calle, el de ensanchado de una autopista, etc., con la expectativa que ustedes sean capaces de deducir de ahí el mapa vial de la ciudad. Ante estas realidades es que hay que recordar que no debemos desesperar, la ingeniería civil nos tiene 2.000 años de ventaja.

Tengo la certeza que la mayoría de las organizaciones no son capaces de dar su mapa de vías en el contexto tecnológico. También que nuestras disciplinas (desarrollo de software, arquitectura empresarial, etc.) seguirán su progreso acelerado en los próximos años y alcanzarán y superarán estos niveles obvios.

Siguiendo con el proyecto y el producto, lo abordo en tres escenarios diferentes y tres ejemplos.

El Proyecto y el Sistema

Un sistema de información inicia su ciclo de vida una vez que entra en producción y termina una vez que es descontinuado (o desenchufado) unos años después. Durante este periodo típicamente pasa por múltiples proyectos que lo completan, adaptan, evolucionan y sobre todo reparan. Al arrancar cualquiera de los proyectos sobre el sistema, el caso típico es que el equipo mantenedor se encuentra con la situación de la analogía inicial, para entender su funcionalidad y su arquitectura el equipo debe reconstruir la historia de los proyectos anteriores cuando en realidad esto no agrega ningún valor para ejecutar la tarea del momento. Si agrega valor es precisamente porque la documentación funcional y de arquitectura del sistema no es suficientemente completa.

Una aplicación o componente de software en general debe contar tanto de documentación funcional como de arquitectura que permita comprender qué hace, para qué lo hace, cómo lo hace y por qué se decidió que lo hiciera de esa forma. Contando con esta información el equipo se enfrenta a un problema con baja incertidumbre y puede tomar acciones;

• Disminuyendo drásticamente el riesgo de afectar el funcionamiento.
• Disminuyendo drásticamente el tiempo de análisis requerido para iniciar el mantenimiento y por ende el costo del proyecto.
• Disminuyendo el riesgo de incluir elementos que no cumplen los lineamientos de diseño del sistema.

Adicionalmente se aumenta la posibilidad de reutilizar diseños y componentes, en este sistema y otros, al permitir entender rápidamente los elementos que conforman el sistema.

En resumen el mensaje que quiero transmitir es que lo importante no es el proyecto, es el producto resultante. Poco valor tendrá el proyecto que terminó en menor tiempo pero que dejó la realidad que disparará los costos del próximo proyecto sobre el mismo producto. El valor de la información del proyecto es temporal o circunstancial, mientras
que el producto es un activo de la organización y su valor dependerá entre otras cosas de la calidad de la información que le acompañe.

Estos son algunos casos específicos donde he visto mezclados el proyecto y el producto.

• Como parte de un proyecto se hace un documento de visión (utilizando como metodología PU) que define nuevas características a incorporar a una plataforma existente, pero no se actualiza el documento funcional original (como el de casos de uso). Lo mismo podría ocurrir en metodologías ágiles si haces por ejemplo nuevos user stories y no los agregas al repositorio de los existentes.
  
• Cualquier cambio de índole tecnológico que no actualiza el documento de arquitectura, luego por ejemplo tomarían días en averiguar qué frameworks se utilizan, en qué versiones y con qué fines.

A partir de estos momentos comienza la historia de tener que reconstruir proyectos para entender el sistema.

El Proyecto y los Sistemas

Lo mismo que ocurre con con un proyecto que afecta un sistema, ocurre con un proyecto que afecta o produce varios sistemas. Se generan documentos en el contexto del proyecto que hablan de múltiples sistemas, haciendo la información aún más densa y compleja de entender.

Se debe asegurar en estos proyectos dejar la información actualizada de cada sistema.

El Proyecto y la Organización

Una situación similar a la que describo en el contexto de sistemas, se me presentó recientemente con procesos de negocio de una organización.

En proyectos orientados a atender necesidades de negocio, es muy posible que se vean afectados los procesos de la organización. Toda organización debe tener sus procesos documentados y difundidos. Cualquier cambio sobre estos implica acciones de difusión, entrenamiento, cambios en sistemas, etc. Pueden y existen grupos de consultores que no ven los procesos más allá del proyecto y donde los cambios a estos quedan sólo en los documentos del proyecto, creando un riesgo importante de operación en la organización. Esto puede ocurrir
en organizaciones pequeñas o inmaduras donde el uso de procesos no está institucionalizado.


Estas situaciones suelen ocurrir por ingenuidad sobre la realidad de la vida de un sistema al pensar sólo en el proyecto actual y no en los futuros, por falta de experiencia y/o por comodidad. En cualquier caso se disminuye el valor del activo y se dispara el costo de futuros mantenimientos.

Tips para construcción de diagramas de clases útiles y legibles

Escribo en este post uno de los temas más recurrentes y de más utilidad en clases, revisiones de pares, recomendaciones de diseño, revisiones de documentos de arquitectura y en general en cualquier momento donde aparezca un diagrama de clases.

Hago una recopilación de los tips y observaciones que surgen continuamente y que teniéndolos en cuenta se mejora significativamente la calidad y utilidad de los diagramas.

El error más común: Relaciones conceptuales

En muchos casos un modelo conceptual, que representa el espacio del problema, se utiliza como base para la identificación de clases. Las relaciones que se presentan en un modelo conceptual suelen ser acciones o interacciones de elementos en el mundo real. Por ejemplo en el modelo conceptual de un sistema de inscripciones de un ente educativo, seguramente consiguiremos una relación inscribe entre los conceptos de Estudiante y Materia.

Figura 1: Modelo Conceptual

En el modelamiento de un diagrama conceptual ésto es perfectamente válido. Ahora cuando se habla de relaciones entre clases, una relación inscribe entre las clases Estudiante y Materia tiene un significado bien específico y está relacionado directamente con la implementación.

Figura 2: Diagrama de Clases

La relación de la figura 2 establece que en la clase Materia existe un método llamado inscribe y que este método es invocado en algún momento por la clase Estudiante. Hay que estar claros con lo que se está expresando y hacerlo concientemente.

Si por ejemplo asumimos que un componente, capa de software o servicio es responsable de un contrato de registro de la inscripción de una materia y ofrece una operación o método con firma:
void inscribirMateria(Estudiante estudiante, Materia nuevaMateria)
throws InscripciónDuplicadaException
Este servicio en su implementación podría hacer una serie de validaciones y luego acceder a un repositorio y almacenar la formalización de la inscripción de la materia.
En este caso la clase Estudiante nunca invocaría un método inscribir de la clase Materia e inclusoeste método podría no existir, aunque sea cierta la relación conceptual entre ambas clases. En un diagrama de clases, de acuerdo a la implementación planteada, sería un error colocarla en un diagrama de clases.

Tipos de relaciones: estáticas vs. dinámicas

Las relaciones entre dos clases pueden ser clasificadas en dos tipos, estáticas y dinámicas.

Las relaciones estáticas son aquellas que definen estructuralmente a la clase, básicamente en los lenguaes OO utilizados actualmente se definen tres tipos; extensión o herencia, agregación y composición. No es el objeto de este artículo explicar estas relaciones, hay múltiples fuentes disponibles.

Las relaciones dinámicas son las que definen la interacción de la clase con otras, invocaciones que desde la clase se hace a métodos de otra clase. Un ejemplo de relación dinámica se define en la Figura 2.

El tip que se presenta a continuación se basa en esta definición teórica para hacer una recomendación concreta en la construcción de diagramas.

No llene el diagrama de clases con relaciones dinámicas descontextualizadas

Las relaciones dinámicas se dan en el contexto de la ejecución de una operación, servicio o contrato específico. Una clase que participa en la realización de múltiples operaciones, probablemente contará con múltiples invocaciones a otras clases, subconjuntos de todas estas relaciones (invocaciones) participan en la relización de una cada operación específica.

Si en un diagrama de clases, adicionalmente a las relaciones estáticas, colocamos todas las relaciones dinámicas que se dan entre las clases del diagrama (es decir, todas las relaciones por cada vez que una clase llama a un método de otra clase) entonces terminaremos con un diagrama sobrecargado, de aquellos que solemos llamar spaghetti diagram.

Figura 4: Espagueti inentendible... encontré un buen ejemplo buscando imágenes en la red.

Cuando se presenta un diagrama de clases, lo más recomendable es presentar la estructura utilizando sólo las relaciones estáticas. Las relaciones dinámicas recomiendo presentarlas en su debido contexto, por ejemplo utilizando un diagrama de secuencias o colaboración para cada operación o servicio. De esta forma se apreciará claramente la interacción entre las diferentes clases e incluso objetos, para lograr la realización de una operación.

Seguir esta recomendación mejora significativamente la utilidad de la documentación para el equipo que hará mantenimiento del sistema en construcción, disminuyendo así los costos de soporte y mantenimiento a futuro.

Póngase en los zapatos de los otros roles!

Es una práctica que viene con la experiencia y el conocimiento del proceso completo, la capacidad de ponerse con cierta frecuencia en el lugar de otros roles del equipo que ejecuta un proyecto de ingeniería de software.

Hago en este texto un análisis rol por rol, indicando el beneficio que puede traer ubicarse en la posición de otros.

Analista de Requerimientos

Es sumamente útil para el analista de requerimientos, al momento de especificar características del sistema o funcionalidades en forma de casos de uso, ubicarse en la posición del equipo de desarrollo y de los encargados del diseño de casos de prueba. Analizar su producto desde esta posición le permitirá evaluar si el nivel de especificidad es suficiente para que el requerimiento pase de forma fluida a las siguientes etapas del ciclo de desarrollo.

• Están claras las restricciones que impone el negocio?
• Los datos que se manejarán están totalmente claros? longitudes, alcance, etc.
• El perfil de los usuarios está claramente descrito?
• Los puntos de integración con otros sistemas fueron analizados y documentados?

Equipo de Desarrollo

Uno de los problemas más comunes en el área, es que un equipo de desarrollo encargado de mantenimiento consiga una implementación pobremente documentada, sin indicativos de los elementos relacionados con el mantenimiento de una funcionalidad en particular o las decisiones de diseño involucradas.
Un desarrollador que trabaja en la implementación de un caso de uso debe, como parte integral de su trabajo, ubicarse en la posición de un desarrollador que llega al proyecto en un futuro sin el contexto que él posee, y que deba incorporar un cambio de requerimiento en la funcionalidad en la que el trabaja.

• Cuáles son los elementos/componentes que participan en la realización de esa funcionalidad?
• Qué reglas o restricciones de negocio están involucradas?
• Está el código lo suficientemente claro y refactorizado para facilitar el proceso de lectura y comprensión?

Está ampliamente documentado los altos costos de mantenimiento en que se puede incurrir en caso de no contar con los insumos necesarios en esta etapa.

Arquitecto

Los arquitectos deben diseñar los lineamientos de construcción de un sistema teniendo en cuenta que su producto debe ser lo suficientemente claro y completo, para que diferentes equipos de desarrollo puedan producir un sistema implementado de la misma forma. El arquitecto debe ubicarse en el rol del desarrollador y tratar de implementar un caso de uso sobre esa arquitectura, con el objetivo de identificar los puntos que aún quedan abiertos y la conveniencia de las decisiones de diseño que se plasmaron en la arquitectura.

• La arquitectura habilita un desarrollo ágil?
• Está clara la distribución de las responsabilidades en los diferentes componentes?
• Están claros los lineamientos de manejo de errores?

En general, el colocarse en la posición de otro, permite evaluar el producto que se ha producido obviando el contexto o conocimiento que una persona tiene sobre ese producto, permitiendo evaluar objetivamente si se ha dejado la suficiente información documentada.

Práctica de Peer Reviews

Hay dos temas que motivan este escrito. El primero es la experiencia de haber pasado por varios peer reviews en los últimos días, donde me sentí en cada una de esas sesiones aplicando repetitivamente las mismas prácticas. Fueron efectivas y lo han sido desde hace algún tiempo, así que considero vale la pena identificar cuáles son y compartirlas. La segunda motivación nace de una pregunta que he realizado en varias oportunidades a mis alumnos de Ingeniería de Software de la USB; ¿si comparan el código que ustedes están produciendo actualmente con el de un equipo de desarrolladores con amplia experiencia produciendo software de calidad mundial, en qué se diferenciaría?. Creo que ambos temas están muy relacionados y son claves en la calidad técnica del software.

El ojo de un experto en su área de experticia, busca de forma natural las anomalías o carencias que pueda tener el producto en cuestión. ¿Cuáles son esas anomalías o carencias que se deben identificar en el código fuente y que deben saltar a la vista del ojo experto en una inspección de código?.

La revisión que suelo aplicar va en dos bloques. El primero relacionado con la correcta y clara definición de lineamientos de diseño y de arquitectura y por supuesto su cumplimiento. El segundo se enfoca en el cumplimiento de la funcionalidad establecida y la búsqueda de defectos.

Bloque de lineamientos de arquitectura

El diseño de la arquitectura de un sistema debe abarcar una serie de aspectos básicos que garanticen uniformidad en la implementación del sistema. Particularmente en las revisiones me fijo en los siguientes; Capas, Asignación de responsabilidades, Uso de patrones, Componentización de alto nivel, Manejo de excepciones y Generación de trazas para auditoría. Claro que hay otros, pero si se cumplen éstos seguramente tendremos una arquitectura bastante sólida.

Una secuencia de acciones para realizar la revisión en base a estos parámetros podría ser la siguiente:

• Buscar que en el documento de arquitectura estén claramente definidas las capas del sistema. Si la solución está compuesta por varios sistemas, aplica la secuencia a cada una.
• Debe establecerse para cada capa quiénes son los responsables en recibir las comunicaciones, en comunicarse con otras capas y cuál es el lenguaje que hablarán las capas entre si (tipos de datos simples, objetos de negocio, etc.).
• Las responsabilidades en cada nivel de la arquitectura lógica deben estar claras y ser consistentes. Quién valida parámetros de otra capa, quién crea objetos de negocio, quién interactúa con cada ente externo, quién interactúa con el repositorio, quién contiene la lógica de reglas de negocio, son algunas de las muchas preguntas que siempre es útil hacerse y cuyas respuestas deben estar claras.
• Qué patrones se están usando y por qué?. Qué piezas o componentes considera las más complejas? qué patrones usan éstas?, si no usan ninguno hay alguno que podría ayudar?.
• Siempre debemos poder mostrar una vista de componentes y debe estar claro cómo interactúan entre ellos, sus interfaces y responsabilidades.
• Debe en el documento de arquitectura o su equivalente estar un diagrama de clases de las excepciones a utilizar y estar definido cómo y cuándo se utilizarán, también debe estar definido de quién es la responsabilidad de capturarla en cada caso. Cuáles son posibles extender y cuáles no.
• Quién ha tenido la experiencia de tener que mantener un sistema en producción ha aprendido la utilidad de las trazas de auditoría de primera mano. Debe estar claro cuál es la estrategia a seguir en las trazas, en qué puntos deben generarse siempre, en cuáles es opcional, cuántos niveles se utilizarán y qué tipo de mensajes van en cada uno.
• Para validar posteriormente que todo lo anterior que está en la documentación se cumpla efectivamente en la implementación, se seleccionan un par de funcionalidades (casos de uso), y se revisan siguiendo su código fuente tal como lo haría durante su ejecución, desde las capas superiores a las inferiores.

Para todos los puntos anteriores las respuestas deben estar en la documentación, sino están y alguien debe explicarlo entonces está incompleta. Cada respuesta que alguien da debe anotarse y luego incorporarse al documento correspondiente. Es una buena forma de identificar los puntos de mejora de la documentación.

De contar con la disponibilidad de tiempo suficiente, podrían tomar en cuenta otros aspectos como Paquetes, Idioma del código fuente (es común y poco deseable el spanglish) y Uniformidad en los nombres.

Este primer bloque de prácticas se aplica cuando se realizan las primeras inspecciones de un proyecto. En sucesivas sesiones, cuando ya se ha garantizado que la arquitectura y los lineamientos de diseño están suficientemente maduros, la actividad puede enfocarse sólo en el segundo bloque.

Bloque de búsqueda de defectos

En el segundo bloque se revisa un conjunto de casos de uso o funcionalidades seleccionadas, el objetivo es verificar que la implementación efectivamente cumple con los requerimientos establecidos y tratar de identificar potenciales defectos.

La revisión al igual que en el bloque anterior es recomendable hacerla siguiendo el código fuente tal como se ejecutaría, línea a línea.

Durante estas revisiones tenga siempre en mente los lineamientos validados en el primer bloque, siempre es posible encontrar puntos donde no se cumple lo establecido y es pertinente alertar para que sea corregido.

Qué relación tiene lo anterior con la pregunta inicial sobre la diferencia del código fuente de un grupo de estudiantes con el de un equipo de desarrollo experto?, creo que los puntos del primer bloque son los principales diferenciales, ya que son continuamente reforzados por la experiencia.

Peer Reviews es todo un tema y existe amplia bibliografía al respecto, Peer Reviews in Software de Karl Wiegers es una muy buena opción para adquirir una base metodológica en el tema.