Questo repository contiene il testo del Manuale operativo di design - Designers Italia, per progettare siti internet e servizi digitali della Pubblica amministrazione, in formato reStructredText.
Il manuale è uno strumento di lavoro per la Pubblica Amministrazione e serve ad orientare la progettazione di ambienti digitali fornendo indicazioni relative al service design, alla user research, al content design e alla user interface. Per discutere sul design dei servizi pubblici è disponibile il nostro forum. Per collaborare al manuale è possibile usare gli strumenti descritti di seguito.
Il presente manuale è un documento pubblico e chiunque può partecipare al processo di revisione e aggiornamento attraverso gli strumenti messi a disposizione attraverso l'apposito repository GitHub. Per poter contribuire, devi accedere con un account GitHub.
Per lasciare commenti e suggerimenti generali, puoi aprire una nuova issue.
Per proporre modifiche specifiche al manuale, puoi usare la funzione pull request:
- vai alla pagina del manuale su cui vuoi proporre delle modifiche;
- clicca sul collegamento “Sorgente” (presente in alto a destra su ogni pagina, nell’header);
- edita il file con le modifiche che vuoi proporre, usando la sintassi RST e ponendo attenzione alla gerarchia dei contenuti e le indentazioni;
- invia una una richiesta di contribuzione (pull request) verso il repository che contiene il sorgente del manuale.
I contenuti del manuale e i contributi di modifica devono essere redatti usando la sintassi RST. Ecco alcune risorse utili:
- Guida alla sintassi RST.
- Editor per il testo
- Editor per le tabelle
- Altre informazioni sugli editor RSR
I nuovi contenuti e le modifiche a contenuti esistenti vengono valutati dal team di Designers Italia e integrati, se necessario con modifiche, nella versione corrente del manuale.
Il manuale è scritto 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
Nella guida usiamo delle etichette per evidenziare alcuni passaggi, specificando se l'applicazione della indicazione è obbligatoria o facoltativa, come segue
- si deve (devi)
- si può (puoi)
- si dovrebbe (dovresti)
- best practice
Il Manuale operativo è disponibile su Docs Italia.
Le funzioni di hosting e di ricerca sono basate su ReadTheDocs e la documentazione viene pubblicata attraverso il tool Sphinx e il linguaggio RST.
Tutti i documenti di Docs Italia possono essere fruiti anche in formato .epub e .pdf
Il repository è strutturato per essere compatibile con Docs Italia. La piattaforma accetta documenti in formato RST o MD. Per informazioni sulla struttura di questo repository visita il repository dedicato.
Per lavorare utilizzando una preview del documento è sufficiente lanciare Docker
docker-compose upla preview sarà visibile all'indirizzo http://localhost:8000/
Ogni contributo è benvenuto! È possibile aprire delle issue per segnalare errori, problemi o per la richiesta di nuove funzionalità. Inoltre, è possibile aprire delle Pull Request per proporre direttamente delle modifiche.
Questo documento è rilasciato con una licenza CC BY 4.0.