Virheraportti
Virheraportti on ohjelmistossa tai palvelussa havaitun virheen, poikkeaman tai epätoimivan toiminnon sekä sen kontekstin dokumentointi. Se toimii keskeisenä työkaluna virheidenhallinnassa ja laadunvarmistuksessa, ja sen tavoitteena on helpottaa virheen toistamista, analysointia, priorisointia ja korjaamista sekä vähentää vastaavien ilmentymien määrää.
- Otsikko: lyhyt, kuvaava nimi virheelle.
- Kuvaus: objektiivinen selostus virheestä ja sen vaikutuksesta.
- Askeleet toistettavuuteen: tarkat ohjeet siitä, miten virhe saadaan esille.
- Odotettu tulos ja todellinen tulos: mitä pitäisi tapahtua ja mitä oikeasti tapahtuu.
- Ympäristö: käyttöjärjestelmä, sovellus- tai firmware-versio, laite, selain, verkko-olosuhteet ja muut relevantet tekijät.
- Toistokerrat: kuinka usein virhe ilmenee.
- Vaikutus: vakavuus tai prioriteetti sekä mahdollinen liiketoiminnallinen vaikutus.
- Liitteet: virheilmoitukset, lokit, kuvakaappaukset tai videomateriaali.
- Muut tiedot: erityisvaatimukset, konfiguraatiot, riippuvuudet tai piilotetut oletukset.
Virheraportteja käytetään tukitiimeissä, QA:ssa ja kehitystiimeissä virheen hallintaan. Kun virhe havaitaan, se kirjataan raporttiin ja luokitellaan
- Käytä kuvaavaa, ei-arvaavaa otsikkoa ja tarkkaa kuvausta.
- Sisällytä toistettavat askelet, ympäristö ja virheellinen vs. odotettu tulos.
- Liitä relevantit liitteet ja virheilmoitukset.
- Pidä kieli tasapainoisena ja vältä subjektiivisuutta.
- Vältä päällekkäisyyksiä ja varmista jäljitettävyys sekä priorisointi.