Questa è una guida per scrivere segnalazioni di bug efficaci in Discourse, al fine di massimizzare le possibilità che i bug vengano risolti.
Livello utente richiesto: Chiunque può segnalare un bug
Scrivere una buona segnalazione di bug è essenziale per aiutare il team di Discourse a risolvere i problemi in modo efficiente. Questa guida ti accompagnerà attraverso i passaggi e le migliori pratiche per assicurarsi che la tua segnalazione sia chiara, concisa e azionabile.
Riepilogo
In questa documentazione tratteremo:
- L’importanza di fornire passaggi riproducibili e dettagli specifici
- Come descrivere il problema e il comportamento atteso
- Le migliori pratiche per le segnalazioni su diverse piattaforme
- Mantenere un tono appropriato nella tua segnalazione
- Errori comuni e soluzioni
Passaggi per scrivere una segnalazione di bug efficace
Priorità/Gravità
Determina l’urgenza della correzione del bug. Sebbene tutti desiderino che i propri problemi vengano risolti rapidamente, riserva la priorità più alta ai problemi critici che impattano significativamente la funzionalità.
Piattaforma
Specifica sempre l’ambiente in cui è stato osservato il bug. Questo include:
- Tipo di dispositivo (desktop, mobile, touchscreen, tablet)
- Sistema operativo e la sua versione
- Browser web e la sua versione
Se possibile, riproduci il bug su più piattaforme per confermarne la presenza.
Descrizione
Sii conciso. Descrivi il problema in modo semplice e senza dettagli non necessari. Separa i problemi diversi se possono essere segnalati individualmente. Un formato di descrizione chiaro include:
Risultato effettivo: Cosa sta succedendo?
Risultato atteso: Cosa avrebbe dovuto succedere?
Evita supposizioni su ciò che il lettore già conosce. Sii esplicito su ciò che avrebbe dovuto essere visto o verificato.
Passaggi riproducibili
Assicurati che il bug possa essere riprodotto in modo coerente. Scrivi istruzioni passo dopo passo partendo dalla schermata iniziale di Discourse. Se il bug appare in modo casuale, specifica con quale frequenza si verifica (ad esempio, 1 volta su 10 tentativi). Per i bug relativi all’interfaccia utente (UI) e all’esperienza utente (UX), aggiungi screenshot o video per chiarezza.
Tono
Mantieni un tono rispettoso e gentile. Evita di utilizzare la segnalazione del bug per esprimere frustrazione. Qualsiasi linguaggio o comportamento tossico può comportare il ritardo o l’ignorare della tua segnalazione.
Modello
Utilizza questo modello per avviare rapidamente un nuovo argomento di segnalazione di bug:
Priorità/Gravità:
Piattaforma:
Descrizione:
Passaggi riproducibili:
Migliori pratiche
- Riproduci in Modalità Sicura: Prima di segnalare, prova a riprodurre il problema nella Modalità Sicura di Discourse se sospetti che le personalizzazioni possano essere la causa.
- Metti in discussione le supposizioni: Le segnalazioni di bug derivano spesso da false supposizioni. Anche nella tua segnalazione, metti in discussione e chiarisci eventuali supposizioni che potresti aver fatto.
- Sii dettagliato: Per bug elusivi o rari, fornisci il maggior numero possibile di dettagli. Inserisci qualsiasi cosa pensi possa essere correlata, come messaggi di errore o file di log.
Problemi comuni e soluzioni
Problema: Impossibile riprodurre il bug in modo coerente.
Soluzione: Documenta l’ambiente e le condizioni in cui appare il bug. Segnala eventuali schemi o somiglianze.
Problema: Mancanza di risposta a una segnalazione di bug.
Soluzione: Assicurati che la tua segnalazione sia dettagliata ma concisa e scritta con un tono cortese.
Domande frequenti (FAQ)
D: Cosa faccio se non ho tempo per una segnalazione dettagliata?
R: È comunque utile aprire una segnalazione con le informazioni che hai. Indica che la aggiornerai con più dettagli in seguito.
D: Dove dovrei pubblicare la mia segnalazione di bug?
R: Utilizza la categoria appropriata: le segnalazioni di bug devono andare nella categoria Contribute > Bug.