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.

2 thoughts on “Manuali: istruzioni d’uso

  1. Ogni volta che apro un vecchio manuale penso orrore!
    Perchè oltre a queste ottime regole c’è anche da dire che spesso e volentieri bisogna trovare un compromesso tra una buona regola/idea e il mezzo tecnologico che ci permette di realizzarla.

    • Grazie Ivan per il commento. Per la mia modesta esperienza il compromesso tecnologico che spesso mi trovo a dover accettare è dettato dal mio editor di testo che in alcuni casi fa di testa sua e sembra si diverta a spaginare quello che io cerco pazientemente di mettere in ordine!

Lascia un commento

Inserisci i tuoi dati qui sotto o clicca su un'icona per effettuare l'accesso:

Logo WordPress.com

Stai commentando usando il tuo account WordPress.com. Chiudi sessione / Modifica )

Foto Twitter

Stai commentando usando il tuo account Twitter. Chiudi sessione / Modifica )

Foto di Facebook

Stai commentando usando il tuo account Facebook. Chiudi sessione / Modifica )

Google+ photo

Stai commentando usando il tuo account Google+. Chiudi sessione / Modifica )

Connessione a %s...