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
- Entscheiden Sie, welche ArchiMate-Elemente und -Beziehungen die Ansicht benötigt. Modellieren Sie die Bedeutung mit Elementtypen und Beziehungen, nicht mit Notizen.
- Schreiben Sie das Diagramm in eine
.mmd-Datei oder in einen gefasstenmermaid-Block in Markdown. - Validieren Sie es und beheben Sie jeden Fehler, dann validieren Sie erneut:
Verwenden Sienpx --yes archimaid validate pfad/zum/diagramm.mmd-für die Standardeingabe. Probleme werden alsdatei:zeile:spalte: nachrichtausgegeben. Warnungen beginnen mitwarning:und führen nicht zum Fehlschlagen des Durchlaufs. - Überprüfen Sie, ob ArchiMate 3.2 jede Beziehung zwischen ihren Quell- und Zieltypen erlaubt (Anhang B). Der Validator prüft dies noch nicht.
- 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
\nfür einen Zeilenumbruch. Lange Namen werden automatisch umgebrochen. - Barrierefreiheit: fügen Sie immer
accTitle:hinzu. Fügen SieaccDescr:oderaccDescr { … }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.
| Verbinder | Beziehung |
|---|---|
*-- | composition |
o-- | aggregation |
@==> | assignment |
..|> | realization |
--> | serving |
.. / <.. / ..> / <..> | access: unspecified / read / write / readWrite |
-.-> | influence |
--- / --/ | association: undirected / directed |
==> | triggering |
-.=> | flow |
--|> | specialization |
manage <.. orderbedeutet manage liest order: der Zugreifer ist links.- Eine ID am Anfang einer Anweisung wird nie als das
o---Glyph gelesen. Schreiben Sieo o-- b, nichto--b. - Wiederholen Sie keine identische Kurzformzeile.
- Langform:
relationship <typ> <id> <quelle> -> <ziel>, optional gefolgt vonaccess read|write|readWrite|unspecifiedoderdirected, dannlabel "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,nestundclick, 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 Sievia, 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 Sieon <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 diedescription.
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 graphoderdirection TB|BT|LR|RLfü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: .
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