När man pratar om mjukvaruutveckling är det omöjligt att inte prata om buggar. Och när det finns buggar finns det buggrapporter.
I den här bloggen kommer vi att utforska hur en välskriven buggrapport ser ut, hur du kan skriva en buggrapport som hjälper dina team att hitta och åtgärda fel snabbt och enkelt. Och slutligen, hur Vmaker kan hjälpa dig att minska tid och energi på att skapa en felrapport.
Vad är en bra felrapport?
Generellt sett en bra felrapport är något som är exakt, effektivt och enkelt, men ändå tillräckligt detaljerat för att ditt team snabbt kan identifiera problemet och lösa det utan problem.
Om du kan skriva en bra felrapport är chansen större att dina problem åtgärdas.
Nu när du har en ungefärlig uppfattning om en bra felrapport, låt oss snabbt zooma in på de aspekter som krävs för att göra en bra rapport, och några andra saker att tänka på för att dela med dig av handlingskraftig feedback.
Titel
Håll det kort och exakt. Precis som alla andra typer av rapporter bör din felrapport ha en titel som ger en tydlig uppfattning om ditt problem, dess plats eller kategori. Att ha ett tydligt namn gör det lättare för ditt team att hitta felet senare och göra eventuella ändringar.
Dåligt:"Jag klickade på fortsätt-knappen på startsidan, men den svarar inte. Kan du åtgärda det här problemet?"
Problemet med exemplet ovan är att det är vagt och det anger inte platsen för problemet. Till exempel kan det finnas flera "fortsätt"-knappar på startsidan.
Bra:Navigationsfält (hemsida):Fortsätt-knappen svarar inte
Detta är tydligt och tydligt, och det specificerar platsen för problemet.
Sammanfattning
Om du inte kan förklara allt med titeln, gå för en sammanfattning. Denna sammanfattning bör skrivas på ett sådant sätt att läsaren kan veta exakt vad som händer och vilken del eller funktion av programvaran som påverkas.
Dåligt: "Igår försökte jag logga in från startsidan, men ingenting hände efter att ha klickat på knappen."
Bra: "Igår [DATE] försökte jag logga in från startsidan genom att klicka på inloggningsknappen på [LOCATION], men ingenting hände."
Visuellt bevis
Oavsett hur exakt du skriver rapporten, kommer att lägga till visuella bevis som en skärmdump, tillsammans med sammanfattningen, hjälpa ditt team att förstå rapporten snabbare.
Miljöinformation
Det finns alltid en chans att du står inför buggproblemet på grund av din lokala datormiljö, så det är alltid fördelaktigt att nämna din cybermiljö i din rapport. Du kan nämna saker som:
- Din enhets hårdvara och dess läge
- Operativsystem
- Kontot du har varit inloggad med
- Appversionen
Steg för att återskapa
Här kommer du att skriva om de steg du tog som utlöste buggen, så att utvecklarna kan följa detsamma och testa det själva.
Steg 1:Öppna startsidan
Steg 2:Klicka på rullgardinsmenyn i navigeringsfältet
Steg 3:Ange din e-postadress och klicka på knappen Fortsätt
Förväntade resultat
I det här avsnittet kommer du att prata om vad du förväntade dig när du följde stegen. Försök att vara så tydlig som möjligt och kom ihåg att det alltid är till hjälp för utvecklarna att veta vad som borde ha hänt istället för vad som inte borde ha hänt.
Faktiska resultat
Här kommer du att prata om vad som faktiskt hände när du följde stegen. Nedan är ett exempel på det förväntade och faktiska resultatet.
Förväntat resultat:Jag borde ha tagits till spelarsidan när jag klickade på fortsätt-knappen.
Faktiskt resultat:När jag klickade på fortsätt-knappen visade det ett "fel"-meddelande
Prioritet
Om du har flera felproblem kan du tala om för ditt utvecklingsteam vilken som ska prioriteras genom att betygsätta felen baserat på deras svårighetsgrad.
Hög prioritet:Åtgärda fortsätt-knappen
Medellång prioritet:Fixa spelarsidan
Låg prioritet:Åtgärda den trasiga webbadressen
Källwebbadress
En viktig men lätt att glömma är källans URL. Detta kommer att hjälpa utvecklarna att navigera snabbare, vilket gör det snabbare att upptäcka problemet och sparar mycket tid för alla!
Exempel på felrapport
Du kan klicka här för att ladda ner mallen .
Hur skriver man en felrapport?
Nu när du är medveten om alla väsentliga aspekter av att skriva en bra felrapport kan du använda mallen ovan och börja skriva din felrapport.
Lägg bara lite tid på den här uppgiften eftersom detta kommer att vara den viktigaste kommunikationspunkten mellan dig och ditt team.
Bonusguide: Integrera Vmaker med Gmail, Github, Gitlab och Jira
Att skriva en sådan här rapport kan vara lätt när problemet är mindre och du är bra med ord, men föreställ dig bara motsatsen. När buggfrågan är komplex och ord inte räcker till.
Som tur är, Vmaker är här för att hjälpa dig. Hur? Låt oss snabbt hoppa till nästa avsnitt för det.
Så här kan Vmaker göra ditt liv enklare
Ibland, när ett buggproblem är komplext, kan du behöva skriva mer innehåll, vilket kan vara tidskrävande och tråkigt. Och det finns en god chans att du förlorar klarhet när du skriver så långa rapporter.
Även om du avslutar din rapport, som kan vara skarp och tydlig ur ditt perspektiv, finns det en god chans att ditt team kan uppfatta det annorlunda. Och med det kan du komma in i en fram och tillbaka loop
Om du tittar på hela den här processen, från att skriva rapporten till ditt team till att hitta felet och lösa det, går så mycket tid och energi till spillo.
Det är här Vmaker kan hjälpa dig. Vmaker är ett gratis skärminspelningsverktyg med vilket du kan spela in en video av ditt buggproblem och skicka det till ditt team. Istället för att skriva långa rapporter kan du spela in din röst för att dela mer information om felet; detta är enkelt, mindre tidskrävande och snabbt för ditt team att förstå problemet.
Den kommer med en anteckningsfunktion, med vilken du kan peka ut detaljer på din skärm och kommunicera bättre.
Vmaker kommer också med en arbetsplatsfunktion, där du kan hålla reda på alla dina felrapporter samtidigt som du samarbetar med ditt team.
Med Vmaker är det så enkelt som 1 2 3 att rapportera ett felproblem. Öppna bara Vmaker-appen, skärmregistrera felet och dela videolänken med ditt team.
Om du gillade att läsa artikeln ovan, så är här några fler artiklar som du kan vara intresserad av att läsa vidare!
Hur man spelar in Google Meet
Hur man skärminspelning på iPhone
Bästa skärminspelaren för Mac
Hur man spelar in Zoom Meeting med ljud
Hur man skärminspelning på Mac