Un șablon de bug report
pe care îl poți copia.
Un șablon bun de bug report îl duce pe programator de la citit la reprodus dintr-o singură trecere: ce s-a întâmplat, ce trebuia să se întâmple, pașii și locul. Copiază șablonul de mai jos într-un document, într-un formular sau într-un issue tracker, sau pune aceleași câmpuri pe un panou care primește și fișierele.
Șablonul de bug report
Șapte întrebări. Cere titlul și pașii; restul lasă-le opționale.
Titlu
Ce nu merge și unde. O singură frază.
Exemplu: Exportul în CSV descarcă un fișier gol
Ce s-a întâmplat?
Ce ai văzut, în una sau două fraze.
Ce te așteptai să se întâmple?
Ce ar fi trebuit să se întâmple în loc.
Pași de reproducere
1.
2.
3.
Cât de des?
De fiecare dată, uneori sau o singură dată.
Unde?
Browserul sau versiunea aplicației, sistemul de operare, contul sau spațiul de lucru.
Ai ceva de arătat?
O captură de ecran, o înregistrare a ecranului, un log, un fișier HAR.
Un exemplu de bug report
Același șablon, completat. Produsul și cifrele sunt inventate.
Titlu
Exportul în CSV descarcă un fișier gol
Ce s-a întâmplat?
Am dat clic pe Export în pagina Rapoarte. S-a descărcat un fișier,
dar are doar rândul de antet.
Ce te așteptai să se întâmple?
Cele 214 rânduri afișate în tabelul de pe ecran.
Pași de reproducere
1. Deschide Rapoarte și alege ultimele 30 de zile.
2. Filtrează după planul „Scale”.
3. Dă clic pe Export, apoi pe CSV.
Cât de des?
De fiecare dată cu filtrul pornit. Fără filtru, exportul merge.
Unde?
Chrome 141 pe macOS 15. Spațiul de lucru: northwind.
Ai ceva de arătat?
export.csv (fișierul gol), reports.har
La ce folosește fiecare câmp
- Titlul. Ce nu merge și unde, ca raportul să poată fi găsit din nou și duplicatele să se întâlnească.
- Ce s-a întâmplat? Simptomul, cu cuvintele celui care raportează, înainte ca cineva să-l interpreteze.
- Ce te așteptai? Jumătate din rapoarte sunt o neînțelegere, iar acest rând arată care jumătate.
- Pașii de reproducere. Partea pe care un programator n-o poate ghici. Numerotați, câte o acțiune pe pas.
- Cât de des? „De fiecare dată” arată spre logică; „uneori” arată spre sincronizare sau date.
- Unde? Browserul, versiunea și contul restrâng căutarea mai mult decât orice descriere.
- Ai ceva de arătat? O înregistrare sau un log ține loc de trei paragrafe.
Cum transformi șablonul într-un formular de raportare a bugurilor
Un formular de raportare a bugurilor ar trebui să ceară mai puțin decât șablonul. Fiecare câmp obligatoriu costă câteva rapoarte, iar un raport lipsă costă mai mult decât un detaliu lipsă.
- Cere titlul și pașii de reproducere, nimic altceva.
- Pune un exemplu în textul ajutător al fiecărui câmp, ca oamenii să vadă nivelul de detaliu pe care îl vrei.
- Arată rapoartele asemănătoare înainte de trimiterea formularului, ca oamenii să adauge un vot, nu un duplicat.
- Lasă oamenii să atașeze fișiere trăgându-le peste formular.
- Spune ce urmează: unde apare raportul și cum vor primi răspunsul.
Ce să atașezi la un bug report
Dovezile scurtează conversația. Acestea sunt fișierele care merită cerute și ce lămurește fiecare.
- O captură de ecran, pentru orice e vizual.
- O înregistrare a ecranului în MP4, când pașii sunt greu de pus în cuvinte.
- Un fișier HAR, când o pagină nu se încarcă, nu salvează sau nu exportă.
- Un log din consolă sau de pe server, ca TXT sau LOG.
- E-mailul în sine, ca EML, pentru probleme de livrare și de formatare.
- Fișierul CSV, XLSX sau JSON care nu s-a putut importa, sau cel care a ieșit greșit.
Colectarea bug reporturilor pe un panou Kjerr
Un panou Kjerr poate pune întrebările șablonului și poate păstra dovezile. Ce este nou, echipa vede acolo unde se face gestionarea feedbackului.
- Formularul este editabil: adaugă câmpuri proprii „Pași de reproducere”, „Ce te așteptai” și „Unde”, până la 10 câmpuri în total, fiecare obligatoriu sau opțional, cu propriul text ajutător.
- Până la 5 fișiere de câte 10 MB pe un raport sau un comentariu: imagini, PDF, EML, TXT, LOG, CSV, JSON, HAR, ZIP, DOCX, XLSX, PPTX și MP4.
- Rapoartele asemănătoare apar în timp ce se scrie titlul, fiecare cu un buton de vot.
- Pentru un panou de QA, fă-l doar pentru membri și limitează autentificarea la domeniul de e-mail al companiei; e aceeași configurare ca la o cutie de sugestii online.
- Când statusul trece pe Shipped, cel care a raportat și toți cei care au votat primesc un e-mail.
- Nu este un issue tracker: fără persoane responsabile, niveluri de severitate sau sprinturi.
Întrebări, răspunsuri simple.
Ce este un șablon de bug report?
Un șablon de bug report este un set fix de întrebări care scoate aceleași fapte din fiecare raport: ce s-a întâmplat, ce se aștepta, pașii de reproducere și unde a apărut problema. Îi permite programatorului să treacă de la citit la reprodus fără o rundă de întrebări.
Ce ar trebui să conțină un bug report, adică un raport de eroare?
Un titlu într-o frază, ce s-a întâmplat și ce se aștepta, pași de reproducere numerotați, cât de des apare, mediul și dovezi, de exemplu o captură de ecran sau un log. Dacă doar două lucruri pot fi obligatorii, să fie titlul și pașii.
Care este diferența dintre un bug report și un feature request?
Un bug report spune că produsul nu face ce promite. Un feature request cere ceva ce produsul n-a promis niciodată. Cer întrebări diferite; pentru al doilea, folosește șablonul de feature request.
Cum scriu bine pașii de reproducere?
Pornește de la o stare la care poate ajunge oricine, scrie câte o acțiune pe rând și pune valorile exacte pe care le-ai tastat sau ales. Oprește-te la pasul în care apare problema. Dacă un pas e nevoie uneori și uneori nu, spune-o.
Ce este un fișier HAR și ar trebui să-l atașez?
Un fișier HAR este o înregistrare a cererilor făcute de o pagină web, salvată din instrumentele pentru dezvoltatori ale browserului. Atașează unul când o pagină nu se încarcă, nu salvează sau nu exportă. Verifică-l mai întâi: poate conține cookie-uri de sesiune și date personale.
Poate Kjerr să înlocuiască un bug tracker?
Nu. Kjerr adună rapoartele, elimină duplicatele și le spune celor care au raportat când statusul se schimbă. Nu are persoane responsabile, niveluri de severitate sau sprinturi și nici sincronizare cu Jira sau Linear. Echipele îl folosesc ca ușă de intrare și își țin issue trackerul în spatele ei.
Pagini înrudite
Dă-le utilizatorilor un răspuns.
În perioada de acces anticipat, Kjerr este gratuit: toate funcționalitățile, fără card de credit. Când vor apărea planurile plătite, vor fi tarifate per spațiu de lucru, niciodată per administrator.