Quando si parla di sviluppo software, è impossibile non parlare di bug. E, quando ci sono bug, ci sono segnalazioni di bug.
In questo blog esploreremo l'aspetto di una segnalazione di bug ben scritta, come puoi scrivere una segnalazione di bug che aiuterà i tuoi team a trovare e correggere gli errori in modo rapido e semplice. E infine, come Vmaker può aiutarti a ridurre il tempo e l'energia spesi per creare una segnalazione di bug.
Cos'è una buona segnalazione di bug?
In generale, una buona segnalazione di bug è qualcosa di preciso, efficace e semplice, ma sufficientemente dettagliato da consentire al tuo team di identificare rapidamente il problema e risolverlo senza alcun problema.
Se riesci a scrivere una buona segnalazione di bug, è più probabile che i tuoi problemi vengano risolti.
Ora che hai un'idea approssimativa di una buona segnalazione di bug, ingrandiamo rapidamente gli aspetti necessari per fare una buona segnalazione e alcune altre cose da tenere a mente per condividere feedback utili.
Titolo
Mantienilo breve e preciso. Come qualsiasi altro tipo di segnalazione, la tua segnalazione di bug dovrebbe avere un titolo che dia un'idea chiara del tuo problema, della sua posizione o categoria. Avere un nome chiaro rende più facile per il tuo team trovare il bug in un secondo momento e apportare modifiche.
Non valido:"Ho fatto clic sul pulsante Procedi nella home page, ma non risponde. Puoi risolvere questo problema?"
Il problema con l'esempio sopra è che è vago e non specifica la posizione del problema. Ad esempio, nella home page possono essere presenti più pulsanti "procedi".
Buono:barra di navigazione (home page):il pulsante Procedi non risponde
Questo è nitido e chiaro e specifica la posizione del problema.
Riepilogo
Se non sei in grado di spiegare tutto con il titolo, fai un riassunto. Questo riepilogo dovrebbe essere scritto in modo tale che il lettore possa sapere esattamente cosa sta succedendo e quale parte o caratteristica del software è interessata.
Cattivo: "Ieri stavo cercando di accedere dalla home page, ma dopo aver cliccato sul pulsante non è successo nulla."
Buono: "Ieri [DATE] ho provato ad accedere dalla home page facendo clic sul pulsante di accesso su [LOCATION], ma non è successo nulla."
Prova visiva
Indipendentemente dalla precisione con cui scrivi il rapporto, l'aggiunta di prove visive come uno screenshot, insieme al riepilogo, aiuterà il tuo team a comprendere il rapporto più velocemente.
Dettagli sull'ambiente
C'è sempre la possibilità che tu stia affrontando il problema del bug a causa dell'ambiente del tuo computer locale, quindi è sempre utile menzionare il tuo ambiente informatico nella tua segnalazione. Puoi citare cose come:
- L'hardware del tuo dispositivo e la sua modalità
- Sistema operativo
- L'account con cui hai effettuato l'accesso
- La versione dell'app
Passaggi per la riproduzione
Qui scriverai dei passaggi che hai eseguito che hanno attivato il bug, in modo che gli sviluppatori possano seguire lo stesso e testarlo da soli.
Passaggio 1:apri la home page
Passaggio 2:fai clic sul menu a discesa nella barra di navigazione
Fase 3:inserisci il tuo indirizzo email e fai clic sul pulsante Procedi
Risultati previsti
In questa sezione parlerai di cosa ti aspettavi quando hai seguito i passaggi. Cerca di essere il più chiaro possibile e ricorda che è sempre utile per gli sviluppatori sapere cosa sarebbe dovuto accadere invece di cosa non sarebbe dovuto accadere.
Risultati effettivi
Qui parlerai di ciò che è realmente accaduto quando hai seguito i passaggi. Di seguito è riportato un esempio del risultato atteso ed effettivo.
Risultato atteso:avrei dovuto essere indirizzato alla pagina del giocatore quando ho cliccato sul pulsante Procedi.
Risultato effettivo:quando ho fatto clic sul pulsante Procedi, è apparso un messaggio di "errore"
Priorità
Se hai più problemi di bug, puoi dire al tuo team di sviluppo a quale dare la priorità valutando i bug in base alla loro gravità.
Alta priorità:correggi il pulsante Procedi
Priorità media:correggi la pagina del giocatore
Bassa priorità:correggi l'URL danneggiato
URL sorgente
Un elemento essenziale ma facile da dimenticare è l'URL di origine. Questo aiuterà gli sviluppatori a navigare più velocemente, il che renderà più veloce l'individuazione del problema e farà risparmiare molto tempo a tutti!
Esempio di segnalazione di bug
Puoi fare clic qui per scaricare il modello .
Come si scrive una segnalazione di bug?
Ora che sei a conoscenza di tutti gli aspetti essenziali per scrivere una buona segnalazione di bug, puoi utilizzare il modello sopra e iniziare a scrivere la tua segnalazione di bug.
Dedica un po' di tempo a questo compito perché questo sarà il principale punto di comunicazione tra te e il tuo team.
Guida ai bonus: Integra Vmaker con Gmail, Github, Gitlab e Jira
Scrivere un rapporto come questo può essere facile quando il problema è minore e sei bravo con le parole, ma immagina il contrario. Quando il problema del bug è complesso e le parole non bastano.
Fortunatamente, Vmaker è qui per aiutarti. Come? Passiamo rapidamente alla sezione successiva per questo.
Ecco come Vmaker può semplificarti la vita
A volte, quando un problema di bug è complesso, potrebbe essere necessario scrivere più contenuti, il che può richiedere molto tempo e noioso. E ci sono buone probabilità che tu perda chiarezza mentre scrivi rapporti così lunghi.
Anche se finisci il tuo rapporto, che potrebbe essere nitido e chiaro dal tuo punto di vista, ci sono buone probabilità che il tuo team possa percepirlo in modo diverso. E con questo, puoi entrare in un ciclo avanti e indietro
Se guardi all'intero processo, dalla stesura del rapporto al tuo team alla ricerca del bug e alla sua risoluzione, si sprecano così tanto tempo ed energie.
È qui che Vmaker può aiutarti. Vmaker è uno strumento di registrazione dello schermo gratuito che consente di registrare un video del problema relativo al bug e inviarlo al tuo team. Invece di scrivere lunghi rapporti, puoi registrare la tua voce per condividere maggiori dettagli sul bug; questo è facile, meno dispendioso in termini di tempo e veloce per il tuo team per comprendere il problema.
Viene fornito con una funzione di annotazione, utilizzando la quale puoi evidenziare i dettagli sullo schermo e comunicare meglio.
Vmaker include anche una funzionalità dell'area di lavoro, in cui puoi tenere traccia di tutte le tue segnalazioni di bug mentre collabori con il tuo team.
Con Vmaker, segnalare un bug è facile come 1 2 3. Basta aprire l'app Vmaker, registrare il bug e condividere il collegamento video con il tuo team.
Se ti è piaciuto leggere l'articolo di cui sopra, ecco alcuni altri articoli che potresti essere interessato a leggere ulteriormente!
Come registrare Google Meet
Come registrare lo schermo su iPhone
Il miglior registratore dello schermo per Mac
Come registrare Zoom Meeting con audio
Come registrare lo schermo su Mac