A veces, dar formato a tus reportes puede ayudar a los lectores a identificar más rápidamente las partes importantes. Especialmente al enviar informes de usabilidad, como al responder varias preguntas en una encuesta, los lectores pueden diferenciar fácilmente entre preguntas y respuestas, así como entre titulares, cuando tu reporte está formateado.
Nuestros formularios de reporte admiten Markdown, un lenguaje de marcado que te permite formatear tu texto con una sintaxis simple. A continuación, enumeramos la sintaxis Markdown más útil para documentar errores en nuestra plataforma.
Texto en negrita
Para resaltar palabras o frases importantes, ponlas en negrita. Basta con añadir dos asteriscos antes y después de la parte importante.
Ejemplo:
The product cannot be added to the cart. This problem affects any product in the webshop. **No products can be purchased.**
Resultado:
The product cannot be added to the cart. This problem affects any product in the webshop. No products can be purchased.
Texto en cursiva
Poner en cursiva las etiquetas de los botones o los nombres de los enlaces en tus pasos puede hacerlos más comprensibles que los apóstrofes o el texto sin formato. Para ello, añade asteriscos o guiones bajos antes y después de la parte que quieras poner en cursiva.
Ejemplo:
Step 3: Click on the button *Add to Cart*.
Step 4: Go to the cart via _Your Shopping Cart_ in the header navigation.
Resultado:
Step 3: Click on the button Add to Cart.
Step 4: Go to the cart via Your Shopping Cart in the header navigation.
Listas
Puedes utilizar viñetas para enumerar información de igual rango, de modo que se mejore la estructura y legibilidad de la información.
Ejemplo:
- 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
Resultado:
Reglas horizontales
Las reglas horizontales ayudan a separar distintas piezas de información entre sí. Por ejemplo, cuando se te pide que proporciones las credenciales que utilizaste en el sitio web del cliente, puedes añadirlas debajo de una regla horizontal en el resultado esperado. Para añadir una, agrega una nueva línea y otra línea con tres guiones, asteriscos o guiones bajos.
Ejemplo:
[...] Therefore, the checkout cannot be completed.
---
User name: tester12345
Password: 112233
Resultado:
Encabezados
Cuando envíes sugerencias de usabilidad y necesites subdividir la información, introducir encabezados es la solución. Añade signos de hashtag (#) delante de tu encabezado para ajustar su tamaño; cuantos más hashtags utilices, más pequeña será la fuente del encabezado. Dado que el uso de # y ## producirá encabezados grandes, recomendamos utilizar tres o más hashtags en los reportes de nuestra plataforma.
Ejemplo:
### 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]
Resultado:
Más información
Puedes encontrar más sintaxis y ejemplos en Internet, por ejemplo, en esta Guía Markdown. Algunos elementos pueden no funcionar o no ser adecuados para ser utilizados en nuestro formulario de errores.