software testing documentation guide
Under min programvarutestningskarriär hörde jag aldrig människor prata mycket om dokumentation om testning av programvara. Den allmänna uppfattningen om testdokumentation är att alla som har ledig tid kan göra dokumentationen som ett testfall, testplan, statusrapport, felrapport, projektförslag etc.
Till och med jag betonade inte mer om dokumentationen, men jag kan säga att det är min vana att placera all information i svartvitt och att uppdatera andra om det också.
Vad du kommer att lära dig:
- Min erfarenhet
- Testdokumentation: Vad är det?
- 10 tips som hjälper dig att uppnå testdokumentationsmålet
- Viktiga dokument för programvarutestning
- Slutsats
- Rekommenderad läsning
Min erfarenhet
Vill bara dela min erfarenhet med dig:
Vi hade levererat ett projekt (med en okänd fråga i det) till en av våra kunder (arg klient). Och de hittade frågan på en klientsida, vilket var en mycket dålig situation för oss, och som vanligt var all skuld på QA.
Frågan handlade om en webbplatss kompatibilitet. När det gällde mig hade jag bevis för att jag inte fick ett sådant kravdokument som säger att jag också måste kontrollera webbplatsens kompatibilitet. Tack och lov, jag var säker.
Det var lektionen för mig, jag insåg vikten av dokumentation och från den dagen började jag arbeta med dokument och skapade testdokument som testplan, testfall, checklista för sanitetsprov, felrapport och många.
“Bläck är bättre än det bästa minnet” - kinesiskt ordspråk
Testdokumentation: Vad är det?
Vi läste alla olika artiklar om testteknik och metoder, men hur många av oss har sett artiklar om dokumentation? Utan tvekan är det få. Är det så att dokument inte är viktiga? Nej, men det är för vi har ännu inte insett vikten av dokument.
Men om vi observerar är faktum, projekt som har alla dokument har en hög mognad.
De flesta företag lägger inte ens lite vikt vid dokumentationen så mycket de ger åt programutvecklingsprocessen. Om vi söker på webben kan vi hitta olika mallar för hur man skapar olika typer av dokument. Men hur många av dem används verkligen av organisationer eller individer?
Faktum är att noggrann dokumentation kan spara en organisations tid, ansträngningar och pengar.
Även om det finns någon typ av certifiering, varför det finns stress på dokumentationen, är det bara för att det visar vikten av klient och processer för individen och organisationen. Om du inte kan producera ett dokument som är bekvämt för användaren oavsett hur bra din produkt är, kommer ingen att acceptera det.
Det är min erfarenhet, vi äger en produkt som har lite förvirrande funktionalitet.
När jag började arbeta med det bad jag om några hjälpdokument till chefen och jag fick svaret ”Nej, vi har inga dokument” Sedan gjorde jag en fråga om det eftersom jag som QA visste att ingen kan förstå hur man använda produkten utan dokument eller utbildning. Och om användaren inte är nöjd, hur ska vi tjäna pengar på den produkten?
”Brist på dokumentation blir ett problem för acceptans” - Wietse Venema
Även samma sak gäller för användarhandböcker. Ta ett exempel på Microsoft, de lanserar varje produkt med rätt dokument, även för Office 2007 har vi sådana dokument, som är mycket förklarande och lätta att förstå för alla användare. Det är en av anledningarna till att alla deras produkter är framgångsrika.
I små företag hörde vi alltid ”projekt avvisas i förslag eller kickoff-fas” det är bara för att förslagsdokumentation saknar kortfattat och uttrycksfullt språk och att visa organisationens förmåga.
Det är inte så att små företag inte kan leverera projekt av god kvalitet utan det är deras oförmåga att uttrycka sin förmåga. (Jag jobbar också med en liten organisation med 80 anställda, och jag hörde det många gånger)
Jag personligen anser att Kvalitet är den enda avdelningen som kan göra det möjligt. Vi är den enda avdelningen som kan argumentera för detta och kan ge en framgångsrik framtid för våra organisationer.
vilket av följande är en av de mest populära testramarna?
Låt oss organisera alla diskussioner i några punkter i kvalitetsperspektiv:
- Förtydliga kvalitetsmål och metoder
- Se till tydlighet om uppgifter och prestanda
- Säkerställa intern samordning i klientarbetet
- Ge feedback om förebyggande åtgärder
- Ge feedback för din planeringscykel
- Skapa objektiva bevis för ditt kvalitetsstyrningssystems prestanda
10 tips som hjälper dig att uppnå testdokumentationsmålet
Som jag nämnde i mitt tidigare inlägg är förståelse för dokumentation om testning av programvara i allmänhet 'Det kan bara göras av den person som har ledig tid'. Vi måste ändra denna inställning, och då kan bara vi utnyttja dokumentationskraften på våra projekt.
Det är inte så att vi inte vet hur man gör dokumentationen rätt. Vi tycker inte att det är viktigt.
Alla måste ha standardmallar för alla typer av dokumentation som börjar från teststrategi, testplan, testfall och testdata till felrapporten.
Dessa är bara för att följa vissa standarder (CMMI, ISO, etc.) men när det gäller den faktiska implementeringen hur många av dessa dokument används egentligen av oss? Vi behöver bara synkronisera vår kvalitetsprocess med dokumentationsstandarder och en annan process i en organisation.
Det enklaste att följa all slags dokumentation är att involvera en person i projektet från startfasen som förstår projektets dynamik, domän, mål och teknik. Och vem som är bättre än en QA-person för detta (naturligtvis finns det tekniska författare närvarande för att göra detta - men med tanke på ett allmänt scenario med små företag där tekniska författare inte är närvarande).
För att uppnå detta mål med testning och dokumentation anser jag att vi måste fokusera på några punkter.
Här är de 10 bästa tipsen som hjälper dig att uppnå testdokumentationsmålet:
# 1) QA bör involveras i den allra första fasen av projektet så att QA och dokumentation fungerar hand i hand.
#två) Processen som definieras av QA bör följas av tekniker, detta hjälper till att avlägsna de flesta av defekterna i ett mycket inledande skede.
# 3) Bara skapa och underhålla Mallar för testning av programvara räcker inte, tvinga människor att använda dem.
# 4) Skapa och lämna inte bara dokumentet, uppdatera efter behov.
# 5) Ändringskrav är en viktig fas i projektet. Glöm inte att lägga till dem i listan.
# 6) Använd versionskontroll för allt. Detta hjälper dig att hantera och spåra dina dokument enkelt.
# 7) Gör förenklingsprocessen enklare genom att dokumentera alla fel. Se till att inkludera en tydlig beskrivning av defekten, reproducera steg, påverkat område och detaljer om författaren medan du dokumenterar eventuella defekter.
# 8) Försök att dokumentera vad som krävs för att du ska förstå ditt arbete och vad du kommer att behöva producera till dina intressenter när det behövs.
# 9) Använd standardmallen för dokumentation. Som alla excel-arkmallar eller doc-filmallar och hålla fast vid den för alla dina dokumentbehov.
# 10) Dela alla projektrelaterade dokument på en enda plats, tillgängliga för varje teammedlem för referens och för uppdatering när det behövs.
Jag säger inte att genom att tillämpa steg kommer du att få plötsliga resultat. Jag vet att den här förändringen inte kommer att ske på en dag eller två, men åtminstone kan vi börja så att dessa förändringar börjar ske långsamt.
När allt kommer omkring ”behöver dokumentationen dokumentation”. Är det inte?
Det finns hundratals dokument som används i programvaruutvecklingen och testningens livscykel.
Viktiga dokument för programvarutestning
Här listar jag några viktiga programvarutestdokument som vi behöver använda / underhålla regelbundet:
1) Testplan
2) Testdesign och Testfallsspecifikation
3) Teststrategi
4) Testöversiktsrapporter
5) Veckovis statusrapport
6) Användardokument / manualer
7) Användaracceptrapport
8) Riskbedömning
9) Testlogg
10) Felrapporter
elva) Testdata
12) Testanalys
Dessutom måste programvarutestare regelbundet hänvisa till följande dokument:
1) Specifikationer för programvarukrav
2) Funktionsdokument
Slutsats
Programvarutestdokument spelar alltid en viktig roll i projektutvecklings- / testfasen. Så håll alltid saker dokumenterade när det är möjligt. Lita inte på verbal kommunikation. Var alltid på den säkra sidan.
Dokumentation kommer inte bara att spara dig utan också hjälpa organisationen på lång sikt att spara tusentals dollar på utbildning och ännu viktigare på att åtgärda problem orsakade på grund av brist på utvecklings- och testdokument.
Dokumentera inte bara för att undvika att peka på dig, men dokumentationsvanan kommer säkert att ge ett systematiskt tillvägagångssätt för din testprocess och lämna ad hoc-testningen.
Om författaren: Denna artikel är skriven av STH-teammedlem Tejaswini. Hon arbetar som QA-chef i en organisation.
Vilka andra dokument underhåller du i dina dagliga testaktiviteter?
Rekommenderad läsning
- Hur man skriver Software Testing Weekly Status Report
- Bästa verktyg för testning av programvara 2021 (QA Test Automation Tools)
- Programvarutestning QA-assistentjobb
- Kurs för programvarutestning: Vilket program för testning av programvara ska jag delta?
- Välja programvarutestning som din karriär
- Programvarutestning Tekniskt innehåll Writer Freelancer Jobb
- Bästa QA Software Testing Services från SoftwareTestingHelp
- Typer av programvarutestning: Olika testtyper med detaljer