Słownik

Szablon zgłoszenia błędu, którego recenzenci nie odrzucą

Taras Shynkarenko
Taras Shynkarenko
•Zaktualizowano: •7 min czytania
Szablon zgłoszenia błędu, którego recenzenci nie odrzucąSzablon zgłoszenia błędu, którego recenzenci nie odrzucą

W skrócie

7 min czytania

Szablon zgłoszenia błędu to stały zestaw nazwanych pól wypełnianych w stałej kolejności, dzięki czemu recenzent nie musi dopytywać o brakujące informacje przed triażem. Tytuł, warunki wstępne, kroki odtworzenia, oczekiwany i faktyczny wynik, ważność, priorytet i środowisko odpowiadają na pytania, które inżynier musiałby inaczej zadawać sam. Pomiń pole, a recenzent odeśle zgłoszenie zamiast naprawiać błąd.

Czym jest szablon zgłoszenia błędu?

Szablon zgłoszenia błędu wymienia każde pole, które musi być wypełnione, zanim inżynier będzie mógł się nim zająć, od tytułu po wiersz o środowisku, dzięki czemu po utworzeniu zgłoszenia nie trzeba niczego dopytywać. Każde pole odpowiada na jedno pytanie, które recenzent musiałby inaczej zadać w komentarzach. Wypełnij wszystkie pola przed wysłaniem i traktuj puste pole jako powód, dla którego zgłoszenie do ciebie wróci.

Po co istnieje pole tytułu i co czyni je przydatnym?

Pole tytułu pozwala recenzentowi zrozumieć, co nie działa, bez otwierania zgłoszenia, a to decyduje, czy trafi ono do najbliższego triażu, czy utonie wśród pięćdziesięciu innych. Przydatny tytuł łączy działanie z awarią, na przykład „Użycie karty podarunkowej przy kasie pokazuje pustą stronę zamiast błędu”, zamiast wyrażać nastrój w stylu „kasa nie działa”. Tytuł napisz na końcu, gdy kroki i faktyczny wynik są już jasne, aby nazywał prawdziwą awarię, a nie domysł.

Inżynier czyta przy biurku spisany raport, co symbolizuje kroki wykonywane po kolei przez osobę odtwarzającą błąd.

Po co istnieje pole kroków odtworzenia?

Pole kroków odtworzenia pozwala drugiej osobie wywołać tę samą awarię bez dopytywania zgłaszającego, dzięki czemu jednorazowa obserwacja staje się powtarzalnym przypadkiem testowym. Ponumerowane działania od określonego punktu startowego odróżniają zgłoszenie, którym inżynier może się zająć, od takiego, które wymaga dodatkowego spotkania. W artykule kroki odtworzenia znajdziesz opis kompletnego zestawu kroków i wyjaśnienie, dlaczego brak warunku wstępnego jest najczęstszą przyczyną ich niepowodzenia.

Dlaczego ważność potrzebuje osobnego pola, innego niż priorytet?

Ważność potrzebuje własnego pola, bo mierzy szkody techniczne, a priorytet określa, jak szybko trzeba coś naprawić, i te dwie odpowiedzi rzadko się pokrywają. Błąd płatności dotykający jednego konta w weekend jest poważny, ale nie pilny tej nocy. Literówka na stronie głównej jest drobna, ale pilna przed premierą. Porównanie ważności i priorytetu pokazuje, jak osoba prowadząca triaż ocenia każdą z tych wartości, tak by jedna liczba nie wpływała na drugą.

Laptop z kilkoma oknami przeglądarki otwartymi obok siebie, symbolizującymi różne środowiska, w których błąd może zachowywać się inaczej.

Ważność i priorytet ciągną w różne strony
Poważny, ale niepilny
  • Błąd płatności dotyka jednego konta
  • Występuje w weekend
Pilny, ale niepoważny
  • Literówka na stronie głównej
  • Trzeba ją poprawić przed premierą
Te dwa pola oceniają co innego, więc ten sam błąd może mieć wysoką wartość w jednym i niską w drugim.

Co powinno znaleźć się w polu środowiska?

Pole środowiska podaje przeglądarkę i jej wersję, system operacyjny, rozmiar ekranu oraz informację, czy awaria wystąpiła na produkcji, na stagingu, czy w lokalnej kompilacji, bo ta sama sekwencja kliknięć może działać inaczej przy zmianie każdego z tych elementów. Bez tego pola recenzent nie wie, czy błąd jest powszechny, czy związany z jedną konfiguracją, więc nie oszacuje nawet, ilu użytkowników dotyka. Skopiuj dokładny numer wersji ze strony „O przeglądarce” zamiast zgadywać w stylu „najnowszy Chrome”.

