CommunityBildgithub.com

archimaid

Schreiben, validieren und rendern Sie ArchiMate® 3.2-Diagramme als Text in der archimate-beta Mermaid-Syntax. Verwenden Sie dies, wenn der Benutzer ein ArchiMate-Diagramm, eine Unternehmensarchitektur-Ansicht (Business-, Anwendungs-, Technologieebenen, Fähigkeiten, Motivation) anfordert oder .mmd-Dateien oder Markdown-Mermaid-Blöcke bearbeitet, die mit archimate-beta beginnen.

Was ist archimaid?

Archimaid fügt ArchiMate 3.2 als `archimate-beta`-Diagrammtyp zu Mermaid hinzu. Es ermöglicht Entwicklern und Architekten, ArchiMate-Diagramme als Text zu schreiben, zu validieren und in SVG zu rendern. Die Validierung erfolgt über die Befehlszeile (`npx archimaid validate`), die Syntax wird Schritt für Schritt geprüft. Die Syntax unterstützt alle 60 ArchiMate-Elementtypen, Beziehungen mit Kurz- und Langform, Verschachtelung, Notizen und Links. Drei Layout-Optionen (architecture, framework, graph) decken verschiedene Sichten ab. Es wird auf Hosts wie GitHub oder GitLab unterstützt, indem die SVG-Datei neben der .mmd-Quelle eingebettet wird. Für Webseiten kann das Plugin mit Mermaid 12.3+ registriert werden.

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

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

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Vorschau

Aus dem Skill-README

Titel

Dokumentation

Was macht archimaid?

Archimaid fügt ArchiMate 3.2 als archimate-beta-Diagrammtyp zu Mermaid hinzu. Schreiben Sie Diagramme als Klartext, überprüfen Sie sie mit der archimaid CLI und rendern Sie sie als SVG.

Arbeitsablauf

  1. Entscheiden Sie, welche ArchiMate-Elemente und -Beziehungen die Ansicht benötigt. Modellieren Sie die Bedeutung mit Elementtypen und Beziehungen, nicht mit Notizen.
  2. Schreiben Sie das Diagramm in eine .mmd-Datei oder in einen gefassten mermaid-Block in Markdown.
  3. Validieren Sie es und beheben Sie jeden Fehler, dann validieren Sie erneut:
    npx --yes archimaid validate pfad/zum/diagramm.mmd
    
    Verwenden Sie - für die Standardeingabe. Probleme werden als datei:zeile:spalte: nachricht ausgegeben. Warnungen beginnen mit warning: und führen nicht zum Fehlschlagen des Durchlaufs.
  4. Überprüfen Sie, ob ArchiMate 3.2 jede Beziehung zwischen ihren Quell- und Zieltypen erlaubt (Anhang B). Der Validator prüft dies noch nicht.
  5. Rendern Sie ein SVG, wenn der Zielhost das Plugin nicht laden kann, z. B. GitHub Markdown (siehe Rendern).

Syntax

Beginnen Sie mit archimate-beta und setzen Sie eine Deklaration pro Zeile.

archimate-beta
  direction LR
  accTitle: Auftragsverwaltung
  accDescr: Die Auftragsverwaltungssuite enthält eine Abrechnungskomponente.

  element applicationComponent suite "Auftragsverwaltungssuite" {
    element applicationComponent billing "Abrechnung"
  }
  description billing "Bearbeitet die Rechnungsstellung."
  click billing href "https://wiki.example.com/abrechnung" "Abrechnungs-Runbook öffnen"

  suite *-- billing
  note review "Wiederholungsverhalten bestätigen" on suite
  • Elemente: element <typ> <id> "Name". Die 60 Typschlüssel (businessProcess, applicationComponent, node, …) sind in references/reference.md aufgelistet. Lesen Sie diese Datei, wenn Sie sich bei einem Schlüssel unsicher sind.
  • IDs: eindeutig, beginnen mit einem Buchstaben oder Unterstrich und enthalten Buchstaben, Ziffern, Unterstriche und Bindestriche.
  • Zeichenketten: JSON-artige doppelte Anführungszeichen, niemals leer. Verwenden Sie \n für einen Zeilenumbruch. Lange Namen werden automatisch umgebrochen.
  • Barrierefreiheit: fügen Sie immer accTitle: hinzu. Fügen Sie accDescr: oder accDescr { … } für mehrere Zeilen hinzu.
  • Frontmatter: ein führender YAML-Block zwischen ----Zeilen ist erlaubt, z. B. config: { theme: dark }.

