Come Scrivere un Bug Report (+ Modello Gratuito da Scaricare)
Saper creare una segnalazione di bug efficace è una parte fondamentale del lavoro di un tester software per garantire l’assicurazione qualità, perciò dedichiamo molto tempo a registrare bug nei nostri strumenti di tracciamento. Trovare un bug può essere entusiasmante, specialmente se riguarda uno scenario interessante. Ma il modo in cui lo segnaliamo può essere importante quanto il suo impatto sul sistema.
Una segnalazione di bug scritta male può causare molta frizione tra i membri del team, in particolare tra tester e sviluppatori, creando ostacoli alla risoluzione dei problemi e, in ultima analisi, peggiorando l’esperienza utente.
In questo articolo, condividerò dettagli essenziali, come:
Want more from The CTO Club?
Create a free account to finish this piece and join a community of CTOs and engineering leaders sharing real-world frameworks, tools, and insights for designing, deploying, and scaling AI-driven technology.
Have an account? Log In
- Diventa un Maestro delle Segnalazioni: Scopri gli elementi chiave che ogni segnalazione efficace deve includere per migliorare la comunicazione e velocizzare le correzioni.
- Migliora l’Armonia del Team: Scopri come una segnalazione dettagliata previene frizioni tra tester e sviluppatori, portando a flussi di lavoro più fluidi.
- Template Gratuito Scaricabile: Scarica gratuitamente un modello di tracciamento bug per avviare subito il tuo processo di segnalazione.
Elementi Chiave di una Segnalazione di Bug
Non importa il tipo di applicazione che stai testando, che sia desktop, web, mobile o un progetto API, ci sono alcuni elementi fondamentali che ogni buona segnalazione di bug dovrebbe contenere. La maggior parte dei software di tracciamento bug prevede campi per questi elementi, tra cui:
- ID: Se utilizzi uno strumento di gestione progetti come Jira, un ID verrà assegnato automaticamente ad ogni nuova segnalazione aperta. Esistono anche strumenti di test management per Jira dedicati al tracciamento dei bug.
- Titolo/Descrizione: Una breve descrizione del problema. Deve essere concisa per essere facilmente leggibile, ma anche abbastanza descrittiva da far capire agli altri dove si trova il problema. Ad esempio, “l’ordinamento per prezzo non funziona quando è applicato un filtro.”
- Passaggi per riprodurre: Includi qui quanti più dettagli rilevanti possibili. Assicurati che chiunque cerchi di riprodurre il problema o verificare la correzione possa farlo semplicemente seguendo i passaggi. Non saltare passaggi dando per scontato che tutti sappiano implicitamente che devono eseguire certe azioni anche se non sono menzionate; inseriscile nella segnalazione.
- Risultati attesi: Ancora una volta, non dare per scontato che le persone sappiano già come dovrebbe funzionare l’applicazione. Ovviamente, se compare un’eccezione nell’interfaccia quando premi un pulsante, sai che non è il comportamento previsto. Tuttavia, non direi che il risultato atteso sia "l’eccezione non viene generata", ma piuttosto quale azione dovrebbe compiere il pulsante, ad esempio, "si apre la finestra delle impostazioni".
- Risultati effettivi: È autoesplicativo—dovresti descrivere cosa accade nell’applicativo una volta completati tutti i passaggi di riproduzione.
- Severità: Rappresenta l’impatto che il bug ha sul sistema in test (AUT).
- Priorità: Con quale urgenza il bug dovrebbe essere risolto. Un’impostazione a priorità alta implica che il bug debba essere gestito con precedenza nel backlog e corretto prima.
Altre Informazioni Importanti Da Includere
Oltre agli elementi sopra menzionati, possono esserci altre informazioni rilevanti, specialmente quando si inseriscono dati in uno strumento di segnalazione bug. Possono dipendere dal tipo di progetto, dai requisiti, o anche dal bug stesso:
- Versione del software: Il numero di build in cui il bug è stato identificato. Questo può aiutare a isolare le versioni in cui il problema è stato introdotto e a individuare il codice che l’ha causato.
- Allegati: Potrebbero non essere sempre necessari o disponibili, ma in genere sono molto utili. Fornisci screenshot o registrazioni del problema riscontrato, file di log, stack trace, richieste e risposte di rete, ecc.
- Dati di test: A volte, i bug rilevati si presentano solo con determinati insiemi di dati. In tal caso, assicurati di includerli, sia nei passaggi per riprodurre (ad esempio, “accedi con user andreea@theqalead.com”) sia in un campo specifico del tracker.
- Dettagli sull’ambiente: Se il bug si verifica solo su uno specifico sistema operativo, browser o ambiente di sviluppo, menzionalo.
Consigli Per Scrivere Una Buona Segnalazione di Bug
- Limita ogni segnalazione a un solo bug. Se scopri più bug nelle stesse aree, puoi collegarli al tuo sistema di tracciamento. Includere più di un difetto può causare confusione e ritardi nella possibile correzione dei bug.
- Verifica nel tuo sistema di tracciamento che il bug non sia già stato segnalato. Se è già aperto, aggiungi eventuali dettagli rilevanti che hai trovato e che non sono stati inseriti nella segnalazione originale.
- Cerca di riprodurre il bug più di una volta. Puoi provare a trovare il modo più breve per riprodurlo (utilizzando il minor numero di passaggi possibile).
- Non perderti in dettagli irrilevanti. Il bug report e i passaggi devono essere facili da leggere e seguire.
- Non fare supposizioni sul motivo per cui si verifica il bug (a meno che tu non sia sicuro al 100% di cosa l'abbia causato).
Template per la Segnalazione Bug
Ora vorrei condividere con te alcuni modelli per la segnalazione dei bug. Puoi copiarli o modificarli in base alle esigenze del tuo progetto.
Template di Tracciamento Bug per Jira
Jira è uno strumento di tracciamento delle segnalazioni molto diffuso realizzato da Atlassian. Se il tuo team lo utilizza, il tipo di segnalazione "bug" è probabilmente già configurato. Come tester o come manager di un team di sviluppo software, puoi impostare un workflow di tracciamento dei bug per il ciclo di vita delle segnalazioni (questa funzionalità è una delle caratteristiche dei software di tracciamento).
Puoi anche aggiungere campi personalizzati in Jira, ad esempio per l’ambiente o per un campo unico dove inserire la funzionalità testata. Oppure puoi aggiungere una descrizione predefinita che contenga tutte le informazioni che desideri siano incluse in ogni segnalazione bug. Eccone una che ho creato:
Ora, quando voglio creare una nuova segnalazione bug, avrò queste informazioni già compilate. Ecco il mio template per i bug su Jira, con campi personalizzati e una descrizione di default:
Include le informazioni essenziali che abbiamo detto devono essere sempre presenti:
- Un titolo (“Bug di esempio”)
- All’interno della descrizione: precondizioni, passaggi per la riproduzione, risultati attesi vs risultati effettivi
- Un campo personalizzato per l’ambiente
- Un livello di gravità e una priorità, selezionabili tramite menu a discesa con valori preimpostati
- Ho lasciato il campo “assegnatario” vuoto. A seconda delle convenzioni di progetto, i nuovi bug possono essere assegnati automaticamente a un membro specifico del team, oppure chi inizia a lavorarci può assegnarselo
- Un'etichetta—può essere utile, ad esempio, per tracciare quale funzionalità è impattata
- Una data di scadenza—potrebbe non essere definita finché il backlog non è stato prioritizzato
- Il segnalatore (in questo caso si autopopola con l’utente Jira che ha creato il bug)
Facoltativamente, Jira offre numerose integrazioni e il bug può essere collegato a casi di test, branch Git o anche pull request.
Puoi anche usare il loro modello di tracciamento bug come template di progetto se ti serve Jira solo per la gestione dei difetti e non lavori in un ambiente agile.
Template di Tracciamento Bug in Excel
Alcuni team possono utilizzare i fogli di calcolo come sistema di tracciamento bug. Li trovo utili per progetti molto piccoli, dove configurare uno strumento apposito non vale la pena, oppure per segnalare bug su nuove funzionalità ancora in sviluppo.
Puoi usare Google Sheets/Docs, o Microsoft Excel/Word – in ogni caso, un template per i bug potrebbe essere simile a questo:
Le colonne riflettono le informazioni che la segnalazione dovrebbe contenere:
- L'ID (Excel saprà come incrementare automaticamente il valore ogni volta che viene aggiunta una nuova riga)
- Un titolo
- I passaggi per riprodurre il problema
- Risultati attesi e reali
- Il nome del segnalatore
- La gravità e la priorità del bug—qui ho utilizzato dei menu a discesa perché i valori dovrebbero essere preimpostati
- Ambiente
- Informazioni aggiuntive: Questo campo è per tutto ciò che vale la pena menzionare e che non rientra nelle altre colonne
Considerazioni finali
Scrivere una buona segnalazione di bug è una competenza essenziale per i tester software, quindi fai particolare attenzione alle buone pratiche spiegate sopra. Puoi anche fare affidamento sugli esempi di template di bug tracker che ho fornito. Possono essere adattati ai diversi strumenti che utilizzi, come Trello o Asana.
Se ti è piaciuto questo contenuto, iscriviti alla newsletter di The QA Lead per rimanere aggiornato su novità e tendenze nel processo di test del software!
