Dans cet article, vous allez apprendre comment documenter correctement un bogue selon nos règles et normes. Afin de comprendre un bogue, nos clients ont besoin d'informations détaillées accompagnées d'une documentation de haute qualité. Vous trouverez des informations plus approfondies sur nos règles dans chaque section de cet article, mais voici un résumé rapide de nos exigences en matière de rapport de bogue:

La première étape dans le formulaire de rapport de bogue consiste à sélectionner la Fonctionnalité appropriée. Si vous ne trouvez pas la fonctionnalité appropriée dans la liste déroulante, veuillez retourner à la page de vue d'ensemble des tests, parcourir toutes les descriptions des fonctionnalités et les marquer comme lues. Ensuite, vous pourrez revenir au formulaire de rapport de bogue, et toutes les fonctionnalités seront disponibles dans la liste déroulante.

Une fois que vous avez sélectionné la fonctionnalité, l'intégralité du formulaire de rapport de bogue sera visible pour vous. Un exemple de formulaire pour les bogues fonctionnels ressemble à ce qui suit:

Vous devez compléter chaque champ du formulaire de rapport de bogue avec les informations spécifiques correctes, conformément à nos normes de qualité. Des informations plus détaillées concernant chaque champ et ses exigences sont disponibles ci-dessous.

Pour les rapports de bogues fonctionnels uniquement, vous verrez un champ supplémentaire appelé Gravité: Faible, Élevée et/ou Critique. La gravité indique l'urgence de votre rapport et dépend de plusieurs facteurs. Pour en savoir plus sur les différents niveaux de gravité, veuillez consulter l'article suivant: Bogues Fonctionnels.

Le champ Gravité ne s'affichera pas pour les autres Types de bogues.

Le titre du rapport de bogue doit résumer le problème de manière à ce que le lecteur ait une idée générale du bogue rien qu'en lisant le titre. Il ne devrait pas avoir à lire l'intégralité du rapport pour comprendre le problème. Votre titre de rapport de bogue doit être précis, mais il ne doit pas être trop long. Il doit contenir des informations telles que : quel est le bogue, où le bogue s'est produit et quand le bogue est déclenché. Donc, lorsque vous rédigez un titre pour votre rapport de bogue, souvenez-vous toujours de répondre aux questions suivantes: Quoi? Où? Quand?

Lorsque vous rédigez un titre de bogue, décrivez ce qui se produit plutôt que ce qui ne se produit pas. Votre titre ne doit jamais indiquer qu'il y a un dysfonctionnement, sinon le lecteur n'aura aucune idée de la nature du problème.

Les titres doivent refléter fidèlement le problème en question. Si le bogue ne se manifeste que dans des conditions particulières, ces conditions doivent être incluses dans le titre du bogue. Par exemple, si vous ne parvenez pas à réserver un billet en indiquant être un adolescent, cette information est pertinente et doit figurer dans votre titre.

Pour créer un titre descriptif, mettez-vous à la place de quelqu'un qui n'a jamais testé le site web ou l'application, qui ne peut pas visualiser la page que vous consultiez, à quoi elle ressemble, ni ce que vous avez fait. Lisez votre titre du point de vue de cette personne pour vérifier s'il permet de comprendre le problème. Si vous avez des doutes sur la qualité du titre ou si vous ne comprenez pas bien le bogue, ajustez-le et répétez le processus.

Mauvais: Erreur affichée sur la page du Panier

Bon: Une "Erreur 500" s'affiche sur la page du Panier après que l'utilisateur ait cliqué sur le bouton "Paiement"

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

Bon: Une "Erreur Inattendue" s'est produite sur la PDP lorsque l'utilisateur a sélectionné la Taille et a cliqué sur le bouton "Ajouter au Panier".

Ces exemples de titres présentent des problèmes potentiels: ils sont trop abstraits et pourraient correspondre à de nombreux scénarios différents. Le lecteur n'a pas suffisamment d'informations pour comprendre quelles actions ont été entreprises ni comment le système a réagi. Par conséquent, le relecteur serait contraint de lire l'intégralité du rapport pour saisir la nature du bogue, ce qui rendrait difficile la distinction de ce bogue parmi d'autres.

