Это руководство по написанию эффективных отчётов об ошибках в Discourse, чтобы максимизировать шансы на их исправление.
Требуемый уровень пользователя: Любой может сообщить об ошибке
Написание хорошего отчёта об ошибке имеет решающее значение для того, чтобы команда Discourse могла эффективно устранять проблемы. Это руководство проведёт вас через шаги и лучшие практики, чтобы убедиться, что ваш отчёт об ошибке будет ясным, лаконичным и побуждающим к действию.
Краткое содержание
В этой документации мы рассмотрим:
- Важность предоставления воспроизводимых шагов и конкретных деталей
- Как описать проблему и ожидаемое поведение
- Лучшие практики для отчётов на разных платформах
- Поддержание соответствующего тона в вашем отчёте
- Распространённые ошибки и решения
Шаги для написания эффективного отчёта об ошибке
Приоритет/Серьёзность
Определите срочность исправления ошибки. Хотя все хотят, чтобы их проблемы решались быстро, резервируйте самый высокий приоритет для критических проблем, которые существенно влияют на функциональность.
Платформа
Всегда указывайте среду, в которой была обнаружена ошибка. Это включает:
- Тип устройства (настольный компьютер, мобильное устройство, сенсорный экран, планшет)
- Операционную систему и её версию
- Веб-браузер и его версию
По возможности воспроизведите ошибку на нескольких платформах, чтобы подтвердить её наличие.
Описание
Будьте лаконичны. Опишите проблему просто и без лишних деталей. Разделяйте разные проблемы, если их можно сообщить отдельно. Чёткий формат описания включает:
Фактический результат: Что происходит?
Ожидаемый результат: Что должно было произойти?
Избегайте предположений о том, что читатель уже знает. Будьте конкретны в том, что должно было быть видно или произошло.
Воспроизводимые шаги
Убедитесь, что ошибку можно воспроизвести последовательно. Напишите пошаговые инструкции, начиная с главного экрана Discourse. Если ошибка появляется случайно, укажите, как часто она возникает (например, 1 из 10 попыток). Для ошибок, связанных с пользовательским интерфейсом (UI/UX), добавьте скриншоты или видео для ясности.
Тон
Поддерживайте уважительный и вежливый тон. Не используйте отчёт об ошибке для выражения разочарования. Любой токсичный язык или поведение могут привести к задержке или игнорированию вашего отчёта.
Шаблон
Используйте этот шаблон, чтобы быстро создать новую тему с отчётом об ошибке:
Приоритет/Серьёзность:
Платформа:
Описание:
Воспроизводимые шаги:
Лучшие практики
- Воспроизведение в безопасном режиме: Перед отправкой отчёта попробуйте воспроизвести проблему в безопасном режиме Discourse, если вы подозреваете, что кастомизации могут быть причиной.
- Опровержение предположений: Отчёты об ошибках часто основаны на ложных предположениях. Даже в вашем отчёте ставьте под сомнение и уточняйте любые предположения, которые у вас могут быть.
- Будьте детализированными: Для трудноуловимых или редких ошибок предоставляйте как можно больше деталей. Включите всё, что, как вы думаете, может быть связано, например, сообщения об ошибках или файлы журналов.
Распространённые проблемы и решения
Проблема: Невозможно последовательно воспроизвести ошибку.
Решение: Задокументируйте среду и условия, при которых появляется ошибка. Отметьте любые закономерности или общие черты.
Проблема: Отсутствие ответа на отчёт об ошибке.
Решение: Убедитесь, что ваш отчёт подробный, но лаконичный и написан в вежливом тоне.
Часто задаваемые вопросы
В: Что делать, если у меня нет времени на подробный отчёт?
О: Всё равно полезно открыть отчёт с той информацией, которая у вас есть. Укажите, что вы обновите его более подробными данными позже.
В: Где следует публиковать мой отчёт об ошибке?
О: Используйте соответствующую категорию — отчёты об ошибках должны отправляться в категорию Contribute > Bug.