"Ma cosa stanno facendo?" Vi chiederete probabilmente questo quando vedete alcune persone che sfogliano un manuale senza un obiettivo ben preciso. E vi chiederete anche perché. Perché con una guida alla lettura adeguata si sarebbero risparmiati quell'inutile girovagare tra le pagine del manuale. Una guida alla lettura consente di creare delle perfette condizioni di partenza, indicare il percorso da seguire e accompagnare il lettore fino alla meta.

In base alla quantità di testo e alle informazioni necessarie al lettore, la lettura di un manuale può essere paragonata a una corsa a breve o a lunga distanza. Molto prima di iniziare la corsa nel leggere un manuale, organizziamo il percorso, evidenziamo strategie, stabiliamo obiettivi, fissiamo il percorso, collocando segnali lungo la strada.

Durante la corsa, però, può andare storto qualcosa, nonostante l'organizzazione accurata del percorso. Persino le condizioni fisiche del lettore svolgono un ruolo importante, ma si potrebbe ottenere di più se i redattori tecnici qualificati cercassero di creare le migliori condizioni possibili per una corsa destinata al successo.

Organizzare il percorso

Prima di iniziare a scrivere il manuale, si organizza un percorso tematico e lo si suddivide in più capitoli facilmente comprensibili. Ciò permette al lettore di affrontare la difficoltà, relativa alla lunghezza del percorso, in un secondo momento, senza stancarsi.

Il percorso viene stabilito sottoforma di un indice che, comunque, non costituisce la fine di questo processo. Durante la fase successiva dovete controllare più volte il percorso, per esempio la sua direzionalità, la sua praticabilità, la presenza di ostacoli o altri rischi per la sicurezza. Se necessario, si deve correggere il percorso, adottare vie più semplici, azzerare il numero di rischi o, in alternativa, renderlo più sicuro. La mancata applicazione di tali misure potrebbe creare un indice come quello illustrato di seguito.

1. Funzioni generali

1.1 Informazioni generali sul funzionamento

1.1.1 Maschere della schermata

1.1.2 Mezzi di inserimento

1.1.2.1 Tastiera alfanumerica

1.1.2.2 Touchscreen

1.1.2.2.1 Funzionamento

1.1.2.2.2 Assegnazione tasto

1.1.3 Funzioni speciali

1.1.3.1 Segnali di avviso

1.1.3.2 Avvisi di sistema

…

Controllando il percorso appare immediatamente chiaro che il capitolo "Funzioni generali" terminerà al capitolo "Funzioni speciali". Questo è tutto fuorché semplice e come minimo irriterebbe il lettore. Se il lettore sceglie il capitolo "Funzioni generali", sicuramente non vorrà arrivare al capitolo "Funzioni speciali", come quando stiamo facendo un giro in città e ci ritroviamo in una foresta. Ed è proprio questo il punto in cui l'organizzatore di questo percorso si è perso perché soffermandosi troppo sul particolare, si perde di conseguenza la visione dell'insieme. Questo è dovuto in parte alla complessità gerarchica dei titoli che supera di gran lunga i livelli di gerarchia consigliati. Nessuno può capire perché accada questo, né un redattore tecnico, né un lettore.

Tuttavia il redattore tecnico non aveva completamente torto, dato che le informazioni riguardo agli "Avvisi di sistema" e ai "Segnali di avviso" appartengono senza dubbio alle "Informazioni sul funzionamento". Come avviene di solito, il momento cruciale è tra la fase di strutturazione e formulazione, in cui le formulazioni, che sono state ben pianificate, semplificano il lavoro di ordinamento dei diversi argomenti. Per esempio possiamo modificare i termini, trasformare la foresta in un bosco cittadino per il nostro giro in città o trasformare le "Informazioni generali sul funzionamento" in "Interfaccia utente". Talvolta è sufficiente anche rimuovere termini non indispensabili, come "Funzioni speciali". In definitiva, l'indice potrebbe apparire così:

1. Informazioni sul funzionamento

1.1 Interfaccia utente

1.1.1 Maschere della schermata

1.1.2 Pulsanti

