Documentación ágil de arquitectura de software: Un enfoque práctico

Los tiempos cambian y con ello, la forma de hacer documentaci?n tambi?n. En este libro aprender?s como las grandes empresas documentan la arquitectura aprovechando t?cnicas modernas como la documentaci?n como c?digo y aprovechando al m?ximo el tiempo para enfocarse en lo que realmente importa, que es que el software funcione.

Cuando comenc? mi carrera en la industria del software (hace m?s de 18 a?os), siempre me llam? la atenci?n la arquitectura de software, debido a que me gustaba entender como el software funcionaba, incluso, m?s all? de lo que cualquier usuario normal pod?a ver, me gustaba entender como funcionaban las cosas por dentro, por lo que literalmente, entraba a los repositorios de c?digo y ve?a como estaba implementadas las cosas por dentro, pr?cticamente era como un minero, escarbando en el c?digo para comprender el funcionamiento de las cosas y enserio que aprend? muchas cosas.

Durante mis expediciones por los repositorios, siempre me encontraba con que la documentaci?n era pobre, un peque?o texto que explicaba de forma general el funcionamiento, algunos m?todos comentados por aqu? o algunas clases comentadas por all?, pero con suerte (y con mucha suerte) entre la documentaci?n encontraba un diagrama de arquitectura, wow, ver un diagrama era revelador, ya que de un solo vistazo pod?a apreciar los elementos que compon?an el proyecto, como se comunicaban, las dependencias, protocolos de comunicaci?n, tecnolog?as, etc. Ver un diagrama era entender en un minuto, lo que me podr?as tomar horas o d?as con solo analizar el c?digo y es justo all?, cuando nace mi pasi?n por la arquitectura de software y la importancia de documentarla el software de forma efectiva.

El objetivo de este libro es ense?arte a documentar arquitectura de software ?gil, que se adapte a los tiempos modernos, donde los equipos de trabajo se han reducido de 10 o 20 personas, a c?lulas Scrum de 3 a m?ximo 8 personas, y donde los requerimientos pueden cambiar de manera frecuente y sin previo aviso.

En este libro vamos a cuestionar duramente la creencia de que entre m?s abundante sea la documentaci?n, es mejor, que entre m?s refinado este un diagrama, aporta m?s valor, o incluso, que entre m?s elementos mostremos en un diagrama, da una mejor vista de la arquitectura, de esta misma forma, vamos a cuestionar la complejidad absurda que dan modelos como UML, SysML o ArchiMate, por lo que si t? eres de esas personas obstinadas que quiere hacer las cosas como dice el manual y no como es el mundo real, te invito ahora mismo a que dejes de leer este libro y busques uno de UML, SysML, ArchiMate o lo que sea, en este libro no vengo a ense?arte el manual, pues para eso seguro hay mejores y m?s completos libros que este, por el contrario, este libro pretende darte un vistazo fresco de c?mo crear arquitectura de software con un enfoque ?gil y del mundo real.

Finalmente, abordaremos unas de las tendencias m?s relevantes, que es la documentaci?n como c?digo, que consisten en la creaci?n de la documentaci?n de todo el software mediante herramientas de software, donde tanto el estilo del documento, como los diagramas mismos, son generados 100% mediante c?digo, y no me mal int?rpretes, no se trata de aprender otro lenguaje de programaci?n, al contrario, son herramientas que con una sintaxis super simple, puedes crear diagramas de clases, secuencia, interacci?n, C4, etc.