Testdocumentatie bij het testen van software (voorbeeld)

Wat is testdocumentatie?

Testdocumentatie is een documentatie van artefacten die vóór of tijdens het testen van software zijn gemaakt. Het helpt het testteam de benodigde inspanning in te schatten, middelen en voortgang te volgen en een adequate testdekking te garanderen. De registratie en rapportages van de test vormen een complete reeks documenten waarmee u de testplanning, het testontwerp, de testuitvoering en de testresultaten die uit de testactiviteit voortvloeien, kunt beschrijven en documenteren.

👉 Schrijf je gratis in voor een live softwaretestproject

Waarom is er behoefte aan testformaliteit?

Voor een beginner is het gemakkelijk om aan te nemen dat testen het ad-hoc uitvoeren van verschillende codesecties en het verifiëren van de resultaten inhoudt. Maar in de praktijk is testen een zeer formele activiteit die gedetailleerd wordt gedocumenteerd. Testdocumentatie maakt de planning, beoordeling en uitvoering van tests eenvoudig en controleerbaar.

De mate van formaliteit van de test hangt af van:

• Het type toepassing dat wordt getest (AUT).
• Normen die uw organisatie hanteert.
• De volwassenheid van het ontwikkelingsproces.

Testactiviteiten duren doorgaans tussen 30% en 50% van de totale softwareontwikkelingsinspanning. Documentatie helpt bij het identificeren van verbeteringen in het testproces die kunnen worden toegepast op toekomstige projecten.

Welke soorten testdocumentatie zijn er?

Dit zijn de belangrijke soorten testdocumentatie:

“In de praktijk worden deze documenten in verschillende fasen opgesteld: van de vroege planning (testbeleid, strategie) tot de uitvoering en afsluiting (defect- en samenvattingsrapporten).”

Soorten testdocumenten	Beschrijving
Testbeleid	Het is een document op hoog niveau dat de principes, methoden en alle belangrijke testdoelen van de organisatie beschrijft.
Strategie testen	Een document op hoog niveau waarin de testniveaus (typen) worden geïdentificeerd die voor het project moeten worden uitgevoerd.
Testplan	Een testplan is een compleet planningsdocument dat de reikwijdte, aanpak, middelen, planning, etc. van testactiviteiten beschrijft.
Vereisten Traceability Matrix	Dit is een document dat de vereisten aan de testcases koppelt.
Testscenario	Testscenario is een item of gebeurtenis van een softwaresysteem dat kan worden geverifieerd door een of meer testcases.
Testgeval	Het is een groep invoerwaarden, uitvoeringsvoorwaarden, verwachte uitvoeringsvoorwaarden en resultaten. Het is ontwikkeld voor een testscenario.
Testgegevens	Testgegevens zijn gegevens die al bestaan ​​voordat een test wordt uitgevoerd. Ze worden gebruikt om de testcase uit te voeren.
Defect Rapport	Een defectrapport is een gedocumenteerd rapport van een fout in een softwaresysteem dat niet de verwachte functie vervult.
Testsamenvattingsrapport	Het testsamenvattingsrapport is een document op hoog niveau dat de uitgevoerde testactiviteiten en de testresultaten samenvat.

Wat zijn de beste werkwijzen om testdocumentatie te realiseren?

In dit gedeelte gaan we dieper in op de beste werkwijzen die u helpen bij het opstellen van testdocumentatie. We geven voorbeelden zodat u de documentatie beter kunt begrijpen:

• Betrek QA al vroeg bij het project: Betrek het QA-team vanaf het begin van het project, zodat de testdocumentatie zich parallel aan het productontwerp en de vereisten ontwikkelt.
  Voorbeeld: QA werkt tijdens de sprintplanning samen om eerste testcases op te stellen op basis van gebruikersverhalen.
• Houd documenten up-to-date: Maak niet zomaar testdocumenten en vergeet ze vervolgens. Werk ze bij wanneer de vereisten of functies veranderen.
  Voorbeeld: Wanneer een login-API verandert, worden de gerelateerde testcases en resultaten onmiddellijk bijgewerkt.
• Gebruik versiebeheer: Beheer en volg alle wijzigingen in testdocumenten via versiebeheersystemen om verwarring en gegevensverlies te voorkomen.
  Voorbeeld: Sla testplannen op in GitHub om een ​​overzichtelijke versiegeschiedenis en terugdraaiopties te behouden.
• Document voor duidelijkheid en doel: Registreer alleen datgene wat u en uw stakeholders helpt inzicht te krijgen in de voortgang van de test en de resultaten.
  Voorbeeld: Voeg testsamenvattingsrapporten toe waarin geslaagde, mislukte en geblokkeerde testcases worden gemarkeerd voor beoordeling door het management.
• Gebruik standaard sjablonen: Gebruik een consistente opmaak, zoals Excel- of Word-sjablonen, zodat u documentatie eenvoudiger kunt maken en beoordelen.
  Voorbeeld: Gebruik een standaard 'Test Case Template' met velden voor ID, beschrijving, voorwaarden en verwachte resultaten.