1.1.3 Avvisi di sistema

1.1.4 Segnali di avviso

1.2 Mezzi di inserimento

1.2.1 Tastiera

1.2.2 Touchscreen

Segnare i punti di partenza

Il lettore di un manuale decide lui stesso quali capitoli leggere. Al fine di semplificarne la scelta e di rendere più chiaro il quadro di insieme dei vari capitoli, dovete segnare un punto di partenza per ogni capitolo tramite i titoli. Quanto più chiaro è il punto di partenza, tanto più facile sarà per il lettore trovare tali punti e minore sarà la possibilità di trovare punti di partenza "fasulli".

Tra le altre cose, un punto di partenza è chiaro se, di primo acchito, risalta rispetto agli altri punti di partenza. Considerando tale aspetto, i seguenti titoli non possono che ottenere un risultato negativo.

I.    Misurazione del generatore solare

II.    Misurazione delle sezioni cavi

III.    Misurazione del regolatore di carica

Titoli che iniziano con termini diversi e ben distinti hanno un impatto migliore sul lettore:

I.    Generatore solare: misurazione

II.   Sezioni cavi: misurazione

III.  Regolatore di carica: misurazione

I termini relativi ai punti di partenza con cui il lettore ha maggiore familiarità semplificherà ulteriormente l'argomento.

Stabilire gli obiettivi

Di solito, se si inizia da un determinato punto si vuole arrivare a un determinato punto. E così fa anche chi legge il manuale. Oltre all'obiettivo principale, ovvero di far funzionare il prodotto nel modo descritto dal manuale, il lettore ha una serie di altri obiettivi intermedi, per esempio superare alcuni problemi che si hanno con il prodotto. Ma per iniziare in modo mirato, il lettore deve sapere qual è l'obiettivo finale. I titoli possono essere d'aiuto in questo suo compito, non solo fornendo precisi punti di partenza, ma anche individuarne in modo chiaro l'obiettivo. Inoltre, i titoli facilitano il lettore a scegliere i capitoli perché in questo modo può paragonare i suoi obiettivi con quelli previsti, già prima di iniziare.

Prendiamo come esempio "Installazione software". Alcuni leggeranno solo le informazioni teoriche sul software, mentre altri vorranno subito iniziare con la parte pratica vera e propria. Ciò dimostra quindi che i lettori di manuali possono avere obiettivi diversi nell'ambito di uno stesso tema. I titoli che presentano sostantivi, come nell'esempio illustrato di seguito, sembrano più teorici, aspettandosi quindi un testo descrittivo, dando alcuna indicazione se i capitoli in questione forniscano istruzioni necessarie per l'installazione.

1. Installazione Software

1.1 Preparazione per l'installazione

1.2 Installazione server

1.3 Installazione client

Mentre in questa versione:

1. Installare il software

1.1 Preparare l'installazione

1.2 Installare il server

1.3 Installare il client

I titoli che comprendono verbi avvisano il lettore circa il valore istruttivo del capitolo. Pertanto, se applichiamo una distinzione coerente tra capitoli istruttivi e puramente descrittivi tramite l'uso o meno di verbi, il lettore potrà orientarsi più facilmente sul suo obiettivo.

Fornire fasi di riscaldamento

Come tutti i corridori, anche i lettori di un manuale hanno bisogno di riscaldarsi prima della lettura: sia prima del percorso da seguire sia prima dei singoli capitoli. Ciò viene tenuto in considerazione, inserendo introduzioni al manuale e a ogni capitolo, consentendo così al lettore di riscaldarsi in vista dell'argomento e di prepararsi perfettamente alla corsa che dovrà svolgere. Un esempio è rappresentato di seguito: l'introduzione a un capitolo tratto da un manuale di software per medici.

Confronto tra valori fissi

Il confronto tra valori è una componente basilare del sistema di informazione dei medicinali. Al fine di prescrivere medicinali il più possibile convenienti, è possibile stabilire varianti economiche per i singoli medicinali, confrontando i loro valori fissi. Quindi iniziare una ricerca differenziata per medicinali generici aventi

