Creare manuali d'istruzione retoricamente efficaci

Manuali d’istruzione

Molte persone associano i manuali d’istruzione a elettrodomestici, accessori per computer e prodotti che richiedono il montaggio (ad esempio, mobili). Siccome non ci troviamo ad usarli regolarmente o ce li aspettiamo solo in certi contesti, è facile dimenticare quanto siano importanti. La qualità di un manuale di istruzioni ben progettato può passare inosservata. Eppure, quando incontriamo frustrazione nel mettere insieme una libreria o un giocattolo, o nel cercare di capire come cambiare o attivare una particolare impostazione di un elettrodomestico, il significato di un manuale di istruzioni ben progettato diventa chiaro.

Comprendere la situazione retorica dei manuali di istruzioni

I manuali di istruzioni, come altri tipi di testi, sono modellati da una situazione retorica. Le scelte che gli scrittori tecnici fanno riguardo al contenuto e alla forma dipendono dallo scopo del manuale d’istruzione, dal pubblico previsto e dal contesto in cui il manuale viene usato. Quando scrivi il tuo manuale di istruzioni, considera le seguenti idee e domande riguardanti la situazione retorica.

Scopo

In generale, lo scopo di un manuale di istruzioni è quello di familiarizzare l’utente con il prodotto e/o di guidarlo attraverso una serie di passi che portano al completamento di un compito. Tuttavia, ogni manuale di istruzioni avrà anche un risultato più specifico. Identificare quale sia questo risultato specifico vi aiuterà a prendere decisioni retoriche più efficaci riguardo al contenuto e al design. Chiedetevi:

Quali sono i risultati specifici delle istruzioni? (ad esempio, cucinare una torta da zero, installare un condizionatore d’aria, ecc.)
Oltre ad aiutare gli utenti a raggiungere il principale risultato desiderato, ci sono altri scopi che il manuale serve? (ad esempio, offrire consigli per la risoluzione dei problemi, insegnare agli utenti come eseguire ulteriori, semplici compiti necessari per raggiungere l’obiettivo principale)

Pubblico

Creare un profilo del vostro pubblico (cioè l’utente principale del documento) è fondamentale per fare scelte ponderate su scopo, contenuto e design. Considerate queste domande sul pubblico prima di scrivere:

Qual è la familiarità o l’esperienza del pubblico riguardo all’argomento del manuale di istruzioni?
Qual è il livello di comfort generale del pubblico nell’imparare nuove abilità relative al software, alle applicazioni, alle ricette, ecc. In che modo il tuo manuale di istruzioni si rivolgerà allo stile di apprendimento, agli obiettivi e alle esigenze del pubblico?

Contesto

Pensa al contesto come alla situazione temporale, sociale, tecnologica e culturale che circonda la creazione e l’uso del manuale di istruzioni. Le seguenti domande ti aiuteranno a identificare il contesto:

Quanto tempo avrai a disposizione per completare questo manuale di istruzioni?
Ci sono vincoli di tempo per l’utente?
Quali vincoli tecnologici devi considerare nel creare il manuale di istruzioni? Considera le tue abilità con la tecnologia e il livello di accesso.
Come farà il tuo pubblico ad accedere al manuale? (ad esempio, il pubblico può accedere al manuale online tramite un sito web aziendale)
Quali strumenti o materiali aggiuntivi presumi che il pubblico abbia già? Avranno accesso alla tecnologia o ai materiali necessari per seguire le istruzioni? (ad esempio, per costruire con successo una libreria, l’utente avrà bisogno di un martello, un cacciavite e un’area di lavoro aperta)
Da quale prospettiva culturale state scrivendo il manuale di istruzioni? Il pubblico condividerà questo stesso contesto culturale? (ad esempio, una ricetta tedesca che richiede lo zucchero vanigliato, un ingrediente non facilmente disponibile negli Stati Uniti, potrebbe aver bisogno di essere modificata per gli utenti americani)

