Virheilmoitus

Virheilmoitus on viesti, jonka ohjelmisto, järjestelmä tai palvelu antaa, kun jokin virhe tai poikkeama tapahtuu. Sen tarkoituksena on ilmoittaa käyttäjälle, mitä tapahtui, auttaa virheen paikantamisessa ja tarjota ohjeita seuraaviin toimenpiteisiin. Hyvin toteutettu virheilmoitus tukee sekä käyttöä että ylläpitoa ja voi vähentää käyttäjän turhautumista sekä virheiden toistumista.

Koostumus ja tyypit. Tyypillinen virheilmoitus sisältää virhekoodin tai tilakoodin, kuvaavan viestin sekä kontekstitietoja siitä, missä toiminto epäonnistui. Lisäksi voidaan tarjota ohjeet korjaamiseen tai paluupolkuja (esim. yritä uudelleen, tarkista syöte). Käyttöliittymässä esiintyvät virheilmoitukset on suunnattu lopullisille käyttäjille, kun taas järjestelmän lokiin tai kehittäjille suunnatut virheilmoitukset voivat sisältää yksityiskohtaisempaa teknistä tietoa.

Suunnittelu ja käytännöt. Hyvä virheilmoitus on selkeä ja ymmärrettävä sekä vähemmän tekninen kuin liikaa teknistä jargonia sisältävä. Siihen kannattaa sisällyttää virhekoodi, lyhyt kuvaus, tapahtuman konteksti sekä mahdolliset toimenpiteet tai seuraavat askeleet. Tuki useille kielille, saavutettavuus sekä sopiva kontrasti parantavat käytettävyyttä. On tärkeää välttää liiallista teknistä tietoa loppukäyttäjälle ja huomioida turvallisuus: asiakirjat eivät saa paljastaa arkaluontoisia tietoja tai paljastaa herkkiä paljastuspolkuja.

Ylläpito ja turvallisuus. Virheilmoitukset voidaan tallentaa lokiin ja analysoida ongelmien ratkaisemiseksi. Strukturointi, kuten määritellyt virhekoodit ja kontekstitiedot, helpottaa vianetsintää. Lisäksi virheilmoitukset tulisi lokalisoida ja mahdollisuuksien mukaan anonymisoida, jotta käyttäjät saavat ymmärrettäviä ja turvallisia viestejä omalla kielellään.

Esimerkki: "Virhe 404 – Sivua ei löytynyt." Tämä kertoo tila‑ ja viestin selvästi ilman liiallista teknistä yksityiskohtaa.