Към съдържанието
wannacode

Видове рецензии

Накратко: Рецензията има пет стъпки: планиране, начало, четене поотделно, обсъждане и поправка с доклад. Ролите са автор, рецензенти, модератор, записващ, водещ и мениджър. Видовете се различават по формалност: неформална, преглед с автора, техническа и инспекция. Чеклистът казва какво да се търси, а рецензира се документът, не авторът.

Проблем

„Прегледахме го“

Спецификацията на връщането е готова. Анализаторката я пуска на срещата в понеделник. Шестима души я виждат за първи път на екрана. Някой пита за шрифта, двама спорят как ще се пази в базата, собственикът казва „изглежда добре“. След час срещата свършва. Никой не е записал нищо.

Две седмици по-късно се оказва, че „14 дни“ се брои от поръчката, а законът брои от получаването. Всички са били на срещата. Никой не е прочел текста.

Срещата не беше рецензия. Беше събиране на хора около документ.

Идеята

Петте стъпки

Истинската рецензия има процес. По ISTQB CTFL той има пет стъпки:

  1. Планиране. Какво се рецензира, с каква цел, кой, до кога, по какъв чеклист и кога рецензията е свършила.
  2. Начало. Всеки получава документа и знае ролята си и какво се търси.
  3. Четене поотделно. Всеки чете сам, преди срещата, и записва находките си. Тук се намира повечето.
  4. Обсъждане. Находките се разглеждат заедно. За всяка се решава: проблем ли е, колко е важен, кой го поправя.
  5. Поправка и доклад. Авторът поправя. Находките и решението се записват: приемаме ли документа, или иска още една рецензия.

Срещата от понеделник беше само стъпка 4, без 1, 2 и 3. Затова на нея се говореше за шрифта.

По-точно, за любопитните

CTFL v4.0.1 (раздел 3.2) описва процеса на рецензията на работен продукт, като се позовава на стандарта ISO/IEC 20246. Английските имена на стъпките: planning, review initiation, individual review, communication and analysis, fixing and reporting. Колко от процеса се прави, зависи от вида на рецензията: неформалната може да пропусне почти всичко, инспекцията го следва изцяло.

Пробвай

Подреди процеса

Подреди стъпките на рецензията.

  1. Обсъждане: находките се разглеждат заедно и се решава какво се прави
  2. Поправка и доклад: авторът поправя, а решението и находките се записват
  3. Планиране: какво се рецензира, кой, до кога, по какъв чеклист
  4. Четене поотделно: всеки чете сам и записва находките си
  5. Начало: всеки получава документа и знае ролята си

Идеята

Кой какво прави

Роля Какво прави В рецензията на връщането
автор (author) създал е документа и го поправя анализаторката
мениджър (manager) решава какво се рецензира, дава хора и време ръководителят на екипа
модератор (moderator, facilitator) води срещата, пази времето и тона някой неутрален, не авторът
записващ (scribe) записва находките и решенията един от екипа
рецензент (reviewer) чете и намира проблеми QA, програмист, складът, собственикът
водещ на рецензията (review leader) отговаря за рецензията като цяло: кой участва, кога, къде често същият като модератора

В малък екип един човек има няколко роли. Важното е ролите да ги има, а не да има шестима души.

Рецензентите са най-полезни, когато гледат от различни места. Складът ще пита „а кой приема върнатия продукт?“. Счетоводството ще пита „кога се връщат парите?“. QA ще пита „а на 14-ия ден?“.

Пробвай

Чия е ролята?

1. Анализаторката, написала спецификацията на промо кода, отговаря на въпросите и после поправя текста.
2. Някой води срещата: дава думата, връща разговора към находките, когато двама започнат да спорят как да се направи.
3. Някой записва всяка находка с мястото ѝ и какво е решено за нея.
4. Ръководителят на екипа решава, че рецензията се прави, и дава време на хората за нея.
5. Тестерът и човекът от склада четат спецификацията и търсят проблеми.

Идеята

Четирите вида

Рецензиите се различават по това колко формални са. Колкото по-рисков е документът, толкова повече формалност си струва.

