Manuale del nuovo sistema di Gestione Emergenze della Protezione Civile di Genova. La versione compilata è disponibile su readthedocs al seguente link: https://manuale-sistema-di-gestione-emergenze-comune-di-genova.readthedocs.io/it/latest/
Questo manuale è stato redatto sulla base delle Linee guida di design per i servizi digitali della PA in formato reStructredText. Le linee guida per il design dei servizi digitali della Pubblica Amministrazione usando stili forniti dal repository Github release 2019.1 Si tratta di uno strumento di lavoro per la Pubblica Amministrazione che serve ad orientare la progettazione di ambienti digitali fornendo indicazioni relative al service design, alla user research, al content design e alla user interface.
I contenuti del manuale linee guida sono scritti in file .rst e possono essere aggiornati via GitHub. Qui è disponibile una guida alla sintassi RST.
Altre risorse per l'editing in formato .rst sono:
Il manuale beneficia del version control system di GitHub, per cui esiste una traccia pubblica di tutte le modifiche effettuate e dei relativi autori.
Le linee guida sono scritte seguendo la style guide di redazione dei testi pubblici. In particolare:
- linguaggio semplice e comprensibile ad un pubblico ampio
- brevità e uso di elenchi
- ricorso ad esempi, meglio se supportati da immagini e link
Il manuale può essere fruito anche in formato .epub e .pdf
I file contenuti in questo repository possono essere modificati sul proprio computer ed essere convertiti in formato HTML per validarne i cambiamenti. È necessario innanzitutto installare il tema di Docs Italia attraverso il seguente comando:
pip install -r requirements.txt
Quindi lanciare il comando Sphinx per validare e generare la documentazione, che sarà consultabile all'indirizzo ./html/index.html:
sphinx-build -n -W -T -b html . html