Co powinno znaleźć się w polach oczekiwanego i faktycznego wyniku?

Pole oczekiwanego wyniku mówi, co interfejs powinien był pokazać, a pole faktycznego wyniku dokładnie, co pojawiło się zamiast tego. Każde z nich to jeden konkretny wiersz, a nie wspólny akapit o wrażeniach z błędu. „Oczekiwano komunikatu »Nieprawidłowy kod«, pojawiła się pusta biała strona bez wpisów w konsoli” daje inżynierowi punkt odniesienia, a „kasa nie działa” już nie. Napisz oba wiersze przed tytułem, bo to rozbieżność między nimi tytuł ma nazwać.

PoleNa jakie pytanie odpowiadaCo recenzent odrzuca, gdy pola brakuje
TytułCo nie działa, w jednym wierszuMglisty lub emocjonalny tytuł bez nazwanej awarii
Warunki wstępneJaki był stan przed pierwszym krokiemPominięty typ konta, istniejące dane lub wcześniejsze działania
Kroki odtworzeniaCo kliknąć, wpisać lub wysłać, po koleiKroki pomijające działanie lub bez numeracji
Oczekiwany wynikCo powinno było się staćBrak oczekiwanego rezultatu lub jego mglisty opis
Faktyczny wynikCo stało się zamiast tego„Nie działa” zamiast dokładnego błędu lub ekranu
WażnośćJak duże szkody techniczne powoduje błądWażność użyta zamiast oceny pilności
PriorytetJak szybko trzeba naprawić błądPriorytet ustawiony bez uzasadniającej go ważności
ŚrodowiskoPrzeglądarka, system, ekran i etap kompilacji„Najnowszy Chrome” zamiast dokładnego numeru wersji

Co sprawia, że recenzent od razu odrzuca zgłoszenie?

Recenzent od razu odrzuca zgłoszenie, gdy jedno z ośmiu powyższych pól jest puste, mgliste lub odpowiada na niewłaściwe pytanie, bo osoba prowadząca triaż nie oceni ważności ani priorytetu błędu, którego nie potrafi sobie wyobrazić. Najczęstszą pojedynczą przyczyną jest brak warunku wstępnego: kroki wyglądają na kompletne, ale nikt nie podaje stanu konta ani istniejących danych, które zakładają. Druga najczęstsza przyczyna to połączenie oczekiwanego i faktycznego wyniku w jednym zdaniu, co ukrywa dokładną rozbieżność, którą poprawka ma usunąć.

Jak nagrania sesji automatycznie wypełniają szablon zgłoszenia błędu?

Nagrania sesji automatycznie wypełniają szablon zgłoszenia błędu, bo zawierają już warunki wstępne, ponumerowane działania i środowisko, które w ręcznym zgłoszeniu trzeba opisać samodzielnie. Flowsery dołącza nagranie, kroki odtworzenia i dane o środowisku do każdego problemu w chwili, gdy trafia on do Slacka, Lineara lub Jiry, więc zgłaszający musi tylko potwierdzić ważność zamiast przepisywać pola, na które nagranie już odpowiada. To samo zgłoszenie błędu z nagraniem sesji pokazuje inżynierowi dokładne kliknięcie, które wywołało awarię, co wypełnia pole faktycznego wyniku bez pisania jakiegokolwiek opisu. Zespoły śledzące błędy w Notion dostają te same pola jako kolumny: rejestr błędów w Notion zasilany przez Flowsery ma w każdym wierszu ważność, liczbę dotkniętych sesji, pierwsze i ostatnie wystąpienie oraz link do nagrania.

Wypełnianie szablonu zgłoszenia błędu po kolei
1
Podaj warunki wstępne. Stan konta, istniejące dane i wszelkie działania przed pierwszym krokiem.
2
Ponumeruj kroki odtworzenia. Jedno kliknięcie, dotknięcie lub wpis w wierszu, w kolejności wykonania.
3
Zapisz oczekiwany i faktyczny wynik w dwóch wierszach. Nie w jednym akapicie o wrażeniach z błędu.
4
Oceń ważność, a potem priorytet. Najpierw wyrządzone szkody, potem to, jak szybko trzeba je naprawić.
5
Zapisz środowisko. Przeglądarka, system, rozmiar ekranu oraz produkcja, staging lub wersja lokalna.
Wypełniaj pola w tej kolejności, a tytuł, czyli ostatnie z nich, napisze się sam.

