Richieste di Modifica Architetturale
Le Richieste di Modifica Architetturale ti permettono di proporre modifiche al tuo modello C4 attraverso un workflow di revisione strutturato. Invece di modificare l'architettura direttamente, i membri del team creano richieste che possono essere revisionate, discusse e applicate.
Come Funziona
Una richiesta di modifica raggruppa una o più modifiche proposte al tuo modello architetturale. Segue un ciclo di vita simile a una pull request nei repository di codice:
- Crea una richiesta con titolo e descrizione
- Aggiungi modifiche -- crea, aggiorna o elimina elementi C4 (sistemi, container, componenti, elementi di codice, relazioni, overlay)
- Apri per la revisione quando la proposta è pronta
- Revisione -- i membri del team approvano, richiedono modifiche o lasciano commenti
- Applica per applicare tutte le modifiche all'architettura live
Ciclo di Vita della Richiesta
Ogni richiesta attraversa questi stati:
| Stato | Descrizione |
|---|---|
| Bozza | Lavoro in corso. Solo l'autore può vedere e modificare le modifiche. |
| Aperta | Inviata per revisione. I membri del team possono revisionare e commentare. |
| Approvata | Ha ricevuto le approvazioni ed è pronta per l'applicazione. |
| Applicata | Le modifiche sono state applicate al modello architetturale. |
| Chiusa | Rifiutata o abbandonata. Può essere riaperta dall'autore. |
Creare una Richiesta
Dalla Scheda Richieste
- Naviga al tuo progetto
- Apri la scheda Richieste
- Clicca su Nuova Richiesta
- Inserisci un titolo (max 200 caratteri) e una descrizione opzionale
- La richiesta inizia nello stato Bozza
Aggiungere Modifiche
All'interno di una richiesta in bozza o aperta, aggiungi modifiche selezionando:
- Operazione: Crea, Aggiorna o Elimina
- Tipo di elemento: Sistema, Container, Componente, Codice, Relazione o Overlay
- Dati dell'elemento: Le proprietà per l'elemento nuovo o modificato
Le modifiche sono raggruppate per tipo di operazione (creazioni, aggiornamenti, eliminazioni) per una revisione più facile.
Modificare una Richiesta
L'autore può modificare il titolo e la descrizione di una richiesta in qualsiasi momento, purché non sia stata applicata. Clicca sull'icona matita accanto al titolo per entrare in modalità modifica.
Revisionare una Richiesta
Inviare una Revisione
I membri del team con accesso in modifica possono revisionare le richieste aperte:
- Approva -- la proposta sembra buona
- Richiedi Modifiche -- sono necessarie modifiche prima dell'applicazione
- Commenta -- lascia feedback senza una decisione formale
Feed Attività
La scheda attività mostra tutte le revisioni e i commenti in ordine cronologico. Usa il compositore di commenti in basso per lasciare commenti rapidi senza una revisione formale.
Applicare una Richiesta
Quando una richiesta è stata revisionata e approvata:
- Apri la pagina dettagli della richiesta
- Clicca su Applica
- Tutte le modifiche vengono applicate atomicamente al modello C4
Solo i membri del team con permessi di modifica possono applicare le richieste.
Anteprima delle Modifiche
La scheda Anteprima mostra una rappresentazione visiva di come apparirà l'architettura dopo l'applicazione delle modifiche, così i revisori possono comprendere l'impatto prima dell'applicazione.
Best Practice
Scrivi Titoli Chiari
Usa titoli descrittivi che spieghino l'intento:
- "Aggiungere servizio pagamenti e integrazione Stripe"
- "Dividere API monolitica in servizi utente e ordini"
- "Rimuovere componente notifiche deprecato"
Mantieni le Richieste Focalizzate
- Una modifica logica per richiesta
- Evita di mischiare modifiche non correlate
- Richieste più piccole sono più facili da revisionare
Usa le Descrizioni
Spiega il ragionamento dietro le modifiche proposte:
- Perché questa modifica architetturale è necessaria
- Quali alternative sono state considerate
- Link ad ADR o documentazione correlata
Revisiona Prima di Applicare
- Almeno un'approvazione è raccomandata
- Usa i commenti per discutere i trade-off
- Controlla la scheda anteprima per verificare il risultato
Prossimi Passi
- Panoramica Modello C4 -- Comprendere il modello architetturale
- Team -- Configurare il team per revisioni collaborative
- Documentazione -- Collegare ADR alle decisioni architetturali