Diagrammi di stato in Confluence
Un diagramma di stato mostra gli stati in cui può trovarsi una cosa e gli eventi che la fanno passare da uno stato al successivo.
Ultimo aggiornamento
Quando usarlo
Usa un diagramma di stato per tutto ciò che ha un ciclo di vita: un ordine, una issue, un abbonamento, una connessione di rete, un circuit breaker. Risponde a “che cosa può succedere da qui”, quindi trova i casi mancanti, come uno stato senza uscita, prima del codice.
Esempio
Questo è il codice del modello Issue workflow: dal backlog a fatto, con gli stati di revisione e di blocco.
stateDiagram-v2
[*] --> Backlog
Backlog --> Selected : prioritise
Selected --> InProgress : start
InProgress --> InReview : open pull request
InReview --> InProgress : changes requested
InReview --> Done : approved and merged
InProgress --> Blocked : waiting on dependency
Blocked --> InProgress : unblocked
Done --> [*]
Vellnar Diagrams lo disegna così:
Cambia una riga e il diagramma cambia con lei. A nessuno serve il file originale del disegno, perché non esiste: il codice è il diagramma.
Aggiungerlo a una pagina di Confluence
- Modifica una pagina di Confluence e scrivi
/mermaiddove vuoi il diagramma. - Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
- Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
- Scegli Save. Il diagramma compare nella pagina.
La documentazione spiega l’editor, le impostazioni e le esportazioni.
Modelli
Il pulsante Templates dell’editor ha 6 modelli pronti per questo tipo:
- Order lifecycle: Da bozza a consegnato, con annullamento e resi.
- Issue workflow: Dal backlog a fatto, con gli stati di revisione e di blocco.
- Connection states: In connessione, connesso e in riconnessione, con i timeout.
- Document approval: Una bozza che passa dalla revisione prima della pubblicazione.
- Circuit breaker: Gli stati chiuso, aperto e semiaperto che fermano le chiamate a un servizio in errore.
- Subscription billing: Un abbonamento dalla prova ad attivo, scaduto e annullato.
Sintassi
Il codice inizia con stateDiagram-v2. La documentazione di Mermaid (in inglese) descrive ogni elemento della sintassi. Vellnar Diagrams lo disegna con Mermaid 12.3; se una riga ha un errore, l’editor segna la riga e tiene a schermo l’ultimo diagramma valido.
Altro
- Mermaid in Confluence: come funzionano i diagrammi scritti come codice in una pagina, e tutti i tipi di diagramma.
- Sicurezza: l’app non chiede nessun permesso e non manda nulla fuori da Atlassian.