Passer au contenu principal

Exigences des rapports de bogue

Comment documenter correctement un rapport de bogue et quelles sont les normes de Test IO?

Zorica Micanovic avatar
Écrit par Zorica Micanovic
Mis à jour aujourd’hui

Dans cet article, tu apprendras comment documenter correctement ton bogue selon nos règles et normes. Afin de comprendre un bogue, les clients ont besoin d'informations suffisantes avec une documentation de haute qualité. Tu trouveras des informations plus détaillées sur nos règles dans chaque section de cet article, mais voici un résumé rapide de nos exigences de rapport de bogue:

  • Si tu signales un bogue fonctionnel, tu dois sélectionner une des Gravités disponibles avant de remplir le reste du rapport de bogue.

  • Le Titre doit répondre aux questions de ce qui s'est passé, où le bogue s'est produit et quand il est déclenché, reflétant le vrai problème et évitant de décrire ce qui ne s'est pas passé (au lieu de cela, concentre-toi sur ce qui s'est réellement passé).

  • L'URL doit être le lien copié depuis ton navigateur de la page où le bogue est déclenché.

  • La première Étape pour Reproduire doit contenir l'URL de la page d'accueil ou le nom de l'application. Les autres étapes devraient décrire les actions que tu as prises pour déclencher le problème, la dernière étape étant la dernière action prise pour déclencher le problème (et non "observer").

  • Le Résultat Réel devrait être formé d'une ou plusieurs phrases expliquant ce qui s'est passé après la dernière action. Tu peux aussi ajouter les résultats d'actions précédentes s'ils sont nécessaires pour comprendre le bogue. Il ne doit pas être identique au titre.

  • Le Résultat Attendu devrait contenir des informations sur ce qui aurait dû se passer à la place après avoir effectué la dernière étape pour déclencher le bogue. Il ne doit pas être une copie du résultat actuel avec des changements mineurs puisque ces champs sont conçus à des fins différentes.

  • Si une Pièce jointe est requise pour ton rapport, tu ne dois pas oublier d'en joindre une.

  • Enfin, tu dois sélectionner l'Environnement Utilisé et le navigateur corrects (si applicable) utilisés pour les tests, basés sur l'appareil avec lequel tu as été invité à tester quand tu as accepté le cycle.

Ta première étape dans le formulaire de rapport de bogue devrait être de sélectionner la bonne Fonctionnalité. Si tu ne peux pas trouver la bonne Fonctionnalité dans la liste déroulante, retourne à la page de vue d'ensemble du test, passe en revue toutes les descriptions de Fonctionnalités et marque-les comme lues. Après cela, tu peux retourner au formulaire de rapport de bogue et toutes les Fonctionnalités seront présentées dans la liste déroulante.

Formulaire de Bogue

Après avoir sélectionné la Fonctionnalité, tout le formulaire de bogue sera visible pour toi. Un formulaire pour bogues fonctionnels, par exemple, ressemble à ceci:

Tu devrais remplir chaque champ du formulaire de bogue avec les informations spécifiques correctes selon nos normes de qualité. Des informations plus détaillées sur chaque champ et ses exigences peuvent être trouvées ci-dessous.

Gravité

Pour les bogues Fonctionnels seulement, tu verras un champ supplémentaire appelé Gravité : Faible, Élevée, et/ou Critique. La gravité indique l'urgence de ton rapport et dépend de multiples facteurs. Pour en apprendre sur les différents niveaux de gravité, visite l'article suivant Bogues Fonctionnels.

Le champ Gravité ne sera pas affiché pour d'autres Types de bogues.

Titre

Le titre du rapport de bogue devrait résumer le problème pour que le lecteur ait une idée générale du bogue juste en lisant le titre du bogue. Il ne devrait pas avoir à lire tout le rapport pour comprendre quel est le problème. Ton titre de rapport de bogue devrait être précis et pas trop long en même temps. Il devrait contenir des informations: quel est le bogue, le bogue s'est-il produit, et quand le bogue est-il déclenché ? Donc quand tu écris un titre pour ton rapport de bogue, rappelle-toi toujours: Quoi? Où? Quand?

Quand tu écris un titre de bogue, décris ce qui se passe au lieu de ce qui ne se passe pas. Ton titre ne devrait jamais déclarer que quelque chose ne fonctionne pas, sinon le lecteur n'a aucune idée de ce qui se passe réellement.

Les titres doivent refléter le vrai problème. Si le bogue ne se produit que sous certaines conditions, les conditions doivent être incluses dans le titre du bogue. Si tu n'es pas capable, par exemple, de réserver un billet quand tu déclares que tu es un adolescent, c'est une information pertinente et doit être incluse dans ton titre.

Pour créer un titre descriptif, mets-toi à la place de quelqu'un qui n'a jamais testé le site web/l'application, qui ne peut pas imaginer sur quelle page tu es, à quoi elle ressemble et ce que tu as fait. Lis ton titre du point de vue de cette personne pour voir si tu comprendrais le bogue. Si tu n'as pas une bonne idée du bogue, ajuste le titre du bogue et répète le processus.

