Questa è una guida per scrivere segnalazioni di bug efficaci in Discourse per massimizzare le possibilità che i bug vengano corretti.
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 assicurarti che la tua segnalazione di bug sia chiara, concisa e attuabile.
Sommario
In questa documentazione, tratteremo:
- L’importanza di fornire passaggi riproducibili e dettagli specifici
- Come descrivere il problema e il comportamento atteso
- Migliori pratiche per segnalare su diverse piattaforme
- Mantenere un tono appropriato nella tua segnalazione
- Fraintendimenti comuni e soluzioni
Passaggi per scrivere una segnalazione di bug efficace
Priorità/Gravità
Determina l’urgenza della correzione del bug. Sebbene tutti vogliano che i loro problemi vengano risolti rapidamente, riserva la priorità più alta per i problemi critici che influiscono significativamente sulla 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 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 sa già. Sii esplicito su ciò che avrebbe dovuto essere visto o accaduto.
Passaggi riproducibili
Assicurati che il bug possa essere riprodotto in modo coerente. Scrivi istruzioni passo-passo a partire dalla schermata iniziale di Discourse. Se il bug appare casualmente, specifica la frequenza con cui si verifica (ad esempio, 1 tentativo su 10). Per i bug relativi all’interfaccia utente/esperienza utente (UI/UX), aggiungi screenshot o video per maggiore chiarezza.
Tono
Mantieni un tono rispettoso ed educato. Evita di usare la segnalazione di bug per esprimere frustrazione. Qualsiasi linguaggio o comportamento tossico può comportare ritardi o l’ignoranza della tua segnalazione.
Modello
Usa questo modello per avviare rapidamente un nuovo argomento di segnalazione di bug:
Priorità/Gravità:
Piattaforma:
Descrizione:
Passaggi riproducibili:
Migliori Pratiche
- Riproduci in Modalità Provvisoria (Safe Mode): Prima di segnalare, prova a riprodurre il problema in Modalità Provvisoria (Safe Mode) di Discourse se sospetti che le personalizzazioni possano essere la causa.
- Metti in Discussione le Ipotesi: Le segnalazioni di bug spesso derivano da ipotesi errate. Anche nella tua segnalazione, metti in discussione e chiarisci qualsiasi ipotesi tu possa avere.
- Sii Dettagliato: Per i bug sfuggenti o rari, fornisci quanti più dettagli possibili. Includi tutto ciò che pensi possa essere correlato, 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 il bug appare. Prendi nota di eventuali schemi o elementi comuni.
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.
FAQ
D: Cosa succede se non ho tempo per una segnalazione dettagliata?
R: È comunque utile aprire una segnalazione con le informazioni che hai. Indica che la aggiornerai con maggiori dettagli in seguito.
D: Dove devo pubblicare la mia segnalazione di bug?
R: Usa la categoria appropriata: le segnalazioni di bug devono essere inserite nella categoria bug.