Architectural Rationale Annotations Tool

ARAT (Architectural Rationale Annotations Tool) es una herramienta que complementa el código fuente basada en anotaciones de código Java que permiten documentar el Rationale arquitectónico.

Introducción y propósito

El Rationale arquitectónico son las razones del porqué una arquitectura está planteada de una forma o de otra, este Rationale arquitectónico define la justificación o el porqué de una acción o un pensamiento dirigido a la toma de decisiones en la construcción de la arquitectura de un sistema. Generalmente este Rationale no se encuentra de manera explícita en los diferentes artefactos de la documentación de un sistema, causando que sea mucho más lenta la fase de mantenimiento del mismo, debido a que se requiere de más tiempo para tratar de capturar y analizar las decisiones tomadas en el diseño del software.

Las anotaciones de código fuente sirven como un puente entre el desarrollador y las diferentes herramientas y librerías que son capaces de reconocerlas, gestionarlas y brindar una mayor cantidad de servicios a través de los metadatos marcados con información relevante para el desarrollo. El uso de estas anotaciones es importante ya que tienen como objetivo construir sistemas más complejos, que permitan encapsular lógica de programación repetitiva en componentes aparte de las reglas de negocio de un sistema en particular, precisamente una de las mayores ventajas de las anotaciones de código fuente es permitir al desarrollador crear diferentes elementos lógicos encargados de capturar y procesar dichas anotaciones con los metadatos de los componentes marcados, con el objetivo de delegarle a las anotaciones de código la responsabilidad de realizar procesos comunes y repetitivos en toda la aplicación

Fundamentos

La documentación del Rationale arquitectónico está caraceterisada por una paradoja que comunmente persiste en el desarrollo de software:

Cuanto más Rationale se genera, hay menos posibilidades de capturarlo.

Esta paradoja está sustentada por las siguientes observaciones manifestadas por Allen Dutoit. et al:

Instalación

En el siguiente link encontrará información relacionada con el proyecto, el código fuente, algunas características de la herramienta, el manual de usuario y la herramienta en formato .jar. Descargue el plugin .jar y guárdelo en un lugar en el que recuerde su ubicación. Para completar la instalación por favor consulte el Manual de usuario. Una vez se haya instalado el plugin se debe instanciar una clase con un método main, la cual puede generar el reporte mediante la clase RationaleFacade

RationaleFacade.generateReportByAll(package)

Para generar un archivo con el reporte de todas las anotaciones marcadas en el código fuente dentro del package especificado.

RationaleFacade.generateReportsByOne(package)

Para generar un archivo por cada anotación marcada en el código fuente dentro del package especificado.

Sobre el proyecto

Este documento es un artefacto generado en la investigación del uso de las anotaciones de código como una herramienta para gestionar conocimiento tácito directamente en el código fuente, estableciendo un modelo de Rationale Arquitectónico que permita el registro y la gestión de decisiones y razones arquitectónicas, importantes para la evolución y el correcto mantenimiento de cualquier sistema. La documentación completa de este proyecto y la investigación se encuentra en el siguiente repositorio de github. En este repositorio también se encuentra el link a un sitio web en el cual se puede descargar la herramienta. Para las personas interesadas en continuar con el proyecto o realizar contribuciones pueden solicitar acceso al repositorio contactando al autor.

Licencia

Apache License 2.0

Uso permitido

Limitaciones

Condiciones