Twój pierwszy przegląd

Ten samouczek zaczyna się od istniejącej funkcji meldowania się. Zapiszesz wymaganie do sprawdzenia, przejrzysz implementację i dowody oraz zapiszesz nową decyzję. Jeśli funkcja wymaga dopiero implementacji, wykonaj opisany niżej wariant, a potem wróć do przeglądu.

Potrzebujesz Noea z agentem o statusie Ready oraz projektu lokalnego, nad którym chcesz pracować. Jeśli Twój projekt nie ma funkcji meldowania się, wybierz inną, równie konkretną regułę.

Otwórz projekt z kodem

Wybierz Open Folder… w przestrzeni roboczej albo File → Open Implementation Folder… i wskaż folder zawierający kod.

Gdy otwierasz ten folder po raz pierwszy, Noea tworzy powiązany projekt. Jeśli projekt już istnieje, otwiera go bezpośrednio albo prosi o wybór spośród kilku powiązanych projektów. Inne metody opisuje artykuł Otwieraj projekty i zarządzaj nimi.

Potwierdź podstawę przeglądu

Kliknij New Intent na pasku bocznym i nadaj dokumentowi nazwę „Codzienne meldunki”. Noea doda rozszerzenie .noea.md i otworzy dokument. Wpisz:

# Codzienne meldunki

Użytkownicy mogą meldować się raz dziennie. Przyznaj użytkownikowi nagrodę po 7 kolejnych dniach meldowania się.

Zapisz za pomocą ⌘S na macOS lub Ctrl+S w Windows / Linuxie. Zacznij od ustalonych kwestii; nie musisz jeszcze wymieniać wszystkich przypadków brzegowych.

Przeanalizuj istniejącą implementację

Explain sprawdza w całym projekcie treści, których wyjaśnienia wymagają uwagi. Akcja Investigation przy akapicie sprawdza tylko ten fragment. Obie analizują implementację oraz tworzą lub aktualizują wyjaśnienia; nie zmieniają kodu.

Jeśli funkcja meldowania się już istnieje, kliknij Explain na pasku bocznym. Aby sprawdzić tylko ten akapit, najedź na niego kursorem i wybierz Investigation po lewej stronie.

Jeśli reguła wymaga dopiero implementacji, rozpocznij nową rozmowę, wpisz @ w polu wiadomości, aby wybrać dokument z założeniami, i wyślij:

Zaimplementuj w tym projekcie nagrodę za meldunki zgodnie ze wskazanymi założeniami. Najpierw sprawdź istniejący kod, zachowaj strukturę projektu i zweryfikuj zarówno serię 7 dni, jak i pominięty meldunek.

Możesz też użyć przycisku Realize na pasku bocznym, jeśli jest dostępny; zobacz Pracuj z agentem nad implementacją. Podczas pracy agenta rozmowa pokazuje odpowiedzi, wywołania narzędzi i zmiany plików.

Po implementacji kliknij Explain, jeśli nie uruchomiło się automatycznie. Nie każda zmiana kodu w zwykłej rozmowie wyzwala aktualizację wyjaśnienia.

Przejrzyj implementację i dowody

Wróć do dokumentu z założeniami i kliknij puste miejsce wewnątrz akapitu, poza jego tekstem, aby otworzyć notatkę na marginesie. Przeczytaj następujące sekcje:

• Realization: jak kod liczy kolejne dni i przyznaje nagrody.
• Evidence: kod, wyniki poleceń lub materiały testowe przywołane w wyjaśnieniu.
• Attention: braki, decyzje implementacyjne, ryzyka lub sugestie wymagające Twojego osądu.

Możesz na przykład odkryć, że implementacja wyznacza dni kalendarzowe na podstawie strefy czasowej urządzenia. Sprawdź, jak projekt rzeczywiście działa i czy odpowiada to Twoim wymaganiom. Otwórz odwołania, aby ocenić, na ile dowody potwierdzają wyjaśnienie.

Ukończone wyjaśnienie nie oznacza, że testy uruchomiono ponownie. Odróżnij kod testów, wcześniejsze wyniki i weryfikację wykonaną podczas tego uruchomienia; zobacz Czytaj wyjaśnienia i dowody. Jeśli implementacja nie spełnia pierwotnego wymagania, popraw ją zamiast przepisywać regułę pod istniejący kod.

Zadaj pytanie i zapisz decyzję

Najedź na akapit i wybierz Ask about this po lewej stronie. Noea wstawi odwołanie do pola wiadomości. Dodaj pytanie i wyślij:

Jak obecna implementacja obsługuje podróże między strefami czasowymi? Czy meldowanie się w dwóch miejscach może wpłynąć na serię? Wyjaśnij na podstawie kodu.

Gdy zrozumiesz działanie, zdecyduj, czy chcesz ograniczyć sposób obliczeń. Jeśli tak, wyślij:

Dodaj do tych założeń zdanie „Dzień odpowiada dacie kalendarzowej w aktualnym miejscu pobytu użytkownika”. Najpierw zaproponuj zmianę założeń do mojego przeglądu.

Gdy agent przedstawi propozycję, kliknij View Changes i przeczytaj dodany oraz zastąpiony tekst. W razie potrzeby popraw nowe sformułowanie, a potem wybierz Accept My Edits albo Accept, jeśli nie trzeba nic zmieniać.

Jeśli propozycja wymaga prac implementacyjnych, jej zaakceptowanie kontynuuje je w tej samej rozmowie. Jeśli istniejąca implementacja już ją spełnia, nowe uruchomienie nie jest potrzebne. Następnie sprawdź wyniki zadania z wyjaśnieniem albo w razie potrzeby przeprowadź analizę ręcznie.

Sprawdź, czego się dowiedziałeś

Przed zakończeniem zapisz dokument i upewnij się, że wyjaśnienie obejmuje jego bieżącą treść. Spróbuj odpowiedzieć własnymi słowami na cztery pytania:

1. Jak zaimplementowano to wymaganie i jakie dowody potwierdzają ten wniosek?
2. Jaką ważną decyzję podjął agent, choć nie określono jej w założeniach?
3. Czy rozumiem i akceptuję tę decyzję? Czy powinna stać się trwałym ograniczeniem?
4. Które zdanie zmienię następnym razem, gdy zechcę zmienić to zachowanie?

Powinieneś na przykład umieć wyjaśnić, jak definiowany jest dzień, znaleźć potwierdzające to dowody i wskazać „7 kolejnych dni” jako warunek nagrody. Jeśli odpowiedź jest niejasna, zapytaj o odpowiedni akapit.

Nie musisz zapisywać każdej reguły podczas pierwszej wizyty. Dodaj następną decyzję wartą zachowania, gdy na nią natrafisz.

Następnie przeczytaj Zapisz ważne założenia oraz Czytaj wyjaśnienia i dowody.