Repolode
plantuml-stdlib

plantuml-stdlib/C4-PlantUML

Biblioteca de macros del modelo C4 para PlantUML que permite crear diagramas de arquitectura de software con código de texto plano.

Alternativa open source a:LucidchartVisio

Estrellas
7,441
Forks
1,168
Issues abiertos
0
Último commit
hace 9 días

¿Qué es?

C4-PlantUML es un conjunto de macros y estereotipos de PlantUML que implementa el modelo C4 para la arquitectura de software. En lugar de dibujar cajas a mano, describes personas, sistemas, contenedores, componentes y nodos de despliegue en un archivo de texto breve, y PlantUML genera el diagrama. Así, resulta fácil mantener los diagramas de arquitectura bajo control de versiones y revisarlos junto con el código.

La biblioteca ofrece includes independientes para los diagramas de Contexto del sistema, Contenedores, Componentes, Dinámicos, Despliegue y Secuencia con estilo C4. Cada include contiene macros para elementos comunes, variantes externas, bases de datos y colas, límites y relaciones con control opcional de dirección. También admite sprites e íconos, enlaces en los elementos, etiquetas personalizadas con leyendas generadas automáticamente y opciones de diseño.

El proyecto es multiplataforma y de código abierto, e incluye snippets para VS Code y live templates para IntelliJ. Los diagramas se pueden generar con un archivo jar local de PlantUML o mediante el servidor web de PlantUML. La biblioteca se puede incluir desde la URL del repositorio o desde la biblioteca estándar incluida con PlantUML.

Funciones clave

  • 01Macros para diagramas de Sistema, Contenedores, Componentes, Dinámicos, Despliegue y Secuencia con estilo C4.
  • 02Tipos de elementos para personas, sistemas, contenedores, bases de datos, colas y elementos externos.
  • 03Macros para relaciones direccionales y agrupación mediante límites.
  • 04Sprites de íconos, enlaces a elementos y etiquetas personalizadas con leyenda generada automáticamente.
  • 05Compatibilidad con editores mediante snippets para VS Code y live templates para IntelliJ.

Casos de uso

  • Documentar la arquitectura de software durante sesiones de diseño inicial.
  • Mantener los diagramas de arquitectura en el mismo repositorio que el código que describen.
  • Comunicar el contexto del sistema y la estructura de los contenedores a partes interesadas que no son especialistas.

Inicio rápido

  1. 1

    Incluye la biblioteca C4_Container en tu archivo .puml

    !include <C4/C4_Container>
  2. 2

    Escribe los elementos y las relaciones de C4 en texto sin formato entre @startuml/@enduml

  3. 3

    Renderiza el diagrama con PlantUML; por ejemplo, usando el archivo jar

    java -jar plantuml.jar -DRELATIVE_INCLUDE="." ...

Antes de usarlo

  • Para renderizar los diagramas se necesita PlantUML, así que necesitas Java o un servidor de PlantUML para verlos.

Temas

Preguntas frecuentes

¿Qué es C4-PlantUML?
Biblioteca de macros del modelo C4 para PlantUML que permite crear diagramas de arquitectura de software con código de texto plano. C4-PlantUML es un conjunto de macros y estereotipos de PlantUML que implementa el modelo C4 para la arquitectura de software. En lugar de dibujar cajas a mano, describes personas, sistemas, contenedores, componentes y nodos de despliegue en un archivo de texto breve, y PlantUML genera el diagrama. Así, resulta fácil mantener los diagramas de arquitectura bajo control de versiones y revisarlos junto con el código.
¿C4-PlantUML es gratuito? ¿Qué licencia tiene?
C4-PlantUML es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿C4-PlantUML sigue mantenido?
Mantenimiento activo. El último commit de C4-PlantUML fue el 13 oct 2026.
¿Para qué puedo usar C4-PlantUML?
Documentar la arquitectura de software durante sesiones de diseño inicial. Mantener los diagramas de arquitectura en el mismo repositorio que el código que describen. Comunicar el contexto del sistema y la estructura de los contenedores a partes interesadas que no son especialistas.
¿Cómo se instala C4-PlantUML?
Incluye la biblioteca C4_Container en tu archivo .puml: !include <C4/C4_Container> Escribe los elementos y las relaciones de C4 en texto sin formato entre @startuml/@enduml Renderiza el diagrama con PlantUML; por ejemplo, usando el archivo jar: java -jar plantuml.jar -DRELATIVE_INCLUDE="." ...
¿Dónde consigo C4-PlantUML?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/plantuml-stdlib/C4-PlantUML

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados