Manchmal kann das Formatieren deiner Bug-Reports Lesern helfen, wichtige Informationen schneller zu identifizieren. Insbesondere bei der Einreichung von Usability-Reports, z. B. wenn du in einer Umfrage mehrere Fragen beantwortest, können Leser leicht zwischen Fragen und Antworten sowie Überschriften unterscheiden, wenn dein Bericht entsprechend formatiert ist.
Unsere Report-Formulare unterstützen Markdown, eine Auszeichnungssprache, die es dir ermöglicht, deinen Text mit einfacher Syntax zu formatieren. Im Folgenden listen wir die Markdown-Syntax auf, die am nützlichsten ist, um Bugs auf unserer Plattform zu dokumentieren.
Fettgedruckter Text
Um wichtige Wörter oder Phrasen zu betonen, hebe sie fett hervor. Füge dazu einfach zwei Sternchen vor und nach dem wichtigen Teil des Textes hinzu.
Beispiel
Das Produkt kann nicht in den Warenkorb gelegt werden. Dieses Problem betrifft jedes Produkt im Webshop. **Es können keine Produkte gekauft werden.**
Ergebnis:
Das Produkt kann nicht in den Warenkorb gelegt werden. Dieses Problem betrifft jedes Produkt im Webshop. Es können keine Produkte gekauft werden.
Kursiver Text
Das Kursivieren von Button-Labels oder Linknamen in deinen Schritten kann sie verständlicher machen als Apostrophe oder normaler Text. Füge ein einzelnes Sternchen oder einen Unterstrich vor und nach dem Teil des Textes hinzu, den du kursiv machen möchtest.
Beispiel:
Schritt 3: Klicke auf den Button *Zum Warenkorb hinzufügen*.
Schritt 4: Gehe via _Dein Warenkorb_ in der Header-Navigation zum Warenkorb.
Ergebnis:
Schritt 3: Klicke auf den Button Zum Warenkorb hinzufügen.
Schritt 4: Gehe via Dein Warenkorb in der Header-Navigation zum Warenkorb.
Listen
Du kannst Aufzählungspunkte verwenden, um gleichrangige Informationen aufzulisten, damit die Struktur und Lesbarkeit deiner Informationen verbessert wird.
Beispiel:
- 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.
Ergebnis:
Horizontale Linien
Horizontale Linien helfen dabei, verschiedene Informationsstücke voneinander zu trennen. Wenn du zum Beispiel aufgefordert wirst, die Anmeldedaten, die du auf der Website des Kunden verwendet hast, anzugeben, kannst du sie unter einer horizontalen Linie in deinem erwarteten Ergebnis hinzufügen. Füge hierfür eine neue Zeile und eine weitere Linie mit drei Gedankenstrichen, Sternchen oder Unterstrichen hinzu.
Beispiel:
[...] Therefore, the checkout cannot be completed.
---
User name: tester12345
Password: 112233
Ergebnis:
Überschriften
Wenn du Usability-Vorschläge einreichen und Informationen unterteilen musst, sind Überschriften die Lösung. Füge vor deiner Überschrift Hashtags (#) ein, um sie zu vergrößern. Je mehr Hashtags du verwendest, desto kleiner wird die Schriftgröße der Überschrift. Da die Verwendung von # und ## zu großen Überschriften führt, empfehlen wir, in Berichten auf unserer Plattform drei oder mehr Hashtags zu verwenden.
Beispiel:
### 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]
Ergebnis:
Weitere Informationen
Weitere Syntax und Beispiele findest du im Internet, z. B. in diesem Markdown-Leitfaden. Einige Elemente funktionieren möglicherweise nicht oder sind nicht für die Verwendung in unserem Bug-Formular geeignet.