Formatar seus relatórios pode, às vezes, ajudar os leitores a identificar partes importantes mais rapidamente. Especialmente ao enviar relatórios de usabilidade, como ao responder várias perguntas em uma pesquisa, os leitores podem diferenciar facilmente entre perguntas e respostas, bem como manchetes quando o relatório é formatado.
Nossos formulários de relatório suportam o Markdown, uma linguagem de marcação que permite que você formate seu texto com uma sintaxe simples. Abaixo, listamos a sintaxe do Markdown que é mais útil para documentar bugs em nossa plataforma.
Texto em Negrito
Para dar ênfase a palavras ou frases importantes, coloque-as em negrito. Basta adicionar dois asteriscos antes e depois da parte relevante.
Exemplo
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 em Itálico
Ao colocar rótulos de botões ou nomes de links em itálico nas suas etapas, isso pode torná-los mais compreensíveis do que aspas ou texto simples. Para fazer isso, adicione um único asterisco ou sublinhado antes e depois da parte que você deseja destacar em itálico.
Exemplo
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
Você pode usar marcadores para listar informações igualmente classificadas, o que melhora a estrutura e a legibilidade das suas informações.
Exemplo
- 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
Regras horizontais
Regras horizontais ajudam a separar diferentes partes de informação entre si. Por exemplo, quando for solicitado que você forneça as credenciais que usou no site do cliente, você pode adicioná-las abaixo de uma regra horizontal no seu resultado esperado. Para adicionar uma, insira uma nova linha seguida por três hifens, asteriscos ou underscores.
Exemplo
[...] Therefore, the checkout cannot be completed.
---
User name: tester12345
Password: 112233
Resultado
Títulos
Ao enviar sugestões de usabilidade e precisar subdividir informações, a introdução de títulos é a solução. Adicione sinais de hashtag (#) na frente da sua legenda para aumentá-la; quanto mais hashtags você usar, menor será o tamanho da fonte do título. Recomendamos o uso de três ou mais hashtags em relatórios na nossa plataforma, já que # e ## produzem títulos grandes.
Exemplo
### 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
Mais informações
Sintaxes adicionais e exemplos podem ser encontrados na internet, por exemplo, neste Guia de Markdown. Alguns elementos não funcionam ou não são adequados para serem usados no nosso formulário de bugs.