Docs Italia beta

Documenti pubblici, digitali.

Come strutturare il contenuto

Dati

I dati sono spesso un elemento importante del contenuto gestito all’interno dei siti. Quando pubblichi dei dati, poniti come obbiettivi:

  • la chiarezza;

  • la facilità di fruizione da parte degli utenti.

Il modo più frequente con cui vengono pubblicati i dati sono le tabelle, che però presentano degli aspetti negativi che vanno considerati, per quanto riguarda:

  • versatilità e fruibilità rispetto nei dispositivi mobile, specialmente con tabelle troppo larghe, troppo lunghe o con troppo contenuto all’interno delle celle;

  • leggibilità dei dati e delle intestazioni della tabella.

Per rendere comprensibili i dati da parte degli utenti, cerca di presentarli in forma visiva, sotto forma di grafici o mappe (data visualization). A seconda del tipo di dati che devi rappresentare, esistono tantissimi strumenti che pui utilizzare, come ad esempio:

  • Per pubblicare delle dashboard in continua evoluzione, ad esempio, è possibile usare tool come Tableau Public o Metabase (quest’ultimo open source);

  • Google Charts, Plot.ly, Online Charts, Rawgraphs permettono di rendere in forma grafica dei dati;

  • MyMaps, Snazzy Maps sono utili per creare delle mappe personalizzate;

  • Wakelet serve a creare e condividere delle “storie” basate su foto, video, tweet, testi e altri contenuti online, in delle bacheche che possono essere embeddate nel proprio sito.

Per approfondire: Linee guida nazionali per la valorizzazione del patrimonio informativo pubblico


Documenti allegati, pdf

Scrivi i tuoi contenuti all’interno di una pagina web piuttosto che all’interno di documenti allegati (come i pdf).

Quando possibile, utilizza la piattaforma Docs Italia per pubblicare tutti i documenti legati alla Pubblica Amministrazione.

Se devi pubblicare il tuo contenuto all’interno di un documento allegato (per esempio nel caso di alcune normative), assicurati:

  • che i documenti siano scritti in modo chiaro, semplice e accessibile per tutti i cittadini;

  • che non ci siano pagine bianche o immagini superflue;

  • di gestire i metadati e la gerarchia dei titoli (H1, H2, ecc) in modo corretto;

  • di inserire sempre una descrizione del contenuto del documento nella pagina web, prima del link al documento;

  • di specificare nel link al documento che si sta aprendo un file, la tipologia (doc; pdf), il peso.

Per approfondire

Guida alla pubblicazione di documenti tecnici (in lavorazione)

Guida all’utilizzo di Docs Italia

Tool per stimare la leggibilità del testo dei tuoi documenti


Domande frequenti (Faq)

Se le pagine del tuo sito spiegano in modo chiaro e sintetico le informazioni che gli utenti cercano non è necessario creare delle Faq, che finirebbero solo per duplicare i contenuti. Se ci sono domande frequenti, invece di creare delle Faq mischiando diversi argomenti in una sezione separata del sito, adegua il contenuto delle tue pagine per soddisfare la richiesta e le reali esigenze di informazione degli utenti.


Elenchi puntati e numerati

Usa un elenco puntato per rendere più leggibile il testo. Verifica che i punti dell’elenco siano:

  • coerenti, se sono parte integrante della frase che introduce la lista: in questo caso, inoltre l’iniziale del punto elenco è minuscola e la frase si chiude col punto e virgola (se è l’ultimo punto dell’elenco con il punto fermo);

  • sintetici e chiari;

  • correttamente allineati.

Usa un elenco numerato quando devi guidare le persone in un processo. In questo caso non serve avere una frase introduttiva.

  1. Assicurati di mettere il punto fermo alla fine di ogni frase.

  2. Scrivi frasi brevi, semplici e chiare per far capire l’azione da compiere.

  3. Segnala con dei link i documenti eventualmente necessari per completare l’azione.

Evita sottoelenchi puntati. Se necessario, crea piuttosto un nuovo elenco puntato.


email

Si scrive senza trattini o spazi, in minuscolo. Inserisci gli indirizzi email come link attivi (usando l’attributo “mailto:”):

use

mario.rossi@comune.it

use-not

mario.rossi@comune.it


Immagini

Usa le immagini se aiutano a comprendere meglio il contenuto della pagina o a renderlo più fruibile.

Nel caso di utilizzo di una immagine:

  • assicurati di avere i diritti di utilizzo;

  • aggiungi sempre una breve didascalia che ne descriva il contenuto;

  • usa un testo alternativo (alt text) nell’html che ne descriva il contenuto.

Per approfondire, leggi la sezione dedicata alle immagini delle Linee guida di design della Pubblica Amministrazione.


Note

Non utilizzare mai le note in una pagina web, tranne che per citare le norme quando ricorri a dei riferimenti normativi.

Per altri tipi di approfondimento, come:

  • lista di una documentazione tecnica o di altro genere;

  • bibliografia;

  • link di approfondimento;

puoi utilizzare degli elenchi, includendo sempre dei link al documento completo, quando disponibile.


Numeri di telefono

Proponi un numero di telefono sempre insieme ad altri canali di contatto (mail, indirizzo).

Quando pubblichi un numero usa anche il prefisso internazionale; raggruppa le cifre separandole con degli spazi, per migliorare la leggibilità. Inserisci i numeri di telefono come link attivi (nel codice html usa l’attributo “tel:”):

use

+39 06 123 456 78

use-not

06 12345678


Paragrafi

Dividi il contenuto in brevi paragrafi, per permettere al lettore di trovare prima l’informazione che cerca. Considera che la maggior parte degli utenti leggerà il testo su uno smartphone o altro dispositivo mobile.