Diagram Kanban
Kanban diagram Mermaid vam omogoča ustvarjanje vizualne predstavitve prehajanja opravil skozi različne faze delovnega procesa; v nadaljevanju je razloženo, kako pravilno uporabljati sintakso kanban diagrama.
Osnove
Kanban diagram se začne s sintakso kanban, nato pa določite stolpce in opravila v teh stolpcih.
Kopiraj
Vdelava
kanban
column1[Column Title]
task1[Task Description]
Določitev stolpcev
Stolpci predstavljajo različne faze delovnega procesa, na primer "za opraviti", "v teku", "dokončano" itd. Vsak stolpec je definiran z edinstvenim identifikatorjem in naslovom, ovitim v oglate oklepaje.
Sintaksa:
Kopiraj
Vdelava
columnId[Column Title]
- columnId: edinstveni identifikator stolpca.
- [Column Title]: naslov, prikazan v glavi stolpca.
比如 id1[Todo]
Dodajanje opravil stolpcu
Opravila so prikazana v svojih stolpcih z zamikom. Vsako opravilo vključuje edinstven identifikator in opis, ovit v oglate oklepaje.
Sintaksa:
Kopiraj
Vdelava
taskId[Task Description]
taskId: edinstveni identifikator opravila.,[Task Description]: opis opravila.
Primer:
Kopiraj
Vdelava
docs[Create Documentation]
Dodajanje metapodatkov opravilu
Za vsako opravilo lahko dodate dodatne metapodatke s sintakso @{ ... }. Metapodatki lahko vsebujejo pare ključ-vrednost, kot so assigned, ticket, priority, ki se prikažejo pri upodabljanju vozlišča.
Podprti ključi metapodatkov
Dodeljeno: določa, kdo je odgovoren za opravilo.,Delovni nalog: poveže opravilo z delovnim nalogom ali številko težave.,Prioriteta: označuje nujnost opravila. Dovoljene vrednosti: zelo visoka, visoka, nizka in zelo nizka.
Kopiraj
Vdelava
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Možnosti konfiguracije
Kanban diagram lahko prilagodite s konfiguracijskim blokom na začetku datoteke markdown. To je uporabno za nastavitev globalnih nastavitev (na primer osnovnega URL delovnega naloga). Trenutno ima kanban diagram <code>ticketBaseUrl</code>; to je zelo uporabno za nastavitev globalnih nastavitev, na primer osnovnega URL delovnega naloga. Trenutno ima kanban diagram eno možnost konfiguracije ticketBaseUrl. Nastavite ga lahko po naslednjem primeru:
Kopiraj
Vdelava
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Ko ima kanban element določeno številko delovnega naloga, bo številka delovnega naloga v diagramu vsebovala povezavo do zunanjega sistema, ki definira ta delovni nalog. ticketBaseUrl nastavi osnovni URL, ki kaže na zunanji sistem, #TICKET# pa se nadomesti z vrednostjo delovnega naloga iz metapodatkov opravila, da se ustvari veljavna povezava.
Popoln primer
Sledi primer celotne kode kanban diagrama:
Kopiraj
Vdelava
---
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]
Skratka, ustvarjanje kanban diagrama v Mermaid je preprost postopek, ki učinkovito vizualizira vaš delovni proces.
S sintakso @{ ... } lahko opravilom dodate neobvezne metapodatke in tako izboljšate diagram; ta sintaksa vam omogoča vključitev dodatnih kontekstnih informacij, kot so odgovorna oseba, številka delovnega naloga in prioriteta. Za nadaljnjo prilagoditev uporabite konfiguracijski blok na vrhu datoteke za nastavitev globalnih možnosti, na primer ticketBaseUrl, da lahko delovne naloge povežete neposredno iz diagrama.
Z upoštevanjem teh smernic, zagotavljanjem edinstvenih identifikatorjev in pravilnega zamika ter uporabo metapodatkov in možnosti konfiguracije lahko ustvarite celovit in prilagojen kanban diagram, ki učinkovito preslika delovni proces projekta.
