Come scrivere istruzioni chiare con passaggi ed esempi

Definisci il punto di arrivo e chi può raggiungerlo

Una procedura dovrebbe iniziare con un compito riconoscibile. “Prenotare una sala per un incontro” è un obiettivo diverso da “richiedere l’autorizzazione a un evento”. Se il servizio distingue le due azioni, non unirle sotto una parola generica come richiesta. Il lettore deve sapere se si trova nel percorso giusto prima di dedicargli tempo.

Indica i prerequisiti che possono bloccare il compito: ruolo abilitato, credenziali, documenti necessari o informazioni da avere a disposizione. Non elencare requisiti inventati per completare un modello. Ricavali dalla procedura effettiva e verifica quali sono obbligatori. Una condizione scoperta soltanto all’ultimo passaggio può rendere inutile tutto il lavoro precedente.

In questa guida useremo un servizio fittizio di prenotazione di materiali per un laboratorio. L’esempio serve a valutare la scrittura e non descrive un portale esistente. Per applicarlo a un prodotto reale occorre controllare nomi dei comandi, regole, messaggi e risultati nell’ambiente pertinente, con le autorizzazioni necessarie.

Scrivi ogni passo intorno a un’azione osservabile

Un passo utile contiene un verbo e un oggetto riconoscibile. “Compila tutto correttamente” non dice che cosa fare. “Indica il giorno di ritiro e il numero di kit richiesti” identifica invece due dati. Se questi dati si trovano nello stesso punto e vengono inseriti insieme, possono condividere un passo; se richiedono schermate diverse, separali.

Le indicazioni sui microtesti di Designers Italia raccomandano azioni specifiche e testi contestuali, orientati all’obiettivo. Per applicare il principio, usa le etichette effettivamente visibili nel servizio. Se il comando si chiama “Invia richiesta”, non chiamarlo altrove “Conferma ordine” quando le due espressioni suggeriscono esiti diversi.

Non affidare l’orientamento soltanto a posizione e colore. “Premi il pulsante verde a destra” può diventare ambiguo quando il layout cambia. Nomina l’azione e aggiungi la posizione soltanto se aiuta nell’ambiente descritto. Se occorre un’immagine, deve mostrare il passaggio corretto e aggiungere informazione al testo.

Una procedura fittizia con buchi di significato

Accedi al servizio e compila il modulo. Quando hai finito, conferma. Se ci sono problemi, controlla i dati e riprova. Per i kit speciali potrebbe servire un’autorizzazione. La richiesta verrà gestita appena possibile.

Il testo sembra breve, ma lascia irrisolti i punti decisivi. Non indica quali dati preparare, quando verificare l’autorizzazione o come capire se l’invio è riuscito. “Conferma” potrebbe indicare la revisione dei dati oppure la prenotazione effettiva. “Riprova” non distingue un errore correggibile da una richiesta già ricevuta.

Prima di riscrivere, ricostruisci il servizio. Supponiamo per il caso fittizio che i kit speciali richiedano un codice di autorizzazione, che il modulo permetta un riepilogo prima dell’invio e che la ricezione produca un numero di richiesta. Queste condizioni diventano la base della procedura revisionata. Non vengono presentate come funzioni di un prodotto realmente provato.

Una versione con condizioni, azioni e risultato

Prima di iniziare, prepara data di ritiro e quantità. Se richiedi un kit speciale, procurati anche il codice di autorizzazione previsto dal laboratorio fittizio. Il codice deve essere disponibile prima dell’invio: questa condizione non va nascosta in una nota finale, dopo la descrizione del percorso ordinario.

1. Accedi al servizio di prenotazione e apri Nuova richiesta.
2. Seleziona il tipo di kit e indica quantità e giorno di ritiro.
3. Per un kit speciale, inserisci il codice di autorizzazione nel campo dedicato.
4. Apri il riepilogo e controlla tipo, quantità e data. Correggi i dati prima di procedere.
5. Se i dati sono corretti, seleziona Invia richiesta.
6. Conserva il numero mostrato nella conferma di ricezione.

La conferma di ricezione non va descritta come approvazione della prenotazione se il servizio prevede ancora una valutazione. Per completare l’esempio occorre indicare come arriverà la decisione e quale canale usare se manca la conferma. In un servizio reale queste informazioni devono essere verificate, non dedotte dal nome del pulsante.

Distingui i problemi che richiedono azioni diverse

“Qualcosa non ha funzionato” non basta quando il lettore può intervenire. Se il codice manca, il messaggio può indicare il campo da completare. Se il codice non è valido, può spiegare come verificarlo o a chi rivolgersi. Se il servizio non è disponibile, non ha senso chiedere di correggere dati già corretti.

Designers Italia indica che i messaggi di errore dovrebbero aiutare a capire problema e soluzione senza colpevolizzare la persona. Nell’esempio fittizio, “Inserisci il codice di autorizzazione per richiedere questo kit” è più utile di “Hai sbagliato la compilazione”. La formulazione esatta dipende però dalla causa che il sistema sa effettivamente riconoscere.

Prevedi anche il dubbio sull’invio. Se il numero non compare, il lettore deve sapere come verificare lo stato prima di duplicare la richiesta. Non scrivere “premi ancora” come soluzione generale. Chiarisci quali azioni sono reversibili e quali possono produrre un secondo invio, sulla base del comportamento reale del servizio.

Rendi visibili i rami senza appesantire il percorso ordinario

Se un’eccezione riguarda poche persone, collocala accanto al punto in cui cambia la procedura. “Se richiedi un kit speciale” deve precedere il codice, non interrompere ogni passo con una parentesi. Se il ramo alternativo è lungo, può avere una sezione propria, collegata con un criterio chiaro di scelta.

Usa elenchi numerati per le azioni in sequenza e punti elenco per materiali che non hanno un ordine. Un titolo come “Dopo l’invio” permette di trovare conferme e tempi senza rileggere tutto. Evita titoli generici ripetuti, come “Altre informazioni”, quando puoi nominare il dubbio concreto a cui la sezione risponde.

Il controllo di leggibilità può segnalare un passaggio linguisticamente pesante, ma non verifica prerequisiti o funzioni. Un testo con frasi brevi può essere inutilizzabile se manca l’unico documento necessario. Usa la misura come supporto della revisione, mantenendo separata la prova di esecuzione della procedura.

Verifica il percorso e registra ciò che osservi

Per un servizio reale, fai partire una persona pertinente dalle condizioni indicate e osserva se raggiunge il risultato senza spiegazioni aggiuntive. Se devi intervenire, annota il punto e la domanda emersa. Non attribuire la difficoltà automaticamente a una lettura distratta: potrebbe mancare un’informazione o esserci una divergenza fra testo e ambiente.

Controlla almeno il percorso ordinario e le alternative che descrivi. Se una parte non è stata provata, registrala come non verificata. Una revisione del testo da sola non dimostra l’esito di un invio, l’accessibilità dell’interfaccia o il funzionamento di un messaggio di recupero. La documentazione deve distinguere questi controlli.

Dopo una modifica del servizio, riesamina etichette, condizioni e risultato finale. Un’immagine vecchia o un nome cambiato possono rendere ambigua una procedura prima chiara. Conserva una data di revisione legata a controlli effettivi. L’obiettivo è consentire il compito con meno incertezze, mantenendo la promessa delle istruzioni allineata a ciò che il servizio fa davvero.