Kanban-Diagramm
Das Mermaid-Kanban-Diagramm ermöglicht es dir, eine visuelle Darstellung davon zu erstellen, wie Aufgaben durch verschiedene Phasen eines Arbeitsablaufs wandern; im Folgenden wird erklärt, wie die Kanban-Diagramm-Syntax korrekt verwendet wird.
Grundlagen
Ein Kanban-Diagramm beginnt mit der kanban-Syntax, dann werden die Spalten und die Aufgaben in diesen Spalten definiert.
Kopieren
Einbetten
kanban
column1[Column Title]
task1[Task Description]
Spalten definieren
Spalten repräsentieren die verschiedenen Phasen im Arbeitsablauf, wie zum Beispiel "To Do", "In Bearbeitung", "Erledigt" usw. Jede Spalte wird mit einem eindeutigen Bezeichner und einem in eckige Klammern gesetzten Titel definiert.
Syntax:
Kopieren
Einbetten
columnId[Column Title]
- columnId: Der eindeutige Bezeichner der Spalte.
- [Column Title]: Der Titel, der am Kopf der Spalte angezeigt wird.
比如 id1[Todo]
Aufgaben zu Spalten hinzufügen
Aufgaben werden in ihren jeweiligen Spalten mit Einrückung angezeigt. Jede Aufgabe umfasst einen eindeutigen Bezeichner und eine in eckige Klammern gesetzte Beschreibung.
Syntax:
Kopieren
Einbetten
taskId[Task Description]
taskId: Der eindeutige Bezeichner der Aufgabe.,[Task Description]: Die Beschreibung der Aufgabe.
Beispiel:
Kopieren
Einbetten
docs[Create Documentation]
Metadaten zu einer Aufgabe hinzufügen
Du kannst mit der Syntax @{ ... } zu jeder Aufgabe zusätzliche Metadaten hinzufügen. Metadaten können Schlüssel-Wert-Paare wie assigned, ticket, priority usw. enthalten, die beim Rendern des Knotens angezeigt werden.
Unterstützte Metadaten-Schlüssel
Zugewiesen an: Legt fest, wer für die Aufgabe verantwortlich ist.,Ticket: Verknüpft die Aufgabe mit einer Ticket- oder Problemnummer.,Priorität: Gibt die Dringlichkeit der Aufgabe an. Zulässige Werte: Sehr hoch, Hoch, Niedrig und Sehr niedrig.
Kopieren
Einbetten
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Konfigurationsoption
Du kannst das Kanban-Diagramm mit einem Konfigurationsblock am Anfang der markdown-Datei anpassen. Dies ist nützlich, um globale Einstellungen festzulegen, wie die Basis-URL für Tickets. Derzeit hat das Kanban-Diagramm <code>ticketBaseUrl</code> – dies ist sehr nützlich, um globale Einstellungen festzulegen, wie die Basis-URL für Tickets. Derzeit hat das Kanban-Diagramm eine Konfigurationsoption ticketBaseUrl. Sie kann wie im folgenden Beispiel festgelegt werden:
Kopieren
Einbetten
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Wenn ein Kanban-Eintrag eine angegebene Ticketnummer hat, enthält die Ticketnummer im Diagramm einen Link zu dem externen System, das dieses Ticket definiert. ticketBaseUrl legt die Basis-URL fest, die auf das externe System zeigt, und #TICKET# wird durch den Ticketwert in den Aufgabenmetadaten ersetzt, um einen gültigen Link zu erstellen.
Vollständiges Beispiel
Im Folgenden findest du ein vollständiges Beispiel für einen Kanban-Diagramm-Code:
Kopieren
Einbetten
---
config:
kanban:
ticketBaseUrl: 'https://mermaidchart.atlassian.net/browse/#TICKET#'
---
kanban
Todo
[Create Documentation]
docs[Create Blog about the new diagram]
[In progress]
id6[Create renderer so that it works in all cases. We also add some extra text here for testing purposes. And some more just for the extra flare.]
id9[Ready for deploy]
id8[Design grammar]@{ assigned: 'knsv' }
id10[Ready for test]
id4[Create parsing tests]@{ ticket: MC-2038, assigned: 'K.Sveidqvist', priority: 'High' }
id66[last item]@{ priority: 'Very Low', assigned: 'knsv' }
id11[Done]
id5[define getData]
id2[Title of diagram is more than 100 chars when user duplicates diagram with 100 char]@{ ticket: MC-2036, priority: 'Very High'}
id3[Update DB function]@{ ticket: MC-2037, assigned: knsv, priority: 'High' }
id12[Can't reproduce]
id3[Weird flickering in Firefox]
Zusammenfassend ist das Erstellen eines Kanban-Diagramms in Mermaid ein einfacher Vorgang, mit dem du deinen Arbeitsablauf effektiv visualisieren kannst.
Du kannst dein Diagramm erweitern, indem du mit der Syntax @{ ... } optionale Metadaten zu Aufgaben hinzufügst; diese Syntax ermöglicht es dir, zusätzliche Kontextinformationen wie Verantwortliche, Ticketnummern und Prioritäten aufzunehmen. Für weitere Anpassungen verwende den Konfigurationsblock am Anfang der Datei, um globale Optionen wie ticketBaseUrl festzulegen, um Tickets direkt aus dem Diagramm heraus zu verlinken.
Indem du diese Richtlinien befolgst, eindeutige Bezeichner und korrekte Einrückung sicherstellst und Metadaten- und Konfigurationsoptionen nutzt, kannst du ein umfassendes und maßgeschneidertes Kanban-Diagramm erstellen, das den Arbeitsablauf deines Projekts effektiv abbildet.
