Hyvä tukipyyntö erottaa havainnot oletuksista. Kirjaa virheteksti, ajankohta, ympäristö ja turvalliset toistovaiheet jakamatta luottamuksellisia tietoja. Ohje ei riipu käyttöjärjestelmästä; versiotietojen ikkunoiden nimet vaihtelevat ohjelmittain.
1. Kirjaa tapahtuma
Merkitse päivämäärä, kellonaika ja aikavyöhyke sekä sovellus ja sen tarkka versio. Lisää käyttöjärjestelmän versio, laitetyyppi ja viimeinen tiedossa oleva onnistunut käyttökerta. Kirjoita puuttuvan tiedon kohdalle “ei tiedossa” arvaamisen sijaan. Kuvaa vaikutus: koskeeko ongelma yhtä tiedostoa, yhtä käyttäjää vai useita työasemia?
2. Kuvaa virhe ja vaiheet tarkasti
- Kopioi koko virheilmoitus ja koodi, jos mahdollista. Muuten ota kuvakaappaus ja kirjoita teksti myös erikseen. Älä käännä tai lyhennä virhekoodia.
- Numeroi virheeseen johtavat toimet: alkutilanne, avattu tiedosto tai toiminto, tarkka painike ja tulos. Käytä tiedostonimien tilalla tarvittaessa neutraaleja nimiä.
- Erota odotettu tulos havaitusta. Kirjoita “Tallentaminen näyttää virheen X” eikä “Palvelin on rikki”, ellei syytä ole osoitettu.
- Kerro, ilmeneekö virhe aina, joskus vai vain kerran. Toista vain turvallisia vaiheita testitiedoilla tai kopiolla. Älä toista maksuja, poistoja tai tietojen menettämistä uhkaavia toimia ongelman toistamiseksi.
3. Todisteet ja aiemmat yritykset
Lisää tiedossa olevat muutokset juuri ennen virhettä ja jo kokeillut toimet kunkin tuloksineen. Älä muuta useita asetuksia samalla kertaa. Suojaa alkuperäinen loki; jaa vain tarvittavat otteet asiaankuuluvalta aikaväliltä. Samanaikainen tapahtuma on vihje, ei todiste syystä.
4. Tarkista ennen lähettämistä
Poista salasanat, istuntotunnisteet, henkilötiedot ja luottamuksellinen asiakirjasisältö lähetettävästä kopiosta. Tarkista myös osoiterivi, tiedostopolut ja kuvakaappausten tausta. Tekstin päälle asetettu suorakulmio muokattavassa tiedostossa ei ole turvallinen poisto. Avaa lopullinen liite uudelleen ja tarkista tulos. Käytä sovittua tukikanavaa ja tarkista vastaanottaja sekä liitteet; älä julkaise tarkistamattomia kokonaisia diagnostiikkapaketteja keskustelupalstalla.
Kopioitava malli
- Lyhyt otsikko ja vaikutus:
- Päivämäärä, kellonaika, aikavyöhyke:
- Sovellus/versio, käyttöjärjestelmä/versio, laite:
- Alkutilanne ja numeroidut vaiheet:
- Odotettu / havaittu tulos:
- Koko virheteksti ja koodi:
- Toistuvuus, viimeinen onnistuminen, tunnetut muutokset:
- Jo kokeillut toimet / kunkin tulos:
- Tarkistetut liitteet ilman luottamuksellisia tietoja:
Lopputarkistus: toisen henkilön pitäisi ymmärtää tapahtumaketju kysymättä perusvaiheista. Ilmoita toisistaan riippumattomat ongelmat erikseen.
Lähde
Mozilla: Bug Writing Guidelines – tarkkojen vaiheiden, selkeiden tulosten ja erillisten raporttien perusta; tietosuojatarkistus täydentää yleistä tukiprosessia.