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

Question

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

Answer 1

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

1. Wikipedia Bug Report Template
2. Apache Bug Writing Template
3. Apple Bug Report Sample
4. Вы можете найти то же самое на любом другом проекте OS.

Добавление подробнее извлекается из here:

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

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

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