Titres de bogue exemplaires

Faux: Erreur montrée sur la page Panier

Correct: Le bouton "Commande" de la page Panier dirige les utilisateurs vers une page "Erreur 500"

Faux: L'utilisateur ne peut pas ajouter un produit au Panier

Correct: Sur la page "T-Shirt Batman", les utilisateurs reçoivent un message "Erreur Inattendue" lors de la tentative d'ajout de l'article au panier

URL

Visite la page où le bogue apparaît et copie & colle l'URL du champ URL de ton navigateur dans le champ URL du formulaire de rapport de bogue.

L'URL doit être valide.

Étapes pour reproduire

Les bogues doivent être reproductibles et ils ont besoin d'un guide détaillé étape par étape sur comment ils peuvent être reproduits. Chaque étape devrait décrire une action séparée.

Note que tu n'as pas à numéroter tes étapes car c'est fait automatiquement par notre système.

La première étape doit contenir une indication pour accéder à l'URL de la page d'accueil fournie par le client dans la section Accès si tu testes un site web ou une indication pour ouvrir l'application (avec son nom) si tu testes une application mobile. Toutes les étapes suivantes devraient décrire tes actions depuis l'étape initiale jusqu'au point où le bogue se produit – quels boutons tu appuies, quels liens tu suis, et ce que tu saisis. Ta dernière étape doit décrire l'action que tu effectues qui déclenche le bogue. Rappelle-toi qu'"observer" n'est pas une action prise par l'utilisateur.

Tes étapes devraient être aussi générales que possible. Seulement si ton bogue se produit sous des conditions spécifiques, par exemple seulement pour une page de vue d'ensemble de produit spécifique, pour un filtre spécifique, pour une saisie spécifique, etc., nomme cette condition dans tes étapes. Par exemple, dans tes étapes, ne décris pas la page de vue d'ensemble de produit spécifique que tu as visitée, puis le produit spécifique que tu as ajouté au panier si le problème se produit pour n'importe quel produit. Cela aidera le lecteur à saisir l'idée de ton bogue et il ne sera pas distrait par des détails non pertinents.

Enfin, assure-toi que tes étapes contiennent le moins d'actions possible à effectuer. Après avoir lu chaque étape, la personne reproduisant ton bogue signalé devrait être capable de les compléter sur le site web ou l'application. Elle ne devrait pas avoir à vérifier la même étape plusieurs fois pour se rappeler ce qui doit être fait.

Étapes exemplaires

  1. Saisis n'importe quelle requête de recherche dans la barre de recherche en haut à droite (par exemple "San Francisco")

  2. Clique sur le bouton "Rechercher Maintenant"

  3. Descends et clique sur "Trier par"

  4. Sélectionne l'option "Trier par prix : Du plus élevé au plus bas"

Étapes exemplaires MAUVAISES

  1. Observer

  2. Recherche > Trier > Du plus élevé au plus bas

  3. Observer

Ce qui ne va pas avec les exemples ci-dessus: La première étape doit contenir une indication pour accéder à l'URL de la page d'accueil, pas juste l'URL elle-même. La troisième étape n'est pas assez détaillée et contient trop d'actions dans une seule étape. Les deuxième et quatrième étapes sont redondantes et pas nécessaires pour comprendre le bogue.

Résultat Actuel

Le résultat actuel est un des champs les plus importants d'un rapport de bogue parce qu'ici tu expliques quel est le problème et tous les détails supplémentaires qui sont nécessaires pour comprendre le bogue.

Ce qui arrive réellement après avoir suivi ton guide étape par étape devrait être décrit de la façon la plus détaillée possible. Essaie d'être très précis et ne sois pas trop général en disant par exemple que les produits restent principalement dans le même ordre après avoir appliqué la méthode de tri X mais décris plutôt des exemples spécifiques des produits qui ne sont pas dans le bon ordre. Ajoute toute information dans ce champ qui est pertinente au bogue, par exemple exemples, conditions supplémentaires, exceptions ou résultats d'autres importants si nécessaire. Assure-toi juste de structurer tes informations pour aider le lecteur à comprendre ton processus de réflexion.

Notes importantes: Les résultats actuels et attendus ne doivent jamais être juste l'opposé l'un de l'autre. L'attente de ce qui aurait dû arriver et ce qui s'est réellement passé à la place diffèrent grandement.

De même, le résultat actuel ne doit pas être identique au titre du rapport. Tandis que le titre est un résumé du problème, le résultat actuel devrait être une description détaillée de celui-ci et devrait inclure des détails supplémentaires tels que des informations de scénario, des exemples et des résultats obtenus lors de l'exécution des étapes pour reproduire le bogue.

Résultat actuel exemplaire

