Skip to content

Clou-dia/manuale-operativo-design-docs

This branch is 382 commits behind italia/manuale-operativo-design-docs:versione-corrente.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f795eba · Dec 9, 2024

History

46 Commits
Sep 6, 2023
Oct 18, 2024
Dec 9, 2024
Jun 9, 2022
Dec 7, 2021
Dec 7, 2021
Jul 18, 2022
Jul 18, 2022
Dec 9, 2024
Dec 7, 2021
Jun 28, 2022
Feb 18, 2022
Dec 9, 2024
Dec 9, 2024

Repository files navigation

Manuale operativo di design - Designers Italia

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.

Sviluppo collaborativo

Il manuale è 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 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:

Stile della documentazione

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

Consultazione della documentazione

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

Dipendenze

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.

Preview

Per lavorare utilizzando una preview del documento è sufficiente lanciare Docker

docker-compose up

la preview sarà visibile all'indirizzo http://localhost:8000/

Come contribuire

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.

Licenza

Questo documento è rilasciato con una licenza CC BY 4.0.

Releases

No releases published

Packages

No packages published

Languages

  • Python 96.5%
  • Dockerfile 2.3%
  • Shell 1.2%