Formatting your reports can help readers identify important bits more quickly. Especially when you submit usability reports, e.g. when answering multiple questions in a survey, readers can easily differentiate between questions and answers as well as headlines when your report is formatted.
Our report forms support Markdown – a markup language – that lets you format your text with simple syntax.
After applying any formatting, you can also easily preview the Result or Expected result description field, to see how it will look by pressing the Preview button.
Below, we list the Markdown syntax that is most useful to document bugs on our platform.
Bold text
To add emphasis to important words or phrases, make it bold. Simply add two asterisks before and after the important bit.
Italic text + highlight
Italicizing button labels or link names in your steps can make them more understandable than apostrophes or plain text. To do so, add single asterisks or underscores before and after the part that you want to make italic. Besides italic text, this part will also be highlighted in blue color.
Lists
You can use bullet points to list equally ranking information, so that the structure and readability of your information is enhanced.
Horizontal rules
Horizontal rules help separate different pieces of information from each other. For example, when you are asked to provide the credentials you used on the customer's website, you can add them below a horizontal rule in your expected result. To add one, add a newline and another line with three dashes, asterisks, or underscores.
Headlines
When you submit usability suggestions and have to subdivide information, introducing headlines is the solution. Add hashtag signs (#) in front of your caption to enlarge it; the more hashtags you use, the smaller the headline font will become. Since using # and ## will produce large headlines, we recommend using three or more hashtags in reports on our platform.
More information
More syntax and examples can be found on the Internet, e.g. in this Markdown Guide. Some items don't work or are not suitable to be used in our bug form.