Faux: Erreur montrée sur la page Panier après avoir cliqué sur le bouton Commande. ​

Correct: "Erreur 500 - Erreur de Serveur Interne - Désolé quelque chose s'est mal passé" est montré à l'utilisateur après qu'il essaie de procéder à la page Commande.

Faux: L'utilisateur ne peut pas ajouter un produit au Panier, une erreur est montrée. ​

Correct: Un message d'erreur "Erreur Inattendue" apparaît dans le coin supérieur droit de la PDP, et le produit n'est pas ajouté au Panier.

Résultat Attendu

Décris ce que tu t'attends à voir arriver après avoir effectué ta dernière étape décrite. Comme toujours, les détails sont la clé. Pense à ce qui aurait dû arriver si tu n'avais pas expérimenté le bogue - si tout avait fonctionné correctement.

Rappelle-toi que le résultat attendu n'est pas identique au résultat actuel avec quelques variations légères ou mots négatifs, mais un champ différent conçu pour que tu puisses expliquer tout ce qui aurait dû arriver après que la dernière étape pour reproduire le bogue ait été complétée.

Résultat attendu exemplaire

Faux: L'utilisateur peut procéder à la Commande ​

Correct: L'utilisateur devrait être redirigé correctement vers la page Commande, où il devrait être capable d'ajouter des informations d'expédition et de paiement et passer une commande.

Faux: Le produit devrait être ajouté au Panier. ​

Correct: Le produit "T-Shirt Batman" devrait être ajouté avec succès au panier. L'utilisateur ne devrait pas rencontrer d'erreurs comme "Erreur 505" et devrait être capable de commander tous les articles dans son panier.

Pièces jointes

Pour apprendre quel type de pièce jointe doit être jointe pour ton bogue et quelles règles s'appliquent, visite l'article suivant: Exigences pour les pièces jointes aux rapports de bogue.

Environnement utilisé

Il est important pour nous et nos clients de savoir quel appareil tu as utilisé quand tu as expérimenté le bogue. Lors du test d'un site web, clique sur l'icône du navigateur à côté de l'appareil que tu as utilisé. Lors du test d'une application mobile, sélectionne l'appareil que tu as utilisé pour les tests et qui a l'application installée.

Tu peux seulement utiliser les appareils pour les tests qui sont listés dans cette section. De plus, tu devrais sélectionner seulement un appareil ou navigateur quand tu signales le bogue, et télécharger seulement des pièces jointes pour celui-ci. Si tu peux reproduire le bogue sur d'autres appareils ou navigateurs, mentionne ceci dans ton Résultat actuel.

Sélectionner l'environnement correct où le bogue se produit est une action obligatoire. Quand tu soumets ton rapport, assure-toi de sélectionner l'environnement correct. Si tu sélectionnes accidentellement le mauvais environnement, tu peux le corriger après l'avoir soumis. Tu peux faire cette correction en changeant ta sélection d'environnement avant que le chef d'équipe révise le rapport de bogue. Si le rapport de bogue contient le mauvais environnement, le TL le rejettera pendant la révision du rapport de bogue.

Tu aimerais tester avec un appareil qui n'est pas dans la liste des appareils disponibles dans ton profil? Envoie-nous simplement une demande via le chat Support et nous ajouterons ton appareil à ta liste pourvu qu'il soit pertinent pour nos clients.

Note: Quand tu supprimes l'appareil pour lequel tu as été invité de ta liste d'appareils dans ton profil de testeur, tu ne peux plus soumettre de rapports dans ce test. La section environnement du formulaire de bogue sera vide et le formulaire ne pourra pas être envoyé. Supprimer un appareil dans ton profil ne peut pas être inversé après que tu aies accepté une invitation de test!

Améliorer ton rapport

Après avoir soumis ton rapport, tu peux encore éditer tous les champs sauf le type de bogue sélectionné. Tu dois toujours soumettre des rapports de bogue complets qui sont prêts à être révisés et utiliser seulement l'option Éditer dans le cas où tu as fait une petite erreur de frappe ou veux reformuler tes mots pour améliorer la qualité du rapport.

Rappelle-toi que les espaces réservés ne sont pas autorisés, donc ne soumets pas de rapports incomplets pour les éditer plus tard.

Si ton bogue n'arrive qu'avec une saisie spécifique, utilise des termes qui seraient utilisés par de vrais utilisateurs et évite de saisir des mots-clés aléatoires lors de la création du rapport de bogue ou des pièces jointes. Un mauvais exemple serait d'utiliser un nom d'utilisateur lors de la création d'un compte sur l'interface client tel que "asdsdfkg_lajsdh" car cela fait paraître ton rapport non professionnel.

Dans le cas où tu as soumis un rapport de bogue par erreur, tu peux le supprimer, mais seulement s'il n'a PAS été révisé par le Chef d'Équipe encore.

Avez-vous trouvé la réponse à votre question ?