Mermaid Dokument

Appearance

Mermaid Kanban Diagram Dokumentation ​

Das Kanban-Diagramm von Mermaid ermöglicht es Ihnen, visuelle Darstellungen von Aufgaben zu erstellen, die durch verschiedene Phasen eines Workflows bewegt werden. Dieser Leitfaden erklärt, wie Sie die Syntax des Kanban-Diagramms verwenden können, basierend auf dem bereitgestellten Beispiel.

Überblick ​

Ein Kanban-Diagramm in Mermaid beginnt mit dem SchlĂĽsselwort kanban, gefolgt von der Definition der Spalten (Phasen) und den Aufgaben innerhalb dieser Spalten.

Code:
mermaid

Spalten Definieren ​

Spalten repräsentieren die verschiedenen Phasen in Ihrem Workflow, wie „Zu Erledigen“, „In Bearbeitung“, „Fertig“ usw. Jede Spalte wird mit einer eindeutigen Kennung und einem Titel in eckigen Klammern definiert.

Syntax:

columnId[Spaltentitel]
  • columnId: Eine eindeutige Kennung fĂĽr die Spalte.
  • [Spaltentitel]: Der Titel, der in der SpaltenĂĽberschrift angezeigt wird.

So wie id1[Zu Erledigen]

Aufgaben zu Spalten Hinzufügen ​

Aufgaben werden unter ihren jeweiligen Spalten mit EinrĂĽckung aufgelistet. Jede Aufgabe hat ebenfalls eine eindeutige Kennung und eine Beschreibung, die in eckigen Klammern eingeschlossen ist.

Syntax:

taskId[Aufgabenbeschreibung]
•	taskId: Eine eindeutige Kennung für die Aufgabe.
•	[Aufgabenbeschreibung]: Die Beschreibung der Aufgabe.

Beispiel:

docs[Dokumentation erstellen]

Metadaten zu Aufgaben Hinzufügen ​

Sie können zusätzliche Metadaten für jede Aufgabe mit der @{ ... } Syntax einfügen. Metadaten können Schlüssel-Wert-Paare wie zugewiesen, Ticket, Priorität usw. enthalten. Dies wird zu der Darstellung des Knotens hinzugefügt.

Unterstützte Metadaten-Schlüssel ​

•	zugewiesen: Gibt an, wer für die Aufgabe verantwortlich ist.
•	ticket: Verknüpft die Aufgabe mit einer Ticket- oder Issue-Nummer.
•	priorität: Gibt die Dringlichkeit der Aufgabe an. Erlaubte Werte: 'Sehr Hoch', 'Hoch', 'Niedrig' und 'Sehr Niedrig'
Code:
mermaid

Konfigurationsoptionen ​

Sie können das Kanban-Diagramm mit einem Konfigurationsblock zu Beginn Ihrer Markdown-Datei anpassen. Dies ist nützlich, um globale Einstellungen wie eine Basis-URL für Tickets festzulegen. Derzeit gibt es eine Konfigurationsoption für Kanban-Diagramme ticketBaseUrl. Diese kann im folgenden Beispiel gesetzt werden:

yaml
---
config:
  kanban:
    ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---

Wenn das Kanban-Element ĂĽber eine zugewiesene Ticketnummer verfĂĽgt, hat die Ticketnummer im Diagramm einen Link zu einem externen System, in dem das Ticket definiert ist. Die ticketBaseUrl setzt die Basis-URL fĂĽr das externe System, und #TICKET# wird durch den Ticketwert aus den Aufgabemetadaten ersetzt, um einen gĂĽltigen Link zu erstellen.

Vollständiges Beispiel ​

Im Folgenden finden Sie das vollständige Kanban-Diagramm basierend auf dem bereitgestellten Beispiel:

Code:
mermaid

Zusammenfassend lässt sich sagen, dass die Erstellung eines Kanban-Diagramms in Mermaid ein unkomplizierter Prozess ist, der Ihren Workflow effektiv visualisiert. Beginnen Sie mit dem Schlüsselwort kanban, um das Diagramm zu initiieren. Definieren Sie Ihre Spalten mit eindeutigen Kennungen und Titeln, um die verschiedenen Phasen Ihres Projekts darzustellen. Unter jeder Spalte listen Sie Ihre Aufgaben – ebenfalls mit eindeutigen Kennungen – und geben nach Bedarf detaillierte Beschreibungen an. Denken Sie daran, dass eine ordnungsgemäße Einrückung entscheidend ist; Aufgaben müssen unter ihren übergeordneten Spalten eingerückt werden, um die korrekte Struktur aufrechtzuerhalten.

Sie können Ihr Diagramm verbessern, indem Sie optionale Metadaten zu Aufgaben mithilfe der @{ ... } Syntax hinzufügen, die es Ihnen ermöglicht, zusätzlichen Kontext wie Zuweisungen, Ticketnummern und Prioritätsstufen einzufügen. Für weitere Anpassungen nutzen Sie den Konfigurationsblock am Anfang Ihrer Datei, um globale Optionen wie ticketBaseUrl für das Verlinken von Tickets direkt aus Ihrem Diagramm festzulegen.

Indem Sie diese Richtlinien befolgen – eindeutige Kennungen sicherstellen, ordnungsgemäße Einrückung verwenden und Metadaten und Konfigurationsoptionen nutzen – können Sie ein umfassendes und angepasstes Kanban-Board erstellen, das den Workflow Ihres Projekts mithilfe von Mermaid effektiv abbildet.