• stessi ingredienti attivi,
• ingredienti attivi equivalenti,
• effetti equivalenti

Procedere come illustrato di seguito:

1. …

2. …

E nel caso in cui non ci sia niente da dire nella premessa, l'introduzione potrebbe almeno fornire un quadro generale di ciò che è all'inizio del manuale, ovvero della struttura e del contenuto del manuale o dei capitoli.

Aumentare i requisiti in modo graduale

Al fine di sostenere la fase di riscaldamento e di non sovraccaricare il lettore, consentendogli di raggiungere la sua forma perfetta, i requisiti in merito alla prestazione dovrebbero essere aumentati con cautela. Pertanto i capitoli più difficili e impegnativi non dovrebbero comparire subito all'inizio.

Da un lato, se l'argomento del manuale lo consente, è possibile inserire capitoli semplici prima dei capitoli più difficili; dall'altro si dovrebbe formare la conoscenza del lettore passo dopo passo tramite le informazioni riportate sul manuale. È possibile osservare entrambi gli approcci nell'indice posto di seguito, relativo a un manuale per il funzionamento di un ferro da stiro:

1. Collegamento ferro da stiro

2. Accensione/Spegnimento

2.1 Accensione

2.2 Spegnimento

3 Stiratura senza vapore

4. Stiratura a vapore

4.1 Riempimento serbatoio acqua

4.2 Stiratura a vapore costante

4.2.1 Stiratura orizzontale

4.2.2 Stiratura verticale

4.3 Stiratura con esplosione di vapore

Prendiamo come esempio il capitolo 3. Confrontandolo con il capitolo successivo, non mostra complessità e quindi sembra più facile. Inoltre, il capitolo 3 trasmette al lettore conoscenze basilari, con le quali il capitolo 4 può proseguire.

Porre punti di riferimento

Ponendo punti di riferimento, si consente al lettore di mantenere il proprio orientamento durante la corsa. I concetti di seguito descritti possono essere utilizzati come punti di riferimento:

• intestazioni con titoli vivi contenenti i titoli dei paragrafi e dei capitoli;
• termini o parole chiave evidenziati, possibilmente come titoli laterali in una colonna di margine;
• simboli e altri aiuti grafici;
• risultati sul funzionamento nel testo o in immagini, da cui il lettore può verificare da vicino se sia sulla giusta strada o meno;
• formati di paragrafi convenzionali.

Osservate l'esempio di un elenco numerato come formato di un paragrafo per istruzioni passo dopo passo o gruppi di frasi. Tale elenco rispetta contemporaneamente diverse funzioni di orientamento:

• in qualità di unica funzione di identificazione, la numerazione permette di localizzare più velocemente le varie fasi delle istruzioni all'interno del testo;
• il numero dei punti o delle fasi numerate fornisce informazioni sulla lunghezza della procedura da eseguire;
• il numero dell'ultima fase eseguita avvisa il lettore quanto dell'operazione sia stato eseguito e quanto manca per arrivare alla fine;
• e nel caso in cui dovrebbe fermarsi per una pausa, il lettore può facilmente ricordare da quale fase deve ripartire, grazie alla numerazione.

Annunciare operazioni di diramazione

Non solo i punti di riferimento sono in grado di aiutare il lettore a trovare il suo percorso. Anche la sua direzionalità è importante tanto quanto è importante leggere e osservare lo schema del percorso. Ma non tutte le strade sono diritte. Alcune di esse si diramano persino nelle nostre istruzioni, per esempio nelle fasi di funzionamento. Prendiamo come esempio la situazione seguente: il Sig. Chiaro ha acquistato delle luci da installare direttamente al soffitto; apre il libretto delle istruzioni per il montaggio in dotazione, in cui vi è scritto:

Le luci vengono fornite come illuminazione ad incasso, progettata per essere montata in una scatola con cavità o in una scatola di giunzione al soffitto.

Eccezione: utilizzando la scatola di montaggio montata sulla superficie, disponibile come accessorio, è possibile montare l'illuminazione anche a soffitti solidi.

