Diagrammi dei requisiti in Confluence
Un diagramma dei requisiti collega ogni requisito alle parti che lo soddisfano e ai test che lo verificano.
Ultimo aggiornamento
Quando usarlo
Usa un diagramma dei requisiti per la tracciabilità in ambiti regolati o di sicurezza: un requisito con il suo rischio e il metodo di verifica, l’elemento che lo soddisfa e il test che lo dimostra. Un auditor può seguire ogni linea dalla regola alla prova.
Esempio
Questo è il codice del modello Encryption requirement: un requisito di sicurezza collegato a ciò che lo soddisfa e lo verifica.
requirementDiagram
requirement EncryptionAtRestAndInTransit {
id: 1
text: Data encrypted at rest and in transit
risk: high
verifymethod: test
}
requirement KeysRotatedYearly {
id: 1.1
text: Keys rotated yearly
risk: medium
verifymethod: inspection
}
element ManagedDatabaseEncryption {
type: infrastructure
docref: database encryption runbook
}
element InfrastructureComplianceCheck {
type: automated check
docref: compliance pipeline
}
ManagedDatabaseEncryption - satisfies -> EncryptionAtRestAndInTransit
InfrastructureComplianceCheck - verifies -> EncryptionAtRestAndInTransit
KeysRotatedYearly - derives -> EncryptionAtRestAndInTransit
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 2 modelli pronti per questo tipo:
- Encryption requirement: Un requisito di sicurezza collegato a ciò che lo soddisfa e lo verifica.
- Data retention: Un vincolo di privacy diviso in requisiti, con il job e i test che lo coprono.
Sintassi
Il codice inizia con requirementDiagram. 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.