Scrivere istruzioni non è facile

Istruzioni per la scrittura delle istruzioni

Molte persone sono abituate a seguire istruzioni scritte, ma la maggior parte delle persone non ha mai scritto istruzioni per qualcun altro. In molti ruoli professionali, invece, potresti dover scrivere istruzioni. Mentre alcune istruzioni possono essere semplici e brevi, altre potrebbero essere più complesse e richiedere più tempo per la scrittura. Per questo motivo è importante sapere come scrivere istruzioni efficaci.

manuali di istruzioni

Scrivere istruzioni efficaci può essere difficile perché le persone leggono e comprendono le cose in modo diverso. Ad esempio, alcune persone hanno uno stile di apprendimento visivo e potrebbero avere difficoltà a seguire istruzioni scritte. Inoltre il nostro pubblico è spesso composto da soggetti con differenti background educativi. Quando si scrivono le istruzioni è quindi importante utilizzare uno stile e un formato semplici e logici.

Quando scrivete le istruzioni evitate un linguaggio didattico e adottate piuttosto un approccio basato sui compiti da eseguire. Mantenete uno stile di scrittura chiaro e conciso e concentratevi sull’obiettivo di fornire all’utente le informazioni utili a svolgere con successo una determinata attività.

In generale, seguite queste linee guida:

Concisione e chiarezza

Utilizzate frasi brevi e comprensibili. Preferite la terminologia più comune quando possibile. Evitate di usare espressioni idiomatiche, gergali, abbreviazioni e acronimi. Se usate un termine che potrebbe risultare nuovo o ambiguo, datene una definizione chiara quando appare per la prima volta nelle istruzioni.

Pubblico

È importante conoscere il pubblico quando si scrivono le istruzioni, questo consente di includere tutte le informazioni necessarie ed escludere le informazioni non necessarie. Conoscere il tuo pubblico ti consente di formulare ipotesi ragionevoli e ben informate sulla base del suo background, dell’esperienza e della familiarità con l’argomento.

Al momento di decidere quali informazioni includere o escludere dalle istruzioni, è importante identificare chiaramente qual’è il tuo pubblico e qual’è la sua competenza rispetto all’argomento delle istruzioni ed alle informazioni di base.

Se è possibile supporre che un determinato pubblico abbia una vasta gamma di esperienze e conoscenze che includono vari livelli di familiarità e competenza, è possibile utilizzare varie tecniche per mantenere ogni serie di istruzioni sintetica e centrata sul un singolo compito, pur fornendo tutte le informazioni necessarie. Ad esempio, è possibile creare istruzioni separate per le informazioni di base e fornire al pubblico i mezzi per accedervi rapidamente e facilmente (tramite hyperlink, appendici, ecc.).

Illustrazioni

Le immagini parlano più delle parole. Aggiungere immagini e simboli grafici per trasmettere i tuoi pensieri potrebbe essere più efficace delle parole stesse. Le istruzioni illustrate graficamente in aggiunta alle tue istruzioni scritte hanno generalmente grande successo. Ciò aggiunge un ulteriore livello di comprensione e consente al lettore trovare le informazioni più velocemente quando ha la necessità di risolvere un problema specifico. Le immagini apportano una dimensione aggiuntiva e consentono al lettore di visualizzare il prodotto finale.

Anche se le immagini sono importanti, devi essere cauto nel non includere fotografie o illustrazioni confuse o non collegate alle istruzioni scritte. Se associ una foto scadente alle tue istruzioni, potresti creare confusione circa il loro reale significato.

Inoltre, quando si scattano delle foto, è opportuno che l’area sia ben illuminata e che le immagini siano chiare e luminose. Le immagini scure o sfocate sono spesso di difficile lettura. Fate attenzione a fotografare il soggetto sempre con la stessa angolazione per evitare confusione e considerate l’utilizzo di un treppiede.

Anche le dimensioni sono importanti quando si usano le immagini nelle istruzioni. Un’immagine troppo piccola per essere vista è altrettanto inutile di un’immagine sfocata.

