Hur man skriver en bra felrapport (med exempel och mallar)

Oavsett om du har hittat ett fel efter att utvecklingsteamet har lanserat en ny funktion eller om mobilappen har slutat fungera efter en större uppdatering, så är tekniska problem en del av att äga en digital produkt. Istället för att starta dussintals e-posttrådar fram och tillbaka där du beskriver felet, lär dig hur du skriver en bra felrapport. Du kan gärna använda Jira, Bugzilla och andra verktyg för felrapportering, men det är fortfarande innehållet i själva rapporten som är det viktigaste.

Men hur skriver man egentligen en bra felrapport?

Läs den här guiden för en genomgång av felrapporter och varför de är viktiga. Vi ger dig även en checklista över vad du bör inkludera samt steg-för-steg-instruktioner om hur du skriver en bra felrapport.

Vad är en felrapport?

En felrapport, även kallad incident- eller problemrapport, är en detaljerad beskrivning av ett problem som någon upptäcker i en programvara. Testare och utvecklare använder dessa rapporter för att kommunicera om fel. Istället för att skicka ett e-postmeddelande med texten ”Hej, formuläret på kontaktsidan verkar inte fungera”, ger felrapporten djupgående information som utvecklingsteamet kan använda för att åtgärda felet så fort som möjligt. 🐞

Det främsta syftet med en felrapport är att ge utvecklaren tillräckligt med information så att hen kan åtgärda problemet. Det räcker inte att bara säga att något inte fungerar; det handlar om att ge en tydlig bild av vad som händer. En bra felrapport påskyndar felsökningsprocessen och förbättrar den övergripande kvalitetssäkringen och testprocessen.

När felrapporten har godkänts arbetar utvecklings- och testteamen med att hitta orsaken till problemet och åtgärda det. De går igenom något som kallas felets livscykel, en process som varje fel genomgår, från upptäckt till avslutning. Många spårningssystem, som ClickUp, övervakar livscykelstatusen för varje fel så att du får en översikt över var allt befinner sig.

Varför är feluppföljning och felrapportering viktigt?

Visst, du kan hoppa över felrapporteringsprocessen och köra allt som i vilda västern. Men det är ett recept på trasiga applikationer, rörig kod och omarbetningar – för att inte tala om en negativ upplevelse för slutanvändaren. Felrapporter ger relevant information som hjälper utvecklingsteamet att prioritera och ta itu med rätt problem, effektivisera sina arbetsflöden och förenkla hela testprocessen. Verktyg för felrapportering har också en rad andra fördelar, från bättre produktkvalitet till bättre samarbete. 🙌

Förbättra samarbetet i teamet

Felrapporter för programvara kan verka som byråkrati, men de är en viktig länk mellan testare, utvecklare och projektets intressenter. En effektiv felrapport innehåller de exakta stegen för att återskapa felet, listar faktiska resultat jämfört med förväntade resultat och ger detaljer om miljön, vilket utvecklare behöver för att åtgärda problemet. Denna tydlighet gör inte bara allas arbetsdag lite enklare, utan förenar också teamet så att de snabbt kan ta itu med uppgiften.

Förbättra användarupplevelsen

Programvarufel kan orsaka alla möjliga konstiga problem för slutanvändarna. Ett enda problem eller fel kan få användare att lämna din plattform för gott, så det ligger i ditt eget intresse att ta felspårning och felrapportering på allvar.

En bra felrapport kan också erbjuda ett systematiskt och strukturerat sätt att hantera dessa fel, vilket säkerställer att din produkt blir så felfri och användarvänlig som möjligt. Om du har många fel bör ditt rankningssystem låta dig rangordna dem efter prioritet så att du kan ta itu med de mest besvärliga problemen i produktbackloggen först.

Skapa en kvalitetsprodukt

All programvara har buggar. Produktkvaliteten beror på hur bra och snabbt ditt team hanterar buggar. Lyckligtvis ger detaljerade felrapporter insikt i produktens svagheter så att utvecklare kan förstå allvaret och konsekvenserna. Ju bättre de förstår problemet, desto mer riktade och effektiva blir deras korrigeringar. Effektiva incidentrapporter minskar också den tid utvecklare lägger på att klargöra krav, vilket ger dem mer tid att koda.

Effektivisera utvecklingsprocessen

Programvaruutveckling kan vara knepigt ur ett projektledningsperspektiv. Istället för att jaga efter buggar som inte finns, konsulterar utvecklare rapporten och går direkt till att åtgärda problemet. Korrekt felrapportering undanröjer tvetydigheter och ser till att alla är på samma sida. Bra rapporter kommer inte helt att eliminera fram- och återgångar och förfrågningar om förtydliganden, men de kommer definitivt att minska onödig förvirring, vilket i slutändan effektiviserar utvecklingsflödet.

Minska kostnaderna

Det stämmer: Att ta itu med buggar tidigt i utvecklingsprocessen kan faktiskt sänka kostnaderna. Ju längre du låter en bugg vara olöst, desto dyrare blir det att åtgärda den. Effektiv felrapportering möjliggör tidig upptäckt, vilket minskar kostnaden och arbetsinsatsen som krävs för att lösa problemen.

Element som bör ingå i en välskriven felrapport

Det är en sak att skriva en felrapport, men att skriva en bra felrapport är en konst. Organisationer skiljer sig åt, men de bästa felrapporterna innehåller ofta dessa element.

Fel-ID

Du har förmodligen en hel del buggar att hantera. Istället för att publicera varje felrapport hur som helst, tilldela den ett unikt fel-ID. Du kan använda denna identifierare för nya felrapporter i ditt ärendehanteringssystem, vilket gör det enklare att spåra och hänvisa till rätt fel. Detta kommer också att vara till nytta om flera personer upplever samma fel.

Rubrik eller sammanfattning

Ge rapporten en kort och koncis rubrik som ger en översikt över det huvudsakliga problemet. Den ska vara tillräckligt tydlig för att vem som helst ska förstå felets natur med ett ögonkast. Lägg inte in för många extra detaljer här. Sammanfatta det till huvudidén och lägg till sammanhang eller information senare i rapporten.

Prioritet och allvarlighetsgrad

Utvecklare har mycket att göra. Att tilldela varje felrapport en prioritet och en allvarlighetsgrad hjälper dem att balansera sin arbetsbelastning och ta itu med uppgifterna i rätt ordning. Felets prioritetsnivå anger hur brådskande åtgärden är, medan felets allvarlighetsgrad återspeglar den inverkan felet kommer att ha på systemets funktionalitet.

Miljöinformation

Kanske laddas inte en apps CSS på din dator, men den fungerar utmärkt på en kollegas MacBook. Detta är en miljörelaterad detalj som utvecklare behöver känna till.

Inkludera information om:

Beroende på produkten kan du också behöva ange vilken version av programvaran du använder och när den senast uppdaterades.

Felbeskrivning

Nu är det dags! Här ger du en detaljerad beskrivning av felet. Förklara hur felet uppstod i applikationen och vilken inverkan det har på användarupplevelsen eller funktionaliteten. 📝

Steg för att återskapa felet

Kanske upplever du ett fel, men utvecklingsteamet ser det inte. När du rapporterar fel är det en bra idé att ge instruktioner om hur du upptäckte det och hur utvecklarna också kan hitta det. Ge tydliga, steg-för-steg-punkter om hur felet kan återskapas. Om det inte går att återskapa hos utvecklaren kan det tyda på ett problem med ditt system och inte med applikationen, vilket är anledningen till att instruktioner för återskapande är så viktiga.

Förväntat resultat jämfört med faktiskt resultat

Appar har många rörliga delar, och utvecklare kanske inte kan alla funktioner och syften utantill. Det är till hjälp om utvecklaren vet vad du förväntar dig ska hända jämfört med vad som faktiskt händer. Något i stil med: ”När jag klickade på den här länken förväntade jag mig att bli omdirigerad till registreringssidan, men jag fick istället ett felmeddelande.” Detta är viktigt eftersom det belyser avvikelsen som utvecklaren behöver åtgärda.

Anteckningar och bilagor

Ibland är det lättare att visa än att berätta. Försök att bifoga relevanta filer, såsom felloggar, datafiler, skärmdumpar eller videoinspelningar. Ibland gör visuella bevis hela skillnaden, så om du behöver få ett problem löst snabbt, lämna så mycket bevis som möjligt.

Vanliga misstag att undvika när du skapar en felrapport

Att lära sig skriva en felrapport kräver lite övning. Kontrollera noga att din rapport inte innehåller något av dessa vanliga problem i felrapporter.

Vaga rubriker

Generiska eller vaga rubriker kommer att få utvecklare att klia sig i huvudet. En rubrik som ”Jag har hittat ett fel” är varken specifik eller hjälpsam. Ge istället en kortfattad sammanfattning av vad som faktiskt händer, till exempel ”Felmeddelande när jag lägger till varor i varukorgen.”