Najczęściej zadawane pytania

Jakie pola musi mieć minimalny szablon zgłoszenia błędu?

Minimalny szablon wymaga tytułu, warunków wstępnych, ponumerowanych kroków odtworzenia, oczekiwanego wyniku, faktycznego wyniku, ważności, priorytetu i środowiska. Bez któregokolwiek z tych ośmiu pól recenzent musi dopytywać przed triażem, a właśnie takie opóźnienie szablon ma eliminować.

Czy ważność i priorytet mogą dzielić jedno pole w szablonie?

Nie powinny, bo błąd może być poważny, ale niepilny, jak błąd płatności dotyczący jednego konta w weekend, albo pilny, ale niepoważny, jak literówka na stronie głównej przed premierą. Połączenie ich w jednym polu zmusza zgłaszającego do zgadywania, którą z odpowiedzi oznacza liczba.

Dlaczego recenzenci odrzucają zgłoszenia z krokami, ale bez warunków wstępnych?

Bo ta sama sekwencja kliknięć daje różne wyniki w zależności od stanu konta, istniejących danych lub działań wykonanych przed pierwszym krokiem. Bez określonego punktu startowego inżynier musi odtworzyć warunek wstępny, zanim w ogóle spróbuje wykonać podane kroki.

Czym różni się pole środowiska od pola faktycznego wyniku?

Pole środowiska mówi, gdzie wystąpił błąd, na przykład w jakiej przeglądarce, systemie i na jakim etapie kompilacji, a pole faktycznego wyniku mówi, co się stało, na przykład jaki pojawił się komunikat błędu lub pusty ekran. Zgłoszenie może dokładnie opisywać problem i wciąż być niemożliwe do odtworzenia, jeśli nie podaje, w jakiej przeglądarce lub środowisku wystąpił.

Czy automatyczne tworzenie zgłoszeń błędów eliminuje potrzebę szablonu?

Eliminuje potrzebę ręcznego wpisywania pól, ale nie same pola. Flowsery automatycznie dołącza do każdego problemu nagranie, kroki odtworzenia i środowisko, więc zgłaszający przegląda i potwierdza pola zamiast przepisywać je z pamięci.

Flowsery
Flowsery

Rozpocznij 14-dniowy okres próbny

Panel w czasie rzeczywistym

Śledzenie celów

Śledzenie bez cookie

Ile czasu powinno zająć wypełnienie szablonu zgłoszenia błędu?

Tyle, ile potrzeba na podanie ośmiu faktów potrzebnych recenzentowi: tytułu, warunków wstępnych, kroków, oczekiwanego wyniku, faktycznego wyniku, ważności, priorytetu i środowiska. Zgłoszenie, które zajmuje znacznie więcej czasu, zastępuje któryś z tych faktów rozwlekłym opisem, a takie, które zajmuje mniej, po prostu któryś pomija.

Kto wypełnia szablon zgłoszenia błędu: zgłaszający czy recenzent?

Zgłaszający wypełnia wszystkie pola przy tworzeniu zgłoszenia: tytuł, warunki wstępne, kroki, oczekiwany i faktyczny wynik, ważność, priorytet oraz środowisko. Recenzent czyta ten sam szablon, by sprawdzić, czy niczego nie brakuje, zanim zgłoszenie trafi do inżyniera, i odsyła je, zamiast uzupełniać, gdy pole jest puste. Gdy nagranie sesji automatycznie dołącza kroki i środowisko, rola zgłaszającego ogranicza się do potwierdzenia ważności.

Co się dzieje, gdy recenzent odrzuci zgłoszenie błędu?

Zgłoszenie wraca do zgłaszającego, zamiast trafić do inżyniera. Musi on uzupełnić to, co wskazał recenzent, najczęściej brakujący warunek wstępny albo oczekiwany i faktyczny wynik upchnięte w jednym zdaniu, zanim zgłoszenie wróci do triażu. Nikt nie ocenia ważności ani priorytetu odesłanego zgłoszenia, bo osoba prowadząca triaż nie oceni błędu, którego nie potrafi sobie wyobrazić.

Dlaczego oczekiwany i faktyczny wynik nie powinny dzielić jednego zdania?

