Scrittura tecnica per tecnici

Uno degli usi più comuni e importanti della scrittura tecnica sono le istruzioni – quelle spiegazioni passo dopo passo di come fare le cose: assemblare qualcosa, far funzionare qualcosa, riparare qualcosa, o spiegare un processo personale (iscriversi al college, per esempio) in modo che i lettori possano capirlo meglio e possibilmente usarlo loro stessi.

I testi di processo sono estremamente comuni nella scuola e nelle professioni. A scuola, gli insegnanti assegnano spesso compiti di processo. Per esempio, i professori di materie umanistiche possono chiedere una descrizione di come si è evoluto un periodo artistico o letterario; i professori di storia, i contributi dei leader di una cultura nel corso del tempo; i professori di scienze sociali, la cronologia delle invenzioni; i professori di ingegneria, spiegazioni su come il suono viene trasformato in segnali elettrici; i professori di economia, come funziona la Federal Reserve o come si vende un prodotto.

Ogni giorno, leggiamo processi descrittivi, incluse ricette, manuali utente per nuovi software, o colonne di consigli su come perdere peso o come avere successo a scuola o in una professione. Questi testi si concentrano sulla risposta a una delle seguenti domande:

• “Come si fa?”
• “Come posso farlo?”

Mentre gli argomenti di una relazione di processo o di una serie di istruzioni possono variare, molti condividono delle somiglianze: la maggior parte è scritta per spiegare come funziona qualcosa, la maggior parte è strutturata in ordine cronologico usando passi numerati, e la maggior parte si basa ampiamente sulle immagini. Nello scrivere istruzioni per imparare un nuovo programma software, per esempio, gli scrittori potrebbero usare schermate e/o video per guidare gli utenti attraverso il tutorial.

Generalmente, è bene avere sia testo che immagini nelle vostre istruzioni poiché il vostro pubblico è probabilmente composto da persone con diversi stili di apprendimento. Tuttavia, l’uso delle immagini può variare a seconda del pubblico e dell’uso previsto delle istruzioni. Le immagini aiutano a chiarire un concetto che è difficile da spiegare usando solo le parole. I grafici possono essere usati per mostrare come appare qualcosa, come qualcosa dovrebbe apparire una volta che il passo è stato completato, come qualcosa viene fatto o costruito, mostrare tendenze o relazioni, aggiungere vivacità al progetto, o semplicemente aiutare ad organizzare le informazioni. I grafici sono utili perché quasi tutti (compresi i bambini e altri di una lingua diversa) possono capire le istruzioni visive e vedere esattamente ciò che devono completare.

Tipi di istruzioni

Ci sono tre tipi principali di testi di processo:

• • • Processi descrittivi: questi rispondono alla domanda, “Come si fa questo?” Questi testi descrivono come avviene un processo in modo che i lettori possano capirlo meglio. Per esempio, scrivere un processo descrittivo su come ci si è registrati a un corso online piuttosto che di persona potrebbe essere utile a qualcuno che non ha mai fatto la registrazione online.

• • • Processi prescrittivi: questi sono di natura esplicativa; prescrivono come qualcosa viene fatto (o dovrebbe essere fatto) in modo che i lettori possano farlo da soli. Questi sono il tipo più comune di documenti didattici. Per esempio, si potrebbe scrivere una guida al processo prescrittivo per gli utenti che spiega come eseguire la manutenzione di base delle loro auto, come cambiare l’olio, controllare le candele o sostituire le pastiglie dei freni. *Gli esempi elencati qui sotto sono esempi di processi prescrittivi.

• • • I processi misti descrittivi e prescrittivi fanno sì che la parte principale del documento sia un processo descrittivo e che vi siano alcune sezioni che riassumono come i lettori possono eseguire il processo. In altre parole, gli scrittori possono affrontare sia “Come posso fare questo?” che “Come si fa questo?” in parti diverse di un testo. In alternativa, potrebbero sviluppare diverse versioni dello stesso documento per due pubblici – un pubblico di utenti e un pubblico di parti interessate.

Iniziare

All’inizio di un progetto o incarico di scrittura di istruzioni, è importante considerare il pubblico e determinare le caratteristiche (il numero di compiti e passi) della particolare procedura di cui si intende scrivere.

Pubblico e situazione: All’inizio del processo, definite il pubblico e la situazione delle vostre istruzioni. Ricordate che definire un pubblico significa definire il suo livello di conoscenza e familiarità con l’argomento. A volte è utile descrivere prima il tuo pubblico a te stesso, e poi usarlo per valutare il tuo messaggio alla fine per essere sicuro che sia appropriato per il tuo pubblico.

Numero di compiti: Una considerazione importante è quanti compiti ci sono nella procedura per la quale state scrivendo le istruzioni. Il termine procedura può essere usato per riferirsi all’intero insieme di attività di cui parlano le vostre istruzioni, mentre il compito può essere usato per definire un gruppo semi-indipendente di azioni all’interno della procedura. Per esempio, impostare il modem è un compito nella procedura complessiva di connessione di un computer a Internet.

