CommunityImagengithub.com

archimaid

Escribe, valida y renderiza diagramas ArchiMate® 3.2 como texto en la sintaxis Mermaid archimate-beta. Úsalo cuando el usuario pida un diagrama ArchiMate, una vista de arquitectura empresarial (capas de negocio, aplicación, tecnología, capacidades, motivación) o edite archivos .mmd o bloques mermaid en Markdown que comiencen con archimate-beta.

¿Qué es archimaid?

Archimaid extiende Mermaid con el tipo de diagrama `archimate-beta` para modelar arquitectura empresarial usando el estándar ArchiMate 3.2. Permite escribir diagramas como texto plano, validarlos con el CLI `archimaid` y renderizarlos a SVG. Soporta los 60 tipos de elementos y 10 relaciones de ArchiMate, incluyendo composición, agregación, realización, asignación, servicio, acceso, influencia, flujo, especialización y disparo. Incluye características como anidamiento de elementos, notas, enlaces click, descripciones y tres modos de diseño (architecture, framework y graph). La validación comprueba la sintaxis, pero todavía no verifica las reglas del Apéndice B de ArchiMate 3.2 (relaciones permitidas entre tipos). Para renderizar se necesita Playwright Chromium en el proyecto, y para entornos que no cargan el plugin (como GitHub o GitLab) se puede incrustar el SVG generado. También se puede registrar el plugin en Mermaid 12.3+ para usar en páginas web. Archimaid es útil para arquitectos de software, consultores de enterprise architecture y desarrolladores que quieren mantener diagramas de arquitectura como código.

Compatible con~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Archimaid/claude-plugin/tree/HEAD/skills/archimaid

Installed? Explore more Imagen skills: steipete/songsee, affaan-m/frontend-design, mattpocock/improve-codebase-architecture · View all 6 →

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Vista previa

Del README del skill

Título

Documentación

¿Qué hace archimaid?

Archimaid añade ArchiMate 3.2 a Mermaid como el tipo de diagrama archimate-beta. Escribe diagramas como texto plano, verifícalos con el CLI archimaid y renderízalos a SVG.

Flujo de trabajo

  1. Decide qué elementos y relaciones de ArchiMate necesita la vista. Modela el significado con tipos de elemento y relaciones, no con notas.
  2. Escribe el diagrama en un archivo .mmd, o en un bloque mermaid delimitado en Markdown.
  3. Valídalo y corrige cada error, luego vuelve a validar:
    npx --yes archimaid validate ruta/al/diagrama.mmd
    
    Usa - para validar la entrada estándar. Los problemas se muestran como archivo:línea:columna: mensaje. Las advertencias comienzan con warning: y no detienen la ejecución.
  4. Comprueba que ArchiMate 3.2 permite cada relación entre sus tipos de origen y destino (Apéndice B). El validador aún no verifica esto.
  5. Renderiza un SVG cuando el host destino no pueda cargar el plugin, como en GitHub Markdown (ver Renderizado).

Sintaxis

Empieza con archimate-beta y pon una declaración en cada línea.

archimate-beta
  direction LR
  accTitle: Gestión de pedidos
  accDescr: El sistema de gestión de pedidos contiene un componente de facturación.

  element applicationComponent suite "Suite de gestión de pedidos" {
    element applicationComponent billing "Facturación"
  }
  description billing "Maneja la facturación."
  click billing href "https://wiki.ejemplo.com/facturacion" "Abrir el manual de facturación"

  suite *-- billing
  note review "Confirmar comportamiento de reintentos" on suite
  • Elementos: element <tipo> <id> "Nombre". Las 60 claves de tipo (businessProcess, applicationComponent, node, …) se listan en references/reference.md. Consúltalo siempre que no estés seguro de una clave.
  • IDs: únicos, comienzan con una letra o guión bajo, y contienen letras, dígitos, guiones bajos y guiones.
  • Cadenas: comillas dobles al estilo JSON, nunca vacías. Usa \n para un salto de línea. Los nombres largos se ajustan automáticamente.
  • Accesibilidad: añade siempre accTitle:. Añade accDescr:, o accDescr { … } para varias líneas.
  • Frontmatter: se permite un bloque YAML inicial entre líneas ---, por ejemplo config: { theme: dark }.

