¿Qué es la documentación de decisiones de arquitectura?

| Última modificación: 24 de abril de 2024 | Tiempo de Lectura: 3 minutos

Algunos de nuestros reconocimientos:

Premios KeepCoding

¿Conoces la documentación de decisiones de arquitectura? La arquitectura de una aplicación se refiere a los elementos y piezas que componen el sistema, de modo que las decisiones que se tomen respecto a su formato serán un determinante de la estructura de la aplicación. Es por esto que es importante establecer una documentación de las decisiones de arquitectura que detalle las elecciones y modificaciones ocurridas en la infraestructura de la aplicación, así como las razones que la justifican.

De manera que, si quieres aprender a utilizar esta herramienta, es indispensable que te quedes en este artículo para poder aprender todo lo que debes saber acerca de la documentación de decisiones de arquitectura, así como sus características y funciones principales.

¿Qué es la documentación de decisiones de arquitectura?

La documentación de decisiones de arquitectura, también conocida como documentación Architecture Decision Records (ADR), se define como un conjunto de documentos que almacenan de manera individual las elecciones a nivel de arquitectura que se han tomado para una determinada aplicación o sistema.

Así pues, la documentación de decisiones de arquitectura (ADR) indica una colección de documentos ligeros que reflejan las decisiones técnicas de mayor relevancia.

Además de esto, este tipo de documentación se encarga de reunir las decisiones arquitectónicas importantes, incluyendo su contexto y las consecuencias o impacto que estas tienen en la aplicación o sistema.

Características de la documentación de decisiones de arquitectura

Dentro de las características y propiedades más importantes de la opción de documentación de decisiones de arquitectura, se encuentra que esta puede ser una colección de documentos de texto en el formato markdown, lo que implica que, para una decisión técnica destacable, se puede crear un archivo bajo ese formato, utilizando como base la plantilla acordada con anterioridad.

🔴 ¿Quieres entrar de lleno al mundo DevOps & Cloud Computing? 🔴

Descubre el DevOps & Cloud Computing Full Stack Bootcamp de KeepCoding. La formación más completa del mercado y con empleabilidad garantizada

👉 Prueba gratis el Bootcamp en DevOps & Cloud Computing por una semana

De la misma manera, la documentación de decisiones de arquitectura puede ser solamente un documento en la plataforma de Google Docs o en el formato que más conveniente le resulte a los desarrolladores encargados de su creación.

Otra de las características de la opción de ADR es que para su correcto funcionamiento necesita de un mantenimiento que le permita estar completa y no se quede desfasada a medida que pasa el tiempo. Esto quiere decir que la documentación de decisiones de arquitectura debe caracterizarse por permitir un acceso fácil para su edición y simple de mantener, además de incluir visibilidad de los elementos para poder encontrarlos de manera más fácil y rápida.

Asimismo, esta documentación destaca como un mecanismo de gran relevancia para mantener una correcta comunicación del diseño de la aplicación. Cabe resaltar que, aunque no existen parámetros fijos y establecidos que especifiquen el nivel de documentación que debe llevarse a cabo, se deben analizar factores como el tipo de proyecto, sus usuarios y desarrolladores para tomar la decisión de qué incluir en la documentación de arquitectura.

Importancia de la documentación de decisiones de arquitectura

Aunque la arquitectura de una aplicación determinada y los recursos que la componen usualmente se documentan haciendo uso de un esquema gráfico, este solo informa acerca de cómo se encuentra actualmente este sistema y no incluye otros aspectos importantes, como las razones y requerimientos que derivaron en esas decisiones.

Es por esto que la documentación de decisiones de arquitectura aparece como un mecanismo que almacena esas motivaciones que llevaron a elegir una arquitectura en específico para la aplicación en lugar de otra, así como las modificaciones que se le han realizado y cómo estas han afectado al sistema.

Cabe destacar que no solo se debe escribir esta documentación, sino que se necesita mantenerla siempre actualizada con la información más relevante de la aplicación.

¿Cuál es el siguiente paso?

En este artículo ha podido conocer qué es la documentación de decisiones de arquitectura, así como sus características y propiedades de mayor relevancia. Ahora, si ya llegaste hasta aquí, es porque te interesa conocer más sobre esta y otras opciones que te ayudarán a mejorar tus procesos de desarrollo tecnológico. Para conseguirlo, no dudes en dar un paso más en tu aprendizaje y matricúlate en nuestro DevOps & Cloud Computing Full Stack Bootcamp.

Con este bootcamp íntegro e intensivo, podrás recibir toda la información práctica y teórica que necesitarás para convertirte en un experto del sector IT y destacar frente a tu competencia, gracias a la optimización de tus proyectos. ¡Anímate a matricularte ahora y continúa formándote para darle un giro a tu vida laboral!

Xoán Mallón

Senior DevOps Engineer en Zscaler & Coordinador del Bootcamp DevOps & Cloud Computing.

Posts más leídos

¡CONVOCATORIA ABIERTA!

DevOps & Cloud Computing

Full Stack Bootcamp

Clases en Directo | Profesores en Activo | Temario 100% actualizado