Dobre zgłoszenie oddziela obserwacje od przypuszczeń. Zapisz komunikat, czas, środowisko i bezpieczne kroki odtworzenia błędu, nie udostępniając poufnych danych. Poradnik jest niezależny od systemu operacyjnego; nazwy okien z informacją o wersji zależą od programu.
1. Zapisz okoliczności zdarzenia
Zanotuj datę, godzinę i strefę czasową, aplikację oraz jej dokładną wersję. Dodaj wersję systemu, typ urządzenia i ostatni znany moment poprawnego działania. Przy brakujących informacjach wpisz „nieznane”, zamiast zgadywać. Opisz wpływ: czy problem dotyczy jednego pliku, użytkownika czy wielu stanowisk?
2. Dokładnie opisz błąd i kroki
- Jeśli to możliwe, skopiuj cały komunikat wraz z kodem. W przeciwnym razie wykonaj zrzut ekranu i dodatkowo przepisz tekst. Nie tłumacz ani nie skracaj kodu błędu.
- Ponumeruj czynności prowadzące do błędu: stan początkowy, otwarty plik lub funkcja, konkretny przycisk i wynik. W razie potrzeby zastąp nazwy plików neutralnymi nazwami.
- Oddziel oczekiwany wynik od zaobserwowanego. Napisz „Zapisz wyświetla błąd X”, a nie „Serwer jest zepsuty”, dopóki przyczyna nie została potwierdzona.
- Podaj, czy błąd występuje zawsze, czasami czy wystąpił raz. Powtarzaj tylko bezpieczne kroki na danych testowych lub kopii. Nie powtarzaj płatności, usuwania ani działań grożących utratą danych, aby odtworzyć problem.
3. Dowody i wcześniejsze próby
Dodaj znane zmiany tuż przed błędem oraz podjęte działania, każde z wynikiem. Nie zmieniaj wielu ustawień jednocześnie. Chroń oryginalny dziennik; udostępniaj tylko potrzebne fragmenty z odpowiedniego przedziału czasu. Równoczesne zdarzenie jest wskazówką, nie dowodem przyczyny.
4. Sprawdź przed wysłaniem
Usuń hasła, tokeny sesji, dane osobowe i poufne treści z kopii przeznaczonej do wysłania. Sprawdź także pasek adresu, ścieżki plików i tło zrzutów. Prostokąt nałożony w edytowalnym pliku nie gwarantuje bezpiecznego usunięcia. Otwórz ponownie końcowy załącznik i sprawdź wynik. Użyj właściwego kanału pomocy oraz sprawdź odbiorcę i załączniki; nie publikuj na forum nieprzejrzanych pełnych pakietów diagnostycznych.
Szablon do skopiowania
- Krótki tytuł i wpływ:
- Data, godzina, strefa czasowa:
- Aplikacja/wersja, system/wersja, urządzenie:
- Stan początkowy i ponumerowane kroki:
- Wynik oczekiwany / zaobserwowany:
- Pełny komunikat i kod:
- Częstotliwość, ostatnie poprawne działanie, znane zmiany:
- Podjęte próby / wynik każdej:
- Sprawdzone załączniki bez poufnych danych:
Kontrola końcowa: inna osoba powinna zrozumieć przebieg bez pytań o podstawowe kroki. Niezależne problemy zgłaszaj osobno.
Źródło
Mozilla: Bug Writing Guidelines – podstawa dokładnych kroków, jasnych wyników i osobnych zgłoszeń; kontrola prywatności uzupełnia ogólną procedurę pomocy.