Con una guida è più facile

"Ma dove andrà?" È proprio questo che ci si può chiedere quando un lettore non riesce a orientarsi leggendo un manuale. E la domanda che si pone è "perché". Infatti, una guida organizzata non avrebbe fatto perdere l'orientamento al lettore. Una guida crea le condizioni di partenza ottimali, segnala i percorsi lunghi e porta il lettore al traguardo nella massima sicurezza.

A seconda del volume di testo e della necessità informativa del lettore, leggere un manuale è un po' come fare una corsa veloce o una corsa di fondo. Molto prima che il lettore inizi la sua "corsa" nel manuale, noi pianifichiamo il percorso, indichiamo i punti di partenza, definiamo gli obiettivi, rendiamo sicura la strada e mettiamo la necessaria segnaletica.
Come in ogni corsa, nonostante la più attenta pianificazione, c'è sempre qualcosa che può andare storto. Anche la condizione del lettore gioca la sua parte. Ma creando le premesse migliori per un manuale ben riuscito, il redattore tecnico avrà già fatto buona parte del lavoro.

Pianificare il percorso

Prima di cominciare a scrivere, pianifichiamo il percorso tematico e lo suddividiamo in diverse tappe ben chiare. Questo permetterà al lettore di affrontare la corsa senza ritrovarsi senza fiato.
Il percorso viene fissato in un indice che però rappresenta solo l'inizio dell'opera. Nelle fasi successive dobbiamo controllare e verificare continuamente il percorso, ad esempio, per garantire linearità, praticabilità o per evitare ostacoli e altri rischi per la sicurezza. Se necessario, è necessario correggere il percorso, adottare vie più praticabili ed eliminare i pericoli, oppure trovare soluzioni alternative. Se non si adottano queste misure, si ottengono indici come il seguente:

1. Funzioni generali
1.1 Informazioni generali di funzionamento
1.1.1 Maschere
1.1.2 Dispositivi di input
1.1.2.1 Tastiera alfanumerica
1.1.2.2 Touchscreen
1.1.2.2.1 Funzionamento
1.1.2.2.2 Assegnazione tasti
1.1.3 Funzioni speciali
1.1.3.1 Segnali di avvertenza
1.1.3.2 Messaggi del sistema

Verificando questo percorso ci si accorge subito che la tappa "Funzioni generali" termina col paragrafo "Funzioni speciali". Una percorso tutt'altro che lineare che può solo irritare il lettore, il quale, scegliendo la tappa "Funzioni generali" non vuole affatto ritrovarsi tra le "Funzioni speciali", esattamente come noi non vorremmo ritrovarci in un bosco durante la visita di una città. Ed è proprio qui che si è perso il redattore del manuale; ha guardato troppo ai dettagli perdendo di vista il quadro generale. Ciò è dovuto in parte alla complessa gerarchia dei titoli che va ben oltre i tre livelli consigliati. Un indice simile è incomprensibile per chiunque, sia per il redattore tecnico che per il lettore.
Il collega non aveva però tutti i torti, visto che le indicazioni sui "Messaggi del sistema" e i "Segnali di avvertenza" appartengono effettivamente alle Informazioni di funzionamento. Ancora una volta, il punto chiave è rappresentato dalla strutturazione e dalla formulazione; infatti una formulazione accurata facilita la successione ordinata degli argomenti. Possiamo cambiare i termini e parlare di parco invece che di bosco nella visita della città, oppure passare da "Informazioni generali di funzionamento" a "Interfaccia utente". Spesso è sufficiente eliminare definizioni superflue, ad esempio "Funzioni speciali". Alla fine, l'indice potrebbe apparire così:

1. Informazioni di funzionamento
1.1 Interfaccia utente
1.1.1 Maschere
1.1.2 Pulsanti
1.1.3 Messaggi del sistema
1.1.4 Segnali di avvertenza
1.2 Dispositivi di input
1.2.1 Tastiera
1.2.2 Touchscreen

Indicare i punti di partenza

Il lettore decide da solo quali tappe percorrere. Per aiutarlo a decidere e offrirgli una panoramica delle sezioni, indichiamo un punto di partenza per ogni tappa, utilizzando i titoli. Quanto più chiari saranno i punti di partenza, tanto più facile sarà individuarli per il lettore, riducendo così le "false partenze".
Un punto di partenza è chiaro anche quando risalta a colpo d'occhio, distinguendosi dal resto del testo. Da questo punto di vista, i titoli riportati di seguito non sono efficaci:

I. Dimensionamento del generatore solare
II. Dimensionamento della sezione dei cavi
III. Dimensionamento del regolatore di carica

I titoli che iniziano con parole diverse e significative sono più efficaci:

I. Generatore solare – Dimensionamento
II. Sezione dei cavi – Dimensionamento
III. Regolatore di carica - Dimensionamento

Punti di partenza definiti con termini familiari al lettore contribuiscono a raggiungere questo obiettivo.

Stabilire gli obiettivi

