how write good bug report
Perché una buona segnalazione di bug?
Se la tua segnalazione di bug è efficace, le sue possibilità di essere risolta sono più alte. Quindi correggere un bug dipende dall'efficacia con cui lo segnali. Segnalare un bug non è altro che abilità e ti spiego come ottenerla.
'Lo scopo di scrivere un rapporto sui problemi (rapporto sui bug) è ottenere la correzione dei bug' - Di Cem Kaner. Se un tester non segnala correttamente un bug, il programmatore molto probabilmente rifiuterà questo bug dichiarandolo irriproducibile.
Questo può danneggiare la morale dei tester e talvolta anche l'ego. (Suggerisco di non mantenere alcun tipo di ego. L'ego dice 'Ho segnalato il bug correttamente', 'Posso riprodurlo', 'Perché ha rifiutato il bug?', 'Non è colpa mia' ecc. ,).
Cosa imparerai:
- Quali sono le qualità di una buona segnalazione di bug software?
- Segnalazione di bug efficace
- Come segnalare un bug?
- Caratteristiche importanti nella segnalazione dei bug
- Alcuni suggerimenti bonus per scrivere una buona segnalazione di bug
- Conclusione
- Lettura consigliata
Quali sono le qualità di una buona segnalazione di bug software?
Chiunque può scrivere una segnalazione di bug. Ma non tutti possono scrivere una segnalazione di bug efficace.
Dovresti essere in grado di distinguere tra una segnalazione di bug media e una buona segnalazione di bug. Come distinguere tra un bug Report buono e uno cattivo? È molto semplice, applica le seguenti caratteristiche e tecniche per segnalare un bug.
Le caratteristiche e le tecniche includono
# 1) Avere un numero di bug chiaramente specificato: Assegna sempre un numero univoco a ogni segnalazione di bug. Questo, a sua volta, ti aiuterà a identificare il record di bug. Se stai utilizzando uno strumento di segnalazione di bug automatizzato, questo numero univoco verrà generato automaticamente ogni volta che segnali il bug.
Annota il numero e una breve descrizione di ogni bug che hai segnalato.
# 2) riproducibile: Se il tuo bug non è riproducibile, non verrà mai risolto.
Dovresti menzionare chiaramente i passaggi per riprodurre il bug. Non dare per scontato o saltare alcun passaggio di riproduzione. Un bug descritto passo dopo passo è facile da riprodurre e correggere.
# 3) Sii specifico: Non scrivere un saggio sul problema.
Sii specifico e conciso. Cerca di riassumere il problema in parole minime ma in modo efficace. Non combinare più problemi anche se sembrano essere simili. Scrivi rapporti diversi per ogni problema.
Segnalazione di bug efficace
La segnalazione di bug è un aspetto importante del test del software. Un bug report efficace comunica bene con il team di sviluppo ed evita confusione o cattiva comunicazione.
Una buona segnalazione di bug dovrebbe essere chiaro e conciso senza punti chiave mancanti. Qualsiasi mancanza di chiarezza porta a incomprensioni e rallenta anche il processo di sviluppo. La scrittura e la segnalazione dei difetti è una delle aree più importanti ma trascurate nel ciclo di vita dei test.
Una buona scrittura è molto importante per segnalare un bug. Il punto più importante che un tester dovrebbe tenere a mente è non usare un tono di comando nella relazione. Questo rompe il morale e crea un rapporto di lavoro malsano. Usa un tono suggestivo.
Non dare per scontato che lo sviluppatore ha commesso un errore e quindi puoi usare parole dure. Prima di segnalare, è altrettanto importante controllare se lo stesso bug è stato segnalato o meno.
Un bug duplicato è un peso nel ciclo di test. Controlla l'intero elenco di bug noti. A volte, gli sviluppatori potrebbero aver conosciuto il problema e ignorato per una versione futura. Possono essere utilizzati anche strumenti come Bugzilla che cerca automaticamente bug duplicati. Tuttavia, è meglio cercare manualmente qualsiasi bug duplicato.
come inizializzare un array di oggetti in java
Le informazioni di importazione che una segnalazione di bug deve comunicare sono 'Come?' e dove?' Il rapporto dovrebbe rispondere chiaramente a come è stato eseguito il test e dove si è verificato esattamente il difetto. Il lettore dovrebbe riprodurre facilmente il bug e scoprire dove si trova.
Tieni presente che il file obiettivo di scrivere la segnalazione di bug è consentire allo sviluppatore di visualizzare il problema. Lui / lei dovrebbe capire chiaramente il difetto dalla segnalazione di bug. Ricordati di fornire tutte le informazioni rilevanti che lo sviluppatore sta cercando.
Inoltre, tieni presente che una segnalazione di bug verrebbe conservata per un uso futuro e dovrebbe essere ben scritta con le informazioni richieste. Usa frasi significative e parole semplici per descrivere i tuoi bug. Non utilizzare affermazioni confuse che fanno perdere tempo al revisore.
Segnala ogni bug come un problema separato. In caso di più problemi in una singola segnalazione di bug, non è possibile chiuderla a meno che non siano stati risolti tutti i problemi.
Quindi è meglio dividere i problemi in bug separati . Ciò garantisce che ogni bug possa essere gestito separatamente. Un bug report ben scritto aiuta uno sviluppatore a riprodurre il bug sul proprio terminale. Questo li aiuta anche a diagnosticare il problema.
Come segnalare un bug?
Utilizza il seguente semplice modello di segnalazione di bug:
Questo è un semplice formato di segnalazione di bug. Può variare a seconda dello strumento di segnalazione dei bug che stai utilizzando. Se stai scrivendo una segnalazione di bug manualmente, alcuni campi devono essere menzionati specificamente come il numero di bug, che dovrebbe essere assegnato manualmente.
Reporter: Il tuo nome e indirizzo email.
Prodotto: In quale prodotto hai trovato questo bug.
Versione: La versione del prodotto, se presente.
Componente: Questi sono i principali sottomoduli del prodotto.
Piattaforma: Menziona la piattaforma hardware in cui hai trovato questo bug. Le varie piattaforme come 'PC', 'MAC', 'HP', 'Sun' ecc.
Sistema operativo: Indica tutti i sistemi operativi in cui hai trovato il bug. Sistemi operativi come Windows, Linux, Unix, SunOS, Mac OS. Indica le diverse versioni del sistema operativo come Windows NT, Windows 2000, Windows XP ecc., Se applicabile.
Priorità: Quando dovrebbe essere corretto un bug? La priorità è generalmente impostata da P1 a P5. P1 come 'correggi il bug con la massima priorità' e P5 come 'Correggi quando il tempo lo permette'.
Gravità: Questo descrive l'impatto del bug.
Tipi di gravità:
software di backup gratuito per Windows 7
- Blocker: Non è possibile eseguire ulteriori test.
- Critico: Arresto anomalo dell'applicazione, perdita di dati.
- Maggiore: Grande perdita di funzionalità.
- Minore: Minore perdita di funzionalità.
- Banale: Alcuni miglioramenti dell'interfaccia utente.
- Aumento: Richiedi una nuova funzionalità o qualche miglioramento in quella esistente.
Stato: Quando si accede al bug in qualsiasi sistema di tracciamento dei bug, per impostazione predefinita lo stato del bug sarà 'Nuovo'.
Successivamente, il bug passa attraverso varie fasi come Risolto, Verificato, Riapertura, Non risolto, ecc.
=> Clicca qui per saperne di più sul ciclo di vita dettagliato dei bug.
Assegnato a: Se sai quale sviluppatore è responsabile di quel particolare modulo in cui si è verificato il bug, puoi specificare l'indirizzo email di quello sviluppatore. Altrimenti tienilo vuoto poiché questo assegnerà il bug al proprietario del modulo, altrimenti il Manager assegnerà il bug allo sviluppatore. Eventualmente aggiungi l'indirizzo email del manager nell'elenco CC.
URL: L'URL della pagina in cui si è verificato il bug.
Sommario: Un breve riassunto del bug principalmente in 60 parole o meno. Assicurati che il tuo riepilogo rifletta qual è il problema e dove si trova.
Descrizione: Una descrizione dettagliata del bug.
Utilizza i seguenti campi per il campo della descrizione:
- Riprodurre i passaggi: Chiaramente, menziona i passaggi per riprodurre il bug.
- Risultato atteso: Come dovrebbe comportarsi l'applicazione nei passaggi sopra indicati.
- Risultato attuale: Qual è il risultato effettivo dell'esecuzione dei passaggi precedenti, ovvero il comportamento del bug.
Questi sono i passaggi importanti nella segnalazione di bug. Puoi anche aggiungere il 'Tipo di rapporto' come un altro campo che descriverà il tipo di bug.
I tipi di rapporto includono:
1) Errore di codifica
2) Errore di progettazione
3) Nuovo suggerimento
4) Emissione della documentazione
5) Problema hardware
Caratteristiche importanti nella segnalazione dei bug
Di seguito sono riportate le caratteristiche importanti nella segnalazione di bug:
# 1) Numero bug / ID
Un numero di bug o un numero di identificazione (come swb001) rende la segnalazione di bug e il riferimento a un bug molto più semplice. Lo sviluppatore può facilmente verificare se un particolare bug è stato corretto o meno. Rende l'intero processo di test e ripetizione più agevole e semplice.
# 2) Titolo del bug
Un titolo di bug viene letto più spesso di qualsiasi altra parte della segnalazione di bug. Dovrebbe dire tutto su ciò che viene fornito nel bug.
Il titolo del bug dovrebbe essere abbastanza suggestivo da consentire al lettore di comprenderlo. Un titolo chiaro del bug lo rende facile da capire e il lettore può sapere se il bug è stato segnalato in precedenza o è stato risolto.
# 3) Priorità
In base alla gravità del bug, è possibile impostare una priorità per esso. Un bug può essere un Blocker, Critical, Major, Minor, Trivial o un suggerimento. È possibile assegnare una priorità di bug da P1 a P5 in modo che quelli importanti vengano visualizzati per primi.
# 4) Piattaforma / Ambiente
La configurazione del sistema operativo e del browser è necessaria per una chiara segnalazione di bug. È il modo migliore per comunicare come è possibile riprodurre il bug.
Senza la piattaforma o l'ambiente esatti, l'applicazione potrebbe comportarsi in modo diverso e il bug alla fine del tester potrebbe non replicarsi da parte dello sviluppatore. Quindi è meglio menzionare chiaramente l'ambiente in cui è stato rilevato il bug.
# 5) Descrizione
La descrizione del bug aiuta lo sviluppatore a capire il bug. Descrive il problema riscontrato. La cattiva descrizione creerà confusione e farà perdere tempo agli sviluppatori e anche ai tester.
È necessario comunicare chiaramente l'effetto della descrizione. È sempre utile utilizzare frasi complete. È una buona pratica descrivere ogni problema separatamente invece di sbriciolarli del tutto. Non utilizzare termini come 'penso' o 'credo'.
# 6) Passaggi da riprodurre
Una buona segnalazione di bug dovrebbe menzionare chiaramente i passaggi da riprodurre. I passaggi dovrebbero includere azioni che causano il bug. Non fare dichiarazioni generiche. Sii specifico nei passaggi da seguire.
Di seguito viene fornito un buon esempio di procedura ben scritta
Passaggi:
- Seleziona il prodotto Abc01.
- Fare clic su Aggiungi al carrello.
- Fare clic su Rimuovi per rimuovere il prodotto dal carrello.
# 7) Risultato atteso ed effettivo
Una descrizione del bug è incompleta senza i risultati attesi ed effettivi. È necessario delineare qual è il risultato del test e cosa dovrebbe aspettarsi l'utente. Il lettore dovrebbe sapere qual è il risultato corretto del test. Chiaramente, menziona cosa è successo durante il test e qual è stato il risultato.
# 8) Screenshot
Un'immagine vale più di mille parole. Scatta uno screenshot dell'istanza di errore con i sottotitoli appropriati per evidenziare il difetto. Evidenzia i messaggi di errore imprevisti con un colore rosso chiaro. Questo attira l'attenzione sull'area richiesta.
Alcuni suggerimenti bonus per scrivere una buona segnalazione di bug
Di seguito sono riportati alcuni ulteriori suggerimenti per scrivere una buona segnalazione di bug:
# 1) Segnala immediatamente il problema
Se trovi qualche bug durante il test, non è necessario attendere per scrivere un rapporto dettagliato sul bug più tardi. Invece, scrivi immediatamente la segnalazione di bug. Ciò garantirà una segnalazione di bug buona e riproducibile. Se decidi di scrivere la segnalazione di bug in seguito, ci sono alte probabilità di perdere i passaggi importanti della segnalazione.
# 2) Riprodurre il bug tre volte prima di scrivere una segnalazione di bug
Il tuo bug dovrebbe essere riproducibile. Assicurati che i tuoi passaggi siano abbastanza robusti da riprodurre il bug senza alcuna ambiguità. Se il tuo bug non è riproducibile ogni volta puoi comunque segnalare un bug menzionando la natura periodica del bug.
# 3) Prova la stessa occorrenza di bug su altri moduli simili
A volte lo sviluppatore utilizza lo stesso codice per diversi moduli simili. Quindi ci sono maggiori possibilità che il bug in un modulo si verifichi anche in altri moduli simili. Puoi anche provare a trovare la versione più grave del bug che hai trovato.
# 4) Scrivi un buon sommario dei bug
Il riepilogo dei bug aiuterà gli sviluppatori ad analizzare rapidamente la natura del bug. Un rapporto di scarsa qualità aumenterà inutilmente i tempi di sviluppo e test. Comunica bene con il riepilogo della segnalazione di bug. Tieni presente che il riepilogo del bug viene utilizzato come riferimento per cercare il bug nell'inventario dei bug.
# 5) Leggi la segnalazione di bug prima di premere il pulsante Invia
Leggi tutte le frasi, le diciture e i passaggi utilizzati nella segnalazione di bug. Verifica se una frase crea ambiguità che possono portare a interpretazioni errate. Parole o frasi fuorvianti dovrebbero essere evitate per avere una chiara segnalazione di bug.
cos'è una chiave di sicurezza di rete
# 6) Non utilizzare un linguaggio offensivo
È bello che tu abbia svolto un buon lavoro e trovato un bug, ma non usare questo credito per criticare lo sviluppatore o per attaccare qualcuno.
Conclusione
Non c'è dubbio che la tua segnalazione di bug dovrebbe essere un documento di alta qualità.
Concentrati sulla scrittura di buone segnalazioni di bug e dedica un po 'di tempo a questa attività perché questo è il principale punto di comunicazione tra il tester, lo sviluppatore e il manager. I manager dovrebbero creare la consapevolezza del loro team che scrivere un buon rapporto sui bug è la responsabilità primaria di qualsiasi tester.
Il tuo sforzo per scrivere un buon rapporto sui bug non solo salverà le risorse dell'azienda, ma creerà anche un buon rapporto tra te e gli sviluppatori.
Per una migliore produttività scrivi una migliore segnalazione di bug.
Sei un esperto nello scrivere una segnalazione di bug? Sentiti libero di condividere i tuoi pensieri nella sezione commenti qui sotto.
Lettura consigliata
- Esempio di segnalazione di bug
- Come trovare un bug nell'applicazione? Suggerimenti e trucchi
- Come scrivere un rapporto sullo stato settimanale del test del software
- Che cos'è il ciclo di vita di difetti / bug nei test del software? Tutorial sul ciclo di vita dei difetti
- Come si risolvono tutti i bug senza l'etichetta 'Bug non valido'?
- Esempi di report di bug per applicazioni Web e di prodotto
- Come scrivere un rapporto di riepilogo del test efficace (Download del rapporto di esempio)
- Perché la segnalazione dei bug è un'arte che dovrebbe essere appresa da ogni tester?