KjerrSzablon bug report
do skopiowania.
Dobry szablon bug report prowadzi programistę od przeczytania do odtworzenia błędu za jednym podejściem: co się stało, co miało się stać, jakie były kroki i gdzie. Skopiuj poniższy szablon do dokumentu, formularza albo trackera zadań, albo ustaw te same pola na tablicy, która przyjmie też pliki.
Szablon bug reportu
Siedem pytań. Wymagaj tytułu i kroków; resztę zostaw jako opcjonalną.
Tytuł
Co nie działa i gdzie. Jedno zdanie.
Przykład: Eksport do CSV pobiera pusty plik
Co się stało?
Co widzisz, w jednym lub dwóch zdaniach.
Co miało się stać?
Co powinno było wydarzyć się zamiast tego.
Kroki do odtworzenia
1.
2.
3.
Jak często?
Za każdym razem, czasami albo raz.
Gdzie?
Przeglądarka lub wersja aplikacji, system operacyjny, konto lub przestrzeń robocza.
Masz coś do pokazania?
Zrzut ekranu, nagranie ekranu, log, plik HAR.
Przykładowy bug report
Ten sam szablon, wypełniony. Produkt i liczby są zmyślone.
Tytuł
Eksport do CSV pobiera pusty plik
Co się stało?
Po kliknięciu Eksportuj na stronie Raporty plik się pobrał,
ale ma tylko wiersz nagłówka.
Co miało się stać?
Plik z 214 wierszami, które widać w tabeli na ekranie.
Kroki do odtworzenia
1. Otwórz Raporty i wybierz ostatnie 30 dni.
2. Przefiltruj według planu „Scale”.
3. Kliknij Eksportuj, potem CSV.
Jak często?
Za każdym razem przy włączonym filtrze. Bez filtra eksport działa.
Gdzie?
Chrome 141 na macOS 15. Przestrzeń robocza: northwind.
Masz coś do pokazania?
export.csv (pusty plik), reports.har
Po co jest każde pole
- Tytuł. Co nie działa i gdzie, żeby zgłoszenie dało się potem znaleźć, a duplikaty się spotkały.
- Co się stało? Objaw słowami osoby zgłaszającej, zanim ktokolwiek go zinterpretuje.
- Co miało się stać? Połowa zgłoszeń to nieporozumienie, a ta linijka pokazuje, która.
- Kroki do odtworzenia. Część, której programista nie zgadnie. Ponumerowane, po jednej czynności w kroku.
- Jak często? „Za każdym razem” wskazuje na logikę; „czasami” na zależności czasowe albo dane.
- Gdzie? Przeglądarka, wersja i konto zawężają poszukiwania bardziej niż jakikolwiek opis.
- Masz coś do pokazania? Nagranie albo log zastępuje trzy akapity.
Jak zrobić z szablonu formularz zgłoszenia błędu
Formularz zgłoszenia błędu powinien pytać o mniej niż szablon. Każde pole obowiązkowe kosztuje kilka zgłoszeń, a brakujące zgłoszenie kosztuje więcej niż brakujący szczegół.
- Wymagaj tytułu i kroków do odtworzenia, niczego więcej.
- W każdym polu pokaż przykład jako podpowiedź, żeby było widać, jakiej szczegółowości oczekujesz.
- Pokaż podobne zgłoszenia przed wysłaniem formularza, żeby można było dodać głos zamiast duplikatu.
- Pozwól dodawać pliki przez przeciągnięcie ich na formularz.
- Powiedz, co będzie dalej: gdzie pojawi się zgłoszenie i jak przyjdzie odpowiedź.
Co załączyć do zgłoszenia błędu
Dowody skracają rozmowę. O te pliki warto prosić, a każdy z nich rozstrzyga co innego.
- Zrzut ekranu, przy wszystkim, co widać.
- Nagranie ekranu w MP4, gdy kroki trudno opisać słowami.
- Plik HAR, gdy strona się nie ładuje, nie zapisuje albo nie eksportuje.
- Log z konsoli albo z serwera jako TXT lub LOG.
- Sam e-mail jako EML, przy problemach z dostarczaniem i formatowaniem.
- Plik CSV, XLSX lub JSON, którego nie dało się zaimportować, albo ten, który wyszedł błędny.
Zbieranie bug reportów na tablicy Kjerr
Tablica Kjerr może zadawać pytania z szablonu i przechowywać dowody. Co jest nowe, zespół widzi tam, gdzie odbywa się zarządzanie feedbackiem.
- Formularz jest edytowalny: dodaj własne pola „Kroki do odtworzenia”, „Co miało się stać” i „Gdzie”, łącznie do 10 pól, każde obowiązkowe lub opcjonalne, z własną podpowiedzią.
- Do 5 plików po 10 MB przy zgłoszeniu i komentarzu: obrazy, PDF, EML, TXT, LOG, CSV, JSON, HAR, ZIP, DOCX, XLSX, PPTX i MP4.
- Podobne zgłoszenia pojawiają się podczas wpisywania tytułu, każde z przyciskiem głosowania.
- Dla tablicy QA ustaw dostęp tylko dla zalogowanych i ogranicz logowanie do domeny e-mail firmy; to ta sama konfiguracja co skrzynka pomysłów online.
- Gdy status zmienia się na Shipped, osoba zgłaszająca i wszyscy głosujący dostają e-mail.
- To nie jest tracker zadań: bez osób przypisanych, poziomów ważności i sprintów.
Pytania i proste odpowiedzi.
Co to jest szablon bug report?
Szablon bug report to stały zestaw pytań, który z każdego zgłoszenia wydobywa te same fakty: co się stało, co miało się stać, jak odtworzyć błąd i gdzie wystąpił. Dzięki niemu programista przechodzi od czytania do odtwarzania bez rundy pytań uzupełniających.
Co powinien zawierać bug report, czyli raport błędu?
Tytuł w jednym zdaniu, opis tego, co się stało i co miało się stać, ponumerowane kroki do odtworzenia, informację, jak często błąd występuje, środowisko oraz dowody, na przykład zrzut ekranu albo log. Jeśli obowiązkowe mogą być tylko dwie rzeczy, niech to będą tytuł i kroki.
Czym różni się bug report od feature requestu?
Bug report mówi, że produkt nie robi tego, co obiecuje. Feature request prosi o coś, czego produkt nigdy nie obiecywał. Wymagają innych pytań; do tego drugiego użyj szablonu feature requestu.
Jak dobrze opisać kroki do odtworzenia?
Zacznij od stanu, do którego każdy może dojść, pisz jedną czynność w linijce i podawaj dokładne wartości, które zostały wpisane lub wybrane. Zatrzymaj się na kroku, w którym pojawia się problem. Jeśli jakiś krok jest potrzebny tylko czasami, napisz to.
Co to jest plik HAR i czy warto go załączać?
Plik HAR to zapis żądań wysłanych przez stronę internetową, zapisywany z narzędzi deweloperskich przeglądarki. Załącz go, gdy strona się nie ładuje, nie zapisuje albo nie eksportuje. Najpierw go sprawdź: może zawierać ciasteczka sesji i dane osobowe.
Czy Kjerr zastąpi bug tracker?
Nie. Kjerr zbiera zgłoszenia, usuwa duplikaty i informuje zgłaszających o zmianie statusu. Nie ma osób przypisanych, poziomów ważności ani sprintów, nie ma też synchronizacji z Jira i Linear. Zespoły używają go jako drzwi wejściowych, a tracker zadań zostawiają za nimi.
Powiązane strony
Daj użytkownikom odpowiedź.
W okresie wczesnego dostępu Kjerr jest darmowy: wszystkie funkcje, bez karty kredytowej. Płatne plany, gdy się pojawią, będą liczone za przestrzeń roboczą, nigdy za stanowisko administratora.