Event model in Confluence

Un event model racconta un sistema come una linea del tempo di schermate, comandi, eventi e viste di lettura.

Ultimo aggiornamento

Quando usarlo

Usa un event model per progettare o spiegare una funzionalità a eventi dal punto di vista dell’utente: che cosa vede, quale comando invia, quale evento viene salvato e quale vista si aggiorna. Si legge da sinistra a destra, come uno storyboard.

Esempio

Questo è il codice del modello Order events: un checkout modellato a eventi, dall’ordine alla fattura.

eventmodeling

tf 01 ui CheckoutPage
tf 02 cmd PlaceOrder
tf 03 evt OrderPlaced [[OrderPlaced]]
tf 04 rmo OrderStatus

rf 05 evt Payments.PaymentCaptured
tf 06 pcr InvoiceProcessor
tf 07 cmd GenerateInvoice
tf 08 evt InvoiceSent
tf 09 rmo OrderStatus ->> 03 ->> 08

data OrderPlaced {
  orderId: string
  total: number
}

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

  1. Modifica una pagina di Confluence e scrivi /mermaid dove vuoi il diagramma.
  2. Seleziona Mermaid diagram. Si apre l’editor con l’elenco dei modelli.
  3. Scegli un modello, oppure Start blank e incolla il codice qui sopra. L’anteprima segue ogni tasto.
  4. Scegli Save. Il diagramma compare nella pagina.

La documentazione spiega l’editor, le impostazioni e le esportazioni.

Modelli

Il pulsante Templates dell’editor ha un modello pronto per questo tipo:

  • Order events: Un checkout modellato a eventi, dall’ordine alla fattura.

Sintassi

Il codice inizia con eventmodeling. 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.