Come scrivere un buon messaggio di errore: le regole da seguire
scritto martedì 07 Novembre 2023
I messaggi di errore nei software sono una parte essenziale della storia dell'informatica. Sin dagli albori dell'informatica, quando i computer erano enormi macchine a schede perforate, è stato necessario sviluppare modi per comunicare agli utenti quando si verificavano errori o problemi nei calcoli. Ecco una panoramica storica:
- Le origini: i primi computer non avevano monitor o schermi come li conosciamo oggi. Invece, gli errori venivano segnalati attraverso stampanti e segnali acustici. Ad esempio, il famoso "bip" delle macchine IBM mainframe segnalava errori nell'elaborazione dei dati.
- Schermi di testo: con l'avvento dei computer personali negli anni '70 e '80, sono stati introdotti schermi di testo che potevano mostrare messaggi di errore direttamente agli utenti. Questi messaggi spesso erano semplici e criptici, ma segnalavano l'errore.
- Interfaccia utente grafica (GUI): con la diffusione delle interfacce utente grafiche negli anni '80 e '90, i messaggi di errore sono diventati più visivamente ricchi e comprensibili. Le finestre di dialogo popup con icone e testi più descrittivi sono diventate comuni.
- Linguaggi di programmazione moderni: con lo sviluppo di linguaggi di programmazione moderni e strumenti di sviluppo, i programmatori hanno potuto personalizzare i messaggi di errore e fornire informazioni più dettagliate. Ciò ha contribuito a semplificare la risoluzione dei problemi da parte degli sviluppatori.
- Internet e applicazioni web: con la crescita di internet e delle applicazioni web, i messaggi di errore sono diventati ancora più importanti. Gli sviluppatori di siti web e applicazioni web hanno dovuto trovare modi per comunicare in modo chiaro gli errori di connessione, di accesso o di dati mancanti agli utenti.
- Focus sull'usabilità: negli ultimi anni, c'è stato un maggiore focus sull'usabilità dei messaggi di errore. Le migliori pratiche ora includono la chiarezza, la gentilezza, la fornitura di soluzioni quando possibile e un supporto intuitivo per aiutare gli utenti a risolvere i problemi.
In breve, i messaggi di errore nei software hanno subito una notevole evoluzione dalla loro concezione iniziale, passando da indicatori acustici o stampati a messaggi di errore visivamente ricchi e informativi. La loro importanza continua a crescere con l'aumento della complessità del software e delle applicazioni, sottolineando la necessità di una comunicazione efficace con gli utenti quando si verificano problemi.
Ecco le regole da seguire per scrivere un buon messaggio di errore.
- Sii chiaro e conciso: il messaggio di errore dovrebbe essere diretto e facilmente comprensibile. Evita linguaggio ambiguo o frasi complesse.
- Usa un linguaggio amichevole: cerca di evitare un tono accusatorio o punitivo. Usa un linguaggio gentile e rispettoso per aiutare l'utente a sentirsi a suo agio.
- Identifica il problema: spiega chiaramente quale errore è stato rilevato. Ad esempio, "Errore di connessione" o "File non trovato."
- Fornisci una breve descrizione: aggiungi una breve descrizione del motivo per cui si è verificato l'errore. Ad esempio, "Impossibile connettersi al server. Controlla la connessione Internet."
- Suggerisci una soluzione: se possibile, suggerisci almeno una soluzione o una serie di passaggi per risolvere l'errore. Ad esempio, "Riavvia l'applicazione" o "Verifica le tue credenziali di accesso."
- Usa codici di errore: se appropriato, include un codice di errore univoco che gli sviluppatori possono utilizzare per identificare il problema in modo più specifico.
- Mostra la posizione dell'errore: se il software è complesso o ha molte funzionalità, indica all'utente dove si è verificato l'errore o quale azione lo ha causato.
- Offri un contatto per il supporto: se il problema non può essere risolto dall'utente, fornisci un contatto per il supporto tecnico o un link a ulteriori risorse.
- Evita termini tecnici e acronimi: se possibile, evita termini tecnici o acronimi che l'utente potrebbe non comprendere. Usa un linguaggio semplice e accessibile.
- Fornisci un pulsante "OK" o "Chiudi": includi un pulsante o un'opzione per chiudere il messaggio di errore. Assicurati che l'utente possa proseguire senza dover riavviare l'applicazione.
- Testa il messaggio di errore: prima di rilasciare il software, testa il messaggio di errore per assicurarti che sia accurato e che fornisca informazioni utili.
Ecco un esempio di come potrebbe apparire un messaggio di errore ben scritto:
Errore di connessione Impossibile connettersi al server. Controlla la connessione Internet e riprova. [Verifica la connessione] [Contatta il supporto]
In generale tutti i messaggi di errore devono fornire guida e indicazioni alla soluzione del problema.
L'ottimo sarebbe evitare che si arrivi al messaggio di errore, ovvero il sistema deve impedire all'operatore di arrivare al messaggio di errore.
Ad esempio: se inserisco un cliente con una partita iva errata sarebbe meglio avvertirlo prima di dare OK all'inserimento.