Ofullständig information

Felrapporter kräver vissa uppgifter av en anledning. Om du inte anger information om ditt operativsystem, programversion eller webbläsartyp kan det försvåra felsökningsprocessen. Om du inte känner till uppgifterna, ta dig tid att ta reda på dem. Utvecklaren kommer ändå att be dig om denna information, så du kan lika gärna spara tid åt alla genom att skicka in dessa uppgifter från början.

Skrivfel

Vi pratar inte om att blanda ihop ”their”, ”there” och ”they’re”. Vi menar stavfel som potentiellt kan ändra innebörden av det du försöker säga. Detta gäller särskilt om du använder varumärkesspecifika termer eller autokorrigering på din dator. Till exempel skiljer sig ”text” och ”test” åt med en enda bokstav, men att blanda ihop de två termerna kan leda till förvirring.

Otydliga steg för att återskapa felet

Instruktioner som ”logga in för att hitta felet” är inte till någon hjälp. Kom ihåg att målet är att göra problemet reproducerbart. Ingenting är ”självklart” eller ”sunt förnuft” här. Gör inga antaganden: Inkludera alltid steg-för-steg-instruktioner, även om de verkar för grundläggande eller enkla.

Kontrollerar inte om det finns dubbletter

Upplever alla samma fel? Om så är fallet är det stor chans att någon redan har skickat in en felrapport och att den ligger i en utvecklares kö. Att skicka in flera rapporter för samma problem saktar ner processen för alla, så om du har tillgång till felrapporteringssystemet bör du först kontrollera om någon redan har skickat in denna begäran.

Användning av subjektivt språk eller åsikter

Personliga åsikter som ”Den här nyansen av lila är ful” är inte till någon hjälp för utvecklare. Personliga åsikter eller småsaker som irriterar dig är inte samma sak som faktiska buggar. Håll din rapport så saklig och precis som möjligt; allt annat är bara en avledningsmanöver som kan bromsa utvecklingsteamet.

Att ignorera feedback eller frågor

Den mottagande utvecklaren kan ha frågor eller kommentarer om din felrapport. Istället för att skicka in den och sedan gå vidare med dina egna saker, se till att du är tillgänglig för att interagera med utvecklaren. Ju snabbare du svarar på deras frågor, desto snabbare kan de åtgärda problemet.

Felaktig bedömning av allvarlighetsgrad eller prioritet

Om du upptäcker en säkerhetsöverträdelse och klassificerar den som ett problem med låg prioritet är det ett problem. Tänk på de faktiska konsekvenserna som felet har för slutanvändarens upplevelse. Att inte kunna logga in är ett stort problem, medan mindre problem som bildåtergivning har lägre prioritet.

Hur man skriver en felrapport i ClickUp

Programvaruteam förlitar sig på ClickUp för mer än bara ärendehantering och felrapporter. Det är en allt-i-ett-lösning för projektledning som stöder samarbete, brainstorming och allt däremellan för tekniska team. Hantera uppgifter, chattar, teknisk dokumentation, mål och mer på ett och samma ställe. ClickUp Forms standardiserar till och med felrapporteringsprocessen, så du behöver inte oroa dig för att folk blir ”kreativa” med sina inlämningar. 👀

Du behöver inte heller skapa dina arbetsflöden för fel- och ärendehantering från grunden. Prova ClickUps mall för fel- och ärendehantering för att stödja tvärfunktionellt samarbete med automatiserade formulär, anpassade intagsformulär och flexibla vyer. Om du behöver lite inspiration kan du se hur ClickUp strukturerar sitt korta och koncisa formulär för felrapportering.

Effektivisera programvarutestningen med ClickUp

Programvarufel är en del av utvecklingen av digitala produkter. Genom att lära dig hur man rapporterar fel förser du dina utvecklare med mer relevant och användbar information som påskyndar korrigeringar, minimerar krångel och förbättrar användarupplevelsen.

Att skriva en gedigen felrapport tar dig långt, men du behöver fortfarande ett system för att spåra, hantera och kommunicera om fel. Det är där vi kommer in. ClickUp är en gedigen projektledningsplattform som samlar IT-mallar, formulär, uppgifter och kommunikation på ett och samma ställe. Sluta växla mellan flera verktyg och samla allt i en verkligt allt-i-ett-plattform med ClickUp. Prova på: Skapa din kostnadsfria ClickUp-arbetsyta nu!