Jak nagrywać jasne raporty o błędach za pomocą Loom

Rejestrowanie jasnych i praktycznych raportów o błędach za pomocą Loom

Jeśli spróbujesz sporządzić raport o błędach, zobaczysz, ile informacji można zgubić. Opisanie kroków, komunikatu o błędzie i wykonywanej wtedy czynności rzadko pozwala uchwycić wszystko, co programista musi zobaczyć.

Czym więc jest raport o błędach w tworzeniu oprogramowania? Raport o błędach to dokument (napisany lub nagrany) zawierający opis, co dokładnie poszło nie tak, jak to odtworzyć oraz jakie powinno było być oczekiwane zachowanie. Celem jest zapewnienie programistom wystarczającej ilości informacji, aby zrozumieli i przeanalizowali zgłoszenie oraz ustalili jego priorytet bez wymiany kilkunastu wiadomości.

Przesyłanie raportów o błędach w formacie wideo za pomocą Loom znacznie przyspiesza ten proces. Zamiast przepisywać obszerny tekst, nagrywasz ekran, omawiasz zgłoszenie i udostępniasz łącze. Pomaga to szybko synchronizować zespoły, unikając nieporozumień. Czytaj dalej, aby dowiedzieć się, jak rejestrować raporty o błędach, które zapewniają zespołowi wszystko, czego potrzebuje, aby szybko rozwiązywać problemy.

Krok 1. Ustalenie, jaki błąd chcesz zgłosić

Zanim zaczniesz nagrywać, poświęć minutę na potwierdzenie, że potrafisz niezawodnie odtworzyć zgłoszenie. Błąd, który wystąpił tylko raz i którego nie można powtórzyć, jest zespołu programistów znacznie trudniejszy do zbadania.

Zastanów się, jakie powinno być oczekiwane zachowanie, a co się faktycznie dzieje. Kontrast między tym, co powinno działać, a tym, co jest zepsute, to podstawa każdego użytecznego raportu o błędach. Gdy już to zrozumiesz, przejdź do obszaru produktu, w którym występuje błąd, aby przygotować się do uchwycenia go w kontekście.

Krok 2. Rozpoczęcie nagrywania ekranu Loom

Otwórz Loom i zdecyduj, czy chcesz nagrać tylko ekran, czy ekran i kamerę. Pierwsza opcja sprawdza się w przypadku większości błędów. Dodanie kamery może pomóc, jeśli przeprowadzasz demonstrację dla nietechnicznego interesariusza lub chcesz dodać bardziej prywatny kontekst.

Wybierz konkretne okno lub konkretną kartę, w których pojawia się błąd. Ograniczenie zakresu nagrania do właściwego obszaru pomaga użytkownikom z uprawnieniem do wyświetlania śledzić go bez rozpraszania się innymi otwartymi oknami lub niepowiązanymi treściami.

Krok 3. Odtworzenie i nagranie kroków, które wyzwalają błąd

To najważniejsza część nagrania. Omawiaj na bieżąco każde działanie, które powoduje problem. Wyjaśnij, co klikasz, czego oczekujesz i co widzisz zamiast tego.

Mów powoli i wyraźnie. Pośpieszne przejście przez dobrze znane Ci kroki może być kuszące, ale odbiorcy mogą to oglądać po raz pierwszy. Zwolnienie sprawi, że mniej osób wciśnie przycisk Powtórz tylko po to, aby nadążyć.

Krok 4. Wywołanie błędu i opisanie, co jest nie tak

Gdy błąd pojawi się na ekranie, przerwij i wyraźnie go wskaż. Nie zakładaj, że to oczywiste. Powiedz dokładnie, co jest zepsute lub nieprawidłowe, a także co powinno się wydarzyć zamiast tego.

To jest moment, w którym nagranie staje się naprawdę przydatne dla zespołów programistycznych. Dzięki jasnej narracji w momencie wystąpienia problemu programiści nie muszą interpretować niejasnych znaczników czasu lub zgadywać, o czym mówi osoba zgłaszająca.

Krok 5. Podkreślenie wpływu i istotności podczas nagrania

