Kanban-diagram
Mermaid-kanbandiagram låter dig skapa en visuell representation av hur uppgifter rör sig genom olika faser i ett arbetsflöde; nedan förklaras hur du använder kanban-diagrammets syntax korrekt.
Grundläggande
Ett kanban-diagram börjar med kanban -syntaxen och definierar sedan kolumner samt uppgifterna i dessa kolumner.
Kopiera
Bädda in
kanban
column1[Column Title]
task1[Task Description]
Definiera kolumner
Kolumner representerar olika faser i arbetsflödet, till exempel "Att göra", "Pågående", "Klart" osv. Varje kolumn definieras med en unik identifierare och en titel omgiven av hakparenteser.
Syntax:
Kopiera
Bädda in
columnId[Column Title]
- columnId: kolumnens unika identifierare.
- [Column Title]: titeln som visas högst upp i kolumnen.
比如 id1[Todo]
Lägg till uppgifter i en kolumn
Uppgifter visas under sina respektive kolumner, med indentering. Varje uppgift består av en unik identifierare och en beskrivning omgiven av hakparenteser.
Syntax:
Kopiera
Bädda in
taskId[Task Description]
taskId: uppgiftens unika identifierare.,[Task Description]: uppgiftens beskrivning.
Exempel:
Kopiera
Bädda in
docs[Create Documentation]
Lägg till metadata till uppgifter
Du kan använda syntaxen @{ ... } för att lägga till ytterligare metadata till varje uppgift. Metadata kan innehålla nyckel-värde-par som assigned, ticket, priority, vilka visas i nodens rendering.
Metadata-nycklar som stöds
Tilldelad: anger vem som ansvarar för uppgiften.,Ärende: länkar uppgiften till ett ärende- eller problemnummer.,Prioritet: anger uppgiftens brådskande grad. Tillåtna värden: mycket hög, hög, låg och mycket låg.
Kopiera
Bädda in
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Konfigurationsalternativ
Du kan anpassa kanban-diagrammet med ett konfigurationsblock i början av markdown-filen. Detta är användbart för att ställa in globala inställningar (som bas-URL för ärenden). För närvarande har kanban-diagrammet <code>ticketBaseUrl</code> , vilket är mycket användbart för att ställa in globala inställningar, till exempel bas-URL för ärenden. För närvarande har kanban-diagrammet ett konfigurationsalternativ ticketBaseUrl. Det kan ställas in enligt följande exempel:
Kopiera
Bädda in
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
När en kanban-post har ett angivet ärendenummer kommer ärendenumret i diagrammet att innehålla en länk till det externa system som definierar ärendet. ticketBaseUrl anger bas-URL:en till det externa systemet, och #TICKET# ersätts av ärendevärdet i uppgiftens metadata för att skapa en giltig länk.
Fullständigt exempel
Följande är ett fullständigt kodexempel på ett kanban-diagram:
Kopiera
Bädda in
---
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]
Sammanfattningsvis är det en enkel process att skapa ett kanban-diagram i Mermaid, och det kan effektivt visualisera ditt arbetsflöde.
Du kan förbättra ditt diagram genom att lägga till valfri metadata till uppgifter med syntaxen @{ ... }; denna syntax låter dig inkludera ytterligare kontextinformation som ansvarig person, ärendenummer och prioritet. För ytterligare anpassning, använd konfigurationsblocket högst upp i filen för att ställa in globala alternativ som ticketBaseUrl, så att ärenden kan länkas direkt från diagrammet.
Genom att följa dessa riktlinjer, säkerställa unika identifierare, korrekt indentering och utnyttja metadata och konfigurationsalternativ kan du skapa ett omfattande och skräddarsytt kanban-diagram som effektivt kartlägger projektets arbetsflöde.
