Перейти до основного контенту
Усі колекціїНавчальний матеріал
Форматування звітів про помилки
Форматування звітів про помилки

Як використовувати Markdown, щоб зробити ваші звіти більш зрозумілими та привабливими

Kostya avatar
Автор: Kostya
Оновлено понад рік тому

Форматування ваших звітів іноді може допомогти читачам швидше ідентифікувати важливі фрагменти. Особливо, коли ви відправляєте звіти про юзабіліті, наприклад, відповідаючи на кілька запитань в опитуванні, читачі можуть легко розрізнити питання і відповіді, а також заголовки, коли ваш звіт відформатований.

Наші форми звітів підтримують мову розмітки Markdown, яка дозволяє форматувати текст за допомогою простого синтаксису. Нижче ми перерахували синтаксис Markdown, який є найбільш корисним для документування помилок на нашій платформі.

Жирний текст

Щоб підкреслити важливі слова або фрази, виділіть їх напівжирним шрифтом. Просто додайте дві зірочки до і після важливого фрагмента.

Приклад

The product cannot be added to the cart. This problem affects any product in the webshop. **No products can be purchased.**

Результат

The product cannot be added to the cart. This problem affects any product in the webshop. No products can be purchased.

Курсивний текст

Виділення підписів кнопок або назв посилань у ваших кроках курсивом може зробити їх більш зрозумілими, ніж апострофи або звичайний текст. Для цього додайте окремі зірочки або підкреслення до і після частини, яку ви хочете виділити курсивом.

Приклад

Step 3: Click on the button *Add to Cart*.
Step 4: Go to the cart via _Your Shopping Cart_ in the header navigation.

Результат

Step 3: Click on the button Add to Cart.
Step 4: Go to the cart via Your Shopping Cart in the header navigation.

Списки

Ви можете використовувати маркери для перерахування інформації з однаковим рейтингом, щоб покращити структуру та читабельність вашої інформації.

Приклад

- 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.

Результат

Горизонтальні правила

Горизонтальні правила допомагають відокремити різні частини інформації одна від одної. Наприклад, коли вас просять надати облікові дані, які ви використовували на сайті клієнта, ви можете додати їх під горизонтальним правилом в очікуваному результаті. Щоб додати один рядок, додайте новий рядок і ще один рядок з трьома тире, зірочками або підкресленням.​

Приклад

[...] Therefore, the checkout cannot be completed.

---
User name: tester12345
Password: 112233

Результат

Заголовки

Коли ви подаєте пропозиції щодо юзабіліті і вам потрібно розділити інформацію, введення заголовків - це рішення. Додайте знаки хештегів (#) перед заголовком, щоб збільшити його; чим більше хештегів ви використовуєте, тим меншим буде шрифт заголовка. Оскільки використання # і ## призводить до створення великих заголовків, ми рекомендуємо використовувати три або більше хештегів у звітах на нашій платформі.

Приклад

### 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]

Результат

Більше інформації

Більше синтаксису та прикладів можна знайти в Інтернеті, наприклад, у цьому Markdown керівництві. Деякі елементи не працюють або не підходять для використання в нашій формі помилок.

Ви отримали відповідь на своє запитання?