Wszystko, co chcielibyście wiedzieć o zgłaszaniu błędów, ale baliście się zapytać

Daniel Owsiański opublikował(a) wpis dnia 2009/02/22 w kategorii: Maktura

Dobrego zgłaszania raportów o błędach (podobnie jak innych aktywności o które boimy się pytać ;-)) trzeba się po prostu nauczyć. W nieco uprzywilejowanej pozycji są tu programiści, oni uczą się tego szybko, kiedy sami muszą naprawiać błędy zgłaszane im przez użytkowników – co nie znaczy, że robią to idealnie. Na szczęście nie wszyscy na świecie są programistami. Aby pokazać normalsom na czym polega prawidłowe zgłaszanie błędów postanowiłem posłużyć się historyjką…

W sklepie

Wyobraź sobie, że stoisz w kolejce do kasy w wielkim supermarkecie w którym jesteś pierwszy raz w życiu. Trochę się spieszysz, ale widzisz, że facet stojący w kolejce przed Tobą ma w koszyku Twój ulubiony sok. Pytasz go “Przepraszam, gdzie mogę znaleźć ten sok, oo ten w zielonym opakowaniu?”

W zależności od tego na kogo trafiliśmy, mamy alternatywne wersje wydarzeń:

Pan Gawędziarz:
“Ten? Ooo też lubię ten sok. Niech pomyślę… Kupowałem pieczywo, ale nie było mojego ulubionego – uwierzy Pan? Pieczywa orkiszowego nie było, kiedyś to były inne czasy. Przeszedłem się na mięsny po mielone, ale potem wróciłem na chemię po proszek. Na końcu pomaszerowałem do napojów, wie Pan przypomniałem sobie że mam kupić wodę, no i tam gdzieś po drodze były soki. Jakoś po drodze trafiłem na TEN sok.”

Pan Idealny:
“Pójdzie Pan tą alejką do końca, potem skręci Pan w prawo i minie dwie następne alejki. Skręci Pan w trzecią, mniej więcej w środku po prawej stronie za wodami stoją soki. TEN sok jest na drugiej półce od dołu.”

Pan Niedziała:
“Nie ma już tego soku.”

Pan Programista:
“Czy wie Pan, że TEN sok jest wyciskany tylko z owoców których fi przekracza 20mm, do tego specjalną wyciskarką, której sterownik jest oprogramowany w Lispie? A wie Pan, że opakowanie jest od wewnatrz pokryte kilkoma warstwami folii…”
STOP, STOP krzyczysz – O Sok pytam, TEN Sok! Gdzie?!
“Aa tak, przepraszam, sok znajdzie Pan na stoisku z sokami, koło napojów” odpowiada Pan Programista.

Dla porządku przypomnę – naszym celem było szybkie znalezienie soku w nieznanym sklepie. Jak widzicie odpowiedź Pana Programisty wcale nie jest idealna, logiczna owszem, ale wcale nie ułatwia znacząco zadania (pomijając nieistotne detale techniczne). Pan Gawędziarz to dużo szumu informacyjnego, przekaz zawiera poszlaki, ale uzyskanie informacji wymaga odfiltrowania informacji zbędnych. Panów Niedziała, no cóż – ich chyba jest najwięcej :)

Podsumowanie

Celem Twojego zgłoszenia błędu jest jego wyeliminowanie. Jest to możliwe tylko, jeżeli zobaczymy go na własne oczy. Ponieważ nie pracujemy biurko w biurko, Twoje zgłoszenie traktujemy jak instrukcję p.t. “Jak spowodować powstanie błędu, który mnie wkurzył“. Czasem jego powtórzenie jest niemożliwe, wówczas bardzo pomocne jest opisanie co zachowywało się nie tak jak tego oczekujesz, tu ogomną pomocą będzie zrzut ekranu. W tych przypadkach szczegóły grają dużą rolę – opisz zatem, co zostało wyświetlone przez program, a co spodziewałeś się zobaczyć. Dobrą poszlaką są tu wszelkie komunikaty o błędach.

