← Back to front page

Ohjeita hyvän virheraportin kirjoittamiseen

Sivut on rikki”, “Palvelu ei toimi

Kuulostaako tutulta? Puutteelliset taustatiedot ja tehtävänannot vaikeuttavat virheiden (bugien) korjaamista niin sovelluskehityksessä kuin asiakaspalvelun käsittelemissä tehtävissä. Yhdelle ihmiselle palvelun rikkoontuminen voi tarkoittaa sitä, että koko palvelu ei enää vastaa sivupyyntöihin. Toiselle palvelu taas on “rikki” jo siinä vaiheessa, kun yksi sivu on kadonnut tai jokin valikko näyttää hieman erilaiselta kuin ennen. Yhteistä kummallekin tapaukselle on, että ilman muuta taustatietoa virheen korjaaja jää helposti ihmettelemään, mistä oikeastaan on kyse ja mitä hänen oletetaan korjaavan.

Olen koonnut tähän kirjoitukseen kymmenen perusohjetta hyvän virheraportin kirjoittamiseen. Näiden ohjeiden avulla helpotat ja nopeutat virheen korjaamista. Ohjeet on kirjoitettu peruskäyttäjän ja testaajan näkökulmasta.

1. Kerro miten virhe toistui.

Liitä raporttiin lyhyt askeleittainen kuvaus siitä mitä olit tekemässä ja miten päädyit virhetilanteeseen. Kerro mikä oli odotettu lopputulos ja mitä tapahtui sen sijaan. Tämä on tärkeää, koska ensimmäinen vaihe virheen korjaamisessa on sen toistaminen ja todentaminen. Mitä tarkemmin voit kertoa virheeseen johtaneet tapahtumat, sitä helpompi virhe on toistaa. Monesti virheen syy löytyy todella pienistä asioista tapahtumaketjussa.

2. Kerro ympäristöstä ja laitteistosta

Erityisesti verkkopalveluiden tapauksessa käytetyn selaimen ja laitteen tiedot ovat ensiarvoisen tärkeitä. Monet virheet toistuvat vain tietyillä selaimilla, niiden versioilla tai esimerkiksi vain puhelinta tai tablettia käytettäessä. Tiedoiksi riittää esimerkiksi “iPhone 5, iOS7” tai “Windows 7, IE10”.

3. Ota ruutukaappaus

Kuva kertoo enemmän kuin tuhat sanaa ja tämä pätee varsinkin virheiden korjaamisessa. “Kuva on vinksallaan” tai “valikko näyttää oudolta” jättää pelkästään sanallisesti kerrottuna liikaa tulkinnanvaraa. Ruutukaappaus ja selitys samasta asiasta kertoo korjaajalle yksiselitteisesti mistä on kyse. Ota tarvittaessa useampia kuvakaappauksia ja merkitse virheet niihin kuvankäsittelyohjelmassa.

4. Ota osoite talteen

Kopioi selaimen osoiteriviltä se osoite missä virhe tapahtui ja liitä se virheraporttiin. Näin korjaajalle ei jää epäselväksi missä palvelussa tai missä kohtaa tiettyä palvelua virhe tapahtuu.

5. Kerro käyttäjätunnuksesi

Monet virhetilanteet liittyvät virheisiin käyttäjätunnuksissa ja käyttöoikeuksissa. Jos palvelu, jossa virhe tapahtui edellyttää sisäänkirjautumista, kerro mitä tunnusta käytit. Älä kuitenkaan koskaan paljasta salasanaasi. Jos tiedät tarkemmin palvelun käyttöoikeusmäärittelyistä, kerro myös mihin käyttäjäryhmiin tunnuksesi kuuluu.

6. Määritä vakavuusaste

Useimmat tehtävänhallintajärjestelmät mahdollistavat virheen vakavuusasteen (prioriteetin) määrittelyn. Vakavuusasteen määrittelystä selviää maalaisjärjellä. Virheet, jotka estävät koko palvelun tai jonkin sen kriittisen toiminnon käyttämisen saavat korkean prioriteetin. Käyttöliittymän lähinnä kosmeettisille virheille taas riittää matalampi prioriteetti. Kaikkien virheiden määrittely kriittisiksi aiheuttaa vain sen, että oikeasti vakavat ja kiireistä korjausta vaativat virheet hukkuvat tehtävämassaan.

7. Tarkista onko virhe jo tiedossa

Jos mahdollista, tarkista että virhettä ole jo raportoitu aikaisemmin. Jos käytät tehtävänhallintajärjestelmää (esim. Jira), käytössäsi on tehokkaat hakutyökalut, joilla voit hakea aiempia virheilmoituksia.

8. Ota virheilmoitus tai lokimerkintä talteen

Jos toimit testaajana ja sinulla on pääsy esimerkiksi palvelimen ja sovelluksen lokitietoihin, etsi sieltä virheen tapahtumisen aikaiset merkinnät. Jos merkinnöissä on jotain virheeseen viittaavaa, kopioi olennainen pätkä lokia talteen ja liitä se virheraporttiin. Jos et pääse lukemaan lokitiedostoja, mutta saat näkyville virheilmoituksen suoraan käyttöliittymään, ota se talteen samalla tavalla tai sisällytä se ruutukaappaukseen. Näin helpotat varsinkin sovelluskehittäjän työtä.

9. Kerro virheen syy ja korjausehdotus

Jos saat itse selville tai tiedät jo valmiiksi virheen syyn, kerro se virheraportilla. Jos tiedät miten virhe korjataan tai miten se kannattaisi korjata, kerro se.

10. Käytä selkeää kieliasua

Käytä tarkkoja ilmaisuja ja ilmaise asiasi selkeästi. “Valikko on huonossa kohtaa” ei kerro mikä kyseisessä kohdassa on huonoa, eikä sitä mikä sille olisi hyvä kohta. Raporteissa ei myöskään kannata raivota, vaikka niitä kirjoittaessa voi monesti olla hankala tilanne päällä. Raivoaminen ei kuitenkaan auta virheen syyn selvittämistä ja korjaamista.

Leave a Reply

  • (will not be published)

Time limit is exhausted. Please reload CAPTCHA.

Please, leave us a message and we'll contact you.
You can also contact our Service Desk by phone +358 290 010 500 or email servicedesk@ambientia.fi.