Как я могу написать хорошие сообщения об ошибках?

Question

Я хотел бы написать более качественные отчеты об ошибках - о чем следует помнить, сообщая об ошибках разработчикам программного обеспечения, которым я пользуюсь?

Answer 1

Я бы сказал, что это зависит от вашей команды / организации. Однако, чтобы иметь в виду, вы можете взглянуть на:

1. Шаблон сообщения об ошибке в Википедии
2. Apache Bug Writing Template
3. Apple Bug Report Sample
4. Вы можете найти то же самое в любом другом проекте ОС.

Добавление дополнительной информации извлечено отсюда:

Будьте конкретны. Если вы можете сделать одно и то же двумя разными способами, укажите, какой из них вы использовали. "Я выбрал Load" может означать "Я нажал на Load" или "Я нажал Alt-L". Скажи, что ты сделал. Иногда это важно.Будьте многословны. Дайте больше информации, чем меньше. Если вы говорите слишком много, программист может игнорировать некоторые из них. Если вы говорите слишком мало, они должны вернуться и задать больше вопросов. Одно сообщение об ошибке, которое я получил, было одним предложением; каждый раз, когда я просил дополнительную информацию, репортер отвечал еще одним предложением. Мне потребовалось несколько недель, чтобы получить полезное количество информации, потому что оно вызывало одно короткое предложение за раз.Будьте осторожны с местоимениями. Не используйте такие слова, как "это", или ссылки, такие как "окно", если неясно, что они означают. Подумайте об этом: "Я запустил FooApp. Он открыл окно с предупреждением. Я попытался закрыть его, и он упал". Не ясно, что пользователь пытался закрыть. Они пытались закрыть окно предупреждения или весь FooApp? Это имеет значение. Вместо этого вы можете сказать: "Я запустил FooApp, который вывел окно с предупреждением. Я попытался закрыть окно с предупреждением, и FooApp упал". Это дольше и более повторяющееся, но также более ясное и менее легкое для понимания.Прочитайте, что вы написали. Прочитайте отчет для себя и посмотрите, считаете ли вы, что он понятен. Если вы перечислили последовательность действий, которая должна вызвать сбой, попробуйте выполнить их самостоятельно, чтобы увидеть, пропустили ли вы шаг.

Я бы сказал, что вы должны предоставить описание, серьезность, шаги для воспроизведения и статус. Затем вы можете изменить некоторые варианты, добавив теги, соответствующую версию, адресата и т. Д.

Надеюсь это поможет!