Hogyan írjunk olyan hibajelentést, ami tényleg segít

Az esetek többségében a fejlesztők hiányos hibajelentéseket kapnak, melyekből nem tudnak kiindulni. 

A rossz hibajelentések pedig onnan erednek, hogy az átlagos felhasználó általában nem tudja, milyen információk segítenek a fejlesztőknek a leggyorsabban kijavítani a hibát.


Alább található egy útmutató, mely segít ebben, és mely könnyen érthető mindenki számára.




Ne féljetek terjeszteni ezeket az információkat, különösen, ha egy kevés hasznos információt tartalmazó hibajelentést kaptok.


Hibajelentő sablon


  1. Cím
  2. Lépések a megismétléséhez*
  3. Kapott és elvárt viselkedés
  4. Képernyőfelvétel vagy képernyőkép
  5. Rendszerinformáció*
  6. Felhasználói azonosító [ha releváns]
  7. Hatás [ha ismert]


*Bizonyos képernyőfelvevő eszközök automatikusan mellékelik ezen információkat


Hogyan használjuk ezt a sablont


A legfontosabb dolog, amit meg kell érteni egy hibajelentő írásánál, hogy az olvasónak tudnia kell reprodukálni a hibát a saját számítógépén, csupán a megadott információk segítségével. Bár nem mindig lehetséges a hiba megismétlése, de az a legjobb, ha a lehető legtöbb információt nyújtjuk.



Cím


Röviden írjuk le a problémát, pl.: „Számológép: hibás eredmény szorzásnál”. Próbáld meg tömören, de pontosan megadni. Például a „Hibás nyitóoldal” cím nem segít az olvasónak megérteni, hogy a problémát már mások is jelentették-e, illetve hogy pontosan mi a probléma. Nem elérhető? Az elrendezés csúszott el? Csak egy elírás az egyik címben?


Lépések a megismétléséhez


Írd le, hogy pontosan mit csináltál, mielőtt belefutottál a hibába. Kinézhet nagyjából így:


  1. Menj a példa.com weboldalra
  2. Kattints rá az A gombra
  3. Válaszd ki a B opciót
  4. Írd be, hogy 123
  5. Nyomd meg az entert


A legjobb, ha te magad is megpróbálod reprodukálni a hibát, hogy biztos lehess benne, hogy az általad leírt lépések tényleg elvezetnek hozzá.


Kapott és elvárt viselkedés


Specifikáld, hogy a tevékenységeid hatására mi volt az eredmény, és hogy ez miben különbözik attól, amit vártál, hogy történni fog. Példa:

„X dolognak kellett volna történnie, ehelyett én egy 404-es Page Not Found hibát kaptam.”



Képernyőfelvétel vagy képernyőkép


Rengeteg képernyőfelvevő eszköz közül tudsz választani. A Mac felhasználók használhatják a QuickTime-ot (a tutorialért kattints ide), vagy a Shift-Command-5 billentyűkombinációt. A Windows 10-en pedig rendelkezésre áll az Xbox alkalmazás (a tutorialért kattints ide).


A hibajelentő felvétel készítésének egy gyorsabb módja, ha egy erre specializált eszközt használunk. A videóval együtt automatikusan felveszi a technikai információkat is, melyek segítenek a mérnököknek sokkal gyorsabban megtalálni és kijavítani a hibát. Ennek használatával nem kell törődnöd a rendszerinformációk és a lépések melléklésével sem – automatikusan dokumentálva lesznek. Hogy találj egy neked megfelelő eszközt, nyisd meg a Chrome Store-t, keress rá a „screen recording” kulcsszóra, és válassz egyet, ami a hibákra van kihegyezve.



Bizonyos esetekben (pl.: elírás a főoldalon) nem szükséges videót készíteni – egy képernyőkép is bőven elegendő. Ennek elkészítéséhez szintén található beépített eszköz a legtöbb operációs rendszeren. Macen itt, Windowson pedig itt megtalálod, hogyan tudsz képernyőképet készíteni.


Rendszerinformáció


  1. Operációs rendszer (verziószámmal együtt): Ha nem tudod, hol találod meg ezt az információt, kattints ide
  2. Böngésző (verziószámmal együtt): Klikkelj ide, ha nem tudod hol keresd.
  3. Eszköz: PC / Tablet / Mobil
  4. Idő (időzónával együtt): Legalább egy közelítőleges időpont, amikor belefutottál a hibába.


Felhasználói azonosító [ha releváns]


Ha te, vagy a hiba bejelentője be volt jelentkezve a hiba felfedezésénél, akkor mellékeld a felhasználói fiók azonosítóját is. Ez általában vagy a felhasználónév, vagy az e-mail cím.


Hatás [ha ismert]


Amennyiben tudod, hogy hány emberre van hatással a hiba, vagy mennyi bevétel esik ki miatta, mindenképp írd bele ezt az információt is. Ez segíteni fog a fejlesztőknek és a menedzsereknek felállítani a megfelelő prioritást.


Végső gondolatok


Ha azt szeretnéd, hogy a te, vagy az ügyfeled problémáját gyorsan elhárítsák, próbálj meg egy jó hibajelentőt írni – egy olyat, ami megkönnyíti a hiba reprodukálását a megadott információ segítségével. Minél többet tudnak a fejlesztők, annál gyorsabban meg tudják majd oldani.



Nem ritka, hogy a csapatok az alábbiakhoz hasonló jelentéseket kapnak:



Ha lehet, ezeket mindenképpen kerüljétek. Mindenkinek jobb lesz, neked és a hibát javítóknak is.


(Forrás)

***
Ha Te is kreatív, kihívásokkal teli mérnök állást keresel minőségi munkáltatónál, jó helyen jársz, mert a Schönherz Bázis épp azért jött létre, hogy Neked segítsen.
Gyere, nézz szét aktuális állásaink között!


2020.01.08.