Per essere potenti e comprensibili, il testo e la grafica di ogni sezione devono essere chiaramente correlati a quella determinata sezione delle istruzioni.

Formattazione

Ricorda che i lettori eseguiranno effettivamente il compito nello stesso momento in cui leggono le istruzioni. Quindi non dovresti usare blocchi di testo piccolo, difficile da decifrare. Assicurati di creare un design e un layout per la tua pagina di istruzioni che consenta una facile leggibilità e aggiunga qualità estetica. Mantenere la pagina semplice, ma con una gerarchia definita, aiuterà il lettore a completare i passaggi delle istruzioni.

Quando progetti la tua pagina, una solida gerarchia è importante per migliorare la capacità di scansione del testo. L’utilizzo di titoli in grassetto, corsivo e numeri romani aiuterà il lettore a trovare facilmente l’informazione desiderata e migliorerà l’aspetto visivo generale.

Ordine

È importante che le istruzioni siano pianificate in una progressione logica. Assicurati di indicare chiaramente il problema sulla prima pagina. Segui i tuoi problemi con una serie di passaggi specifici che descrivono dettagliatamente come risolvere il problema proposto. Le istruzioni tecniche devono fluire secondo un modello logico. Ad esempio, quando si monta un tavolo non sarebbe bello se si apportasse il tocco finale prima di avere tutte le viti in posizione. Come affermato in precedenza, ci dovrebbe essere anche una illustrazione chiara al posto giusto per chiarire l’azione. Ricorda: un’immagine vale più di mille parole.

Test e verifica

Sappiamo tutti che le istruzioni sono difficili da scrivere e che a volte “suonano” bene sulla carta, ma quando si tenta di mettere in pratica le istruzioni per l’uso si potrebbe scoprire che il testo risulta incomprensibile agli altri. Ricorda: ciò che potrebbe essere banale o ovvio per te potrebbe non esserlo per i tuoi lettori. Oltre a testare le tue istruzioni su te stesso, chiedi di farlo a qualcuno che non sa nulla del tuo prodotto. Questo è chiamato studio di usabilità. Prendi nota di ciò che ha funzionato e di cosa no e poi rivedi di conseguenza le tue istruzioni. Più persone testeranno le tue istruzioni, più efficace sarà il risultato finale.

Adatta le tue istruzioni al pubblico previsto

Adattare le tue istruzioni al pubblico previsto può essere uno dei compiti più difficili del tuo processo di scrittura. Prima di iniziare il processo di scrittura, devi identificare quale sarà il tuo pubblico e come personalizzare le tue istruzioni per renderle il più possibile comprensibili. Per aiutarti a fare questo, ci sono diverse domande che puoi porti:

  • Che background avranno gli individui che compongono il tuo pubblico e quali informazioni preliminari potrebbero possedere? Saperlo ti aiuterà a determinare ciò che dovrai includere o meno nelle tue istruzioni.
  • Quali saranno i loro bisogni / interessi?
  • In che modo i loro dati demografici influenzeranno il modo in cui scrivi? Se la maggior parte del tuo pubblico ha un’estrazione molto diversa dalla tua, devi prendere in considerazione i problemi linguistici e assicurarti che la grafica sia chiara.
  • Il tuo pubblico è eterogeneo? Se il tuo pubblico è composto da persone con background diversi, la tua scrittura dovrebbe essere adattata alla maggior parte del tuo pubblico e potresti anche considerare di aggiungere ulteriori informazioni nelle appendici.