Chi inizia un percorso di solito vuole arrivare da qualche parte. Questo vale anche per il lettore di un manuale. A prescindere dall'obiettivo primario di utilizzare in modo efficiente il prodotto descritto nel manuale, il lettore ha una serie di obiettivi intermedi, ovvero di singole conoscenze da acquisire per usare correttamente il prodotto. Per potere partire bene, deve però sapere dove deve arrivare. I titoli servono proprio a questo, ovvero offrire punti di partenza precisi e allo stesso tempo definire chiaramente l'obiettivo. Mettono a disposizione del lettore una panoramica delle tappe, affinché egli possa confrontare i propri obiettivi con quelli offerti dal manuale, già prima della partenza.
Prendiamo l'argomento "Installazione del software". Alcuni lettori vorranno solo informazioni teoriche di base sull'installazione, mentre altri vorranno arrivare subito al punto e iniziare con la procedura pratica. Quindi si possono avere obiettivi diversi anche rispetto allo stesso argomento. Titoli in forma sostantivata, come nell'esempio seguente, risultano più teorici, fanno supporre che il capitolo sarà descrittivo e non indicano se verranno fornite istruzioni per l'installazione:

1. Installazione del software
1.1 Preparazione all'installazione
1.2 Installazione del server
1.3 Installazione del client

La situazione è diversa in questa versione:

1. Installare il software
1.1 Preparare l'installazione
1.2 Installare il server
1.3 Installare il client

I titoli in forma verbale segnalano al lettore che il capitolo contiene delle istruzioni. Quindi, utilizzando in modo coerente la forma verbale o quella nominale per distinguere tra capitoli che contengono istruzioni e quelli descrittivi, permettiamo al lettore di orientarsi verso il suo obiettivo.

Prevedere fasi di riscaldamento

Come tutti i corridori anche i lettori devono riscaldarsi prima della partenza, anche prima delle singole tappe. Questo è possibile inserendo un'introduzione all'inizio del manuale e di ogni singolo capitolo. Il lettore può così entrare nell'argomento e prepararsi in modo ottimale alla corsa che lo attende. Di seguito un esempio dell'introduzione a un capitolo tratto dal manuale di un software destinato ai medici.

Confrontare gli importi fissi

Il confronto degli importi fisi è una funzione fondamentale del sistema informativo sui farmaci. Con l'obiettivo di prescrivere i farmaci meno costosi è possibile individuare alternative economiche per i singoli farmaci confrontando gli importi fissi. A tale scopo avviare una ricerca differenziata per farmaci generici con
• gli stessi principi attivi,
• principi attivi paragonabili,
• effetti paragonabili.

Procedere nel modo seguente:
1. …
2. …

Nel caso in cui non ci fossero informazioni da dare, l'introduzione può almeno offrire una panoramica sul contenuto che seguirà, quindi sulla struttura e sul contenuto del manuale o del capitolo.

Aumentare gradualmente il livello dell'impegno

Per ottenere un buon riscaldamento, senza sovraccaricare il lettore e allo stesso tempo fargli raggiungere la massima forma, è necessario aumentare gradualmente il livello dell'impegno. Le tappe più difficili e impegnative non devono quindi trovarsi subito all'inizio del manuale.
Da una parte possiamo mettere le tappe più semplici prima di quelle più difficili, purché l'argomento del manuale lo consenta; dall'altra dobbiamo accrescere le conoscenze del lettore aumentando gradualmente la quantità di informazioni fornite dal manuale. Queste due strategie sono illustrate nell'indice seguente che è stato tratto dal manuale di un ferro da stiro.

1. Collegare il ferro da stiro
2. Accendere e spegnere il ferro da stiro
2.1 Accendere
2.2 Spegnere
3. Stirare senza vapore
4. Stirare a vapore
4.1 Riempire il serbatoio dell'acqua
4.2 Stirare con vapore costante
4.2.1 Stirare in orizzontale
4.2.2 Stirare in verticale
4.3 Stirare con getto di vapore

Prendiamo ad esempio la sezione 3. Al contrario della sezione seguente, non è complicata e manifestamente più semplice. Inoltre, essa offre conoscenze di base che vengono poi ampliate nella sezione 4.

Fissare i segnavia

I segnavia permettono al lettore di mantenere l'orientamento durante la corsa. Come segnavia è possibile utilizzare i seguenti strumenti:

• Riga di intestazione che contiene il titolo del capitolo e del paragrafo,
• Parole o concetti chiave, meglio se riportati come titoli laterali in una colonna a margine,
• Simboli e altri strumenti grafici,
• Risultati operativi in parole e immagini che permettano al lettore di controllare attentamente se si trova ancora sulla strada giusta.
• Formati di paragrafo specifici.

Pensiamo ad esempio all'elenco numerato come formato di paragrafo ormai consolidato per le singole fasi di una procedura oppure per una serie di indicazioni. Svolge più funzioni allo stesso tempo:

