I punti elenco: norme d’uso

Da tempo cercavo una regola chiara e condivisa per l’uso delle liste in un testo per web.
Finalmente l’ho trovata sul manuale di stile di Infotel e, oltre a trascriverla nel mio quaderno di scrittura, la condivido con tutti.
Nel web l’uso delle liste permette di alleggerire il testo e renderlo più leggibile.
Spesso mi capita di usare le liste nei manuali: qual è la sequenza di azioni da compiere per completare un’operazione, quali sono le funzioni legate ad tasto, quali facoltà sono associate ad un profilo utente e così via.
In principio scrivo il concetto in forma discorsiva, in fase di revisione  – invece – mi capita quasi sempre di sostituire il periodo con un elenco puntato: più chiaro da comprendere e da memorizzare, più facile da ritrovare a primo colpo d’occhio.
Nell’ortografia della frase, però, mi sfuggivano alcuni dettagli:

  • maiuscola o minuscola a inizio parola?
  • punto e virgola, punto o nulla a fine frase?

Finalmente ho trovato la norma (anche se è ovvio che c’è chi non concorda):

1. se i termini della lista sono semplici e brevi non si usa la punteggiatura tra un termine e l’altro;

es.
Prima di uscire indossa:

  • cappotto
  • guanti
  • cappello
  • sciarpa

2. se i termini sono composti da frasi parte integrante della frase che introduce la lista si usa la miniscola, il punto e virgola alla fine di ogni termine e il punto sull’ultimo;

es.
Prima di uscire è consigliato:

  • indossare un cappotto piuttosto pesante;
  • scegliere un paio di guanti felpati;
  • calzare ben bene il cappello sulla nuca per evitare di lasciare scoperta la fronte;
  • stringere attorno al collo una lunga sciarpa di lana.

3. se i termini sono complessi e costituiti da frasi distinte rispetto al periodo introduttivo si usa la maiuscola e il punto alla fine di ogni frase.

es.
Come vestirsi in Norvegia.

  • È consigliato comprare un cappotto per attutire il gelo pungente, le piume d’oca sono le più calde in assoluto.
  • Per evitare i geloni alle mani (quelle dolorose bolle provocate dagli sbalzi di temperatura) è sempre bene mettere dei guanti tecnici tipo sci.
  • Chi non sopporta il freddo alla testa o soffre di emicrania, non deve mai uscire senza cappello. Molti uomini scelgono cappelli di lana, mentre le donne indossano cappelli di pelliccia, decisamente più eleganti.
  • In ultimo, ma non meno importante, non dimenticare lunghe e avvolgenti sciarpe di lana, evitaranno i fastidiosi colpi di freddo al collo.
Annunci

Manuali: istruzioni d’uso

Qualche giorno fa mi sono ritrovata a dover aprire un mio vecchio lavoro, un manuale per l’esattezza. Orrore! Dopo aver pensato che  -forse – non meritavo neanche la licenza elementare, ho respirato profondamente e ho cercato di capire cosa non andava assolutamente.

Ho afferrato il mio quaderno della scrittura e mi sono appuntata dei pensieri sparsi, un promemoria per fissare a me stessa delle linee guida sulla redazione di manuali, in particolare per i siti web.

Ecco quello che ho scritto:

  • è opportuno intitolare i capitoli principali con il nome delle sezioni del menu di primo livello; non leggendo nomi amici, il lettore potrebbe essere preso da ansia da abbandono già nell’indice
  • ogni capitolo deve prevedere una descrizione dell’architettura della pagina; chi legge – infatti – spesso non è un addetto ai lavori e ha bisogno di una corrispondenza tra ciò che vede (nel sito) e ciò che legge (nel manuale): serve a coccolarlo
  • già dall’indice deve essere ben chiaro che il manuale è una guida per l’utente quindi occorre distinguere la descrizione del sito dal supporto di back-end
  • se in realtà l’obiettivo del documento è descrivere l’uso del CMS (Content Management System) – ovvero il gestore dei contenuti del sito – è opportuno suddividere il paragrafo in due parti: descrizione dei contenuti, elenco delle operazioni da svolgere
  • non dimenticare mai che anche l’occhio vuole la sua parte: la scrittura deve convivere in armonia con gli spazi bianchi. Se all’interno di uno stesso paragrafo, c’è una cambio di argomento netto (ad esempio passiamo dalla descrizione della pagina a quella del CMS), una soluzione potrebbe essere inserire una spaziatura maggiore tra i capoversi
  • anche se il mio mestiere sarebbe quello di scrivere, devo ammettere una dura verità: sono gli spazi bianchi a rendere leggibile un testo! Frasi ponderate e leggere, il vero ritmo di un documento è scandito dall’alternanza misurata tra bianco e nero, ovvero tra scrittura e spaziatura. Una pagina fitta e senza spazi non avrà mai grande l’appeal, neanche se parla di gossip e pettegolezzi succulenti
  • punti elenco e liste possono risolvere un mare di problemi, scandiscono le azioni da svolgere e aiutano ad individuarle a prima occhiata
  • se ci sono delle azioni che ricorrono spesso, usare sempre gli stessi nomi, anche questo serve a rassicurare chi legge che sta facendo bene
  • quando richiamati, i titoli delle sezioni del sito vanno in corsivo, così come il nome dei tasti o delle tab
  • infine, non trascurare di inserire delle catture direttamente dal sito o delle immagini esemplificative, aggiungere una didascalia chiara e applicare lo stesso stile a tutte le immagini.

Per il momento mi fermo qui, ma tornerò sull’argomento.