Słownik

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

Taras Shynkarenko
Taras Shynkarenko
•Zaktualizowano: •6 min czytania
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

W skrócie

6 min czytania

Kroki do odtworzenia to ponumerowane działania, stan początkowy i dane wejściowe, które pozwalają drugiej osobie wywołać ten sam błąd, na który trafiła pierwsza. Kompletny opis podaje warunki wstępne, dokładne kliknięcia lub wpisy w odpowiedniej kolejności, oczekiwany wynik, faktyczny wynik i środowisko. Bez któregokolwiek z tych elementów programista albo nie odtworzy błędu, albo odtworzy inny, dlatego "u mnie działa" oznacza brakujący warunek wstępny, a nie zagadkę.

Czym są kroki do odtworzenia w zgłoszeniu błędu?

Zgłoszenie błędu zasługuje na miano odtwarzalnego, gdy jego kroki do odtworzenia wymieniają dokładne, ponumerowane działania, stan początkowy i dane wejściowe potrzebne do ponownego wywołania awarii. Każda osoba czytająca tę listę, a nie tylko ta, która znalazła błąd, powinna móc przejść ją i trafić na ten sam problem. Pisz kroki jak krótki scenariusz do wykonania przez kogoś innego, a nie jak streszczenie zdarzeń, albo dołącz nagranie sesji, dzięki czemu scenariusz powstanie sam.

Co zawiera kompletna sekcja kroków do odtworzenia?

Kompletna sekcja podaje pięć rzeczy: warunki wstępne, ponumerowane działania, oczekiwany wynik, faktyczny wynik i środowisko. Brak któregokolwiek z nich zamienia odtwarzalny błąd w zgadywanie, bo programista bez stanu początkowego musi go najpierw odtworzyć, zanim w ogóle spróbuje wykonać kroki. Te same szczegóły decydują też o wadze i priorytecie, ponieważ osoba oceniająca zgłoszenie bez pełnego odtworzenia zgaduje zarówno skalę szkód, jak i pilność.

PoleNa co odpowiadaPrzykład
Warunki wstępneJaki stan musi istnieć przed krokiem 1Zalogowany użytkownik, 2 produkty w koszyku, zastosowany kupon
Ponumerowane krokiCo kliknąć, wpisać lub wysłać, w jakiej kolejności1. Otwórz płatność 2. Kliknij "Użyj karty podarunkowej" 3. Wpisz 20-cyfrowy kod
Oczekiwany wynikCo powinno się staćKomunikat o błędzie: "Nieprawidłowy kod"
Faktyczny wynikCo dzieje się zamiast tegoStrona robi się pusta, bez komunikatu o błędzie
ŚrodowiskoGdzie to występujeChrome 128, macOS 15, staging

Osoba klika w aplikacji internetowej przy biurku, czyli wykonuje sesję, którą zgłoszenie błędu musi opisać krok po kroku.

Dlaczego warunki wstępne są ważne przed ponumerowanymi krokami?

Warunki wstępne są ważne, bo ta sama sekwencja kliknięć daje różne wyniki w zależności od stanu, w jakim zaczął użytkownik. "Kliknij płatność" działa inaczej przy pustym koszyku, a inaczej przy zastosowanym kuponie, więc lista kroków bez warunków wstępnych daje programiście działania, ale nie punkt startu. Przed krokiem pierwszym podaj typ konta, dane obecne już w systemie i wcześniejsze działania w tej samej sesji.

Jak opisać oczekiwane i faktyczne zachowanie?

Oczekiwane i faktyczne zachowanie powinny znaleźć się w osobnych wierszach, a każdy z nich powinien podawać jeden konkretny wynik, a nie odczucie na temat błędu. Oczekiwany wynik opisz jako to, co interfejs ma pokazać, a faktyczny jako dokładnie to, co pojawiło się zamiast tego, w tym treść błędu, pusty ekran lub błędną wartość. "Strona wygląda na zepsutą" niczego nie pozwala odtworzyć, natomiast "oczekiwano komunikatu 'Nieprawidłowy kod', pojawiła się pusta biała strona bez wpisów w konsoli" daje programiście konkretny punkt odniesienia.

Jakie dane o środowisku powinny znaleźć się w zgłoszeniu błędu?

Dane o środowisku obejmują przeglądarkę i jej wersję, system operacyjny, rozmiar ekranu, warunki sieciowe oraz informację, czy błąd wystąpił na produkcji, na stagingu, czy w lokalnej kompilacji. Błąd układu związany z obsługą flexboxa w Safari lub błąd czasowy związany z wolnym łączem znika, gdy ktoś testuje w innej konfiguracji, więc wiersz o środowisku zamienia "nie mogę tego odtworzyć" w "testowałem w złej przeglądarce".

Dwoje programistów porównuje notatki przy laptopie, czyli wykonuje sprawdzenie, które wychwytuje niezgodność środowisk.

Skąd bierze się "u mnie działa"?

