Kanban-tavle
Mermaid-kanbandiagrammer lar deg lage en visuell representasjon av hvordan oppgaver flyter gjennom ulike faser i en arbeidsflyt. Nedenfor forklares hvordan du bruker kanbandiagram-syntaksen på riktig måte.
Grunnleggende
Et kanbandiagram begynner med kanban -syntaksen, og deretter defineres kolonner og oppgavene i disse kolonnene.
Kopier
Bygg inn
kanban
column1[Column Title]
task1[Task Description]
Definer kolonner
Kolonner representerer ulike faser i arbeidsflyten, for eksempel "oppgaver", "pågår", "fullført" osv. Hver kolonne defineres med en unik identifikator og en tittel omsluttet av hakeparenteser.
Syntaks:
Kopier
Bygg inn
columnId[Column Title]
- columnId: kolonnens unike identifikator.
- [Column Title]: tittelen som vises øverst i kolonnen.
比如 id1[Todo]
Legg til en oppgave i en kolonne
Oppgaver vises i sine respektive kolonner, med innrykk. Hver oppgave består av en unik identifikator og en beskrivelse omsluttet av hakeparenteser.
Syntaks:
Kopier
Bygg inn
taskId[Task Description]
taskId: oppgavens unike identifikator.,[Task Description]: oppgavens beskrivelse.
Eksempel:
Kopier
Bygg inn
docs[Create Documentation]
Legg til metadata for en oppgave
Du kan bruke @{ ... } -syntaksen til å legge til ekstra metadata for hver oppgave. Metadata kan inneholde nøkkel-verdi-par som assigned , ticket , priority osv., som vises i nodens rendring.
Støttede metadatanøkler
Tildelt til: angir hvem som er ansvarlig for oppgaven.,Sak: kobler oppgaven til en sak eller et saksnummer.,Prioritet: angir oppgavens hastegrad. Tillatte verdier: Svært høy, Høy, Lav og Svært lav.
Kopier
Bygg inn
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Konfigurasjonsalternativer
Du kan tilpasse kanbandiagrammet med en konfigurasjonsblokk i begynnelsen av markdown-filen. Dette er nyttig for å angi globale innstillinger (som basis-URL-en for saker). For tiden er kanbandiagrammet <code>ticketBaseUrl</code> Dette er svært nyttig for å angi globale innstillinger, for eksempel basis-URL-en for saker. For tiden har kanbandiagrammet ett konfigurasjonsalternativ ticketBaseUrl . Det kan angis som i følgende eksempel:
Kopier
Bygg inn
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Når en kanbanoppføring har et angitt saksnummer, vil saksnummeret i diagrammet inneholde en lenke til det eksterne systemet som definerer saken. Innstillingen ticketBaseUrl angir basis-URL-en til det eksterne systemet, og #TICKET# erstattes med saksverdien i oppgavens metadata for å opprette en gyldig lenke.
Fullstendig eksempel
Følgende er et fullstendig kodeeksempel på et kanbandiagram:
Kopier
Bygg inn
---
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 prosess å opprette et kanbandiagram i Mermaid, og det kan effektivt visualisere arbeidsflyten din.
Du kan forbedre diagrammet ditt ved å legge til valgfrie metadata for oppgaver med @{ ... } -syntaksen. Denne syntaksen lar deg inkludere ekstra kontekstinformasjon, for eksempel ansvarlig, saksnummer og prioritet. For ytterligere tilpasning bruker du konfigurasjonsblokken øverst i filen til å angi globale alternativer, for eksempel ticketBaseUrl , slik at du kan lenke saker direkte fra diagrammet.
Ved å følge disse retningslinjene, sikre unike identifikatorer, riktig innrykk og bruke metadata og konfigurasjonsalternativer, kan du lage et omfattende og tilpasset kanbandiagram som effektivt kartlegger prosjektets arbeidsflyt.