Połączenie ich w jednym zdaniu ukrywa dokładną rozbieżność, którą poprawka ma usunąć, i jest to druga najczęstsza przyczyna odrzucania zgłoszeń. Gdy zapisane są w dwóch osobnych wierszach, na przykład oczekiwany komunikat „Nieprawidłowy kod” i faktyczna pusta biała strona, inżynier od razu widzi różnicę i nie musi analizować akapitu o wrażeniach z błędu. Pole tytułu działa dopiero wtedy, gdy ta rozbieżność jest jasno opisana, bo tytuł ma nazywać awarię opisaną w tych dwóch wierszach.

Czy kolejność pól w szablonie zgłoszenia błędu ma znaczenie?

Ma, bo każde pole zależy od poprzedniego: warunki wstępne muszą poprzedzać kroki, które je zakładają, a ważność ocenia się przed priorytetem, aby pilność miała się na czym oprzeć. Oczekiwany i faktyczny wynik zapisuje się przed tytułem, bo to rozbieżność między nimi tytuł ma nazwać. Dzięki wypełnianiu pól w tej kolejności tytuł, czyli ostatnie pole, pisze się sam.

Czy ten artykuł był pomocny?

Chętnie poznamy opinię!

Częściej widoczni w Google

Jedno kliknięcie ustawia Flowsery jako preferowane źródło, dzięki czemu nasze artykuły pojawiają się wyżej w Najważniejszych artykułach, trybie AI i Przeglądach od AI.

Jeszcze jedno...

Flowsery

Flowsery

Analityka witryny skupiona na przychodach

Każdy odwiedzający, źródło i konwersja w czasie rzeczywistym. Prosto, skutecznie i bez plików cookie.

Panel w czasie rzeczywistym

Śledzenie celów

Śledzenie bez cookie

Powiązane hasła ze słownika

Dlaczego od kroków do odtworzenia zależy, czy błąd zostanie naprawionyDlaczego od kroków do odtworzenia zależy, czy błąd zostanie naprawiony
Słownik

Dlaczego od kroków do odtworzenia zależy, czy błąd zostanie naprawiony

Dobre zgłoszenie błędu opisuje kroki do odtworzenia jako ponumerowane działania od znanego punktu wyjścia, by każdy w zespole mógł wywołać tę samą awarię.

•6 min czytania
Triaż błędów, po którym praca naprawdę ma właścicielaTriaż błędów, po którym praca naprawdę ma właściciela
Słownik

Triaż błędów, po którym praca naprawdę ma właściciela

Triaż błędów to cykliczne spotkanie, które klasyfikuje nowe zgłoszenia według ważności, przydziela im właścicieli i pozostaje oddzielone od porządkowania backlogu.

•6 min czytania
Co mapa przewijania mówi o tym, gdzie czytelnicy się zatrzymująCo mapa przewijania mówi o tym, gdzie czytelnicy się zatrzymują
Słownik

Co mapa przewijania mówi o tym, gdzie czytelnicy się zatrzymują

Każdy pas mapy przewijania ma kolor zależny od odsetka odwiedzających, którzy do niego dotarli. Poznaj linię zgięcia, kolumnę odpływu i pułapki wysokości strony.

•8 min czytania
Co ścieżka konwersji pokazuje, zanim ktoś kupiCo ścieżka konwersji pokazuje, zanim ktoś kupi
Słownik

Co ścieżka konwersji pokazuje, zanim ktoś kupi

Ścieżka konwersji to uporządkowana lista kanałów, z którymi kupujący się zetknął. Jak GA4 dzieli ją na punkty wczesne, środkowe i późne oraz co z tym zrobić.

•8 min czytania
Do czego służą wymiary niestandardowe w GA4 i jakie mają limityDo czego służą wymiary niestandardowe w GA4 i jakie mają limity
Słownik

Do czego służą wymiary niestandardowe w GA4 i jakie mają limity

Rejestracja wymiarów niestandardowych w GA4 zmienia parametry zdarzeń w pola raportów. Poznaj trzy zakresy, limity 50, 25 i 10 oraz pułapkę kardynalności.

•8 min czytania
Jak identyfikator użytkownika w GA4 łączy wizyty zalogowanych na różnych urządzeniachJak identyfikator użytkownika w GA4 łączy wizyty zalogowanych na różnych urządzeniach
Słownik

Jak identyfikator użytkownika w GA4 łączy wizyty zalogowanych na różnych urządzeniach

Identyfikator użytkownika w GA4 łączy sesje zalogowanej osoby na różnych urządzeniach. Poznaj konfigurację gtag, limit 256 znaków, wylogowanie i ograniczenia.

•8 min czytania

Powiązane artykuły