"U mnie działa" pojawia się wtedy, gdy zgłaszający i programista po cichu pracują przy innych warunkach wstępnych lub w innych środowiskach, a nie wtedy, gdy błąd jest zmyślony. Flaga funkcji włączona dla jednego konta i wyłączona dla drugiego, nieaktualna pamięć podręczna, inna szerokość ekranu lub rozszerzenie przeglądarki blokujące skrypt sprawiają, że awaria występuje u jednej osoby, a u drugiej nie. Traktuj to zdanie jak brakujące pole w zgłoszeniu i uzupełnij środowisko oraz warunki wstępne, zamiast zamykać zgłoszenie. Przy długim procesie skrócenie go do minimalnego odtwarzalnego przykładu, który wciąż zawodzi na drugim komputerze, pozwala ustalić, który warunek wstępny naprawdę ma znaczenie.

Ten sam błąd, inny komputer
Flaga funkcjiWłączona dla jednego konta, wyłączona dla innego
Nieaktualna pamięć podręcznaSerwuje jednej osobie starą wersję
Szerokość ekranuInny widok pokazuje inny układ
Rozszerzenie przeglądarkiBlokuje skrypt, zanim się uruchomi
Każdy z tych elementów może różnić zgłaszającego i programistę, a wtedy u jednego z nich ten sam błąd znika.

Jak odtwarzanie sesji skraca pisanie kroków do odtworzenia?

Odtwarzanie sesji skraca opis, bo nagranie zawiera już każde kliknięcie, wpis i stan strony, które w ręcznym zgłoszeniu trzeba opisać samodzielnie. Flowsery automatycznie dołącza nagranie i kroki do odtworzenia do każdego problemu i zgłoszenia błędu, gdy trafia ono do Slacka, Linear lub Jira, więc programista ogląda dokładną sekwencję, zamiast polegać na pamięci użytkownika. Wściekłe kliknięcia i martwe kliknięcia oznaczają moment, w którym użytkownik trafił na awarię, co eliminuje zgadywanie, od którego miejsca zacząć, a oznaczenie @flowsery w tym samym wątku na Slacku otwiera roboczy pull request, gdy poprawka jest już jasna.

Jak napisać zgłoszenie, które ktoś inny odtworzy
1
Podaj warunki wstępne. Stan konta, istniejące dane i wcześniejsze działania w sesji.
2
Ponumeruj każde działanie. Jedno kliknięcie, stuknięcie lub wpis na wiersz, w kolejności wykonania.
3
Oddziel oczekiwania od faktów. Dwa konkretne wiersze, a nie akapit o wrażeniach.
4
Zapisz środowisko. Przeglądarka, system, rozmiar ekranu oraz informacja, czy to produkcja, czy staging.
Cztery pola, które zamieniają opis błędu w kroki do odtworzenia.

Najczęściej zadawane pytania

Co odróżnia dobre kroki do odtworzenia od ogólnikowych?

Dobre kroki są ponumerowane, zaczynają się od podanego warunku wstępnego i kończą oczekiwanym wynikiem obok faktycznego. Ogólnikowe zgłoszenie opisuje odczucie ("płatność jest zepsuta"), a dobre wymienia pięć kliknięć, to, co powinno się pojawić, i to, co pojawiło się zamiast tego.

Czym kroki do odtworzenia różnią się od opisu błędu?

Opis błędu wyjaśnia prozą, co poszło nie tak, a kroki do odtworzenia to scenariusz, który inna osoba może wykonać, by zobaczyć tę samą awarię. Zgłoszenie może mieć jasny opis, a mimo to być nieodtwarzalne, jeśli pomija ponumerowane działania lub stan początkowy.

Dlaczego programista nie może odtworzyć błędu zgłoszonego przez klienta?

Zwykle dlatego, że w zgłoszeniu brakuje warunku wstępnego lub informacji o środowisku, na przykład stanu konta, wersji przeglądarki lub flagi funkcji, które różnią obie konfiguracje. Błąd jest prawdziwy, ale zgłoszenie jest niekompletne.

Co powinna zawierać sekcja o środowisku w zgłoszeniu błędu?

Powinna podawać przeglądarkę i jej wersję, system operacyjny, rozmiar ekranu, warunki sieciowe oraz informację, czy błąd wystąpił na produkcji, na stagingu, czy lokalnie. Każdy z tych elementów może przesądzić o tym, czy błąd w ogóle się pojawi.

Ile kroków powinno mieć odtworzenie błędu?

Tyle ponumerowanych kroków, ile odrębnych działań użytkownik wykonał przed awarią, nie więcej i nie mniej. Łączenie dwóch działań w jeden krok lub dodawanie kroków bez wpływu na wynik utrudnia śledzenie zgłoszenia.

Czy odtwarzanie sesji zastępuje spisane kroki do odtworzenia?