• Centraliseer documentenopslag: Bewaar alle projectgerelateerde documenten op één toegankelijke locatie, zodat teamleden ze eenvoudig kunnen raadplegen of bijwerken.
  Voorbeeld: Sla testartefacten op in een gedeelde Google Drive map die toegankelijk is voor het gehele QA- en ontwikkelteam.
• Geef voldoende details: Vermijd vage of onvolledige informatie; gedetailleerde documentatie verbetert het begrip en vermindert fouten tijdens de uitvoering van de test.
  Voorbeeld: In plaats van 'Controleer login' schrijft u 'Controleer de login van de gebruiker met geldige inloggegevens en u wordt doorgestuurd naar het dashboard.'

Wanneer moet u testdocumentatie voor softwaretesten maken?

Hier zijn enkele belangrijke punten over wanneer u testdocumentatie voor softwaretesten moet maken:

• Planningsfase: Voordat de uitvoering van de test begint, moeten de scope, doelstellingen en teststrategie duidelijk worden gedefinieerd.
• Testvoorbereiding: Tijdens de testplanning, om op efficiënte wijze tijdlijnen, middelen en omgevingsvereisten vast te leggen.
• Vereistenanalyse: Na de vereistenanalyse, om ervoor te zorgen dat alle functionele en niet-functionele specificaties zijn gedekt.
• Ontwerpstandaardisatie: Voordat u testcases ontwerpt, moeten formaten worden gestandaardiseerd en moet de traceerbaarheid van alle documenten worden gewaarborgd.
• Scenariodocumentatie: Tijdens het testontwerp moeten scenario's, invoer, verwachte uitvoer en testgegevensdetails worden vastgelegd.
• Uitvoeringsgereedheid: Voordat de test wordt uitgevoerd, wordt gecontroleerd of de testomgeving, de hulpmiddelen en de documentatie gereed zijn.
• Post-evaluatie: Na het testen worden de resultaten, defecten en geleerde lessen vastgelegd ter verbetering van het proces.

Welke typen sjablonen zijn vereist voor testdocumentatie?

Hier zijn enkele sjablonen die u nodig hebt voor testdocumentatie bij het testen van software:

Sjabloonnaam	Tools
Sjabloon voor testplan	Microsoft Word, Google Docs, of Confluence voor collaboratieve bewerking en versiebeheer
Sjabloon voor testcases	TestRail, Zephyr (in JIRA), Xray of Excel/Google Sheets voor gestructureerd testbeheer
Sjabloon voor testscenario's	JIRA, TestLink of Google Sheets voor het documenteren van testomstandigheden op hoog niveau
Sjabloon voor een Requirement Traceability Matrix (RTM)	Excel, Google Sheets of TestRail voor het koppelen van vereisten aan testcases
Defectenrapport sjabloon	JIRA, Bugzilla of Azure DevOps voor het loggen en volgen van defecten
Testsamenvattingsrapport sjabloon	Samenvloeiing, Google Docs, of TestRail voor het samenstellen van testresultaten en analyses

Voor- en nadelen van testdocumentatie

VOORDELEN

• De belangrijkste reden achter het maken van testdocumentatie is het verminderen of wegnemen van onzekerheden over de testactiviteiten. Het helpt onduidelijkheden weg te nemen die vaak ontstaan ​​bij de taakverdeling.
• Documentatie biedt niet alleen een systematische aanpak software testen, maar het dient ook als trainingsmateriaal voor beginners in het softwaretestproces.
• Het is een goede marketing- en verkoopstrategie om testdocumentatie te presenteren en zo een volwassen testproces te illustreren.
• Met testdocumentatie kunt u de klant binnen specifieke tijdslimieten een kwalitatief product aanbieden.
• In Software Engineering, testdocumentatie helpt ook bij het configureren of instellen van het programma via het configuratiedocument en de bedieningshandleidingen.
• Testdocumentatie helpt u de transparantie naar de klant te verbeteren.

NADELEN

• De kosten van de documentatie kunnen hoger zijn dan de waarde ervan, omdat het veel tijd kost.
• Vaak worden teksten geschreven door mensen die niet goed kunnen schrijven of die de stof niet kennen.
• Het bijhouden van door de klant gevraagde wijzigingen en het bijwerken van bijbehorende documenten is vermoeiend.
• Slechte documentatie is een direct signaal voor de kwaliteit van het product, aangezien er misverstanden kunnen ontstaan ​​tussen de klant en de organisatie.

Veelvoorkomende fouten die u moet vermijden bij testdocumentatie

Dit zijn de meest voorkomende fouten die u in testdocumentatie moet vermijden:

1. Vermijd het schrijven van onduidelijke of dubbelzinnige beschrijvingen van testcases.
2. Sla het documenteren van testvoorwaarden en afhankelijkheden niet over.
3. Vergeet nooit de verwachte resultaten voor elke test te vermelden.
4. Voorkom inconsistente opmaak in verschillende testdocumenten.
5. Gebruik geen vage of niet-meetbare testdoelstellingen.
6. Laat versiebeheer nooit achterwege bij updates van de testdocumentatie.
7. Voorkom dat informatie over meerdere testartefacten wordt gedupliceerd.
8. Controleer de documentatie op juistheid en volledigheid.

Veelgestelde vragen