Documentation de test dans les tests de logiciels (exemple)

Qu'est-ce que la documentation des tests ?

La documentation de test regroupe les artefacts créés avant ou pendant les tests logiciels. Elle aide l'équipe de test à estimer l'effort requis, à suivre les ressources et l'avancement, et à garantir une couverture de test adéquate. Le compte rendu et les rapports de test constituent un ensemble complet de documents permettant de décrire et de documenter la planification, la conception, l'exécution et les résultats des tests.

👉 Inscrivez-vous gratuitement au projet de test de logiciel en direct

Pourquoi un formalisme accru pour les tests ?

Pour un novice, il est facile de croire que les tests consistent à exécuter les différentes sections de code de manière ponctuelle et à vérifier les résultats. Or, dans la réalité, les tests constituent une activité très formelle et sont documentés en détail. Cette documentation facilite la planification, la revue et l'exécution des tests, tout en garantissant leur vérification.

Le degré de formalité du test dépend de :

• Le type d'application testée (AUT).
• Normes suivies par votre organisation.
• La maturité du processus de développement.

Les activités de test durent généralement entre 30% et 50% de l'effort total de développement logiciel. La documentation permet d'identifier les améliorations à apporter au processus de test, applicables aux projets futurs.

Quels sont les types de documentation de test ?

Voici les principaux types de documentation de test :

« En pratique, ces documents sont créés à différentes étapes — de la planification initiale (politique et stratégie de test) à l’exécution et à la clôture (rapports de défauts et rapports de synthèse). »

Types de documents de test	Description
Politique de test	Il s'agit d'un document de haut niveau qui décrit les principes, les méthodes et tous les objectifs de test importants de l'organisation.
Stratégie de test	Un document de haut niveau qui identifie les niveaux (types) de tests à exécuter pour le projet.
Plan de test	Un plan de test est un document de planification complet qui contient la portée, l'approche, les ressources, le calendrier, etc. des activités de test.
Matrice de traçabilité des exigences	Ce document établit le lien entre les exigences et les cas de test.
Scénario de test	Scénario de test est un élément ou un événement d'un système logiciel qui pourrait être vérifié par un ou plusieurs cas de test.
Cas de test	Il s'agit d'un ensemble de valeurs d'entrée, de préconditions d'exécution, de postconditions d'exécution attendues et de résultats. Il est conçu pour un scénario de test.
Données de test	Les données de test sont des données existantes avant l'exécution d'un test. Elles servent à exécuter le cas de test.
Rapport de défaut	Un rapport de défaut est un compte rendu documenté de tout défaut dans un système logiciel qui ne parvient pas à remplir sa fonction attendue.
Rapport de synthèse du test	Le rapport de synthèse des tests est un document de haut niveau qui résume les activités de test réalisées ainsi que les résultats obtenus.

Quelles sont les meilleures pratiques pour obtenir une documentation de test adéquate ?

Dans cette section, nous allons découvrir les meilleures pratiques pour réaliser une documentation de test, avec des exemples pour vous aider à mieux la comprendre :

• Impliquez l'assurance qualité dès le début du projet : Intégrez l'équipe d'assurance qualité dès le début du projet afin que la documentation des tests se développe en parallèle de la conception et des exigences du produit.
  Exemple : L'équipe QA collabore lors de la planification du sprint pour rédiger les premiers cas de test basés sur les récits utilisateurs.
• Tenez vos documents à jour : Ne vous contentez pas de créer des documents de test et de les oublier ; mettez-les à jour chaque fois que les exigences ou les fonctionnalités changent.
  Exemple : Lorsqu'une API de connexion est modifiée, mettez immédiatement à jour les cas de test et les résultats associés.
• Utiliser le contrôle de version : Gérez et suivez toutes les modifications apportées aux documents de test grâce à des systèmes de contrôle de version afin d'éviter toute confusion et toute perte de données.
  Exemple : Stockez les plans de test sur GitHub pour conserver un historique des versions clair et des options de restauration.
• Document destiné à clarifier et à préciser son objectif : N'enregistrez que ce qui vous permet, ainsi qu'à vos parties prenantes, de comprendre l'avancement des tests et les livrables.
  Exemple : Inclure des rapports de synthèse des tests mettant en évidence les cas de test réussis, échoués et bloqués, à l'intention de la direction.
• Utilisez des modèles standard : Adoptez un format cohérent — comme des modèles Excel ou Word — pour faciliter la création et la révision des documents.
  Exemple : Utilisez un « Modèle de cas de test » standard comportant des champs pour l'identifiant, la description, les préconditions et les résultats attendus.
