Uno degli usi più comuni e importanti della scrittura tecnica è quello di fornire istruzioni, quelle spiegazioni passo dopo passo su come assemblare, far funzionare, riparare o fare la manutenzione ordinaria di qualcosa. Anche se possono sembrare intuitive e semplici da scrivere, le istruzioni sono alcuni dei documenti peggio scritti che si possano trovare. La maggior parte di noi ha probabilmente avuto molte esperienze esasperanti con istruzioni scritte male. Questo capitolo vi mostrerà quelle che i professionisti considerano le migliori tecniche per fornire istruzioni.
Un insieme efficace di istruzioni richiede quanto segue:
- Scrittura chiara, precisa e semplice
- Comprensione approfondita della procedura in tutti i suoi dettagli tecnici
- La capacità di mettersi nei panni del lettore, la persona che cerca di usare le tue istruzioni
- La capacità di visualizzare la procedura in dettaglio e di catturare questa consapevolezza sulla carta
- Volontà di provare le tue istruzioni sul tipo di persona per cui le hai scritte.
All’inizio di un progetto per scrivere una serie di istruzioni, è importante determinare la struttura o le caratteristiche della particolare procedura che si sta per scrivere. Ecco alcuni passi da seguire:
Fate un’attenta analisi del pubblico e del compito
Precocemente nel processo, definite il pubblico e la situazione delle vostre istruzioni. Ricordate che definire un pubblico significa definire il livello di familiarità che i vostri lettori hanno con l’argomento.
Determinate il numero di compiti
Quanti compiti ci sono nella procedura che state scrivendo? Usiamo il termine procedura per riferirci all’insieme delle attività che le vostre istruzioni intendono trattare. Un compito è un gruppo semi-indipendente di azioni all’interno della procedura: per esempio, impostare l’orologio su un forno a microonde è un compito nella grande procedura complessiva del funzionamento di un forno a microonde.
Una procedura semplice come cambiare l’olio in un’auto contiene solo un compito; non ci sono raggruppamenti semi-indipendenti di attività. Una procedura più complessa come l’uso di un forno a microonde contiene diversi compiti semi-indipendenti: impostazione dell’orologio; impostazione del livello di potenza; uso del timer; pulizia e manutenzione del microonde, tra gli altri.
Alcune istruzioni hanno un solo compito, ma hanno molti passi all’interno di quel singolo compito. Per esempio, immaginate una serie di istruzioni per assemblare un’altalena per bambini. Nella mia esperienza personale, c’erano più di 130 passi! Questo può essere un po’ scoraggiante. Un buon approccio è quello di raggruppare passi simili e correlati in fasi, e iniziare a rinumerare i passi ad ogni nuova fase. Una fase è quindi un gruppo di passi simili all’interno di una procedura a compito singolo. Nell’esempio dell’altalena, impostare il telaio sarebbe una fase; ancorare la cosa nel terreno sarebbe un’altra; assemblare l’altalena sarebbe ancora un’altra.
3. Determinare il miglior approccio alla discussione passo dopo passo
Per la maggior parte delle istruzioni, ci si può concentrare sui compiti o sugli strumenti (o caratteristiche degli strumenti). In un approccio ai compiti (noto anche come orientamento ai compiti) alle istruzioni sull’uso di un servizio di risposta al telefono, si avrebbero queste sezioni:
- Registrare il tuo saluto
- Ripassare i tuoi messaggi
- Salvare i tuoi messaggi
- Inoltrare i tuoi messaggi
- Cancellare i tuoi messaggi, e così via
Questi sono compiti – le cose tipiche che vorremmo fare con la macchina.
D’altra parte, in un approccio di strumenti per istruzioni sull’uso di una fotocopiatrice, ci sarebbero probabilmente sezioni su come usare funzioni specifiche:
- Tasto copia
- Tasto annulla
- Tasto ingrandisci/riduci
- Tasto incolla/stacca
- Tasto taglia copia, e così via
Se tu progettassi un set di istruzioni su questo piano, scriveresti i passi per usare ogni tasto o caratteristica della fotocopiatrice. Le istruzioni che usano questo approccio di strumenti sono difficili da far funzionare. A volte, il nome del pulsante non corrisponde esattamente al compito a cui è associato; a volte bisogna usare più di un pulsante per realizzare il compito. Tuttavia, ci possono essere momenti in cui l’approccio strumenti/caratteristiche può essere preferibile.
4. Progettare raggruppamenti di compiti
L’elenco dei compiti può non essere tutto ciò che è necessario fare. Ci possono essere così tanti compiti che è necessario raggrupparli in modo che i lettori possano trovare più facilmente quelli individuali. Per esempio, i seguenti sono raggruppamenti di compiti comuni nelle istruzioni:
- Task di disimballaggio e configurazione
- Task di installazione e personalizzazione
- Task operativi di base
- Task di manutenzione ordinaria
- Task di risoluzione dei problemi.
Sezioni comuni nelle istruzioni
Quella che segue è una rassegna delle sezioni che troverai comunemente nelle istruzioni. Non date per scontato che ognuna di esse debba essere presente nelle istruzioni che scriverete, né che debbano essere nell’ordine qui presentato, né che queste siano le uniche sezioni possibili in un insieme di istruzioni.
Per formati alternativi, date un’occhiata alle istruzioni di esempio.
Introduzione: pianificate attentamente l’introduzione alle vostre istruzioni. Potrebbe includere uno dei seguenti elementi (ma non necessariamente in quest’ordine):
- Indicare i compiti specifici o la procedura da spiegare e lo scopo (ciò che sarà e non sarà coperto)
- Indicare di cosa ha bisogno il pubblico in termini di conoscenza e background per capire le istruzioni
- Dare un’idea generale della procedura e di cosa realizza
- Indicare le condizioni in cui queste istruzioni dovrebbero (o non dovrebbero) essere usate
- Dare una panoramica dei contenuti delle istruzioni.
Avvertimento generale, attenzione, avvisi di pericolo: le istruzioni devono spesso avvertire i lettori della possibilità di rovinare il loro equipaggiamento, sbagliare la procedura e farsi male. Inoltre, le istruzioni devono spesso sottolineare punti chiave o eccezioni. Per queste situazioni si usano avvisi speciali: avvisi di nota, avvertimento, attenzione e pericolo. Notate come questi avvisi speciali sono usati nelle istruzioni di esempio elencate sopra.
Sfondo tecnico o teoria: all’inizio di certi tipi di istruzioni (dopo l’introduzione), potreste aver bisogno di una discussione sul background relativo alla procedura. Per certe istruzioni, questo background è fondamentale, altrimenti i passi della procedura non hanno senso. Per esempio, potreste aver avuto qualche esperienza con quelle applet software in cui si definiscono i propri colori muovendo le barre di scorrimento rosse, verdi e blu. Per capire davvero quello che state facendo, dovete avere un po’ di background sul colore. Allo stesso modo, potete immaginare che, per certe istruzioni che usano le macchine fotografiche, potrebbe essere necessaria anche un po’ di teoria.
Attrezzatura e forniture: notate che la maggior parte delle istruzioni include una lista delle cose che dovete raccogliere prima di iniziare la procedura. Questo include l’attrezzatura, gli strumenti che si usano nella procedura (come ciotole per mescolare, cucchiai, teglie per il pane, martelli, trapani e seghe) e le forniture, le cose che si consumano nella procedura (come legno, vernice, olio, farina e chiodi). Nelle istruzioni, queste cose sono tipicamente elencate in una semplice lista verticale o in una lista a due colonne. Usate l’elenco a due colonne se avete bisogno di aggiungere alcune specifiche ad alcuni o a tutti gli elementi – per esempio, nomi di marche, dimensioni, quantità, tipi, numeri di modello, e così via.
Discussione dei passi: quando arrivate alla scrittura effettiva dei passi, ci sono diverse cose da tenere a mente: (1) la struttura e il formato di quei passi, (2) le informazioni supplementari che potrebbero essere necessarie, e (3) il punto di vista e lo stile generale di scrittura.
Struttura e formato: normalmente, immaginiamo un insieme di istruzioni come formate da liste verticali numerate. E la maggior parte lo sono in effetti. Normalmente, si formattano le istruzioni passo dopo passo in questo modo. Ci sono alcune variazioni, tuttavia, così come alcune altre considerazioni:
- I passi di ordine fisso sono passi che devono essere eseguiti nell’ordine presentato. Per esempio, se state cambiando l’olio in un’auto, scaricare l’olio è un passo che deve venire prima di mettere l’olio nuovo. Questi sono elenchi numerati (di solito, elenchi numerati verticali).
- I passi di ordine variabile sono passi che possono essere eseguiti praticamente in qualsiasi ordine. Buoni esempi sono quelle guide per la risoluzione dei problemi che vi dicono di controllare questo, controllare quello dove state cercando di riparare qualcosa. Puoi fare questo tipo di passi praticamente in qualsiasi ordine. Con questo tipo, l’elenco puntato è il formato appropriato.
- I passi alternativi sono quelli in cui vengono presentati due o più modi per realizzare la stessa cosa. I passi alternativi si usano anche quando possono esistere varie condizioni. Usate elenchi puntati con questo tipo, con OR inseriti tra le alternative, o il lead-in che indica che le alternative stanno per essere presentate.
- I passi annidati possono essere usati nei casi in cui i singoli passi di una procedura sono piuttosto complessi di per sé e devono essere suddivisi in sottopassi. In questo caso, si indentano ulteriormente e si mettono in sequenza i sotto-passi come a, b, c, e così via.
- Istruzioni “senza passi”. possono essere usate quando non si può davvero usare una lista verticale numerata o fornire una diretta regia in stile istruzioni al lettore. Alcune situazioni devono essere così generalizzate o così variabili che i passi non possono essere indicati.
Discussione supplementare: spesso, non è sufficiente dire ai lettori di fare questo o fare quello. Hanno bisogno di informazioni esplicative aggiuntive come il modo in cui la cosa dovrebbe apparire prima e dopo il passo; perché dovrebbero preoccuparsi di fare questo passo; quale principio meccanico c’è dietro a quello che stanno facendo; una spiegazione ancora più micro-livello del passo-discussione delle azioni specifiche che compongono il passo.
Il problema con la discussione supplementare, tuttavia, è che può nascondere il passo effettivo. Voi volete che il passo vero e proprio – le azioni specifiche che il lettore deve compiere – risalti. Non volete che sia tutto sepolto in un mucchio di parole. Ci sono almeno due tecniche per evitare questo problema: si può dividere l’istruzione dal supplemento in paragrafi separati; oppure si può mettere in grassetto l’istruzione.
Stile di scrittura
Porre i passi chiave dell’utente in grassetto può essere un modo molto utile per segnalare chiaramente cosa il lettore deve fare. Spesso il verbo del comando è in grassetto; a volte il carattere in grassetto evidenzia il componente chiave che viene discusso.
L’uso della voce passiva nelle istruzioni può essere problematico. Per qualche strana ragione, alcune istruzioni suonano così: “Il pulsante Pausa deve essere premuto per fermare temporaneamente il display”. Non solo siamo preoccupati per la salute mentale del pulsante di pausa, ma ci chiediamo chi dovrebbe premerlo (i ninja?). Sarebbe più utile indicare quando il lettore deve “premere il pulsante Pausa”. Considerate questo esempio: “Il pulsante del timer è quindi impostato su 3:00”. Di nuovo, ci si potrebbe chiedere: “è impostato da chi? I ninja?” La persona che segue queste istruzioni potrebbe pensare che sia semplicemente un riferimento a qualche stato esistente, o potrebbe chiedersi: “Stanno parlando con me?” L’uso della terza persona può anche portare all’imbarazzo: “L’utente dovrebbe quindi premere il pulsante Pausa”. Le istruzioni dovrebbero tipicamente essere scritte usando forme verbali di comando e usando il “tu” per rendere perfettamente chiaro ciò che il lettore dovrebbe fare.
Illustrare le vostre istruzioni
Forse più che in qualsiasi altra forma di scrittura tecnica, la grafica è cruciale per le istruzioni. A volte, le parole semplicemente non possono spiegare il passo. Le illustrazioni sono spesso critiche per la capacità dei lettori di visualizzare ciò che devono fare. Assicuratevi che la grafica rappresenti l’immagine dal punto di vista del lettore.
Formattare le vostre istruzioni
Siccome le persone raramente vogliono leggere le istruzioni, ma spesso devono farlo, formattate le vostre istruzioni per una lettura riluttante. Cercate di fare in modo che il vostro lettore voglia leggerle, o almeno che non sia restio all’idea di consultarle. Un formato altamente leggibile permetterà ai lettori che hanno capito alcune delle istruzioni da soli di saltare alla sezione in cui sono bloccati. Usate ciò che avete imparato su titoli, elenchi, immagini e spazio passivo per creare istruzioni efficaci e leggibili:
Titoli: normalmente, vorrete titoli per qualsiasi sezione di background che potreste avere, la sezione sull’attrezzatura e le forniture, un titolo generale per la sezione delle istruzioni vere e proprie, e sottotitoli per i singoli compiti o fasi all’interno di quella sezione.
Liste: analogamente, le istruzioni fanno in genere un uso esteso di liste, in particolare liste verticali numerate per le spiegazioni passo per passo. Semplici elenchi verticali o elenchi a due colonne sono solitamente buoni per la sezione delle attrezzature e delle forniture. Gli elenchi di frasi sono buoni ogni volta che si dà una panoramica delle cose che verranno.
Avvisi speciali: si può avere la necessità di avvertire i lettori delle possibilità in cui possono danneggiare le loro attrezzature, sprecare le forniture, far fallire l’intera procedura, ferire se stessi o altri – anche seriamente o mortalmente. Le aziende sono state citate in giudizio per la mancanza di questi avvisi speciali, per avvisi speciali scritti male, o per avvisi speciali che erano fuori posto. Vedi avvisi speciali per una discussione completa sull’uso appropriato di questi avvisi speciali così come il loro formato e posizionamento all’interno delle istruzioni.
Quando rileggi e rivedi le tue istruzioni, controlla che facciano quanto segue:
- Descrivere chiaramente l’esatta procedura da spiegare
- Fornire una panoramica del contenuto
- Indicare i requisiti del pubblico
- Utilizzare vari tipi di liste dove appropriato; in particolare, usare elenchi numerati per i passi sequenziali
- Utilizzare titoli e sottotitoli per dividere le sezioni principali e le sottosezioni in un ordine logico e coerente
- Utilizzare avvisi speciali come appropriato
- Utilizzare grafici per illustrare azioni e oggetti chiave
- Fornire ulteriori spiegazioni supplementari dei passi, se necessario
- Creare una sezione che elenchi attrezzature e forniture se necessario.