Beziehungen

Kurzform: <quelle> <verbinder> <ziel>, optional mit : "Beschriftung". Der linke Endpunkt ist immer die Modellquelle.

VerbinderBeziehung
*--composition
o--aggregation
@==>assignment
..|>realization
-->serving
.. / <.. / ..> / <..>access: unspecified / read / write / readWrite
-.->influence
--- / --/association: undirected / directed
==>triggering
-.=>flow
--|>specialization
  • manage <.. order bedeutet manage liest order: der Zugreifer ist links.
  • Eine ID am Anfang einer Anweisung wird nie als das o---Glyph gelesen. Schreiben Sie o o-- b, nicht o--b.
  • Wiederholen Sie keine identische Kurzformzeile.
  • Langform: relationship <typ> <id> <quelle> -> <ziel>, optional gefolgt von access read|write|readWrite|unspecified oder directed, dann label "Text". Verwenden Sie die Langform, wenn eine andere Deklaration auf die ID der Beziehung verweisen muss.

Verschachtelung

  • Deklarieren Sie Kinder innerhalb von element … { und }, jeweils in einer eigenen Zeile. Blöcke können verschachtelt werden und enthalten Elemente, Beschreibungen, Beziehungen, Notizen, nest und click, aber keine Diagrammeinstellungen.
  • Verschachtelung benötigt keine Beziehung. Wenn genau eine Eltern-Kind-Beziehung die Verschachtelung unterstützt, repräsentiert die Umschließung sie und ihre Zeile wird ausgeblendet. Composition, Aggregation, Assignment, Realization und Access zeigen vom Elternteil zum Kind. Specialization zeigt vom Kind zum Elternteil.
  • nest <kind> in <elternteil> [via <beziehungsId>] ist die Linienform. Verwenden Sie via, wenn mehrere Beziehungen die Verschachtelung unterstützen könnten. Jedes Kind hat einen visuellen Elternteil, und die Verschachtelung darf keinen Zyklus bilden.

Notizen und Links

  • note <id> "Text" deklariert eine eigenständige Notiz. Fügen Sie on <elementId> an, um sie an ein Element zu heften. Notizen können Beziehungsendpunkte sein.
  • click <id> href "<url>" ["Tooltip"] [_blank|_self|_parent|_top] verlinkt ein Element. URLs müssen http, https, mailto oder relativ sein. Ohne Tooltip zeigt Schweben die description.

Layout

  • Standardmäßig oder layout architecture: Schichten von oben nach unten (Strategie, Business, Anwendung, Technologie und Physisch, Implementierung & Migration), mit Motivation oben in der Nähe dessen, womit sie verbunden ist. Bevorzugen Sie dies für schichtübergreifende Ansichten.
  • layout framework: dieselben Schichten, mit festen Spalten für Passive Struktur, Verhalten und Aktive Struktur sowie Motivation rechts.
  • layout graph oder direction TB|BT|LR|RL für sich: beziehungsgesteuerte Platzierung. Bevorzugen Sie dies für kleine einschichtige Ansichten und Ketten.

Nicht unterstützt

Junctions, Beziehungen als Endpunkte, alternative Figuren, Viewpoints und Model Exchange werden nicht unterstützt. Erfinden Sie keine Syntax dafür. Sagen Sie es und verwenden Sie das nächstgelegene unterstützte Konstrukt.

Rendern

Zum Rendern wird Playwright Chromium im Projekt benötigt:

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

Für Hosts, die das Plugin nicht registrieren (GitHub, GitLab), committen Sie die .mmd-Quelle neben dem SVG und betten Sie das SVG ein: ![Titel](diagramm.svg).

Für eine Webseite registrieren Sie das Plugin mit Mermaid 12.3 oder neuer:

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

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

Um die Syntax schnell mit dem Benutzer zu überprüfen, verweisen Sie ihn auf den Browser-Playground: https://try.archimaid.org

Beispiele

references/examples.md enthält drei vollständige, gültige Diagramme:

  • Auftragsverwaltung: assignment, realization, serving und read access
  • Schichtübergreifende Beziehungen: Architektur-Layout mit verschachtelter Schadensbearbeitung
  • Verschachtelte Komponenten: composition, angehängte und eigenständige Notizen, grenzüberschreitende Flüsse

Verwandte Skills