Стр: 202/301
2.5.7.
Типичные ошибки при написании отчётов о дефектах
Перед прочтением этого текста рекомендуется перечитать раздел с описа-
нием типичных ошибок при составлении тест-кейсов и чек-листов
{160}
, т.к. многие
описанные там проблемы актуальны и для отчётов о дефектах (ведь и то, и другое
— специфическая техническая документация).
Ошибки оформления и формулировок
Плохие краткие описания (summary).
Формально эта проблема относится
к оформлению, но фактически она куда опаснее: ведь чтение отчёта о дефекте и
осознание сути проблемы начинается именно с краткого описания. Ещё раз напом-
ним его суть:
•
Отвечает на вопросы «что?», «где?», «при каких условиях?».
•
Должно быть предельно кратким.
•
Должно быть достаточно информативным для понимания сути проблемы.
Посмотрите на эти краткие описания и попробуйте ответить себе на вопрос
о том, что за проблема возникает, где она возникает, при каких условиях она воз-
никает:
•
«
Неожиданное прерывание
».
•
«
Найдено 19 элементов
».
•
«
Поиск по всем типам файлов
».
•
«
Неинформативная ошибка
».
•
«
В приложении красный шрифт
».
•
«
Error when entering just the name of computer disk or folder
».
•
«
No reaction to 'Enter' key
».
Иногда ситуацию спасает поле «подробное описание», из которого можно по-
нять суть проблемы, но даже в этом случае сначала нужно приложить немало уси-
лий, чтобы соотнести такое краткое описание с подробным, где представлено со-
вершенно иное и иначе.
Перечитайте ещё раз раздел про формулировку качественных кратких опи-
саний
{175}
.
Достарыңызбен бөлісу: |
