Hibabejelentés: lépések, elvárt és tényleges eredmény

A hibát nevezd meg a címben

Az „Elromlott az egész” nem azonosít egy vizsgálható jelenséget. A „Mentés után újranyitva üres a Cím mező” már megmutatja a műveletet, az érintett részt és a tapasztalt eltérést. Ez még nem állítja, mi romlott el a háttérben.

A Mozilla hibabejelentési útmutatója pontos megismétlési lépéseket, valamint külön elvárt és tényleges eredményt kér. Ezek a nyelvi szempontok más programok leírásánál is használhatók. A programhoz tartozó további követelményeket az adott hibabejelentő felület alapján kell kitölteni.

Saját, megismételhető lépéssor

• Kiinduló állapot: megnyitottam az Új jegyzet űrlapot.
• 1. A Cím mezőbe beírtam: Próba.
• 2. Megnyomtam a Mentés gombot. Megjelent a Mentve felirat.
• 3. Visszaléptem a jegyzetlistára, és onnan újranyitottam ugyanezt a bejegyzést.
• Elvárt eredmény: a Cím mezőben továbbra is a Próba szöveg látható.
• Tényleges eredmény: a Cím mező üresen jelent meg.

Az alábbi kitalált példa egy jegyzetkészítő felületre vonatkozik. A teszthez létrehozott bejegyzésnek nincs valódi ügyféladata.

A megfigyelés és a magyarázat külön mondatba kerüljön

A fenti próba az üresen megjelenő mezőt írja le. Ebből önmagában nem tudjuk, hogy a program nem tárolta az adatot, nem olvasta vissza, vagy más megjelenítési hiba történt. A „törlődött az adatbázis” mondat ennél jóval többet állítana.

Ha van feltevésed, jelöld feltevésként, és add mellé a megfigyelést, amely miatt felmerült. A hibaüzenet szövegét pontosan másold át. Ha egy képernyőkép csak a végeredményt mutatja, a hozzá vezető műveleteket szövegben is sorold fel.

Az előfordulást a kipróbált körhöz kösd

A „három próbából kétszer üresen jelent meg” pontosabb, mint a „mindig üres”. Add meg az ellenőrzött programváltozatot és környezetet, ha ezek ismertek és a vizsgálat szempontjából fontosak. Egy másik eszköz működéséről ne következtess olyan próbából, amely csak a sajátodon történt.

A bejelentés végén ellenőrizd, hogy a leírt lépésekből semmi lényeges nem maradt-e ki. Az olyan fordulatokat, mint „aztán a szokásos módon”, bontsd ki konkrét műveletté. A jó leírás segíti a vizsgálatot; a hiba okának feltárása és a javítás ellenőrzése további munka.