Kanbantavle
Mermaid-kanban-diagrammer giver dig mulighed for at skabe en visuel repræsentation af, hvordan opgaver bevæger sig gennem forskellige faser af en arbejdsgang; nedenfor forklares, hvordan du bruger kanban-diagrammets syntaks korrekt.
Grundlæggende
Et kanban-diagram begynder med kanban-syntaksen og definerer derefter kolonner og opgaverne i disse kolonner.
Kopiér
Integrer
kanban
column1[Column Title]
task1[Task Description]
Definér kolonner
Kolonner repræsenterer forskellige faser i arbejdsgangen, f.eks. "to-do", "i gang", "afsluttet" osv. Hver kolonne defineres med en unik identifikator og en titel i kantede parenteser.
Syntaks:
Kopiér
Integrer
columnId[Column Title]
- columnId: kolonnens unikke identifikator.
- [Column Title]: titlen, der vises i kolonneoverskriften.
比如 id1[Todo]
Tilføj opgaver til en kolonne
Opgaverne vises i deres respektive kolonner med indrykning. Hver opgave indeholder en unik identifikator og en beskrivelse i kantede parenteser.
Syntaks:
Kopiér
Integrer
taskId[Task Description]
taskId: opgavens unikke identifikator.,[Task Description]: opgavens beskrivelse.
Eksempel:
Kopiér
Integrer
docs[Create Documentation]
Tilføj metadata til en opgave
Du kan tilføje yderligere metadata til hver opgave med syntaksen @{ ... }. Metadata kan indeholde nøgle-værdi-par som assigned, ticket, priority osv., som vises i knudens rendering.
Understøttede metadatanøgler
Tildelt til: Angiver, hvem der er ansvarlig for opgaven.,Sag: Linker opgaven til en sag eller et problemnummer.,Prioritet: Angiver opgavens hastighedsgrad. Tilladte værdier: meget høj, høj, lav og meget lav.
Kopiér
Integrer
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Konfigurationsmuligheder
Du kan tilpasse kanban-diagrammet med en konfigurationsblok i begyndelsen af markdown-filen. Dette er nyttigt til at angive globale indstillinger (f.eks. sagens basis-URL). I øjeblikket har kanban-diagrammet én konfigurationsmulighed: ticketBaseUrl. Den kan angives som i følgende eksempel:
Kopiér
Integrer
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Når et kanban-element har et angivet sagsnummer, indeholder sagsnummeret i diagrammet et link til det eksterne system, der definerer sagen. ticketBaseUrl angiver basis-URL'en til det eksterne system, og #TICKET# erstattes af sagsværdien i opgavens metadata for at oprette et gyldigt link.
Fuldt eksempel
Nedenfor ses et komplet kodeeksempel på et kanban-diagram:
Kopiér
Integrer
---
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]
Kort sagt er det en enkel proces at oprette et kanban-diagram i Mermaid, og det kan effektivt visualisere din arbejdsgang.
Du kan forbedre dit diagram ved at tilføje valgfri metadata til opgaver med syntaksen @{ ... }, som giver dig mulighed for at medtage yderligere kontekstinformation som ansvarlig person, sagsnummer og prioritet. Til yderligere tilpasning kan du bruge konfigurationsblokken øverst i filen til at angive globale indstillinger, f.eks. ticketBaseUrl, så sager kan linkes direkte fra diagrammet.
Ved at følge disse retningslinjer, sikre unikke identifikatorer og korrekt indrykning samt udnytte metadata og konfigurationsmuligheder kan du oprette et omfattende og tilpasset kanban-diagram, der effektivt afspejler projektets arbejdsgang.
