Редактирование отчётов об ошибках
Как использовать пометки, чтобы сделать ваши отчеты более понятными и привлекательными
Форматирование ваших отчетов иногда может помочь читателям быстрее определить важные моменты. Особенно, когда вы отправляете отчеты об удобстве использования, например, отвечая на несколько вопросов в опросе, читатели могут легко различать вопросы и ответы, а также заголовки при форматировании вашего отчета.
Наши формы отчетов поддерживают Markdown - язык разметки - который позволяет форматировать текст с простым синтаксисом. Ниже мы перечисляем синтаксис Markdown, который наиболее полезен для документирования ошибок на нашей платформе.
Жирный текст
Чтобы подчеркнуть важные слова или фразы, выделите их жирным шрифтом. Просто добавьте две звездочки до и после важного бита.
Пример:
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.
Результат:
Шаг 3: Нажмите на кнопку Добавить в корзину .
Шаг 4: Перейдите в корзину через вашу корзину в заголовке навигации.
Списки
Вы можете использовать маркеры, чтобы вывести в равной степени информацию о ранжировании, чтобы улучшить структуру и удобочитаемость вашей информации.
Пример:
- 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]
Результат