Usare la conoscenza della situazione retorica per fare scelte retoriche efficaci

Anche se la maggior parte dei manuali di istruzioni si basa su alcune convenzioni standard, ogni manuale di istruzioni dovrebbe essere personalizzato per raggiungere uno scopo specifico per un pubblico particolare in un determinato contesto. La sezione seguente introduce alcune caratteristiche comuni dei manuali d’istruzione, prendendo anche in considerazione la situazione retorica e come questa possa richiedere la deviazione da certe convenzioni.

Scope

La situazione retorica aiuta a determinare la quantità di dettagli da includere in un manuale d’istruzione. Per esempio, lo scopo di un manuale di istruzioni per assemblare una scrivania è facile da determinare perché ha un solo risultato: mettere insieme la scrivania. Tuttavia, un manuale di istruzioni per una macchina fotografica digitale reflex a obiettivo singolo (DSLR) può essere scritto sia per i dilettanti che per gli utenti più esperti e può avere bisogno di includere istruzioni per completare i compiti di base (ad esempio, l’installazione della batteria e della scheda di memoria) così come compiti più avanzati (ad esempio, regolazione delle impostazioni per specifici ambienti di ripresa).

Contenuto

Alcune sezioni standard dei manuali di istruzioni includono la parte anteriore, un’introduzione, una serie di passi, una conclusione e il retro, sebbene alcuni manuali possano non utilizzare tutte queste sezioni o etichettarle in questo modo. Un’ampia parte anteriore e posteriore, per esempio, si trova spesso in manuali più lunghi e complessi. La maggior parte dei set di istruzioni, tuttavia, contiene un’introduzione che fornisce le informazioni necessarie per completare i passi in modo sicuro ed efficiente. L’introduzione può includere una spiegazione di chi dovrebbe eseguire il compito (forse l’utente deve avere competenza in una certa abilità), i materiali necessari, qualsiasi precauzione che l’utente dovrebbe prendere (consigli di sicurezza o altre avvertenze), e in alcuni casi, una stima di quanto tempo il processo richiederà (una caratteristica comune delle ricette). In alcuni casi, è necessario includere una spiegazione del perché l’utente dovrebbe seguire le istruzioni. Per esempio, le istruzioni per cambiare l’olio in un’automobile possono spiegare perché il compito è necessario per il corretto funzionamento del veicolo.

Seguendo questo materiale introduttivo c’è la sequenza di istruzioni passo dopo passo. Vedere la sezione seguente sul “Linguaggio” per sapere come redigere passi chiari ed efficaci. Infine, un manuale di istruzioni può includere una “Guida alla risoluzione dei problemi” o una sezione di “Suggerimenti” per aiutare gli utenti ad affrontare i problemi comuni che possono incontrare mentre seguono le istruzioni o dopo aver completato il processo.

Lingua

Le domande su “Pubblico” e “Contesto” di cui sopra possono aiutare a fare scelte linguistiche efficaci. Le seguenti sottosezioni includono spiegazioni delle caratteristiche linguistiche comuni dei manuali d’istruzione insieme a suggerimenti per scrivere in modo chiaro e conciso in questo genere.

Modalità imperativa

Le istruzioni, come i comandi, spesso utilizzano la modalità imperativa. Per scrivere in questo modo, ci si rivolge direttamente al pubblico usando la voce attiva e verbi specifici. Quale delle seguenti fornisce il passo istruttivo più chiaro?

“Premere il pulsante rosso per iniziare a giocare”
“Quando il pulsante rosso viene premuto, il gioco inizierà”
“L’operatore dovrebbe premere il pulsante”

Anche se un utente potrebbe probabilmente dare un senso a qualsiasi di queste frasi, la prima fornisce la spiegazione più chiara di quale azione dovrebbe essere eseguita dall’utente. La seconda costruzione passiva non specifica chi dovrebbe premere il pulsante. Il terzo esempio si riferisce a un soggetto vago, l'”operatore”, che può confondere l’utente.

Scelta delle parole

