Virhekuvaus

Virhekuvaus on virheen tai epäyhtenäisyyden yksiselitteinen kuvaus, jonka tarkoituksena on antaa kehitystiimille tiedot ongelman ymmärtämiseksi, toistamiseksi ja korjaamiseksi. Se toimii kommunikaationa testersin tai käyttäjän ja kehittäjän välillä ja auttaa määrittämään virheen laajuuden sekä prioriteetin.

Yleensä virhekuvaus sisältää seuraavat tiedot: otsikko tai tiivistelmä, kuvaus virheestä, ympäristö- ja version tiedot (käyttöjärjestelmä, sovellusversio, laite), toistettavuuden luonteen kuvaus, vaiheet virheen toistamiseksi, odotettu tulos ja todellinen tulos, sekä mahdolliset lisätiedot kuten virhekoodi, lokit, näyttökuvat tai videot. Lisäksi merkitään virheen vakavuus sekä prioriteetti, ja annetaan mahdolliset liitteet sekä viittaukset liittyviin tehtäviin tai korjaustoimenpiteisiin.

Parhaat käytännöt virhekuvauksessa ovat: kirjoittaa selkeä, yksiselitteinen otsikko; antaa reproduktioasteen mukaan yksityiskohtaiset, toistettavat vaiheet; väistää oletuksia ja epäselvyyksiä, käyttää täsmällistä terminologiaa sekä kontekstia (esim. ohjelmistoversio, ympäristö, data). Kuvaus tulisi olla erillään oletuksista ja keskittyä siihen, mitä todistetusti tapahtuu. Tarvittaessa jaat tiedot liitteiksi (lokit, virhekoodit, näyttökuvat) ja käytät standardoituja kategorisointeja sekä merkkijonoja virheen luokittelemiseksi. Virhekuvauksia käsitellään yleensä bug-seurantajärjestelmissä, kuten Jira tai YouTrack, joissa ne muuntuvat tehtäväksi tai virheilmoitukseksi.

Esimerkkipohja:

Otsikko: Näyttökaatuminen kirjautumisen yhteydessä Android-sovelluksessa

Kuvaus: Kun yritän kirjautua tietyllä käyttäjätunnuksella, sovellus sulkeutuu äkillisesti.

Odotettu tulos: Näytölle avautuu pääsyruutu.

Todellinen tulos: Sovellus sulkeutuu.

Ympäristö: Android 12, sovellusversio 2.3.4, Pixel 5.

Toistettavuus: 3/3 kerran.

Vaiheet: 1) Avaa sovellus 2) Mene Kirjaudu sisään 3) Syötä tunnus ja salasana 4) Paina Kirjaudu.

Liitteet: crash log, näyttökuva.