Purtroppo il Sig. Chiaro rinuncia a leggere le istruzioni subito dopo la prima fase introduttiva a causa della sua posizione come prima frase generale e universalmente valida. Ora il Sig. Rossi ripensa al commerciante che gli ha venduto le luci. Non gli aveva promesso che le luci si installavano direttamente al soffitto? E ora non si può più? É il secondo paragrafo a fornire la risposta a queste due domande, ma il Sig. Rossi non ci arriverà.

Tutto sommato ne risulta una situazione infelice. Semplicemente perché il redattore tecnico ha nascosto un'importante informazione sul metodo di installazione delle luci sotto altre informazioni. Invece avrebbe potuto annunciare fin dall'inizio la presenza di più strade. Il Sig. Rossi avrebbe continuato a leggere attentamente e trovato ciò che viene riportato di seguito:

È possibile montare l'illuminazione in modi diversi:

• come illuminazione  a incasso a soffitto: utilizzando una normale scatola di giunzione con cavità o una scatola di giunzione al soffitto
• direttamente sul soffitto: utilizzando un supporto montato sulla superficie che è possibile acquistare dal commerciante.

Fissare il percorso

Il percorso deve essere sufficientemente sicuro affinché il lettore arrivi al suo obiettivo finale, non inciampando lungo la strada. In particolare le avvertenze aiutano, ma non quando si trovano proprio dietro il punto in cui si può "inciampare", come nell'esempio di seguito riportato:

Svitare la valvola di ventilazione dal sistema di ventilazione della scatola

ATTENZIONE: l'olio di paraffina fuoriesce se la valvola di ventilazione è aperta. Rimanere a distanza non inalare assolutamente l'olio di paraffina

A causa della struttura di una tale frase il lettore non leggerà l'avvertenza "ATTENZIONE" poiché sarà già stanco dopo aver svitato la valvola e anche perché sarà passato alla fase successiva. Nella versione seguente, l'avviso è stato preposto:

ATTENZIONE: l'olio di paraffina fuoriesce se la valvola di ventilazione è aperta. Rimanere a distanza non inalare assolutamente l'olio di paraffina.

Svitare la valvola di ventilazione dal sistema di ventilazione della scatola

La prima cosa da fare è inserire l'avvertenza prima della fase ritenuta "pericolosa". Dopodichè bisogna assicurarsi che l'avvertenza venga letta. L'utilizzo di simboli permette di aumentarne la probabilità di lettura. Questo è particolarmente adatto per coloro che sfogliano velocemente il manuale.

Via libera!

Prima di concludere il nostro lavoro, si consiglia di ricontrollare i seguenti punti:

• gli argomenti e i capitoli sono lineari e chiari?
• possono essere trattati riguardo a lunghezza e grado di prestazione?
• ci sono abbastanza fasi di riscaldamento?
• i singoli punti di partenza sono facili da ritrovare?
• gli obiettivi sopra menzionati sono chiari e costanti?
• ci sono indicazioni?
• il percorso è sicuro?

Avete risposto "sì" a tutte queste domande? Allora il manuale può essere distribuito. E anche se noi come redattori tecnici vediamo raramente come procede il lettore, almeno ora saprà dove si sta dirigendo, grazie alla nostra guida alla lettura.

Da oltre vent'anni Ageliki Ikonomidis si occupa di documentazione IT, materiali per la formazione, testi per pubbliche relazioni e pubblicità e articoli tecnici. Ha parlato in merito all'argomento "Scrivere un manuale" alla conferenza annuale Tekom nonché per diversi gruppi Tekom a livello locale. Ageliki Ikonomidis lavora come redattore tecnico freelance, scrittore e docente alla Facoltà di Ingegneria e Economia dell'Università di Karlsruhe (Germania) dal 2011.

info@opuswort.de

www.opuswort.de

Traduzione dalla lingua tedesca dell'articolo presente in 'technische kommunikation', rivista specializzata in comunicazione tecnica e sviluppo dell'informazione di Tekom. Per avere maggiori informazioni, visitare il sito www.tekom.de

Cliccare qui per leggere l'articolo in lingua originale