Вид Кой води Цел В магазина
неформална (informal review) никой; няма процес да се намерят проблеми, бързо „хвърли едно око на критериите“
преглед с автора (walkthrough) авторът да се намерят проблеми, хората да разберат документа и да се съгласят анализаторката минава спецификацията на връщането със склада
техническа (technical review) модератор съгласие и решение по технически въпрос как се смятат отстъпките
инспекция (inspection) обучен модератор да се намерят колкото може повече проблеми; метриките подобряват процеса спецификацията на плащането

Неформалната не е лоша. Тя е най-честата и най-евтината. Но когато грешка струва пари на клиенти, като плащането, си струва пълният процес.

По-точно, за любопитните

В CTFL v4.0.1 инспекцията е единственият вид, при който процесът се следва изцяло и се събират метрики. Там авторът не може да бъде водещ на рецензията или записващ. Видът се избира според целта, риска, културата на екипа и изискванията на средата: в регулирани области (медицина, транспорт) инспекциите често са задължителни.

На английски walkthrough буквално значи „разходка“: авторът води другите през документа. На български няма утвърден превод. „Преглед с автора“ е описание, не термин.

Пробвай

Кой вид е?

1. Програмистът пише в чата: „Хвърли едно око на критериите, преди да почна.“ Колегата отговаря с два коментара.
2. Анализаторката събира собственика, склада и QA и минава през спецификацията на връщането ред по ред, за да я разберат всички.
3. Трима опитни програмисти и архитектът се събират да решат как магазинът ще смята отстъпките, след като всеки е прочел предложението.
4. Спецификацията на плащането минава през пълния процес: обучени роли, чеклист, всяка находка записана, броят им се следи от проект в проект.

Идеята

Чеклистът

Рецензентът, който чете „да видя дали всичко е наред“, вижда малко. Този, който има въпроси, вижда много. Чеклистът (checklist) е списък с въпроси, които се задават на всеки документ от един вид.

Чеклист за изисквания в магазина:

  • Казано ли е кой (клиент, служител, всеки посетител)?
  • Има ли мерило вместо „бързо“, „удобно“, „ясно“?
  • Ясно ли е какво става на границата (50,00 €, 14-ият ден, 10-ата бройка)?
  • Казано ли е какво става в отрицателния случай (отказ, грешка, изтекъл код)?
  • Има ли затворен списък вместо „и т.н.“?
  • Казва ли какво, а не как?
  • Противоречи ли на друго изискване?

Чеклистът е жив. Всеки път, когато дефект се изплъзне от рецензия, екипът пита: „какъв въпрос щеше да го хване?“ и го добавя.

И едно правило за тона: рецензира се документът, не авторът. „Тук не е ясна границата“, а не „ти не си помислил за границата“. Рецензия, на която някой бива съден, не се повтаря доброволно.

По-точно, за любопитните

CTFL v4.0.1 изрежда и какво прави рецензиите успешни: ясни цели и критерии за край; подходящ вид за целта; малки части, за да не се изморят рецензентите; достатъчно време за подготовка; подкрепа от ръководството; култура, в която рецензията е за учене, а не за наказание. Освен чеклистите има и други начини на четене: по сценарий (рецензентът минава документа по конкретна употреба) и по гледна точка (единият чете като клиент, другият като тестер, третият като склад).

Упражнение

Рецензия с чеклист

1. Кой въпрос го хваща? За всяко изискване избери въпроса от чеклиста, който намира проблема.

1. Изискването: „Клиентът получава точки за лоялност при всяка поръчка.“ Кой въпрос от чеклиста намира проблем?
2. Изискването: „Доставката е безплатна за поръчки над 50 €.“ Кой въпрос намира проблем?
3. Изискването: „Отстъпката се пази в полето discount_pct на таблицата orders.“ Кой въпрос намира проблем?

Тест

Провери се

1. Кое е вярно за четенето поотделно?
2. Кой вид рецензия е най-формален?
3. Кой води прегледа с автора (walkthrough)?
4. Защо на рецензията се обсъжда документът, а не авторът?
5. Защо е полезен чеклистът?

Създаден от Иво Гергов като част от кампанията на Evo Tech за достъпно обучение по програмиране ·