Documentación como Código

Share on:

Llevo tiempo promoviendo en los proyectos la utilización de Documentación como Código, por diversos motivos:

  • Es más cómodo para el equipo de desarrollo a la hora de realizar documentación técnica, dado que se puede utilizar el mismo entorno de desarrollo (IDE).

  • La documentación está almacenada en el mismo repositorio de código fuente, en modo texto, y por lo tanto es más sencillo gestionar los cambios / merge, etc.

Para ello, el lenguaje que recomiendo es AsciiDoc, que junto a PlantUML y ditaa, podemos generar la documentación incluyendo gráficos, UML,…​ como:

doc as code ditaa
Figure 1. ditaa
doc as code plantuml
Figure 2. PlantUML

See Also