Pierwsze kroki01 / 16
Poznaj Noea Code
Na tej stronie
Noea Code (w skrócie Noea) pomaga sprawdzać, jak oprogramowanie napisane przez AI realizuje Twoje wymagania. Zacznij od istniejącej implementacji: wykorzystaj założenia jako podstawę oceny działania i dowodów, zrozum ważne decyzje i zapisz własne ustalenia na przyszłość.
Zacznij od jednej reguły w istniejącym projekcie. Może to być zachowanie produktu, ograniczenie architektoniczne albo wymaganie dotyczące algorytmu.
Założenia to wymagania, które oprogramowanie ma nadal spełniać. Pozostają ważne także po ukończeniu funkcji. Gdy zdecydujesz się zmienić jej działanie, zmieniasz odpowiedni zapis. Nie musisz opisywać całej aplikacji: zacznij od tego, co jest dla Ciebie ważne.
Połącz założenia z implementacją
Załóżmy, że tworzysz aplikację do codziennego meldowania się i zapisujesz:
Przyznaj użytkownikowi nagrodę po 7 kolejnych dniach meldowania się.
Określasz w ten sposób warunek otrzymania nagrody, ale pozostawiasz kilka kwestii otwartych: co liczy się jako dzień, co się dzieje po pominięciu meldunku i jaką nagrodę przyznać. Agent musi podjąć te decyzje podczas implementacji reguły.
Noea łączy to zdanie z wyjaśnieniem implementacji. Możesz przeczytać, jak kod liczy dni, otworzyć odwołania do kodu lub testów stojących za wyjaśnieniem oraz znaleźć niespełnione wymagania i decyzje warte omówienia. Jeśli uznasz, że dzień ma odpowiadać lokalnej dacie kalendarzowej użytkownika, dodaj tę decyzję do założeń, aby przyszłe prace ją uwzględniały.
Poznaj trzy rodzaje treści
| Treść | Cel | Gdzie ją znaleźć |
|---|---|---|
| Dokumenty z założeniami | Zapisują wymagane zachowanie i ograniczenia | Sekcja założeń na pasku bocznym; pliki mają rozszerzenie .noea.md |
| Implementacja | Kod, konfiguracja i powiązane pliki oprogramowania | Połączony folder implementacji projektu |
| Wyjaśnienia implementacji | Opisują, jak implementacja realizuje fragment założeń, wraz z dowodami i wątpliwościami | Notatki na marginesie dokumentu z założeniami |
Dokumenty z założeniami są plikami Markdown. Możesz śledzić je w Gicie lub edytować w innym edytorze. Noea przechowuje wyjaśnienia implementacji osobno i pokazuje je w notatkach na marginesie. Niektóre angielskie etykiety interfejsu nazywają dokumenty z założeniami Source; nie chodzi o kod w folderze implementacji.
Pracuj na co dzień w trzech krokach
- Potwierdź podstawę przeglądu. Zapisz wymaganie, które chcesz sprawdzić, albo omów je z agentem i potwierdź proponowane sformułowanie.
- Przejrzyj implementację. Sprawdź, jak istniejący kod realizuje wymaganie, oceń dowody i znajdź decyzje wymagające Twojego osądu.
- Zapisz swoje decyzje. Zapytaj o konkretny akapit, dodaj wymagania, które chcesz zachować, i kontynuuj implementację oraz sprawdzanie.
Jeśli kod już istnieje, zapisz wymaganie, które chcesz sprawdzić, i uruchom Explain. Jeśli trzeba je dopiero zaimplementować, użyj rozmowy lub akcji Realize.
Możesz zaakceptować zrozumiałą dla siebie decyzję bez zamieniania każdego szczegółu implementacji w trwałe wymaganie. Wskazówki dotyczące wyboru treści założeń znajdziesz w artykule Czytaj wyjaśnienia i dowody.
Przegląd implementacji oznacza porównanie działania, dowodów i decyzji z Twoimi założeniami. Przegląd zmiany założeń polega na sprawdzeniu proponowanego sformułowania przed przyjęciem go do dokumentów. Pierwszy pomaga zdecydować, co należy zmienić; drugi zapisuje wymagania, które postanowisz zachować.
Zrozum role Noea i agenta
Noea udostępnia przestrzeń roboczą do pisania dokumentów, omawiania decyzji, przeglądania zmian i czytania wyjaśnień. Agent czyta projekt, wywołuje narzędzia i zmienia kod. Wybierz obsługiwanego agenta oraz dostępne dla niego modele i metody logowania.
W procesie propozycji Noea zmiany dokumentów z założeniami wymagają Twojej decyzji. Możesz poprawić i zaakceptować propozycję albo ją odrzucić. Zmiany w kodzie i polecenia zależą od możliwości agenta oraz ustawień uprawnień.
Wyjaśnienia implementacji nie zastępują testów ani samodzielnego używania produktu. Sprawdź dowody dotyczące ważnych zachowań i zweryfikuj je stosownie do potrzeb.
Zacznij od małego, ważnego pytania
Wybierz wąski temat z obserwowalnym wynikiem: kiedy przyznawana jest nagroda, jak obsługiwany jest niewystarczający stan magazynowy albo jakiego ograniczenia musi przestrzegać API. W pozostałej części projektu możesz nadal korzystać ze swojego dotychczasowego procesu tworzenia oprogramowania.
Następnie zainstaluj aplikację i przygotuj środowisko, po czym wykonaj swój pierwszy przegląd.