Wikipedia:Hvordan beskrive og rapportere feil
Hvordan beskrive og rapportere feil er litt grunnleggende informasjon om hvordan en lager gode feilbeskrivelser, slik at utviklere og andre kan gjenta feilen i kontrollerte omgivelser. I tillegg til selve feilbeskrivelsen bør det tas med litt informasjon om hva slags plattform som ble brukt når feilen ble funnet, slik som hva slags nettleser du har brukt og dennes versjon. For å kunne identifisere en feil hender det at en også må ha oversikt over ekstra tilleggsfunksjoner, både on-wiki og i selve nettleseren, og at en må ha logger fra nettleseren.
Feilrapporter om tilleggsfunksjoner skal på siden(e) som beskriver den aktuelle funksjonen, eller på Wikipedia:Torget. Feilrapporter om selve programvaren på Wikipedia skal til Phabricator.
Feilbeskrivelsen[rediger kilde]
Et stadig tilbakevendende problem er hvordan en skal beskrive hva som er ønsket og uønsket oppførsel av et system. Som oftest er problemene som brukere beskriver reelle nok, men det kan være vanskelig å beskrive akkurat hvor noe har skjedd, hvorfor noe har skjedd, hva som var forventet. Beskrivelsen vi ønsker er hva som er forventet utfall, men når noe blir feil så beskriver dere i tillegg hva som faktisk skjedde. En form som er veldig vanlig er basert på steg som ofte angis som gitt (given), når (when) og så (then), og med tilleggene og (and) og men (but).
Når noe er galt så feiler en sekvens av slike enkle steg. Det er kanskje enklest å vise hvordan dette brukes i praksis
| Eksempel | |
Egenskap: Redigering av side
Skribenter klikker på «lagre siden» for å lagre utførte endringer
Scenario: endret tekst
Gitt at jeg har endret teksten på en side
Og at jeg ikke er blokkert fra å redigere
Og at siden ikke er beskyttet
Når jeg klikker på «lagre siden»
Så skal den redigerte siden lagres
Den lagrede siden ble blank |
Feature: Editing of page
Editors clicks on "save page" to store pending changes
Scenario: text is changed
Given that I have changed the text on a page
And that I am not blocked from editing
And that the page is not protected
When I clicks on «save page»
Then the edited page should be saved
The saved page become blank |
Det er viktig at alle steg som inngår i det som leder opp til det ønskede resultatet tas med, og hva som er feilen du observerer. Feilen beskrives utenfor det som er ønsket oppførsel, for det er kun en klargjøring av hva som ble observert, men slik at det er tilstrekkelig til at de som leser feilbeskrivelsen ser hva som er forskjell mellom ønsket oppførsel og feilen.
Slike sekvenser brukes som arbeidsbeskrivelser av utviklerne, og de kan også settes opp i testrammeverkene. Hvis dere kan lage slike beskrivelser så blir det enklere for utviklerne, og vi kan oversette dem til engelsk og putte dem rett inn i feilmeldingene på Phabricator eller bruke dem i automatiserte tester.
Tilleggsfunksjoner og oppsett[rediger kilde]
Tidligere kunne en dumpe ut hele sitt eget oppsett på Wikipedia, men nå er ikke dette så enkelt. I praksis må en nå gå gjennom de aktuelle listene inne på Spesial:Innstillinger og skrive ned hva en har valgt. Hvis en tenker etter hva som kan utløse en feil er det som oftest kun noen få av innstillingene som har betydning.
På samme måte som tilleggsfunksjoner kan påvirke hva som skjer i nettleseren og hvordan feil oppstår, så kan også nettleserens oppsett påvirke dette. Vanligvis holder det å identifisere nettleseren og dennes versjonsnummer, og så de utvidelsene du tror har betydning. Nettleserens versjonsnummer finner du i «Hjelp» om deretter «Om nettleseren».
Logger fra nettleseren[rediger kilde]
I noen tilfeller vil du bli spurt om «console log» fra nettleseren. Denne får du opp på litt forskjellig måte i de forskjellige nettleserne, men det er et tekstområde hvor feilmeldinger og andre rapporter listes. Blir du spurt om å se etter bestemte feilmeldinger så vil du av og til få beskjed om å gå på bestemte sider eller gjøre helt bestemte ting. Da er det viktig at du er nøyaktig og følger oppskriften. Det er da helt bestemte feil en ønsker å finne, eller en ønsker å se om helt bestemte feil er borte.
Skjermskudd[rediger kilde]
For å gjøre det helt klart hvilken feil en forsøker å identifisere så er det ofte helt nødvendig å legge ved et skjermskudd. Dette lager du på litt forskjellige måter, men som oftest finnes det en tast «print screen» på tastaturet. Når du trykker på denne tas det bilde av skjermen. På noen maskiner dukker det opp et lite program, og så kan du kopiere til til kopitavla (clip board) mens på andre maskiner havner skjermskuddet rett på kopitavla med en gang.
Som oftest ønsker vi å bare vise det som helt konkret er feil på nettsiden, så du bør lime skjermskuddet inn i et eller annet billedredigeringsverktøy. Et godt verktøy er Gimp, men du kan igrunnen bruke hva som helst. Velg ut tilstrekkelig fra skjermskuddet til at en ser hva som er feilen og konteksten til den, sett en seleksjonsramme og beskjær bildet. Lagre bildet som «png» eller lignende, slik at det ikke er problematisk å åpne det.
Hvis du har rapportert feilen inne på Wikipedia så laster du opp skjermskuddet til Wikimedia Commons. Hvis du har rapportert feilen på Phabricator så drar du bildet inn i redigeringsruta.
Se også[rediger kilde]
- Oppførelsdrevet utvikling (Behavior-driven development)
- Akseptansetest-drevet utvikling (Acceptance test-driven development)
- Cucumber (Cucumber)