• Essendo una caratteristica distintiva, la numerazione consente di mettere facilmente in evidenza una sequenza di istruzioni all'interno del resto del testo.
• Il numero delle voci o un elenco numerato forniscono informazioni sulla lunghezza della fase operativa.
• Il numero dell'ultima fase eseguita indica al lettore a che punto si trova rispetto all'intera procedura.
• Inoltre, anche nel caso in cui facesse una pausa, grazie alla numerazione egli individuerebbe subito la fase da cui riprendere.

Segnalare diramazioni

Ad aiutare il lettore non ci sono solo i segnavia. La linearità del percorso non ha sicuramente meno importanza di quanta ne abbia conoscere la panoramica dell'intero percorso. Ma non tutti i percorsi hanno un andamento lineare e anche nel nostro manuale ci sono delle diramazioni, ad esempio, per quanto riguarda le alternative di utilizzo. Ecco uno scenario possibile: il Signor Chiari ha acquistato delle lampade che vuole applicare direttamente al soffitto. Sfoglia le istruzioni di montaggio allegate al prodotto dove si dice:
Le lampade fornite sono lampade da incasso destinate all'installazione in una scatola a incasso da controsoffitto o in una scatola a soffitto.
Eccezione: La presa disponibile come accessorio permette il montaggio anche su soffitti in muratura.
Purtroppo già dopo la prima frase il Signor Chiari smette di leggere scoraggiato perché ritiene che la frase introduttiva, essendo in una posizione di rilievo, abbia un valore generale e universalmente valido. Il Signor Chiari è arrabbiato e ce l'ha con chi gli ha venduto la lampada. Non gli aveva assicurato che le lampade potevano essere montate direttamente a soffitto? Non è più così? Una risposta gliela dà il secondo paragrafo, ma il nostro lettore non arriva a leggerlo.
Nel complesso una situazione sgradevole. E solo perché il redattore tecnico ha tenuta nascosta troppo a lungo e senza motivo un'importante variante di montaggio. Egli avrebbe dovuto segnalare subito all'inizio le diverse possibilità a disposizione. Il Signor Chiari sarebbe andato avanti prestando attenzione fino a trovare ciò che cercava.
Esistono diverse possibilità di installazione delle lampade:

• come lampade da incasso a soffitto utilizzando una normale scatola a incasso da controsoffitto o una scatola a soffitto,
• direttamente a soffitto utilizzando una presa speciale acquistabile presso il proprio rivenditore di lampade.

Rendere sicuro il percorso

Per permettere al lettore di raggiungere con la massima sicurezza il suo obiettivo, senza inciampare per la strada, è necessario rendere sicuro il percorso. A questo scopo è particolarmente utile ricorrere alle indicazioni di avvertenza, che però non devono seguire il punto pericoloso, come in questo esempio:

Svitare il cappuccio di sfiato dallo scarico dell'alloggiamento

ATTENZIONE: Aprendo il cappuccio di sfiato può fuoriuscire nebbia di olio. Mantenersi a distanza e non inalare mai la nebbia di olio.

Con la successione riportata sopra è possibile che il lettore non riesca nemmeno a leggere l'avvertenza perché dopo avere svitato il cappuccio di sfiato sarà già stato "spruzzato" dall'olio e a quel punto non ci sarà più niente da fare. Le cose vanno diversamente nella versione seguente in cui l'avvertenza precede l'operazione:

ATTENZIONE: Aprendo il cappuccio di sfiato può fuoriuscire nebbia di olio. Mantenersi a distanza e non inalare mai la nebbia di olio.
Svitare il cappuccio di sfiato dallo scarico dell'alloggiamento

La prima cosa da fare è posizionare l'avvertenza prima della fase "pericolosa". La seconda cosa da fare è assicurarsi che l'indicazione non passi inosservata. L'utilizzo di simboli aiuta ad aumentare la probabilità di lettura. Questo è particolarmente importante per i lettori che di solito sfogliano i manuali velocemente.

Via libera!

Prima di concludere il nostro lavoro, dobbiamo verificare ancora i singoli punti:

• I singoli argomenti e le diverse sezioni sono lineari e chiari?
• Possono essere affrontati bene dal punto di vista della lunghezza e del livello di impegno richiesto?
• Sono previste fasi di riscaldamento sufficienti?
• È facile individuare i singoli punti di partenza?
• Gli obiettivi previsti sono chiari e coerenti?
• È presente la segnaletica?

Il percorso è sicuro?
Avete risposto "sì" a tutte le domande? Allora il manuale può essere approvato. E anche se noi redattori tecnici sappiamo raramente come andrà l'esperienza del lettore, egli saprà almeno dove andare, grazie alla nostra guida di lettura.

Ageliki Ikonomidis redige da oltre 20 anni documentazione IT, materiale didattico, testi pubblicitari e PR e articoli tecnici. È intervenuta alla conferenza tekom e per numerosi gruppi regionali tekom in merito alla redazione di manuali tecnici. Ageliki Ikonomidis lavora come redattrice, copywriter e docente free-lance e dal 2011 ha un incarico di insegnamento presso l'Università di Karlsruhe di Scienze applicate.

Ageliki Ikonomidis
Opuswort – Worte für alle(s)
info@opuswort.de
www.opuswort.de