Hogyan írjunk jó hibabejelentést, sablonnal
Egy jó hibabejelentés alapján a fejlesztő egyetlen kérdés nélkül reprodukálni tudja a problémát. Ez az útmutató elmagyarázza, mit érdemes beleírni, ad egy másolható sablont, és bemutatja azokat a hibákat, amelyek megnehezítik a javítást.
Mitől jó egy hibabejelentés?
Egy jó hibabejelentés konkrét, reprodukálható és teljes. Egyetlen problémát ír le, elmagyarázza, hogyan idézhető elő, megmondja, mi lett volna a várt eredmény, és tartalmazza a környezetet, amelyben a hiba jelentkezett. Aki elolvassa, megnyitja az oldalt, és egy percen belül látja a hibát.
Egy jó hibabejelentés nyolc része
- Cím. Rövid összefoglaló arról, mi a hiba és hol. A „Pénztár – a Fizetés gomb mobilon nem csinál semmit” jobb, mint a „Hiba a pénztárban”.
- Az oldal címe. A pontos URL, ahol a probléma jelentkezik.
- A reprodukálás lépései. Számozott lépések egy ismert kiindulópontból.
- Várt eredmény. Minek kellett volna történnie.
- Tényleges eredmény. Mi történt helyette, a pontos hibaüzenettel, ha van ilyen.
- Környezet. Böngésző és verziója, operációs rendszer, eszköz, képernyő- vagy ablakméret, be van-e jelentkezve, és a felhasználói szerepkör.
- Bizonyíték. Képernyőkép a probléma megjelölésével, vagy működési problémáknál rövid képernyőfelvétel.
- Technikai adatok. Konzolhibák és sikertelen hálózati kérések, ha hozzáférhetők.
Ha csapata használ prioritást, adja meg azt is, például kritikus (egy fő funkciót blokkol, nincs kerülőút), magas, normál vagy alacsony.
Hibabejelentő sablon
Másolja ezt a sablont a hibakövető rendszerébe, e-mailbe vagy chatbe.
Title: [Area] - [what is wrong]
Page: https://
Steps to reproduce:
1.
2.
3.
Expected result:
Actual result:
Environment: [browser + version], [operating system], [device], [window size]
Logged in as: [role or "not logged in"]
Evidence: [screenshot / recording]
Console errors / failed requests: [if available]
Priority: [critical / high / normal / low]
Példa
Title: Product page - price shows "12.9" without the euro sign
Page: https://shop.example/coffee/autumn-roast
Steps to reproduce:
1. Open the product page
2. Choose the 250 g variant
Expected result: the price shows "€12.90"
Actual result: the price shows "12.9"
Environment: Chrome 131, macOS 15, 1440 x 900 window
Logged in as: not logged in
Evidence: screenshot attached
Console errors: none
Priority: high (visible to every customer)
Gyakori hibák
- Több probléma egy bejelentésben. Ezeket különböző időpontokban javítják, tesztelik és zárják le; jelentse be őket külön.
- Nincsenek lépések. A „Nem működik” nem reprodukálható. Induljon egy ismert oldalról, és sorolja fel az összes kattintást.
- Hiányzó környezet. Sok elrendezési hiba csak egy bizonyos ablakméretnél vagy egyetlen böngészőben jelentkezik.
- Képernyőképek kontextus nélkül. Jelölje meg a problémát, és legyen rajta a címsor, vagy adja meg az oldal címét.
- Vélemény tényként. A „Csúnya a kék” módosítási kérés, nem hiba. Írja le, mit szeretne helyette.
Bízza a részleteket egy eszközre
A környezet és a konzolhibák kézi összegyűjtése fárasztó, és könnyen elmarad. Egy vizuális hibabejelentő eszköz ezeket automatikusan rögzíti. A mumusban a bejelentő a hibás elemre kattint, és megírja a címet, a lépéseket és a várt eredményt; a képernyőkép, az oldal címe, a böngésző, az ablakméret, a konzolhibák és a sikertelen kérések automatikusan hozzáadódnak.
Gyakori kérdések
Mit kell tartalmaznia egy hibabejelentésnek?
Egyértelmű címet, az oldal címét, a reprodukálás számozott lépéseit, a várt és a tényleges eredményt, a környezetet (böngésző, operációs rendszer, eszköz, ablakméret, felhasználói szerepkör), egy képernyőképet vagy felvételt, valamint ha hozzáférhetők, a konzolhibákat és a sikertelen hálózati kéréseket.
Hogyan írjuk le egy hiba reprodukálásának lépéseit?
Induljon egy ismert állapotból, például egy oldalcímből és abból, hogy be van-e jelentkezve, majd sorolja fel számozott lépésként az összes műveletet, amíg a probléma meg nem jelenik. A bejelentés elküldése előtt egyszer próbálja ki maga is a lépéseket.