En god supportrapport skelner mellem observationer og antagelser. Notér fejltekst, tidspunkt, miljø og sikre trin til at genskabe fejlen uden at dele fortrolige data. Vejledningen er uafhængig af operativsystemet; navnene på versionsdialoger varierer mellem programmer.
1. Registrér hændelsen
Notér dato, klokkeslæt og tidszone samt programmet og dets præcise version. Tilføj operativsystemets version, enhedstype og seneste kendte tidspunkt, hvor det virkede. Skriv “ukendt” ved manglende oplysninger i stedet for at gætte. Beskriv omfanget: rammer fejlen én fil, én bruger eller flere arbejdspladser?
2. Beskriv fejl og trin præcist
- Kopiér hele fejlmeddelelsen og fejlkoden, hvis muligt. Ellers tag et skærmbillede og skriv også teksten af. Oversæt eller forkort ikke fejlkoden.
- Nummerér handlingerne frem til fejlen: udgangspunkt, åbnet fil eller funktion, konkret knap og resultat. Brug om nødvendigt neutrale pladsholdere for filnavne.
- Adskil forventet resultat fra det faktisk observerede. Skriv “Gem viser fejl X” frem for “Serveren er i stykker”, så længe årsagen ikke er påvist.
- Angiv, om fejlen opstår altid, lejlighedsvis eller kun én gang. Gentag kun sikre trin med testdata eller en kopi. Gentag ikke betalinger, sletninger eller handlinger med risiko for datatab for at genskabe fejlen.
3. Dokumentation og tidligere forsøg
Tilføj kendte ændringer kort før fejlen og allerede afprøvede tiltag med hvert resultat. Ændr ikke flere indstillinger samtidig. Beskyt den originale log; del kun nødvendige uddrag fra det relevante tidsrum. En samtidig hændelse er et spor, ikke bevis for årsagen.
4. Kontrollér før afsendelse
Fjern adgangskoder, sessionstokens, personoplysninger og fortroligt dokumentindhold fra kopien, der skal sendes. Kontrollér også adresselinje, filstier og baggrunden i skærmbilleder. Et rektangel lagt ovenpå tekst i en redigerbar fil er ikke sikker fjernelse. Åbn det endelige bilag igen og kontrollér resultatet. Brug den aftalte supportkanal og kontrollér modtager og bilag; offentliggør ikke ukontrollerede komplette diagnosepakker i et forum.
Skabelon til kopiering
- Kort titel og omfang:
- Dato, klokkeslæt, tidszone:
- Program/version, operativsystem/version, enhed:
- Udgangspunkt og nummererede trin:
- Forventet / faktisk observeret:
- Fuld fejltekst og kode:
- Hyppighed, seneste succes, kendte ændringer:
- Allerede forsøgt / resultat af hvert forsøg:
- Kontrollerede bilag uden fortrolige data:
Slutkontrol: en anden person skal kunne forstå forløbet uden at spørge til grundlæggende trin. Uafhængige problemer hører til i separate rapporter.
Kilde
Mozilla: Bug Writing Guidelines – grundlag for præcise trin, klare resultater og separate rapporter; kontrollen af fortrolige data supplerer den generelle supportproces.