Diagramma Kanban
Il diagramma kanban di Mermaid ti permette di creare una rappresentazione visiva delle attività che fluiscono attraverso le diverse fasi di un flusso di lavoro; di seguito è spiegato come usare correttamente la sintassi del diagramma kanban.
Nozioni di base
Il diagramma kanban inizia con la sintassi kanban, poi definisce le colonne e le attività in esse contenute.
Copia
Incorpora
kanban
column1[Column Title]
task1[Task Description]
Definire le colonne
Le colonne rappresentano le diverse fasi del flusso di lavoro, ad esempio "da fare", "in corso", "completato" ecc. Ogni colonna è definita con un identificatore univoco e un titolo racchiuso tra parentesi quadre.
Sintassi:
Copia
Incorpora
columnId[Column Title]
- columnId: l'identificatore univoco della colonna.
- [Column Title]: il titolo mostrato nell'intestazione della colonna.
比如 id1[Todo]
Aggiungere attività a una colonna
Le attività sono mostrate nelle rispettive colonne, con rientro. Ogni attività comprende un identificatore univoco e una descrizione racchiusa tra parentesi quadre.
Sintassi:
Copia
Incorpora
taskId[Task Description]
taskId: l'identificatore univoco dell'attività.,[Task Description]: la descrizione dell'attività.
Esempio:
Copia
Incorpora
docs[Create Documentation]
Aggiungere metadati a un'attività
Puoi aggiungere metadati aggiuntivi a ogni attività usando la sintassi @{ ... }. I metadati possono contenere coppie chiave-valore come assigned, ticket, priority ecc., e verranno mostrati nel rendering del nodo.
Chiavi di metadati supportate
assegnato: specifica chi è responsabile dell'attività.,ticket: collega l'attività a un numero di ticket o di problema.,priorità: indica l'urgenza dell'attività. Valori ammessi: molto alta, alta, bassa e molto bassa.
Copia
Incorpora
kanban
todo[Todo]
id3[Update Database Function]@{ ticket: MC-2037, assigned: 'knsv', priority: 'High' }
Opzioni di configurazione
Puoi personalizzare il diagramma kanban con un blocco di configurazione all'inizio del file markdown. Questo è utile per impostare impostazioni globali (come l'URL di base dei ticket). Attualmente, il diagramma kanban <code>ticketBaseUrl</code> Questo è molto utile per impostare impostazioni globali, come l'URL di base dei ticket. Attualmente il diagramma kanban ha un'opzione di configurazione ticketBaseUrl. Puoi impostarla come nel seguente esempio:
Copia
Incorpora
---
config:
kanban:
ticketBaseUrl: 'https://yourproject.atlassian.net/browse/#TICKET#'
---
Quando una voce kanban ha un numero di ticket specificato, il numero di ticket nel diagramma conterrà un link al sistema esterno che definisce quel ticket. L'impostazione ticketBaseUrl punta all'URL di base del sistema esterno, e #TICKET# viene sostituito con il valore del ticket nei metadati dell'attività, per creare un link valido.
Esempio completo
Di seguito è riportato un esempio completo di codice di un diagramma kanban:
Copia
Incorpora
---
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]
In sintesi, creare un diagramma kanban in Mermaid è un processo semplice, che permette di visualizzare efficacemente il tuo flusso di lavoro.
Puoi migliorare il tuo diagramma aggiungendo metadati opzionali alle attività usando la sintassi @{ ... }; questa sintassi ti permette di includere informazioni contestuali aggiuntive, come responsabile, numero di ticket e priorità. Per ulteriori personalizzazioni, usa il blocco di configurazione all'inizio del file per impostare opzioni globali, come ticketBaseUrl, così da collegare i ticket direttamente dal diagramma.
Seguendo queste linee guida, assicurandoti identificatori univoci, un rientro corretto e sfruttando i metadati e le opzioni di configurazione, puoi creare un diagramma kanban completo e personalizzato, che mappa efficacemente il flusso di lavoro del progetto.
