Kanbanbord
Met Mermaid-kanbanborden kun je een visuele weergave maken van taken die door verschillende fasen van een workflow stromen; hieronder wordt uitgelegd hoe je de kanbanbord-syntaxis correct gebruikt.
Basics
Een kanbanbord begint met de syntaxis kanban en definieert vervolgens de kolommen en de taken in deze kolommen.
Kopiëren
Insluiten
kanban
column1[Column Title]
task1[Task Description]
Kolommen definiëren
Kolommen vertegenwoordigen de verschillende fasen in de workflow, zoals "te doen", "in behandeling", "voltooid", enz. Elke kolom wordt gedefinieerd met een unieke identificatie en een titel tussen vierkante haken.
Syntaxis:
Kopiëren
Insluiten
columnId[Column Title]
- columnId: de unieke identificatie van de kolom.
- [Column Title]: de titel die bovenaan de kolom wordt weergegeven.
比如 id1[Todo]
Taken aan kolommen toevoegen
Taken worden per kolom weergegeven, met inspringing. Elke taak bestaat uit een unieke identificatie en een beschrijving tussen vierkante haken.
Syntaxis:
Kopiëren
Insluiten
taskId[Task Description]
taskId: de unieke identificatie van de taak.,[Task Description]: de beschrijving van de taak.
Voorbeeld:
Kopiëren
Insluiten
docs[Create Documentation]
Metadata aan taken toevoegen
Je kunt met de syntaxis @{ ... } aan elke taak extra metadata toevoegen. Metadata kan sleutel-waardeparen bevatten zoals assigned, ticket en priority, die in de weergave van het knooppunt worden getoond.
Ondersteunde metadatasleutels
assigned: specificeert wie verantwoordelijk is voor de taak.,ticket: koppelt de taak aan een ticket- of issuenummer.,priority: geeft de urgentie van de taak aan. Toegestane waarden: Very High, High, Low en Very Low.
Kopiëren
Insluiten
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Configuratieopties
Je kunt het kanbanbord aanpassen met een configuratieblok aan het begin van het markdown-bestand. Dit is nuttig voor het instellen van globale instellingen (zoals de basis-URL van tickets). Momenteel heeft het kanbandiagram <code>ticketBaseUrl</code>; dit is zeer nuttig voor het instellen van globale instellingen, zoals de basis-URL van tickets. Momenteel heeft het kanbandiagram één configuratieoptie: ticketBaseUrl. Dit kan als volgt worden ingesteld:
Kopiëren
Insluiten
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Wanneer een kanbanitem een opgegeven ticketnummer heeft, bevat het ticketnummer in het diagram een link naar het externe systeem waarin dat ticket is gedefinieerd. De instelling ticketBaseUrl verwijst naar de basis-URL van het externe systeem, en #TICKET# wordt vervangen door de ticketwaarde uit de taakmetadata om een geldige link te maken.
Volledig voorbeeld
Hieronder volgt een volledig codevoorbeeld van een kanbanbord:
Kopiëren
Insluiten
---
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]
Kortom, het maken van een kanbanbord in Mermaid is een eenvoudig proces waarmee je je workflow effectief kunt visualiseren.
Je kunt je diagram verrijken door met de syntaxis @{ ... } optionele metadata aan taken toe te voegen; deze syntaxis laat je extra contextuele informatie opnemen, zoals de verantwoordelijke, het ticketnummer en de prioriteit. Gebruik voor verdere aanpassing het configuratieblok bovenaan het bestand om globale opties in te stellen, zoals ticketBaseUrl, zodat je tickets rechtstreeks vanuit het diagram kunt linken.
Door deze richtlijnen te volgen, unieke identificaties te waarborgen, correct in te springen en gebruik te maken van metadata en configuratieopties, kun je een uitgebreid en op maat gemaakt kanbanbord maken dat de workflow van je project effectief in kaart brengt.