Come altro esempio, una procedura semplice come cambiare l’olio di un’auto contiene solo un compito; non ci sono raggruppamenti semi-indipendenti di altre attività. Una procedura più complessa, come usare un forno a microonde, contiene molti compiti semi-indipendenti, come impostare l’orologio, impostare il livello di potenza, usare il timer, pulire e mantenere il forno a microonde, e altro ancora.

Alcune istruzioni hanno solo un singolo compito ma hanno molti passi all’interno di quel singolo compito. Per esempio, immaginate una serie di istruzioni per assemblare un’altalena per bambini. Un approccio efficace sarebbe quello di raggruppare passi simili e correlati in fasi, e poi rinumerare i passi ad ogni nuova fase. Una fase è 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; e assemblare l’altalena sarebbe ancora un’altra.

Focalizzare le istruzioni

Un’altra considerazione, che forse non puoi determinare all’inizio, è come focalizzare le tue istruzioni. Per la maggior parte delle istruzioni, puoi concentrarti sui compiti coinvolti, o puoi concentrarti sugli strumenti necessari.

• • • In un approccio per compiti alle istruzioni sull’uso di una segreteria telefonica, avresti sezioni sulla registrazione del tuo saluto, la riproduzione dei tuoi messaggi, il salvataggio dei tuoi messaggi, l’inoltro dei tuoi messaggi, e la cancellazione dei tuoi messaggi. Queste sono attività – le cose tipiche che gli utenti vorrebbero fare con la macchina.

• • • D’altra parte, in un approccio di strumenti alle istruzioni sull’uso di una fotocopiatrice, ci sarebbero sezioni sul pulsante di copia, il pulsante di cancellazione, il pulsante di ingrandimento/riduzione, il pulsante di fascicolazione/ pinzatura, il vassoio della carta, il pulsante del formato copia, e così via. Se progettassi un set di istruzioni su questo piano, probabilmente scriveresti i passi per usare ogni pulsante o caratteristica della fotocopiatrice.

Contenuto delle istruzioni

Assicurati di leggere la sezione sulla “Progettazione del documento” prima di creare le tue istruzioni. Includi i seguenti elementi:

Introduzione: Nel pianificare attentamente l’introduzione delle vostre istruzioni, assicuratevi di:

• • • Indicare i compiti specifici o la procedura da spiegare.
    • Indicare di cosa ha bisogno il pubblico in termini di conoscenze e background per capire le istruzioni.
    • Dare un’idea generale della procedura e di ciò che essa realizza.
    • Indicare le condizioni in cui queste istruzioni dovrebbero (o non dovrebbero) essere usate.
    • Dare una panoramica del contenuto delle istruzioni.

Avvertimento generale, attenzione, avvisi di pericolo: Le istruzioni devono anche avvertire i lettori della possibilità di rovinare la loro attrezzatura, sbagliare la procedura e/o farsi male. Inoltre, le istruzioni devono sottolineare punti chiave o eccezioni. Per queste situazioni, si dovrebbero usare avvisi speciali, come Nota, Attenzione, Precauzione, e/o Pericolo.

Sfondo tecnico o teoria: All’inizio di alcune istruzioni (di solito dopo l’introduzione), potrebbe essere necessaria una discussione sul background relativo alla procedura. Per alcune istruzioni, questo background è fondamentale, altrimenti i passi della procedura non hanno senso. In alcuni casi, gli scrittori di istruzioni possono aver bisogno di passare molto tempo a spiegare le cose ai lettori prima di passare ai passi effettivi coinvolti nel processo.

Apparecchiature e forniture: La maggior parte delle istruzioni include una lista delle cose che è necessario 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 sono tipicamente elencate in una semplice lista verticale o in una lista a due colonne all’inizio delle istruzioni. Usa l’elenco a due colonne se hai bisogno di aggiungere 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, assicuratevi di considerare attentamente la struttura e il formato di questi passi, qualsiasi informazione supplementare che potrebbe essere necessaria, e il punto di vista e lo stile generale di scrittura delle istruzioni. Un punto di vista usato nella scrittura tecnica è la seconda persona, che si rivolge al pubblico come te.

*In generale, chi scrive istruzioni dovrebbe sforzarsi di fare quanto segue:

• • • Utilizzare una scrittura chiara e semplice quando possibile.

• • • Avere una comprensione approfondita del processo in tutti i suoi dettagli tecnici.

• • • Lavora per metterti al posto del lettore che userà le tue istruzioni.

  

  Campioni di istruzioni per studenti

  • Esempio di istruzioni di saldatura (campione per studenti)
  • Esempio di istruzioni di meccatronica – Test diodi & Transistor (campione per studenti)
  • Istruzioni Auto/Diesel – Come sostituire una barra di deviazione posteriore su una Toyota Corolla (campione per studenti)
  • Letto Transfer Instructions (student sample)
  • How to Change Guitar Strings (student sample)

  Professional instruction samples

  • Welding Istruzioni campione 1 (campione professionale)
  • Barbie Dreamhouse (campione professionale)
  • Assemblaggio del trampolino (campione professionale)