Recomendamos la utilización de PlantUML por las siguientes razones:
- Se pueden versionar los distintos diagramas.
- Existen herramientas que lo interpretan y no requiere la instalación de un software. Ver aquí.
- Permite la utilización de
includey variables, lo cual facilita la actualización de los diagramas.
Para trabajar localmente con Plantuml necesitará instalar la aplicación java. Las instrucciones las encontrarán aquí.
Utilizando el script render_diagrams.sh se pueden generar los archivos *.png asociados a cada uno de los diagramas cuyo archivo es *.plantuml.
Este script inspecciona la carpeta diagrams/.
Forma de ejecución:
$ scripts/render_diagrams.sh Nota 1:
El script requiere que la herramienta plantuml esté instalada.
Nota 2:
No contamos con un script para sistemas operativos Windows. Cualquier colaboración es aceptada. Para más información revisar guía de desarrollo.
Nota: Es útil para pequeños ensayos de notación.
Existen múltiples plugins para interpretar estos archivos
| Herramienta | Version | Plugin | Version |
|---|---|---|---|
| VSCode | v1.58.0 | Plantuml extension | v2.15.1 |
| Idea | 2020.3 | Plantuml plugin | v2.15.2/v5.5.1 |
| Emacs | ? | Plugin | ? |
Plantuml nos permite utilizar inclusión de archivos y utilización de variables!
Esto les permitiría definir sus clases (una única vez) y utilizarlas en la definición de sus relaciones.
Aquí pueden encontrar un ejemplo ejemplo
Sugerencia:
Les recomendamos implementar esta herramienta para mitigar los errores de inconsistencia en los diagramas uml.
