¶ Scrittura e documenti

Scrivere istruzioni passo passo che le persone seguono davvero

Come scrivere una procedura operativa chiara: obiettivo, prerequisiti, un'azione per passaggio, risultato atteso, avvertenze e prova con un utente.

Una procedura scritta bene ha un effetto preciso: una persona che non l'ha mai eseguita arriva al risultato senza chiedere aiuto. Sembra un obiettivo modesto, ma la maggior parte delle istruzioni che circolano negli uffici non lo raggiunge. Mancano passaggi che all'autore sembravano ovvi, i nomi dei pulsanti non corrispondono a quelli sullo schermo, le avvertenze compaiono dopo l'azione che avrebbero dovuto evitare.

Scrivere istruzioni è una competenza con regole chiare, e si può imparare.

Prima di scrivere: chi, cosa, da dove

Tre domande definiscono la procedura:

  • Chi la eseguirà? Un collega esperto, un nuovo assunto, un cliente? Il livello di dettaglio cambia completamente.
  • Qual è il risultato finale? Una frase, verificabile: «la casella di posta è configurata sul telefono e riceve messaggi».
  • Da che situazione si parte? Cosa deve essere già pronto: accessi, programmi installati, file a disposizione.

La struttura

Titolo: verbo + oggetto («Configurare la posta aziendale sul telefono»)

Obiettivo: una o due frasi.
Prima di iniziare: prerequisiti e cosa tenere a portata di mano.
Tempo indicativo: se è utile saperlo.

Passaggi numerati.

Risultato: come capire che è andato tutto bene.
Se qualcosa non funziona: i problemi più probabili.

Il titolo con un verbo all'infinito («Configurare», «Ripristinare», «Esportare») rende la procedura trovabile: chi cerca, cerca un'azione.

Le regole dei passaggi

1. Un'azione per passaggio. «Aprite le impostazioni, scegliete Account e toccate Aggiungi» sono tre passaggi. Separarli permette a chi legge di non perdere il segno.

2. Il verbo all'inizio. «Fate clic su Salva» è più immediato di «Il pulsante Salva va premuto».

3. Il contesto prima dell'azione. «Nella scheda Sicurezza, attivate Verifica in due passaggi». Chi legge cerca prima il luogo, poi l'oggetto.

4. I nomi esatti dell'interfaccia, con la stessa grafia e in evidenza: corsivo o grassetto, sempre lo stesso. Se l'interfaccia è in inglese, usate il nome inglese.

5. Il risultato visibile dopo i passaggi importanti. «Compare una finestra di conferma con il codice a sei cifre.» Serve a chi esegue per capire di essere sulla strada giusta.

6. Le scelte esplicite. Quando si deve decidere, ditelo: «Se usate un iPhone, passate al punto 7; altrimenti continuate».

Un esempio prima e dopo

Versione tipica:

Andare nelle impostazioni del router e cambiare la password del Wi-Fi, ricordandosi di salvare. Attenzione che tutti i dispositivi verranno disconnessi.

Versione riscritta:

  1. Avvisate le persone collegate: al termine tutti i dispositivi dovranno ricollegarsi con la nuova password.
  2. Da un computer collegato alla rete, aprite il browser e digitate l'indirizzo del router indicato sull'etichetta.
  3. Accedete con le credenziali di amministrazione.
  4. Aprite la sezione Wireless e poi Sicurezza.
  5. Nel campo Password, inserite la nuova password.
  6. Fate clic su Applica. La connessione si interrompe per qualche secondo.
  7. Ricollegate il computer alla rete usando la nuova password.

La seconda versione è più lunga, ma si esegue senza dubbi, e l'avvertenza arriva prima dell'azione che ha conseguenze.

Avvertenze al posto giusto

Le avvertenze funzionano solo se compaiono prima del passaggio a cui si riferiscono e se sono rare. Una procedura con un avviso ogni tre righe insegna a ignorarli. Distinguete al massimo due livelli:

  • Nota: informazione utile, nessun rischio.
  • Attenzione: c'è il rischio di perdere dati, interrompere un servizio o dover ricominciare.

Immagini: quando servono

Le catture dello schermo aiutano quando l'elemento da trovare è difficile da descrivere o quando l'interfaccia è affollata. Hanno però un costo: invecchiano al primo aggiornamento del programma. Usatele per i passaggi chiave, ritagliate sulla parte utile, con un riquadro o una freccia sull'elemento da cliccare. Il testo deve comunque bastare da solo, anche per chi non vede le immagini.

La prova decisiva

Il controllo più efficace è far eseguire la procedura a qualcuno che non la conosce, osservandolo senza intervenire. Ogni volta che esita, torna indietro o chiede qualcosa, avete trovato un punto da riscrivere. Nel mio lavoro questa prova di dieci minuti scova più problemi di qualsiasi rilettura.

In sintesi

  • Definite chi esegue, il risultato finale e la situazione di partenza prima di scrivere.
  • Un'azione per passaggio, con il verbo all'inizio e il contesto prima dell'azione.
  • Usate i nomi esatti dell'interfaccia e indicate il risultato visibile dopo i passaggi importanti.
  • Le avvertenze vanno prima dell'azione rischiosa e devono essere poche.
  • Far eseguire la procedura a un'altra persona è il test più affidabile.
MM
Marco Marzaduri

Marco Marzaduri si occupa di cybersecurity, informatica forense e sviluppo web. Laureato in informatica, unisce il rigore dell'analisi tecnica all'attenzione per le persone che usano la tecnologia.

Leggi anche