Klasyfikowanie problemów

BeeWare regularnie otrzymuje zgłoszenia problemów od użytkowników, którzy napotykają trudności. Kiedy pojawia się nowe zgłoszenie, musi ono zostać poddane ocenie — oznacza to, że ktoś musi przeczytać zgłoszenie, zapoznać się z informacjami przekazanymi przez zgłaszającego i spróbować odtworzyć opisany problem.

Niestety, chociaż zgłoszenia problemów są zazwyczaj składane w dobrej wierze, często są niekompletne lub niejasne. Celem procesu selekcji jest uzupełnienie braków w oryginalnym zgłoszeniu. Oznacza to albo dostarczenie wystarczających szczegółów, abyśmy mogli potwierdzić, w jaki sposób problem można odtworzyć, albo potwierdzenie, że osoba zgłaszająca popełniła błąd w swoim zgłoszeniu.

Triage problemu nie oznacza, że oczekuje się od Ciebie jego rozwiązania. W zależności od problemu, triage może nawet nie wymagać pisania kodu. Możesz przeprowadzić triage problemu, mając bardzo niewielką wiedzę na temat BeeWare, ponieważ powinieneś być w stanie wykonać kroki zawarte w raporcie i odtworzyć opisany problem.

Pomoc w klasyfikacji problemów

Odtwórz problem

Nie można naprawić problemu, jeśli w ogóle nie występuje. Dlatego odtworzenie problemu jest warunkiem koniecznym do jego naprawienia. W oprogramowaniu problemy są powszechnie nazywane „błędami” (https://en.wikipedia.org/wiki/Software_bug), a zgłoszenia problemów często nazywane są „raportami o błędach”.

Ktoś zgłosił błąd. Musisz sprawdzić, czy czynności opisane przez zgłaszającego prowadzą do wystąpienia zgłoszonego błędu. Czy możesz odtworzyć ten sam wynik, wykonując dokładnie czynności opisane w zgłoszeniu? Jeśli nie, musisz ustalić, dlaczego.

Błędy w kodzie

W idealnej sytuacji będziesz mieć taką samą konfigurację jak osoba, która zgłosiła błąd, wykonasz opisane kroki i będziesz w stanie odtworzyć błąd zgodnie z opisem. Jednak w wielu przypadkach nie będzie to takie proste. Wiele zgłoszeń błędów zawiera jedynie niejasne wyjaśnienia i niejasny zestaw warunków. Problem polega na tym, że wiele błędów różni się w zależności od zestawu warunków, w tym sposobu interakcji, różnych warunków wstępnych, systemu operacyjnego, wersji systemu operacyjnego, architektury procesora lub tego, czy komputer użytkownika jest stary i wolny, czy nowy i szybki. Im więcej informacji mamy na temat sytuacji związanej z błędem, tym lepiej. Spróbuj odtworzyć zestaw warunków podanych przez zgłaszającego. Jeśli nie jesteś w stanie tego zrobić, kolejnym krokiem może być poproszenie osoby, która zgłosiła błąd, o dodatkowe informacje.

Najlepszym sposobem na odtworzenie błędu jest użycie jak najmniejszej próbki, która nadal pokazuje problem. W większości przypadków osoby zgłaszające błędy nie podają minimalnej próbki; jeśli podają jakąkolwiek próbkę, to jest ona skopiowana bezpośrednio z ich „prawdziwej” aplikacji. Twoim celem będzie zredukowanie zgłoszenia do najprostszej możliwej formy, która ujawnia problem. Najlepszym przypadkiem odtworzenia jest najmniejszy możliwy program. Ta redukcja sama w sobie jest pomocna, ponieważ pozwala określić, na czym polega rzeczywisty problem. Każdy może wziąć minimalny przykład, uruchomić go i zaobserwować opisany błąd.

Błędy w dokumentacji

Błędy w dokumentacji mogą przejawiać się na różne sposoby. Istnieją problemy z formatowaniem, które powodują problemy z renderowaniem. Czasami nie jest to nawet błąd; osoba mogła źle odczytać dokumentację lub popełnić prawdziwy błąd. Nie oznacza to jednak, że dokumentacja nie zawiera żadnych problemów. Treść może być niejasna lub nieprecyzyjna, co pozostawia miejsce na nieporozumienia lub błędną interpretację. Możliwe jest, że koncepcja, która powinna zostać omówiona, nie jest omawiana, ponieważ nie została w ogóle udokumentowana.

W przypadku zgłoszenia błędu dotyczącego dokumentacji należy sprawdzić, czy zgłoszony problem nadal występuje. W przypadku problemów z renderowaniem należy skompilować dokumentację, aby sprawdzić, czy można odtworzyć problem. Problemy związane z treścią wymagają przeczytania dokumentacji w celu sprawdzenia, czy nikt nie zgłosił aktualizacji.

Zaktualizuj problem

Ostatnim krokiem w procesie selekcji jest udokumentowanie swoich ustaleń poprzez dodanie komentarza do zgłoszenia.

Jeśli jesteś w stanie odtworzyć problem dokładnie tak, jak został opisany, to wystarczy. Dodaj komentarz, że potwierdziłeś, że widzisz ten sam problem, dokładnie tak, jak opisał to pierwotny zgłaszający.

Jeśli jesteś w stanie podać dodatkowe informacje, dołącz szczegóły dotyczące tego kontekstu. Może to obejmować możliwość odtworzenia problemu w innym systemie operacyjnym lub przy użyciu innej wersji niektórych programów lub cokolwiek innego, co różni się od pierwotnego zgłoszenia.

Jeśli w oryginalnym zgłoszeniu brakowało szczegółów potrzebnych do odtworzenia problemu, dodaj te szczegóły. Może to obejmować podanie informacji o systemie operacyjnym lub wersji, których nie zawierało oryginalne zgłoszenie, bardziej kompletne logi lub ślady stosu lub jaśniejsze instrukcje dotyczące dokładnej sekwencji operacji potrzebnych do odtworzenia problemu. Jeśli opracowałeś prostszy sposób odtworzenia problemu (lub osoba zgłaszająca problem nie podała przypadku odtworzenia), możesz dołączyć szczegóły dotyczące tej metody odtworzenia.

Jeśli nie możesz odtworzyć problemu, również zostaw komentarz, opisując, co próbowałeś zrobić. Wiedza o tym, gdzie problem nie występuje, jest prawie tak samo ważna jak wiedza o tym, gdzie występuje, ponieważ pomaga to zawęzić zakres możliwych przyczyn. Jeśli masz jakieś teorie na temat dlaczego nie możesz odtworzyć problemu — na przykład, jeśli uważasz, że jest to błąd użytkowania lub że problem został rozwiązany przez ostatnią aktualizację systemu operacyjnego — uwzględnij tę spekulację w swoim komentarzu.

Na koniec możesz przekazać zespołowi głównym wszelkie swoje zalecenia. Jeśli uważasz, że pierwotny raport zawiera błąd, zaproponuj zamknięcie zgłoszenia; jeśli masz teorię na temat przyczyny problemu, również możesz ją przedstawić. Twoje uwagi pomogą zespołowi głównemu ustalić, jak przejść do kolejnego etapu.