Po pokazaniu błędu poświęć chwilę na wyjaśnienie, na kogo wpływa i jak zakłóca jego przepływ pracy lub komfort obsługi. Błąd uniemożliwiający użytkownikowi wyewidencjonowanie bardzo różni się od drobnego problemu z wyświetlaniem.

Wspomnij, jak często się to zdarza, czy jest to kompletny bloker oraz czy są znane jakieś sposoby jego obejścia. Te informacje pomagają nadać priorytet rozwiązaniu.

Przydatne są tutaj również funkcje komentarzy i reakcji Loom. Można dodać komentarz ze znacznikiem czasu dokładnie w momencie pojawienia się błędu, więc każdy oglądający może przeskoczyć prosto do tego punktu bez przeglądania całego filmu.

Loom automatycznie rejestruje również kontekst techniczny, którego programiści potrzebują do rozwiązywania problemów, w tym typ przeglądarki, urządzenie, dzienniki konsoli i dane sieci. Eliminuje to zwykłą rundę dodatkowych pytań między osobą zgłaszającą, a zespołem, który się tym zgłoszeniem zajmuje.

Krok 6. Przejrzenie, przycięcie i dopracowanie raportu o błędach za pomocą Loom AI

Przed udostępnieniem obejrzyj nagranie jeszcze raz. Szukaj wszystkiego, co jest niejasne, i wytnij niepotrzebne przerwy lub przypadkowy czas bezczynności. Lepiej zmontowany film łatwiej się ogląda i łatwiej wykorzystuje do działania.

Ułatwia to Loom AI. Każdy może stworzyć dopracowane, profesjonalne nagranie bez doświadczenia w edycji filmów. Edycja oparta na sztucznej inteligencji czyści wszystko automatycznie, co jest szczególnie pomocne dla członków zespołu, którzy nie czują się komfortowo przed kamerą, ale jednak muszą się jasno komunikować.

Krok 7. Udostępnienie nagrania zespołowi, aby mógł je przejrzeć w dogodnym czasie

Skopiuj łącze do Loom i umieść je tam, gdzie pracuje Twój zespół, np. w aplikacji Slack, e-mail lub bezpośrednio w narzędziu do śledzenia błędów.

Jeśli Twój zespół korzysta z Jiry, Loom jeszcze bardziej usprawnia to przekazanie. W karcie Generuj znajduje się przycisk „Utwórz w Jirze”, który pozwala utworzyć zgłoszenie bezpośrednio na tablicy Jiry zespołu bez opuszczania Loom. Film, kontekst i szczegóły trafiają bezpośrednio do miejsca, w którym wykonywana jest praca.

Tam koledzy z zespołu mogą oglądać, komentować i dokonywać uzgodnień za pomocą komunikacji asynchronicznej bez konieczności planowania. Praca asynchroniczna za pomocą Loom oznacza, że zespoły rozproszone mogą przeglądać, omawiać i uzgadniać zgłoszenia w odpowiednim dla nich czasie, skracając cykle informacji zwrotnej i ograniczając liczbę niepotrzebnych spotkań.

Jakie są najważniejsze elementy, które należy uwzględnić w zgłoszeniu błędu?

Każdy dobry film przedstawiający zgłoszenie błędu powinien zawierać następujące elementy:

• Dokładny opis kroków prowadzących do błędu: Opisz szczegółowo każdą czynność, która powoduje wystąpienie błędu, aby programiści mogli go odtworzyć bez zgadywania.
• Widoczne zachowanie: Pokaż, co faktycznie dzieje się na ekranie, zamiast tylko opisywać to słowami.
• Wyniki oczekiwane a rzeczywiste: Jasno opisz, co powinno się wydarzyć, a co faktycznie się stało. Takie ujęcie sprawia, że problem staje się od razu zrozumiały.
• Kontekst wpływu i wagi: Wyjaśnij, na kogo błąd ma wpływ i jak bardzo zakłóca działanie systemu, aby zespół mógł odpowiednio ustalić priorytety.
• Szczegóły dotyczące środowiska: Loom automatycznie rejestruje informacje o przeglądarce i urządzeniu, jednak w stosownych przypadkach warto podać system operacyjny, wersję aplikacji lub typ konta.