La mise en forme de tes rapports peut parfois aider les lecteurs à identifier rapidement les éléments importants. Surtout lorsque tu soumets des rapports d'utilisabilité, par exemple en répondant à plusieurs questions dans une enquête, les lecteurs peuvent facilement différencier entre les questions, les réponses et les titres lorsque ton rapport est formaté.
Nos formulaires de rapport prennent en charge Markdown, un langage de balisage qui te permet de formater ton texte avec une syntaxe simple. Ci-dessous, nous répertorions la syntaxe Markdown la plus utile pour documenter les bogues sur notre plateforme.
Texte en Gras
Pour mettre en évidence des mots ou des phrases importantes, mets-les en gras. Ajoute simplement deux astérisques avant et après la partie importante.
Exemple
The product cannot be added to the cart. This problem affects any product in the webshop. **No products can be purchased.**
Résultat
The product cannot be added to the cart. This problem affects any product in the webshop. No products can be purchased.
Texte en Italique
Mettre en italique les libellés de boutons ou les noms de liens dans tes étapes peut les rendre plus compréhensibles que les apostrophes ou le texte brut. Pour ce faire, ajoute un astérisque ou un souligné avant et après la partie que tu veux mettre en italique.
Exemple
Step 3: Click on the button *Add to Cart*.
Step 4: Go to the cart via _Your Shopping Cart_ in the header navigation.
Résultat
Step 3: Click on the button Add to Cart.
Step 4: Go to the cart via Your Shopping Cart in the header navigation.
Listes
Tu peux utiliser des puces pour énumérer des informations de même rang, afin que la structure et la lisibilité de tes informations soient améliorées.
Exemple
- The user gets redirected back to the shopping cart.
- The shopping cart is suddenly empty; items have been removed.
- The layout of the shopping cart page is broken.
Résultat
Lignes Horizontales
Les lignes horizontales aident à séparer différentes pièces d'information les unes des autres. Par exemple, lorsque l'on te demande de fournir les informations d'identification utilisées sur le site web du client, tu peux les ajouter sous une ligne horizontale dans ton résultat attendu.
Exemple
[...] Therefore, the checkout cannot be completed.
---
User name: tester12345
Password: 112233
Résultat
Titres
Lorsque tu soumets des suggestions d'utilisabilité et que tu dois subdiviser les informations, l'introduction de titres est la solution. Ajoute des signes dièse (#) devant ta légende pour l'agrandir; plus tu utilises de dièses, plus la police du titre devient petite. Puisque l'utilisation de # et ## produit des titres importants, nous recommandons d'utiliser trois dièses ou plus dans les rapports sur notre plateforme.
Exemple
### Survey
##### Question 1: Name three things that you liked most about the product.
[Answer question 1]
##### Question 2: Which prototype website do you find more intuitive? Justify your answer!
[Answer question 2]
Résultat
Plus d'Informations
Plus de syntaxe et d'exemples peuvent être trouvés sur Internet, par exemple dans ce Guide Markdown. Certains éléments ne marchent pas ou ne sont pas adaptés à être utilisés dans notre formulaire de rapport de bogue.