Rendez-vous sur la page où le bogue se manifeste, puis copiez et collez l'URL depuis la barre d'adresse de votre navigateur dans le champ URL dans le formulaire de rapport de bogue.

Assurez-vous que l'URL est correcte et valide.

Les bogues doivent être reproductibles, et ils ont besoin d'un guide détaillé étape par étape sur la manière de les reproduire. Chaque étape devrait décrire une action séparée.

La première étape doit contenir une instruction pour accéder à l'URL de la page de destination fournie par le client dans la section d'accès si vous testez un site web, ou une instruction pour ouvrir l'application (en précisant son nom) si vous testez une application mobile. Toutes les étapes suivantes doivent décrire vos actions depuis l'étape initiale jusqu'au moment où le bogue se produit: quels boutons vous appuyez, quels liens vous suivez, et ce que vous saisissez. Votre dernière étape doit décrire l'action que vous effectuez pour déclencher le bogue. N'oubliez pas que "observer" n'est pas une action prise par l'utilisateur

Vos étapes devraient être aussi générales que possible. Seulement si votre bogue se produit dans des conditions spécifiques, par exemple, uniquement pour une page d'aperçu de produit spécifique, pour un filtre spécifique, pour une entrée spécifique, etc., mentionnez cette condition dans vos étapes. Par exemple, dans vos étapes, ne décrivez pas la page d'aperçu de produit spécifique que vous avez visitée, puis le produit spécifique que vous avez ajouté au panier, si le problème se produit pour n'importe quel produit. Cela aidera le lecteur à comprendre l'idée de votre bogue, et il ne sera pas distrait par des détails non pertinents.

Enfin, assurez-vous que vos étapes contiennent le moins d'actions possible à effectuer. Après avoir lu chaque étape, la personne reproduisant votre bogue signalé devrait être en mesure de les accomplir 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.

Ce qui pose problème dans les exemples précédents: la première étape devrait contenir une instruction pour accéder à l'URL de la page de destination, plutôt que de se limiter à mentionner l'URL elle-même. La troisième étape manque de détails et regroupe trop d'actions en une seule étape. Les deuxième et quatrième étapes sont redondantes et ne contribuent pas à la compréhension du bogue.

Le résultat réel représente l'un des champs les plus cruciaux dans un rapport de bogue. Ici, vous expliquez en détail le problème et fournissez toutes les informations nécessaires pour une compréhension approfondie du bogue.

Il est essentiel de décrire avec précision ce qui se produit réellement après avoir suivi votre guide étape par étape. Évitez d'être trop général ; par exemple, au lieu de dire que les produits restent principalement dans le même ordre après l'application de la méthode de tri X, décrivez plutôt des exemples spécifiques de produits qui ne sont pas dans le bon ordre. Dans ce champ, incluez toutes les informations pertinentes au bogue, telles que des exemples, des conditions particulières, des exceptions ou les résultats d'autres actions importantes, le cas échéant. Assurez-vous simplement de structurer vos informations de manière à aider le lecteur à suivre votre raisonnement.

De plus, le résultat réel ne doit pas être identique au titre du rapport. Alors que le titre sert de résumé du problème, le résultat réel doit fournir une description détaillée, y compris des informations sur le scénario, des exemples et les résultats obtenus lors de l'exécution des étapes pour reproduire le bogue

Mauvais: Erreur affichée sur la page du Panier après avoir cliqué sur le bouton Paiement.

Bon: Lorsqu'un utilisateur ajoute un produit au Panier et tente de passer à la page de Paiement, il constate qu'il ne peut pas le faire. Une "Erreur 500 - Erreur Interne du Serveur - Désolé, une erreur s'est produite" s'affiche lorsque le bouton "Paiement" est cliqué dans le menu latéral droit.

