Ceci est un guide pour rédiger des rapports de bogue efficaces dans Discourse afin de maximiser les chances que les bogues soient corrigés.
Niveau d’utilisateur requis : Tout le monde peut signaler un bogue
Rédiger un bon rapport de bogue est essentiel pour aider l’équipe de Discourse à résoudre les problèmes efficacement. Ce guide vous guidera à travers les étapes et les meilleures pratiques pour vous assurer que votre rapport de bogue est clair, concis et exploitable.
Résumé
Dans cette documentation, nous couvrirons :
- L’importance de fournir des étapes reproductibles et des détails spécifiques
- Comment décrire le problème et le comportement attendu
- Les meilleures pratiques pour signaler sur différentes plateformes
- Maintenir un ton approprié dans votre rapport
- Pièges courants et solutions
Étapes pour rédiger un rapport de bogue efficace
Priorité/Sévérité
Déterminez l’urgence de la correction du bogue. Bien que tout le monde souhaite que ses problèmes soient résolus rapidement, réservez la priorité la plus élevée aux problèmes critiques qui ont un impact significatif sur les fonctionnalités.
Plateforme
Spécifiez toujours l’environnement dans lequel le bogue a été observé. Cela comprend :
- Type d’appareil (bureau, mobile, écran tactile, tablette)
- Système d’exploitation et sa version
- Navigateur Web et sa version
Dans la mesure du possible, reproduisez le bogue sur plusieurs plateformes pour confirmer sa présence.
Description
Soyez concis. Décrivez le problème simplement et sans détails inutiles. Séparez les différents problèmes s’ils peuvent être signalés individuellement. Un format de description clair comprend :
Résultat actuel : Que se passe-t-il ?
Résultat attendu : Que se serait-il passé ?
Évitez les suppositions quant à ce que le lecteur sait déjà. Soyez explicite sur ce qui aurait dû être vu ou s’être produit.
Étapes reproductibles
Assurez-vous que le bogue peut être reproduit de manière cohérente. Rédigez des instructions étape par étape en commençant par l’écran d’accueil de Discourse. Si le bogue apparaît de manière aléatoire, spécifiez à quelle fréquence il se produit (par exemple, 1 tentative sur 10). Pour les bogues liés à l’interface utilisateur/expérience utilisateur, ajoutez des captures d’écran ou des vidéos pour plus de clarté.
Ton
Maintenez un ton respectueux et poli. Évitez d’utiliser le rapport de bogue pour exprimer votre frustration. Tout langage ou comportement toxique peut entraîner un retard ou l’ignorance de votre rapport.
Modèle
Utilisez ce modèle pour démarrer rapidement un nouveau sujet de rapport de bogue :
Priorité/Sévérité :
Plateforme :
Description :
Étapes reproductibles :
Meilleures pratiques
- Reproduire en mode sans échec : Avant de signaler, essayez de reproduire le problème dans le Mode sans échec de Discourse si vous soupçonnez que des personnalisations pourraient en être la cause.
- Questionner les suppositions : Les rapports de bogues découlent souvent de fausses suppositions. Même dans votre rapport, questionnez et clarifiez toutes les suppositions que vous pourriez avoir.
- Soyez détaillé : Pour les bogues difficiles à cerner ou rares, fournissez autant de détails que possible. Incluez tout ce que vous pensez pouvoir être pertinent, comme les messages d’erreur ou les fichiers journaux.
Problèmes courants et solutions
Problème : Impossible de reproduire le bogue de manière cohérente.
Solution : Documentez l’environnement et les conditions dans lesquelles le bogue apparaît. Notez tout modèle ou toute caractéristique commune.
Problème : Absence de réponse à un rapport de bogue.
Solution : Assurez-vous que votre rapport est détaillé mais concis et rédigé sur un ton courtois.
FAQ
Q : Que faire si je n’ai pas le temps de rédiger un rapport détaillé ?
R : Il est toujours utile d’ouvrir un rapport avec les informations dont vous disposez. Indiquez que vous le mettrez à jour avec plus de détails plus tard.
Q : Où dois-je publier mon rapport de bogue ?
R : Utilisez la catégorie appropriée - les rapports de bogues doivent aller dans la catégorie bug.