Register
Process Type
Graphical expression
Mind Type
Structured expression
Note Type
Efficient expression

Kanban nástěnkaSyntaxe

Kanban nástěnka

Kanban diagram Mermaid umožňuje vytvářet vizuální znázornění pohybu úloh různými fázemi pracovního postupu; níže je vysvětleno, jak správně používat syntaxi kanban diagramu.

Základy

Kanban diagram začíná syntaxí kanban a poté definuje sloupce a úlohy v těchto sloupcích.

Kód
                            
Kopírovat
Vložení
kanban column1[Column Title] task1[Task Description]

Definice sloupců

Sloupce představují různé fáze pracovního postupu, například „k vyřízení“, „probíhá“, „dokončeno“ atd. Každý sloupec je definován jedinečným identifikátorem a názvem uzavřeným v hranatých závorkách.

Syntaxe:

                            
Kopírovat
Vložení
columnId[Column Title]
  • columnId: jedinečný identifikátor sloupce.
  • [Column Title]: název zobrazený v záhlaví sloupce.

比如 id1[Todo]

Přidání úlohy do sloupce

Úlohy se zobrazují ve svých sloupcích s odsazením. Každá úloha obsahuje jedinečný identifikátor a popis uzavřený v hranatých závorkách.

Syntaxe:

                            
Kopírovat
Vložení
taskId[Task Description]

taskId: jedinečný identifikátor úlohy.,[Task Description]: popis úlohy.

Příklad:
                            
Kopírovat
Vložení
docs[Create Documentation]

Přidání metadat k úloze

Ke každé úloze můžete přidat další metadata pomocí syntaxe @{ ... }. Metadata mohou obsahovat páry klíč-hodnota, jako je assigned, ticket, priority atd., které se zobrazí při vykreslení uzlu.

Podporované klíče metadat

Přiřazeno: určuje, kdo je za úlohu odpovědný.,Tiket: propojí úlohu s tiketem nebo číslem problému.,Priorita: vyjadřuje naléhavost úlohy. Povolené hodnoty: velmi vysoká, vysoká, nízká a velmi nízká.

Kód
                            
Kopírovat
Vložení
kanban todo[Todo] id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }

Možnosti konfigurace

Kanban diagram lze přizpůsobit pomocí konfiguračního bloku na začátku souboru markdown. To je užitečné pro nastavení globálních nastavení (jako je základní URL tiketů). V současnosti má kanban diagram <code>ticketBaseUrl</code>, což je velmi užitečné pro nastavení globálních nastavení, jako je základní URL tiketů. V současnosti má kanban diagram jednu možnost konfigurace ticketBaseUrl. Lze ji nastavit podle následujícího příkladu:

                            
Kopírovat
Vložení
--- config: kanban: ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#' ---

Pokud má kanbanová položka zadané číslo tiketu, číslo tiketu v diagramu bude obsahovat odkaz na externí systém, který tento tiket definuje. ticketBaseUrl nastavuje základní URL odkazující na externí systém a #TICKET# bude nahrazeno hodnotou tiketu z metadat úlohy, aby vznikl platný odkaz.

Úplný příklad

Následuje příklad úplného kódu kanban diagramu:

Kód
                            
Kopírovat
Vložení
--- 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]

Stručně řečeno, vytvoření kanban diagramu v Mermaid je jednoduchý proces, který umožňuje efektivně vizualizovat váš pracovní postup.

Vzhled diagramu můžete vylepšit přidáním volitelných metadat k úlohám pomocí syntaxe @{ ... }; tato syntaxe vám umožňuje zahrnout další kontextové informace, jako je odpovědná osoba, číslo tiketu a priorita. Pro další přizpůsobení použijte konfigurační blok na začátku souboru k nastavení globálních možností, jako je ticketBaseUrl, abyste mohli tikety propojit přímo z diagramu.

Dodržováním těchto pokynů, zajištěním jedinečných identifikátorů, správného odsazení a využitím metadat a možností konfigurace můžete vytvořit komplexní a přizpůsobený kanban diagram, který efektivně mapuje pracovní postup projektu.