Сообщений в теме: 13

[Snap]

Хотел бы собрать мнения. В описании ошибки (бага) вы пишете сначала фактический результат, а потом ожидаемый или наоборот, сначала ожидаемый результат - затем фактический? Есть ли стандарты на этот счет?

 

Скажу честно, в тестовой документации не слишком силен. Но лично я при описании бага пишу сначала фактический, после ожидаемый результат. А новые коллеги, напротив. Мне кажется, вариант ФР/ОР удобнее для понимания адресату.

[SHINNOK]

Фактический, а затем ожидаемый

[Сергей]

Коллеги они такие, пишут как им удобно. Запилите общий шаблон.

[Snap]

Коллеги они такие, пишут как им удобно. Запилите общий шаблон.

Вот для этого и создал тему. Чтобы понять, в каком порядке лучше расположить.

[Little_CJIOH]

В том, в котором будет всем удобно. Главное, чтобы было однозначно понятно, какой результат ожидаемый а какой фактический.

ЗЫЖ лично я сначала пишу фактический

[checo]

Привычка описания ОР -> ФР появляется так: Если баг найден в тесте, копипастим содержание теста, а внизу дописываем ФР.

И некоторые трекеры так же настроены: форма для бага в целом скопирована с формы для тест-кейса, но с дополнительными полями (снизу).

[astenix]

Рассказываю, что вообще было нужно.

 

Рассказываю, что делал.

 

Рассказываю, что увидел в итоге.

 

Рассказываю, чего ожидал увидеть.

[SALar]

Чаще вообще не пишу. В идеале в заголовке пишем, что получилось. И все. Без дескрипшена. 

Меньше текста - проще читать.

[Snap]

Чаще вообще не пишу. В идеале в заголовке пишем, что получилось. И все. Без дескрипшена. 

Меньше текста - проще читать.

Главное, не скатиться в "см. скриншот"  .

Заголовок в данном случае выступает фактическим результатом, просто в начале.

[tjupka]

Опираясь на психологию программистов, которые обычно читают всё с конца, приняли шаблоны, описанные в группе "Description" статьи "Issue review (ГКЧП-2)". И это очевидно вытекает из правила: из череды событий или разговора ярко запоминается первое и/или последнее. 

[aksi]

Фактический, потом ожидаемый, потому что логика чтения бага. "Шаги-шаги-шаги привели к фейлу, а должны были вот к чему привести"

[TatyanaV]

Сначала фактический (что же произошло в результате указанных шагов), потом ожидаемый (что должно было быть и почему).

[i_love_SPGU]

Тут в основном люди пишут, что сначала ФР, а потом ОР, а я думаю, что удобнее ФР в конце писать, потому что, как правило, он больше - туда крепится вся инфа о произошедшем: логи, запросы/ответы, скрины и т.д.

Все вышесказанное наводит на мысль, что да - людям часто удобнее смотреть в начало и конец написанного. Кроме того, маленький ОР не затеряется где-то в конце баг-репорта

[aksi]

Тут в основном люди пишут, что сначала ФР, а потом ОР, а я думаю, что удобнее ФР в конце писать, потому что, как правило, он больше - туда крепится вся инфа о произошедшем: логи, запросы/ответы, скрины и т.д.

Все вышесказанное наводит на мысль, что да - людям часто удобнее смотреть в начало и конец написанного. Кроме того, маленький ОР не затеряется где-то в конце баг-репорта

Если люди читают только начало и конец, могут с тем же успехом вообще баг-репорт не читать. Ну и не надо логами и скринами разносить тело задачи, файлами крепите или под спойлеры, это любой трекер умеет, и никаких Огромных Фактических Результатов не будет. 99% моих ФР занимают максимум 3-4 строчки.