Jeżeli zaciekawiłem Cię tym, jak wygląda zgłaszanie błędów z perspektywy ich naprawiacza, polecam przeczytanie tego artykułu “Jak efektywnie zgłaszać błędy“.

Na zakończenie zaczerpnąłem z niego listę porad, które pomogą Ci skutecznie zgłosić, a nam szybko zidentyfikować i rozwiązać problemy związane nie tylko z Makturą:

  • Bądź konkretny. Jeśli jest kilka dróg do jednego celu, powiedz której z nich użyłeś. ,,Otworzyłem” może oznaczać ,,Kliknąłem na Otwórz” lub ,,Nacisnąłem Alt+O”. Sprecyzuj co zrobiłeś. Czasem to ma znaczenie.
  • Bądź gadatliwy – jeżeli nie możesz być konkretny :-) Przekazuj raczej więcej niż mniej informacji. Jeśli powiesz za dużo programista może część zignorować. Jeśli powiesz za mało, będzie musiał zadawać dodatkowe pytania. Kiedyś otrzymałem powiadomienie o błędzie w postaci jednego zdania; za każdym razem, gdy prosiłem o dodatkowe informacje zgłaszający odpowiadał kolejnym jednym zdaniem. Kilka tygodni zajęło mi dojście do kompletu użytecznych informacji.
  • Uważaj na zaimki. Nie używaj słów typu ,,to” czy ,,to okno”, gdy nie jest pewne co mogą znaczyć. Rozważ taki przykład: “Uruchomiłem Foo. Pojawiło się okienko z błędem. Chciałem je zamknąć, ale cała aplikacja się wyłożyła.” Jest to dłuższa, zawierająca więcej powtórzeń wersja, jednakże jaśniejsza i trudniejsza do błędnego zinterpretowania.
  • Przeczytaj to co napisałeś. Jeszcze raz przeczytaj całe zgłoszenie i zastanów się, czy jest dla Ciebie jasne. Upewnij się, że opisałeś sekwencję czynności, która powinna spowodować wystąpienie błędu. Sprawdź ją jeszcze raz, aby upewnić się, że nie pominąłeś żadnego kroku.
  • Wyrażaj się jasno. Pisz co masz na myśli i upewnij się, że nie da się tego błędnie zinterpretować.
  • Przede wszystkim bądź precyzyjny. Programiści lubią precyzję.

