Documentare i messaggi di errore: creare una segnalazione utile all’assistenza

Una buona segnalazione distingue osservazioni e supposizioni. Registra messaggio, ora, ambiente e passaggi sicuri per riprodurre il problema senza condividere dati riservati. Questa guida non dipende dal sistema operativo; i nomi delle finestre della versione variano in base al programma.

1. Registrare l’incidente

Annota data, ora e fuso orario, applicazione interessata e versione esatta. Aggiungi versione del sistema operativo, tipo di dispositivo e ultimo funzionamento corretto noto. Scrivi “sconosciuto” invece di indovinare le informazioni mancanti. Descrivi l’impatto: un file, un utente o più postazioni?

2. Descrivere con precisione errore e passaggi

  1. Copia, se possibile, messaggio completo e codice. Altrimenti acquisisci uno screenshot e trascrivi anche il testo. Non tradurre né abbreviare il codice di errore.
  2. Numera le azioni fino all’errore: stato iniziale, file o funzione aperta, pulsante preciso e risultato. Usa nomi neutri per i file quando necessario.
  3. Separa risultato previsto e risultato osservato. Scrivi “Salva mostra l’errore X” anziché “Il server è guasto”, finché la causa non è dimostrata.
  4. Indica se l’errore avviene sempre, occasionalmente o una sola volta. Ripeti solo passaggi sicuri con dati di prova o una copia. Non ripetere pagamenti, eliminazioni o operazioni con rischio di perdita dati per riprodurre il problema.

3. Prove e tentativi precedenti

Aggiungi le modifiche note poco prima dell’errore e le misure già provate, con il risultato di ciascuna. Non modificare più impostazioni contemporaneamente. Proteggi il registro originale; condividi solo gli estratti necessari dell’intervallo pertinente. Un evento contemporaneo è un indizio, non la prova della causa.

4. Controllare prima dell’invio

Rimuovi password, token di sessione, dati personali e contenuti riservati dalla copia da inviare. Controlla anche barra degli indirizzi, percorsi e sfondo degli screenshot. Un rettangolo sovrapposto in un file modificabile non garantisce la rimozione sicura. Riapri l’allegato finale e controlla il risultato. Usa il canale di assistenza previsto e verifica destinatario e allegati; non pubblicare pacchetti diagnostici completi non controllati in un forum.

Modello da copiare

  • Titolo breve e impatto:
  • Data, ora, fuso orario:
  • Applicazione/versione, sistema operativo/versione, dispositivo:
  • Stato iniziale e passaggi numerati:
  • Previsto / osservato:
  • Messaggio completo e codice:
  • Frequenza, ultimo successo, modifiche note:
  • Tentativi precedenti / risultato di ciascuno:
  • Allegati verificati e privi di dati riservati:

Controllo finale: un’altra persona dovrebbe comprendere la sequenza senza chiedere i passaggi basilari. Segnala separatamente i problemi indipendenti.

Fonte

Mozilla: Bug Writing Guidelines – base per passaggi precisi, risultati chiari e segnalazioni separate; il controllo della riservatezza integra la procedura generale di assistenza.