Podstawowy proces05 / 16
Czytaj wyjaśnienia i dowody
Na tej stronie
Wyjaśnienia implementacji pozwalają zacząć od fragmentu założeń, zrozumieć działanie kodu i znaleźć dowody potwierdzające opis. Skup się na zachowaniu, materiałach źródłowych i pytaniach, które nadal wymagają Twojego osądu.
Otwórz wyjaśnienia akapitów i fragmentów
Kliknij tekst dokumentu, aby go edytować. Kliknij puste miejsce wewnątrz akapitu, poza jego tekstem, aby otworzyć wyjaśnienie akapitu oznaczone L1.
Niektóre wyjaśnienia dotyczą słowa lub wyrażenia. Najedź na akapit, aby zobaczyć krótkie podkreślenia, a następnie kliknij jedno z nich, aby przeczytać lokalne wyjaśnienie oznaczone L2.
Listy, tabele i bloki kodu także mogą mieć wyjaśnienia. Cała lista jest analizowana łącznie; same nagłówki nie są analizowane.
Możesz pozostawić otwarte notatki na marginesie kilku akapitów. Każdy akapit pokazuje naraz jedno wyjaśnienie akapitu lub fragmentu. W wąskim oknie notatka może pojawić się pod akapitem.
Przeczytaj trzy sekcje
| Sekcja | Na jakie pytanie odpowiada | Czego szukać |
|---|---|---|
| Realizacja | Jak implementacja realizuje te założenia? | Zachowania, kroki, przypadki brzegowe i decyzje implementacyjne. |
| Dowody | Co potwierdza wyjaśnienie? | Odwołania do kodu, testy, wyniki poleceń i inne materiały do sprawdzenia. |
| Wymaga uwagi | Co wymaga dalszego osądu? | Braki, decyzje implementacyjne, ryzyka i sugestie. |
Sekcja Realizacja jest domyślnie rozwinięta. W razie potrzeby rozwiń Dowody. Sekcja Wymaga uwagi jest ukryta, gdy nie ma żadnych wątpliwości do pokazania.
W przypadku nagrody po 7 kolejnych meldunkach wyjaśnienie może opisywać sposób liczenia dat, wskazywać odpowiednią funkcję i testy oraz zwracać uwagę na obsługę podróży między strefami czasowymi. Rzeczywista treść zależy od analizy Twojego projektu.
Sprawdź dowody
Odwołania do kodu otwierają pliki w domyślnej aplikacji systemu. Obrazy można oglądać i powiększać w notatce na marginesie. Etykiety materiałów, takich jak wyniki poleceń i różnice w kodzie, otwierają nową kartę. Noea informuje, gdy materiał nie jest już dostępny.
Zastanów się, czy każde odwołanie odpowiada na Twoje pytanie, jakie warunki obejmuje test i czy wyniki potwierdzają wniosek. Jeśli brakuje ważnego scenariusza, zapytaj o akapit i poproś o dalszą analizę lub weryfikację.
Rozróżniaj zwłaszcza trzy rodzaje dowodów:
| Materiał | Co pomaga ustalić | Czego nie dowodzi |
|---|---|---|
| Kod implementacji lub testów | Zastosowaną logikę i scenariusze określone w testach. | Samo istnienie testów nie oznacza, że zostały uruchomione ani że przeszły. |
| Wcześniejsze wyniki wykonania | Co uruchomiono wtedy i jaki był wynik w tamtym momencie. | Późniejsze zmiany kodu mogą sprawić, że wyniki przestaną być miarodajne. |
| Weryfikacja wykonana teraz | Wynik dla środowiska i zakresu tego uruchomienia. | Pomyślny wynik objętych nią scenariuszy nie dowodzi poprawności nieprzetestowanych przypadków. |
Explain i Investigation zwykle czytają kod oraz istniejące dowody zamiast za każdym razem ponownie uruchamiać testy, kompilacje czy aplikację. Weryfikują fakt w razie potrzeby, gdy sama lektura nie wystarcza do ustalenia czegoś istotnego dla oceny. Oceniaj zakres weryfikacji według tego, co rzeczywiście uruchomiono.
Aby ponownie uruchomić konkretny test, poproś agenta w rozmowie o jego wykonanie i podanie zakresu oraz wyniku, a potem ponownie przeanalizuj odpowiedni akapit.
Zdecyduj, które wybory należą do założeń
Wyjaśnienie „Implementacja obecnie używa pamięci lokalnej” opisuje dzisiejszy sposób działania; nie nakazuje przyszłym wersjom korzystać z niego. Wymagania, które chcesz zachować, zapisz w dokumencie z założeniami.
Rozważ, czy dana decyzja wpływa na doświadczenie użytkowników, koszty, prywatność, ryzyko lub przyszłe wybory. Gdy ją zrozumiesz, możliwe są dwa częste rozstrzygnięcia:
- Obecne rozwiązanie jest do przyjęcia, ale chcesz zachować możliwość jego późniejszej zmiany: korzystaj z niego bez zamieniania go w ograniczenie.
- Rozwiązanie musi pozostać prawdziwe w przyszłych wersjach: zapisz wymaganie wprost i przejrzyj ograniczenia, które wprowadza.
Możesz na przykład dziś zaakceptować pamięć lokalną dla zapisów meldowania się. Jeśli praca bez sieci stanie się niezbędna, zapisz „Użytkownicy nadal mogą meldować się bez połączenia z siecią”, a potem sprawdź, jak implementacja zapewnia to zachowanie. Wymagane zachowanie jest zwykle łatwiejsze do utrzymania niż szczegółowy opis implementacji.
Zrozum sekcję Wymaga uwagi
Pozycje wymagające uwagi są klasyfikowane jako braki, decyzje implementacyjne, ryzyka lub sugestie. Pozwala to odróżnić brakujące zachowanie od obecnych decyzji projektowych i tematów do dalszej rozmowy.
Znacznik po prawej stronie akapitu otwiera odpowiednie wyjaśnienie. Pokazana liczba oznacza panele wyjaśnień zawierające wątpliwości, a nie pojedyncze problemy. Brak nadaje znacznikowi wyraźniejszy kolor.
Zanim zdecydujesz o poprawieniu kodu, dodaniu weryfikacji, zmianie założeń lub zachowaniu obecnego działania, zrozum wpływ danej kwestii. Nie każda wątpliwość musi stać się wymaganiem. Brak znacznika oznacza tylko, że bieżące wyjaśnienie nie wymienia żadnych wątpliwości.
Wypróbuj ilustracje działania
Niektóre wyjaśnienia zawierają małą interaktywną ilustrację zachowania. Możesz ją wypróbować, zresetować albo obejrzeć jej kod źródłowy.
Ilustracje działają w odizolowanym środowisku bez dostępu do aplikacji i sieci oraz nie zapisują stanu interakcji. Objaśniają regułę; sprawdzenie, czy rzeczywiste oprogramowanie jej przestrzega, nadal wymaga dowodów z kodu i weryfikacji.
Sprawdź, czy wyjaśnienie nadal obowiązuje
Previous text oznacza, że wyjaśnienie dotyczy założeń sprzed Twojej edycji. May be outdated oznacza, że pliki przeczytane lub przywołane w wyjaśnieniu zmieniły się po analizie. W obu przypadkach warto ponownie przeprowadzić analizę.
Notatki na marginesie są tylko do odczytu. Aby zmienić wymaganie, edytuj założenia; aby sprawdzić wyjaśnienie, użyj Investigation lub Investigate Again. Zobacz Dbaj o aktualność wyjaśnień.