Odtwarzanie sesji zwalnia z ręcznego spisywania ponumerowanych działań, bo nagranie pokazuje dokładne kliknięcia, wpisy i stany strony w odpowiedniej kolejności. Środowisko i warunki wstępne są dołączane automatycznie wraz z nagraniem, więc programista otwiera jedno zgłoszenie, zamiast dopytywać o brakujące szczegóły.

Flowsery
Flowsery

Rozpocznij 14-dniowy okres próbny

Panel w czasie rzeczywistym

Śledzenie celów

Śledzenie bez cookie

Dlaczego "strona wygląda na zepsutą" nie jest zgłoszeniem błędu?

To opis odczucia, a nie wyniku, więc programista nie ma z czym tego porównać. Zgłoszenie wymaga dwóch osobnych wierszy: co interfejs miał pokazać i co dokładnie pojawiło się zamiast tego, w tym treść błędu lub pusty ekran. Porównaj to z "oczekiwano komunikatu 'Nieprawidłowy kod', pojawiła się pusta biała strona bez wpisów w konsoli", co wskazuje wprost, co sprawdzić.

Jak kroki do odtworzenia wpływają na wagę i priorytet?

Osoba oceniająca zgłoszenie bez pełnych kroków musi zgadywać zarówno szkody powodowane przez błąd, jak i pilność naprawy. Warunki wstępne, ponumerowane działania, oczekiwany wynik, faktyczny wynik i środowisko razem mówią, co naprawdę się psuje i u kogo. Bez któregokolwiek z tych pól waga i priorytet stają się szacunkami, a nie decyzjami.

Co wściekłe i martwe kliknięcia wnoszą do zgłoszenia błędu?

Oznaczają w nagraniu sesji dokładny moment, w którym użytkownik trafił na awarię. Ten znacznik czasu eliminuje zgadywanie, od którego miejsca nagrania zacząć szukać błędu. W połączeniu z automatycznie dołączonymi krokami do odtworzenia programista przechodzi prosto do awarii, zamiast przewijać całą sesję.

Do których narzędzi Flowsery automatycznie dołącza kroki do odtworzenia?

Flowsery automatycznie dołącza nagranie sesji i kroki do odtworzenia do każdego problemu, który trafia do Slacka, Linear lub Jira. Programista ogląda dokładną sekwencję kliknięć i wpisów, zamiast polegać na pamięci zgłaszającego. Oznaczenie @flowsery w tym samym wątku na Slacku może też otworzyć roboczy pull request, gdy poprawka jest już jasna.

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

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

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

Szablon zgłoszenia błędu wymienia każde pole, jakiego oczekuje recenzent, od kroków odtworzenia po ważność, więc niepełne zgłoszenia odpadają, zanim zajmie się nimi inżynier.

•7 min czytania
Co siedmiu dostawców publikuje o retencji danych z odtwarzania sesjiCo siedmiu dostawców publikuje o retencji danych z odtwarzania sesji
Słownik

Co siedmiu dostawców publikuje o retencji danych z odtwarzania sesji

Retencja danych z odtwarzania sesji według dokumentacji FullStory, Hotjar, Clarity, LogRocket, PostHog, Sentry i Datadog oraz wymagania RODO.

•8 min czytania
Skąd pochodzą dane w odtwarzaniu sesji i mapach cieplnychSkąd pochodzą dane w odtwarzaniu sesji i mapach cieplnych
Słownik

Skąd pochodzą dane w odtwarzaniu sesji i mapach cieplnych

Odtwarzanie sesji a mapy cieplne: jedna wizyta kontra wiele oraz to, jak Hotjar, Datadog, PostHog, Clarity i FullStory tworzą mapy z nagrań lub niezależnie od nich.

•7 min czytania
Co nagrywa rrweb i jak działają jego opcje prywatnościCo nagrywa rrweb i jak działają jego opcje prywatności
Słownik

Co nagrywa rrweb i jak działają jego opcje prywatności

Jak rrweb zapisuje sesję jako zrzut DOM i mutacje, a nie wideo: pakiety npm, licencja MIT i opcje prywatności, takie jak maskAllInputs i blockClass.

•8 min czytania
Jak działa częstotliwość próbkowania odtwarzania sesji w Sentry, PostHog i innychJak działa częstotliwość próbkowania odtwarzania sesji w Sentry, PostHog i innych
Słownik

Jak działa częstotliwość próbkowania odtwarzania sesji w Sentry, PostHog i innych

Częstotliwość próbkowania odtwarzania sesji określa, jaka część wizyt jest nagrywana. Zobacz, jak opisują ją Sentry, PostHog, LogRocket, Datadog i Clarity.

•8 min czytania
Czego RODO naprawdę wymaga od odtwarzania sesjiCzego RODO naprawdę wymaga od odtwarzania sesji
Słownik

Czego RODO naprawdę wymaga od odtwarzania sesji

Ocena odtwarzania sesji pod kątem RODO opiera się na czterech kwestiach: podstawie z art. 6, danych szczególnych kategorii z art. 9, zgodzie z art. 5 ust. 3 ePrivacy i DPIA.

•9 min czytania

Powiązane artykuły