Spring til indhold

Har renset fejlbeskederne for bebrejdelser

Har omskrevet applikationens fejlbeskeder efter en nedskrevet standard for tone, efter at et afvist login gav brugeren skylden for at have tastet forkert, mens udbyderen i virkeligheden krævede en applikationsspecifik adgangskode, og dækket det med en test, der nævner udbyderen.

  • Pen, calligraphy, fountain pen
    Foto: SamuelFJohanns / Pixabay
  • Letter, flowers, lily of the valley
    Foto: beasternchen / Pixabay

fejlbeskeder, der nævner årsagen, ikke brugeren

Situation. Et login hos en stor mailudbyder mislykkedes, og programmet fortalte brugeren, at adgangskoden var forkert. Den var ikke forkert. Den udbyder kræver en programspecifik adgangskode til tredjepartsklienter og afviser kontoens adgangskode, uanset hvor omhyggeligt den tastes. Beskeden sendte brugeren ud i at genindtaste noget, der aldrig kunne virke, og den reelle anvisning — gå ind og opret en anden slags adgangskode — stod ingen steder.

Opgave. Fejlbeskederne skulle omskrives efter en skriftlig standard i stedet for at blive lappet én ad gangen, for denne var det synlige eksempel på en vane, der gik igen i dem alle.

Handling. Standarden har tre krav: sig, hvad der skete, antyd aldrig, at brugeren gjorde noget forkert, når årsagen ligger et andet sted, og angiv næste skridt, når der findes et. Målt mod standarden overtrådte de fleste beskeder i fejlfladen mindst ét krav — flere var det underliggende biblioteks fejlstreng sendt direkte videre, og den beskriver en tilstand for en programmør og ikke en situation for et menneske. Beskeden for den udbyder blev omskrevet, så den nævner udbyderen, oplyser, at den kræver en programspecifik adgangskode til andre klienter, og siger, hvor man opretter en. Testen er det, der forhindrer tilbagefald, og den er bevidst konkret: den fremkalder et mislykket login hos den udbyder og tjekker, at beskeden indeholder udbyderens navn og den formulering, der beskriver den krævede type adgangsoplysninger. En test, der kun tjekkede, at der viste sig en fejl, ville bestå med den oprindelige forkerte besked, så assertionen gælder indholdet, som er den eneste del, der nogensinde var i stykker.

Resultat. Fejlfladen følger en nedskrevet standard, og det tilfælde, der foranledigede den, er dækket af en test, der fejler på den gamle tekst. Det, der forbliver uafklaret, er omfanget: standarden håndhæves ved gennemgang og ved én test på én besked, og de øvrige udbydere med deres egne særlige krav har ingen tilsvarende test, så fejlklassen er dokumenteret, men ikke lukket.

Ét stykke af en længere fortegnelse — og det hele ligger her på sitet.

Hver post er skrevet på samme måde: situationen, opgaven, hvad vi gjorde, og hvad der ændrede sig.

Se hele fortegnelsen