1.6. Versionamento e storico del Manuale operativo di design¶
Il manuale operativo di design beneficia del version control system (sistema di controllo versione) di GitHub, per cui esiste una traccia pubblica di tutte le modifiche effettuate e dei relativi autori. Il manuale operativo adotta un sistema di release (rilascio) basato sui tag di GitHub. Ogni release è etichettata secondo un sistema basato su anno e versione. Le versioni sono espresse attraverso un numero progressivo. Il sistema delle release è in vigore dal 2022, quindi la prima release delle linee guida è 2022.1 (prima release del 2022). Il manuale contiene le indicazioni operative a supporto delle Linee guida di design dei siti internet e servizi digitali della PA, emanate a norma CAD e disponibili in un documento sulla pagina Docs Italia creato ad hoc. Di interesse che sia le Linee guida a norma CAD, che il presente manuale, sono la diretta evoluzione delle precedenti Linee guida di design per i siti web della PA, ancora disponibili a solo scopo di consultazione storica sulla relativa pagina di Docs Italia.
1.6.1. Version control e release del manuale operativo di design¶
I nuovi contenuti e le modifiche a contenuti esistenti - dopo essere approvati - vengono pubblicati nella versione «bozza» del manuale operativo, disponibile per una discussione pubblica e revisione da parte della community. Solo successivamente, in occasione di una nuova release del manuale, il team di Designers Italia valuta eventualmente di consolidare e farle confluire, dopo eventuali modifiche, nella versione ufficiale «stabile».
1.6.2. Stile della documentazione¶
Il manuale operativo di design è stato redatto seguendo la style-guide (guida di stile) di redazione dei testi pubblici. In particolare:
- linguaggio semplice e comprensibile a un pubblico ampio;
- brevità e uso di elenchi;
- ricorso ad esempi, meglio se supportati da immagini e collegamenti.
1.6.3. Consultazione della documentazione¶
La documentazione è disponibile su Docs Italia, la piattaforma di gestione della documentazione pubblica gestita dal Dipartimento per la trasformazione digitale. Tutti i documenti di Docs Italia possono essere fruiti anche in formato .epub e .pdf.
1.6.4. Sviluppo collaborativo del Manuale operativo di design¶
Il presente manuale è un documento pubblico, e chiunque può partecipare al processo di revisione e aggiornamento attraverso gli strumenti messi a disposizione attraverso GitHub, in particolare le issues (per le discussioni) e le pull request (per le proposte di modifica).
I contenuti del manuale sono redatti in file .rst e possono essere aggiornati via GitHub. Qui è disponibile una guida alla sintassi RST.
Altre risorse per l’editing in formato .rst:
Il Manuale operativo di design si colloca all’interno di un sistema in continua evoluzione e si basa su una logica di miglioramento continuo. Poiché i contenuti presenti all’interno del manuale operativo di design evolvono continuamente, diventa fondamentale introdurre il versionamento che consente di tenere traccia dei diversi rilasci nel tempo. Grazie al versionamento, chi realizza siti e servizi aderenti alle Linee guida a norma CAD di riferimento, può citare una precisa versione del manuale operativo di design che utilizza (da citare, ad esempio, quando si partecipa a un bando di gara).