Mauvais: L'utilisateur ne peut pas ajouter un produit au Panier, une erreur s'affiche.

Bon: Après qu'un utilisateur ait ouvert la page de détails "Test IO - Produit 1", sélectionné la Taille : 36, et cliqué sur le bouton "Ajouter au Panier", il se retrouve avec une bannière de message d'erreur "Erreur Inattendue" dans le coin supérieur droit de la PDP, et le produit n'est pas ajouté au Panier.

Décrivez ce que vous attendez qu'il se passe après avoir effectué votre dernière étape décrite. Comme toujours, les détails sont essentiels. Réfléchissez à ce qui aurait dû se produire si vous n'aviez pas rencontré le bogue, si tout avait fonctionné correctement. Rappelez-vous que le résultat attendu n'est pas la même chose que le résultat réel avec quelques légères variations ou des mots négatifs, mais un champ différent conçu pour que vous puissiez expliquer tout ce qui aurait dû se passer après que la dernière étape pour reproduire le bogue ait été terminée.

Mauvais: L'utilisateur peut accéder au Paiement.

Bon: Après avoir ajouté un produit au Panier et cliqué sur le bouton "Paiement", l'utilisateur devrait être redirigé correctement vers la page de Paiement, où il devrait pouvoir ajouter des informations de livraison et de paiement, et passer une commande.

Mauvais: Le produit doit être ajouté avec succès au Panier.

Bon: Lorsque la taille 36 est sélectionnée pour le "Test IO - Produit 1" et que le bouton "Ajouter au Panier" est cliqué, le produit devrait être ajouté avec succès au Panier. L'utilisateur ne devrait rencontrer aucune erreur dans ce processus.

Pour déterminer le type de pièce jointe à inclure dans votre rapport de bogue ainsi que les règles qui s'appliquent, veuillez vous référer à l'article suivant: Exigences pour les pièces jointes aux rapports de bogue.

Il est essentiel pour nous et nos clients de connaître le dispositif que vous avez utilisé lors de la découverte du bogue. Lorsque vous testez un site web, veuillez cliquer sur l'icône du navigateur correspondant au dispositif que vous avez employé. En cas de test sur une application mobile, sélectionnez le dispositif que vous avez utilisé pour le test et sur lequel l'application est installée.

Vous ne pouvez utiliser que les dispositifs répertoriés dans cette section pour les tests. De plus, veuillez choisir un seul dispositif ou navigateur lorsque vous signalez le bogue et joindre uniquement des pièces jointes correspondant à celui-ci. Si vous parvenez à reproduire le bogue sur d'autres dispositifs ou navigateurs, veuillez en faire mention dans votre résultat réel.

Sélectionner l'environnement correct où le bogue se produit est une étape obligatoire. Lorsque vous soumettez votre rapport, assurez-vous de choisir l'environnement approprié. Si vous avez accidentellement sélectionné le mauvais environnement, vous pouvez le corriger après avoir soumis le rapport. Pour ce faire, vous pouvez modifier votre choix d'environnement avant que l'équipe de gestion n'examine le rapport de bogue. Si le rapport de bogue indique un environnement incorrect, il sera rejeté lors de l'examen.

Souhaitez-vous effectuer des tests avec un dispositif qui ne figure pas dans la liste des appareils disponibles dans votre profil? Il vous suffit de nous envoyer une demande via le chat de support, et nous ajouterons votre dispositif à la liste, à condition qu'il soit pertinent pour nos clients.

Après avoir soumis votre rapport, vous pouvez toujours éditer tous les champs, sauf le type de bogue sélectionné. Vous devez toujours soumettre des rapports de bogue complets prêts à être examinés et n'utiliser l'option de modification que si vous avez fait une petite faute de frappe ou si vous souhaitez reformuler vos mots pour améliorer la qualité du rapport.

Si votre bogue ne se produit que pour une entrée spécifique, utilisez les termes qui seraient utilisés par de vrais utilisateurs et évitez d'entrer 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 donnerait un aspect non professionnel à votre rapport.