• Centraliser le stockage des documents : Conservez tous les documents relatifs au projet dans un seul endroit facilement accessible afin que les membres de l'équipe puissent les consulter ou les mettre à jour facilement.
  Exemple : Stockez les artefacts de test dans un espace partagé Google Drive Dossier accessible à toute l'équipe QA et de développement.
• Inclure suffisamment de détails : Évitez les informations vagues ou incomplètes ; une documentation détaillée améliore la compréhension et réduit les erreurs lors de l'exécution des tests.
  Exemple : Au lieu de « Vérifier la connexion », écrivez « La vérification de la connexion de l'utilisateur avec des identifiants valides redirige correctement vers le tableau de bord. »

Quand faut-il créer une documentation de test pour les tests logiciels ?

Voici quelques points clés concernant le moment où vous devriez créer une documentation de test pour les tests logiciels :

• Phase de planification : Avant de commencer l'exécution des tests, il convient de définir clairement la portée, les objectifs et la stratégie de test.
• La préparation du test: Lors de la planification des tests, afin d'établir efficacement les échéanciers, les ressources et les exigences environnementales.
• Analyse des exigences: Après l'analyse des exigences, afin de garantir une couverture complète des spécifications fonctionnelles et non fonctionnelles.
• Normalisation de la conception : Avant de concevoir les cas de test, il convient de standardiser les formats et de maintenir la traçabilité de tous les documents.
• Documentation du scénario : Lors de la conception des tests, documenter les scénarios, les entrées, les sorties attendues et les détails des données de test.
• État de préparation à l'exécution : Avant l'exécution des tests, vérifier que l'environnement de test, les outils et la documentation sont prêts et exacts.
• Évaluation finale : Après les tests, consigner les résultats, les défauts et les enseignements tirés en vue de l'amélioration des processus.

Quels types de modèles sont nécessaires pour la documentation de test ?

Voici quelques-uns des modèles dont vous avez besoin pour la documentation de test dans le cadre des tests logiciels :

Nom du modèle	Outils
Modèle de plan de test	Microsoft Word, Google Docs, ou Confluence pour l'édition collaborative et le contrôle de version
Modèle de cas de test	TestRail, Zephyr (dans JIRA), Xray ou Excel/Google Sheets pour la gestion structurée des tests
Modèle de scénario de test	JIRA, TestLink ou Google Sheets pour documenter les conditions de test de haut niveau
Modèle de matrice de traçabilité des exigences (RTM)	Excel, Google Sheets ou TestRail pour associer les exigences aux cas de test
Modèle de rapport de défaut	JIRA, Bugzilla ou Azure DevOps pour la consignation et le suivi des anomalies
Modèle de rapport de synthèse de test	Confluence, Google Docs, ou TestRail pour la compilation et l'analyse des résultats de tests

Avantages et inconvénients de la documentation des tests

Avantages

• La principale raison de créer une documentation de test est de réduire, voire d'éliminer, toute incertitude concernant les activités de test. Elle permet de lever les ambiguïtés, souvent présentes lors de la répartition des tâches.
• La documentation offre non seulement une approche systématique de test logiciel, mais il sert également de matériel de formation pour les débutants dans le processus de test de logiciels.
• Cela constitue une bonne stratégie de marketing et de vente que de présenter la documentation de test afin de démontrer la maturité du processus de test.
• La documentation de test vous aide à proposer un produit de qualité au client dans des délais précis.
• In Génie logicielLa documentation de test permet également de configurer ou de paramétrer le programme grâce au document de configuration et aux manuels d'utilisation.
• La documentation des tests vous aide à améliorer la transparence avec le client.

Inconvénients

• Le coût de la documentation peut dépasser sa valeur car elle prend beaucoup de temps.
• Souvent, ces textes sont écrits par des personnes qui ne savent pas bien écrire ou qui ne connaissent pas le sujet.
• Suivre les modifications demandées par le client et mettre à jour les documents correspondants est fatiguant.
• Une documentation de mauvaise qualité reflète directement la qualité du produit, car un malentendu entre le client et l'organisation peut survenir.

Erreurs courantes à éviter dans la documentation de test

Voici les erreurs les plus courantes à éviter dans une documentation de test :

1. Évitez de rédiger des descriptions de cas de test imprécises ou ambiguës.
2. N’omettez pas de documenter les préconditions et les dépendances des tests.
3. N'oubliez jamais d'inclure les résultats attendus pour chaque test.
4. Évitez les incohérences de mise en forme entre les différents documents de test.
5. N’utilisez pas d’objectifs de test vagues ou non mesurables.
6. N’omettez jamais le contrôle de version pour les mises à jour de la documentation de test.
7. Évitez de dupliquer les informations dans plusieurs artefacts de test.
8. N’oubliez pas de vérifier l’exactitude et l’exhaustivité des documents.

Questions fréquentes