Quando si scrivono le istruzioni, è importante un’attenta considerazione della scelta delle parole perché in alcuni casi, la sicurezza dell’utente è a rischio. Per questo motivo, sforzatevi di essere chiari e concisi. Per prendere decisioni efficaci sulla scelta delle parole, considerate il livello di competenza e il background culturale del vostro pubblico principale. Potrebbe essere necessario

definire termini complessi.
spiegare gli acronimi la prima volta che vengono introdotti (es, macchina fotografica reflex digitale a lente singola, DSLR).
evitare l’uso di similitudini, metafore, gergo o sostituzioni che possono confondere gli utenti.
usare un linguaggio semplice, perché in alcuni casi, gravi conseguenze legali possono sorgere quando una serie di istruzioni non è chiara. Per saperne di più sul linguaggio semplice, vedi http://www.plainlanguage.gov/index.cfm
includere traduzioni delle istruzioni in più lingue.
usare titoli e sottotitoli brevi e informativi

Consistenza e parallelismo

Struttura parallela, o parallelismo, significa usare la stessa struttura grammaticale per presentare informazioni o idee. Il parallelismo è spesso usato per migliorare la leggibilità e creare coerenza.

Questa lista numerica di istruzioni contiene un passo che rompe la struttura parallela. Quale di questi passi sembra diverso dagli altri?

Rimuovere la vite per aprire il vano batterie.
Inserire le batterie seguendo l’immagine sul vano batterie.
Ora puoi chiudere il vano, e avvitarlo.

Il terzo passo rompe la struttura parallela della lista perché non inizia con un verbo direttiva.

I titoli seguenti usano la struttura parallela? Perché o perché no?

“Installare le batterie”
“Spegnere/accendere il dispositivo”
“Come caricare il dispositivo”

Design

Il design del documento si riferisce al modo in cui le informazioni sono organizzate e presentate. Poiché le immagini richiedono meno tempo per essere elaborate, gli utenti noteranno e risponderanno alla qualità del design prima della qualità del contenuto. Anche se si sceglie di non includere immagini o grafici, è necessario considerare il design. Minimamente, questo include fare scelte sul layout, l’ordine delle informazioni, la dimensione dei caratteri, il carattere, le intestazioni, il colore e lo spazio bianco. Gli elementi di design dovrebbero guidare l’utente attraverso il manuale senza problemi. Questo significa rendere il documento scannerizzabile; un documento scannerizzabile permette agli utenti di navigare attraverso il contenuto per localizzare informazioni specifiche. Come per qualsiasi documento, le decisioni riguardanti il design dovrebbero considerare il pubblico, lo scopo e la facilità d’uso generale.

Consistenza/Ripetizione

Utilizzare un elemento di design in modo uniforme in tutto il documento guida gli utenti dando loro un senso di cosa aspettarsi (ad esempio, lo stesso carattere e la stessa dimensione per tutti i titoli; lo stesso layout da una pagina all’altra).

Contrasto

Utilizzare un elemento di design per evidenziare informazioni specifiche o caratteristiche del manuale (per esempio, scrivere in maiuscolo una parola per enfatizzarla; mettere un riquadro o un bordo intorno a un elemento; cambiare i colori per enfatizzarlo). Il contrasto è principalmente efficace quando un documento usa la coerenza in generale. Se c’è una mancanza di coerenza, è più difficile creare contrasto.

Allineamento

Organizzare gli elementi su una pagina con un allineamento orizzontale e/o verticale crea gerarchia e struttura, e può essere usato per aiutare a raggiungere equilibrio, contrasto o coerenza. Per esempio, questo documento usa l’allineamento verticale per creare una gerarchia tra il nome di un elemento di design, che è allineato a sinistra, e la sua descrizione, che è rientrata.

Equilibrio