Ci sono diversi modi in cui puoi garantire che le tue istruzioni siano il più chiare possibile per i tuoi lettori.

  • Aggiungi informazioni (come suggerimenti, note a margine) di cui i lettori avranno bisogno per comprendere le tue istruzioni e assicurati che siano presenti le informazioni chiave.
  • Non aggiungere informazioni non necessarie; potrebbe confondere o fuorviare i tuoi lettori.
  • Assicurati che il documento sia al livello del tuo pubblico.
  • Aggiungi esempi / grafici. La grafica può essere molto utile per un lettore.
  • Organizza il testo in modo chiaro e semplice: la mancanza di organizzazione crea confusione e frustrazione.
  •  Fai in modo che le azioni si distinguano dal resto del testo.
  • Dì al lettore cosa fare se commette un errore. Non sapere cosa fare causerà frustrazione e il lettore potrebbe rinunciare al compito.

Aiuti visivi

L’uso di grafica e immagini corrispondenti ad ogni passaggio è altamente raccomandato. Ogni persona ha diverse abitudini di apprendimento; alcuni preferiscono i testi mentre altri hanno più familiarità con le immagini. La presenza di elementi grafici consente inoltre al lettore di assicurarsi di essere sulla strada giusta. Nella maggior parte dei casi è utile avere una combinazione di grafica e testo.

Risoluzione dei problemi

Le istruzioni dovrebbero includere questa sezione per dire al lettore cosa fare se qualcosa va storto durante il processo di costruzione o se il progetto completato non assomiglia al risultato atteso. Inserire queste informazioni in un formato tabella ne migliora la leggibilità.

Scrivi le tue istruzioni

Le sezioni seguenti sono descrizioni delle diverse parti della struttura di un manuale di istruzioni. Le sezioni da includere variano in base alla complessità delle istruzioni.

  • Introduzione
  • Descrizione dell’apparecchiatura
  • Materiali e attrezzature necessari
  • Procedure
  • Supporti visivi
  • Risoluzione dei problemi

Introduzione

Ciò che è incluso nella tua introduzione dipenderà dal tipo di istruzioni e dal pubblico al quale sono destinate. In ogni caso, l’introduzione dovrebbe essere breve, ma comunque informativa. L’introduzione può includere una o tutte le seguenti sezioni:

  • Oggetto / Scopo: qui è necessario indicare l’attività specifica che verrà spiegata e quale sarà l’esito della procedura.
  • Lettori interessati: è possibile indicare a quali lettori sono rivolte le istruzioni e se il lettore avrà bisogno di ulteriori conoscenze o competenze per completare l’attività.
  • Obiettivo: aiuterà il lettore a comprendere se le istruzioni lo aiuteranno a completare l’attività che intende realizzare.
  • Organizzazione: dare al lettore una panoramica di come è organizzato il resto delle istruzioni può aiutarle a comprenderle più facilmente.
  • Sicurezza: è responsabilità dell’utente informare i lettori dei rischi collegati allo svolgimento dell’attività. È necessario visualizzare gli avvertimenti in modo chiaro e comprensibile.

Descrizione delle attrezzature

Se sono necessarie delle attrezzature che il lettore dovrà usare per poter completare l’attività è opportuno fornirne una descrizione dettagliata.

Elenco materiali / attrezzature

Fornire un elenco delle attrezzature di cui il lettore avrà bisogno per svolgere l’attività in modo che sappia se avrà bisogno di strumenti aggiuntivi o di oggetti che potrebbe non avere normalmente. Un elenco dei materiali è utile per per assicurarsi che il lettore abbia tutte le componenti e i pezzi di cui ha bisogno.

Procedura

Questa sezione è ovviamente la parte più importante di un manuale di istruzioni perché descrive i passaggi che il lettore seguirà per completare l’attività in corso. Esistono molti modi per formattare le procedure, ma nella maggior parte dei casi si usano elenchi numerati. Le seguenti sono le cose che dovresti fare per rendere i passaggi chiari e concisi:

  • Scrivi ogni passo con un testo sintetico in modo che sia facilmente comprensibile e completo.
  • Fornisci ai lettori le informazioni sufficienti per eseguire il passaggio, evitare la ridondanza.
  • Metti i passaggi in un elenco. La numerazione spesso funziona meglio.
  • Evidenzia le parole chiave.
Torna in alto