Relaciones

Taquigrafía: <fuente> <conector> <destino>, con un opcional : "Etiqueta". El extremo izquierdo es siempre la fuente del modelo.

ConectorRelación
*--composición
o--agregación
@==>asignación
..|>realización
-->servicio
.. / <.. / ..> / <..>acceso: no especificado / lectura / escritura / lecturaEscritura
-.->influencia
--- / --/asociación: no dirigida / dirigida
==>disparo
-.=>flujo
--|>especialización
  • manage <.. order significa manage lee order: el accesor está a la izquierda.
  • Un ID al inicio de una sentencia nunca se interpreta como el glifo o--. Escribe o o-- b, no o--b.
  • No repitas una línea taquigráfica idéntica.
  • Forma larga: relationship <tipo> <id> <fuente> -> <destino>, seguido opcionalmente de access read|write|readWrite|unspecified o directed, luego label "Texto". Usa la forma larga cuando otra declaración deba referenciar el ID de la relación.

Anidamiento

  • Declara hijos dentro de element … { y }, cada uno en su propia línea. Los bloques se anidan y pueden contener elementos, descripciones, relaciones, notas, nest y click, pero no configuraciones del diagrama.
  • El anidamiento no necesita relación. Cuando exactamente una relación padre-hijo soporta el anidamiento, el contenedor la representa y su línea se oculta. Composición, agregación, asignación, realización y acceso apuntan del padre al hijo. Especialización apunta del hijo al padre.
  • nest <hijo> in <padre> [via <idRelacion>] es la forma de línea. Usa via cuando varias relaciones puedan soportar el anidamiento. Cada hijo tiene un padre visual, y el anidamiento no debe formar un ciclo.

Notas y enlaces

  • note <id> "Texto" declara una nota independiente. Añade on <idElemento> para adjuntarla a un elemento. Las notas pueden ser extremos de relaciones.
  • click <id> href "<url>" ["Tooltip"] [_blank|_self|_parent|_top] enlaza un elemento. Las URL deben ser http, https, mailto o relativas. Sin tooltip, al pasar el ratón se muestra la description.

Diseño

  • Por defecto, o layout architecture: capas de arriba a abajo (Estrategia, Negocio, Aplicación, Tecnología y Física, Implementación y Migración), con Motivación en la parte superior cerca de lo que conecta. Prefiérelo para vistas entre capas.
  • layout framework: las mismas capas, con columnas fijas de Estructura Pasiva, Comportamiento y Estructura Activa, y Motivación a la derecha.
  • layout graph, o direction TB|BT|LR|RL por sí solo: colocación basada en relaciones. Prefiérelo para vistas pequeñas de una sola capa y cadenas.

Fuera del alcance

Uniones, relaciones como extremos, figuras alternativas, puntos de vista e intercambio de modelos no están soportados. No inventes sintaxis para ellos. Dilo y usa la construcción soportada más cercana.

Renderizado

El renderizado necesita Playwright Chromium en el proyecto:

npm install --save-dev archimaid mermaid playwright
npx playwright install chromium
npx archimaid render diagrama.mmd diagrama.svg --theme default --background theme

Para hosts que no registran el plugin (GitHub, GitLab), confirma el código fuente .mmd junto al SVG e incrusta el SVG: ![Título](diagrama.svg).

Para una página web, registra el plugin con Mermaid 12.3 o posterior:

import mermaid from 'mermaid';
import { archimate } from 'archimaid';

mermaid.initialize({ startOnLoad: false, securityLevel: 'strict' });
await mermaid.registerExternalDiagrams([archimate]);

Para verificar la sintaxis rápidamente con el usuario, dirígelo al playground del navegador: https://try.archimaid.org

Ejemplos

references/examples.md tiene tres diagramas completos y válidos:

  • Gestión de pedidos: asignación, realización, servicio y acceso de lectura
  • Relaciones entre capas: diseño de arquitectura con procesamiento de reclamaciones anidado
  • Componentes anidados: composición, notas adjuntas e independientes, flujos entre límites

Skills relacionados