Distribuire gli elementi in modo uniforme in un dato spazio. Per ottenere questo, si deve considerare il peso di ogni elemento, cioè la tendenza dell’occhio a gravitare verso un elemento. Per esempio, poiché un’immagine pesa più del testo, le decisioni sul posizionamento dell’immagine dovrebbero considerare come bilanciare il suo peso rispetto agli altri elementi per evitare confusione visiva.

Spazio bianco

Utilizzare lo spazio bianco per creare un documento professionale ed equilibrato. Piuttosto che indicare il colore dello spazio, questo elemento di design si riferisce a un’assenza di immagini e testo. Lo spazio bianco aiuta a distinguere tra i singoli elementi e i gruppi di elementi (cioè le sezioni del manuale) e rende più facile la scansione dei documenti.

Gruppo/Prossimità

Posizionare immagini o contenuti correlati uno vicino all’altro. Per esempio, raggruppando le immagini di tutti i materiali necessari per completare un dato compito.

Colore

Selezionare i colori per creare contrasto ed enfasi, per guidare i lettori nello spazio, e per progettare un documento visivamente piacevole. Si dovrebbe considerare il documento nel suo complesso per creare uno schema di colori coerente. Per esempio, se vuoi usare il blu nel tuo documento, vorrai assicurarti che sia usato in modo coerente e che completi gli altri colori del documento. Questo è particolarmente importante quando si integrano grafici e/o immagini a colori.

Immagini

Scegliere immagini appropriate per il contesto dato e lo scopo del manuale. Si dovrebbe considerare se le immagini sono destinate a stare da sole o ad integrare le istruzioni scritte. Considerate i tipi di immagini, come disegni, foto e illustrazioni grafiche, e se sono necessari ulteriori richiami o annotazioni per evidenziare parti specifiche dell’immagine. Le immagini dovrebbero essere scelte per completare altri elementi di design nel manuale.

Conclusione

Un buon manuale di istruzioni inizia con un’attenta considerazione della situazione retorica – scopo, pubblico e contesto. Queste informazioni sono fondamentali per fare scelte appropriate ed efficaci riguardo al contenuto, al linguaggio e al design. In una linea temporale ideale, gli scrittori tecnici hanno l’opportunità di condurre test di usabilità, che sono progettati per valutare quanto bene un documento soddisfa il suo scopo. Una volta che il tuo manuale di istruzioni è stato testato, incorporerai il feedback ricevuto per finalizzare il suo design e contenuto.

Esercizio 1 – Familiarizza con i manuali di istruzioni

Il seguente sito web contiene diversi esempi di manuali di istruzioni open-source. Segui questo link, scorri la lista e scegli un manuale da guardare in profondità. Scorri il manuale per familiarizzare con il suo contenuto e il suo design. Poi, in una nota al tuo istruttore o ai tuoi compagni di classe, affronta quanto segue.

Identifica la situazione retorica

Chi è il pubblico? Come fai a sapere chi è il pubblico? Cosa puoi supporre sul pubblico in base al contenuto e alle scelte di design del manuale?
Qual è lo scopo del documento? Come fai a sapere che questo è lo scopo primario (cioè, quali scelte di contenuto e di design segnalano lo scopo)?
Quale contesto informa il contenuto scritto e il design di questo manuale?

Esamina le scelte di composizione

Descrivi lo scopo generale e l’organizzazione del manuale. Quanto è dettagliato il manuale? Di cosa tratta? Come sono organizzate le informazioni?
Tutte le “caratteristiche standard” del contenuto sono coperte in questo manuale? Perché o perché no? Ci sono caratteristiche aggiuntive? Quali sono e qual è il loro scopo?
Cerca e descrivi esempi di scelte linguistiche efficaci. Spiega perché li trovi efficaci.
Cerca e descrivi esempi di design efficace. Spiega perché li trovi efficaci.
Se tu fossi l’autore di questo manuale, cosa avresti fatto diversamente e perché?

Esercizio 2 – Pianificare un manuale di istruzioni

Immagina di scrivere un manuale di istruzioni per un processo o prodotto che ti è familiare e affronta i seguenti suggerimenti.