18 odpowiedzi do “Wszystko, co chcielibyście wiedzieć o zgłaszaniu błędów, ale baliście się zapytać”

  1. Bjjboy napisał(a):

    Strasznie fajny manual. Choć nie jestem programistą a administratorem i jeszcze nie dostałem BETY to bardzo mi się podoba.

    Szczerze po paru modyfikacjach wykorzystam dla swoich userów… do tego jak zgłaszać błędy.

    Wydaje mi się że brakuje jednej opcji róbcie screenshoty, bo bardzo często pojawiają się ważne informację o których użytkownik nie pamięta lub nie potrafi opisać, bo nie ma wystarczającej wiedzy czy chęci…

    Pozdrawiam i powodzenia
    lukasz

  2. Daniel Owsiański napisał(a):

    Dzięki, dzięki – zastanawiałem się jak pokazać drugą stronę kabla (czyli tych którzy odbierają zgłoszenia) i w tem nagle przyśniło mi się, że to może być scenka ze sklepu :)

    >Szczerze po paru modyfikacjach wykorzystam dla swoich userów… do tego jak zgłaszać błędy.
    Oczywiście copyright i linka do naszego bloga także planujesz dodać do tego tekstu? :))

    PS: beta jest wysyłana sukcesywnie, za pare minut idzie następna tura

  3. Bjjboy napisał(a):

    :-) właśnie dostałem BETĘ i bawię się wystawianiem faktur dla moich klientów.

    Już wiem czego mi brakuje… :-)

    Ja jestem dobrym użytkownikiem i piszę feedback’i. Bo naturalne jeśli za coś płacę to chcę aby to działało dobrze.

    I oczywiście pełny copyright i link do waszej strony będą :D

    Dzięki.

  4. W napisał(a):

    Czy przypadkiem Maktura nie jest wyłączne na Leoparda? Coś mi się nie chce odpalić pod Tygrysem…

  5. Zbigniew Sobiecki napisał(a):

    @W: Maktura wymaga Leoparda. Więcej w FAQ i komentarzach tutaj.

  6. MACiek napisał(a):

    … przydało by się, aby wiadomość wysłana do Was z uwagami, była gdzieś archiwizowana aby człowiek pamiętał o czym już pisał …

  7. Łukasz Kowalczyk napisał(a):

    Witam Serdecznie!

    Nareszcie powstało dzięki Wam “coś” co wygląda i służy jak powinno :) Gratuluję!!! i jestem naprawdę pod dużym wrażeniem, szczególnie pod kontem graficznej strony.
    Już od dłuższego czasu poszukiwałem dobrego i prostego programu do wystawiania elektronicznie faktur na maca, i przyznam że to co udało mi się znaleźć (a niebyło tego wiele) z różnych przyczyn nie spełniało moich oczekiwań pod różnym kontem… ale nareszcie (niezapeszając) znalazłem: Maktura!!!
    Wersja Beta w skali oceny punktowej 1<10 wygląd graficzny: 10! funkcjonalność i prostota: 10!
    Wypisałem testowo już kilka faktur i jak na razie wszystko działa super :) i mam nadzieję że tak zostanie.
    Wersja beta działa przez 19 dni… i co będzie dalej??? przyznam że ręczne wypisywanie faktur mnie już “dobija” więc liczę na Was i trzymam kciuki za pełen sukces Maktury :)
    ok, do testów… a jak coś wymyśle lub znajdę jakąś nieprawidłowość to będę pisać ;)

    P.S.
    napisałem i wysłałem już to co powyżej używając tzw. “ikonki megafonu” ale uważam że pozytywne komentarze należy zamieścić też do wiedzy publicznej stąd się powtarzam ;)

    Powodzenia i pozdrawiam,
    Łukasz Kowalczyk

  8. Daniel Owsiański napisał(a):

    @Łukasz – dziękuję w imieniu swoim i reszty Macoscope za tak wysoką ocenę! Co do 19 dni – po tym czasie program… przestanie działać! (chyba, że wcześniej się zakutalizuje :)) Jak więc widzisz to najpóźniejszy termin następnej wersj beta, nie możemy przecież pozwolić, aby już raz zaleczone frustracje związane z wystawianiem faktur powróciły! Jeszcze raz dzięki za miłe słowa.

  9. Qper napisał(a):

    Program graficznie rewelacyjny nic dodać nic ująć.

    Jest parę rzeczy które, trzeba rozważyć ale sądząc po profesjonalizmie Panów tworzących program to nie będzie najmniejszego problem :)

    Swoje uwagi już wysłałem i mam nadzieję, że w jakiś sposób pomogą w ulepszeniu programu.

    Mam dużą nadzieję, że w przyszłości powstanie wersja sieciowa na np: 2 komputery

    Pozdrawiam i owocnych prac ;)
    Finalną wersję zakupię

  10. Łukasz Kowalczyk napisał(a):

    Witam ponownie ;)

    testowałem… testowałem… i stwierdzam że wszystko działa jak należy :)

    jedyne co dostrzegłem, czego może brakować w druku faktury to wyznaczonego miejsca na pieczęć firmową (patrząc pod kontem US oni uwielbiają się czepiać takich szczegółów)

    reszta bez zastrzeżeń :)

    Podajcie cenę… finalną wersję biorę bez wahania !!! :)

    Pozdrawiam :)

  11. Łukasz Kowalczyk napisał(a):

    …jeszcze znalazłem jedną rzecz która mogłaby usprawnić funkcjonalność Maktury a raczej wprowadzić dodatkowy ład w wystawionych fakturach: możliwość oznaczenia w historii wystawionych faktur które są opłacone przez klienta a które nie.
    to już chyba można nazwać czepianiem się drobnostek ;) ale czego się czepiać kiedy program działa jak należy :)

    Pozdrawiam,
    Łukasz Kowalczyk

  12. Qper napisał(a):

    Ta funkcjonalność z oznaczeniem faktur opłaconych to była by przydatna…
    Można rozważyć :)

  13. MACiek napisał(a):

    @Łukasz Kowalczyk
    cytat -> “jedyne co dostrzegłem, czego może brakować w druku faktury to wyznaczonego miejsca na pieczęć firmową (patrząc pod kontem US oni uwielbiają się czepiać takich szczegółów)”

    na wydruku jest tyle miejsca, że śmiało możesz “walnąć pieczątkę” gdzie ci się podoba, US nie ma prawa kwestionować takich rzeczy – kompletna bzdura

  14. Łukasz Kowalczyk napisał(a):

    @MACiek
    cytat ->”na wydruku jest tyle miejsca, że śmiało możesz “walnąć pieczątkę” gdzie ci się podoba, US nie ma prawa kwestionować takich rzeczy – kompletna bzdura”

    to Ty tak sądzisz lub pewnie niemiałeś nigdy do czynienia z US warszawa-wawer… ja już tam “przerabiałem” nie takie rzeczy, czepiają się wszystkiego jak wpadną na kontrole :(

  15. MACiek napisał(a):

    @Łukasz Kowalczyk
    prowadzą działalność od 17 lat, miałem kilkanaście kontroli, w tym klika z UKS-u (wygrałem nawet jedna sprawę w NSA), i czepianie się szczegółów to pestka i bzdura.

    Tutaj chodzi o to, aby program funkcjonował poprawnie i zgodnie z prawem, na dzień dzisiejszy faktura VAT może być tylko wydrukiem komputerowym bez podpisu, a nawet czasem i bez pieczątki ;)

    … to nie te czasy, aby bać się urzędników, i robić wszystko aby im się dobrze pracowało :)

  16. Łukasz Kowalczyk napisał(a):

    Wiem… wiem… czego brakuje, nareszcie chyba znalazłem coś co powinien zawierać program do wystawiania faktur a czego nie ma ;) a więc nie ma opcji wystawiania faktur lub not korygujących.

  17. Łukasz Kowalczyk napisał(a):

    @MACiek

    ja prowadzę działalność od 9 lat i wiem jedno że każdy US rządzi się swoimi prawami a raczej tym jak pan/pani z urzędu interpretuje i rozumie przepisy… (mimo że prawo i zasady dla wszystkich US są takie same)
    ok, nie po to powstał ten blog abyśmy wymieniali się tym ile kto miał kontroli itp.
    według mojego US na fakturze VAT-owskiej powinna być pieczęć firmowa… może faktycznie wyznaczanie miejsca gdzie powinna być to przesada więc niech każdy przybija gdzie chce ;) a ja przybije tam gdzie powie mi księgowa :)

  18. Daniel Owsiański napisał(a):

    Hola hola Panowie :) mam dwie uwagi:
    1) długość stażu jako przedsiębiorca nie będzie miała wpływu na funkcjonalność Maktury
    2) ilość blizn i nacięć na klawiaturze po starciu z US patrz punkt 1)

    Proponuję więc zakończyć dysputy o samowoli urzędniczej, bo może nam zabraknąć liczb naturalnych w bazie, żeby ponumerować wszystkie komentarze w tej sprawie…