Zapisz ważne założenia

Dokumenty z założeniami opisują zachowanie i ograniczenia, które oprogramowanie ma spełniać. Zapisz swoje decyzje, a potem doprecyzowuj je na podstawie tego, czego dowiadujesz się z implementacji i dowodów. Dzięki temu dokument pozostaje czytelny, a agent ma przestrzeń na wybór sposobu implementacji.

Wybierz wymagania warte zachowania

Założenia mogą opisywać różne rodzaje wymagań:

Opisz warunek wyzwalający i obserwowalny wynik. „Eksport musi być niezawodny” trudno sprawdzić. „Jeśli eksport się nie powiedzie, zachowaj obecne filtry i pozwól ponowić próbę” daje jaśniejszą podstawę oceny.

Gdy decyzja implementacyjna jest na tyle ważna, że przyszłe zmiany muszą ją respektować, zapisz ją w założeniach. Szczegóły, których jeszcze nie ustaliłeś, mogą pozostać do decyzji podczas implementacji.

Oddziel trwałe wymagania od dzisiejszego zadania

Założenia opisują to, co oprogramowanie musi robić także w przyszłości. Nie są listą rzeczy do usunięcia po zakończeniu pracy. Zachowaj wymagania po ukończeniu funkcji, a gdy postanowisz zmienić jej działanie, zmień odpowiedni zapis.

Rozmowy zawierają też instrukcje dotyczące bieżącego etapu pracy. Rozróżniaj je w ten sposób:

Zastanów się, co naprawdę ogranicza dane zdanie. „Sprawdzaj dane przed każdym eksportem” określa kolejność działania oprogramowania i należy do założeń. „Tym razem najpierw przeanalizuj moduł eksportu” organizuje bieżące zadanie.

Powiedz agentowi, które instrukcje są trwałymi wymaganiami, a które dotyczą tylko tego zadania. W razie potrzeby powtarzaj ważne instrukcje dotyczące konkretnego zadania; nie zakładaj, że nowa rozmowa je dziedziczy.

Utwórz i edytuj dokument

Kliknij New Intent na pasku bocznym i wpisz nazwę. Noea utworzy plik .noea.md w głównym katalogu folderu założeń, z nagłówkiem pierwszego poziomu.

Dokumenty używają Markdowna, a czytanie i edycja odbywają się w tym samym widoku. Kliknij tekst, aby go zmienić, i porządkuj treść za pomocą nagłówków, list, tabel oraz bloków kodu.

Na przykład:

# Codzienne meldunki

Użytkownicy mogą meldować się raz dziennie.

## Nagrody

Przyznaj użytkownikowi nagrodę po 7 kolejnych dniach meldowania się. W ramach tej samej serii przyznaj nagrodę tylko raz.

Używaj nagłówków do wydzielania sekcji, a akapitów do odrębnych wymagań. Funkcja Investigation traktuje całą listę jako jeden fragment treści. Rozdzielaj tematy na osobne akapity lub sekcje, jeśli chcesz je analizować i omawiać niezależnie.

Dopracuj założenia w rozmowie

Jeśli reguła nie jest jeszcze jasna, omów ją przed poproszeniem agenta o propozycję zmiany:

Chcę zapobiec wielokrotnemu przyznawaniu nagród za meldunki. Pomóż mi określić, co w tym przypadku oznacza „duplikat”, i poczekaj na moje potwierdzenie przed zaproponowaniem zmiany założeń.

Gdy podejmiesz decyzję, poproś agenta, aby przygotował na jej podstawie propozycję. Przejrzyj sformułowanie, w razie potrzeby popraw nowy tekst i zaakceptuj go. Wypowiedź w rozmowie staje się częścią dokumentu z założeniami dopiero po zapisaniu jej w tym dokumencie.

Powstały tekst powinien używać zrozumiałych dla Ciebie pojęć i sformułowań. Zapytaj o nieznane terminy lub dodane wymagania, zanim zdecydujesz się je zachować. Dobrze zapisane wymaganie potrafisz sam wyjaśnić i łatwo odnajdziesz zdanie do zmiany, gdy zechcesz uzyskać inne działanie.

Propozycje i karty sugestii opisuje artykuł Omawiaj i przeglądaj zmiany założeń.

Używaj diagramów do przedstawiania zależności

Blok kodu z oznaczeniem języka mermaid może zostać wyświetlony jako diagram. Użyj go do zilustrowania przejść stanów, procesów lub zależności między modułami.

Kontrolka w prawym górnym rogu przełącza między diagramem a jego źródłem. Aby edytować diagram, przejdź do źródła. Jeśli składnia jest błędna albo typ diagramu nie jest obsługiwany, Noea pokazuje źródło i przyczynę; reszta dokumentu pozostaje czytelna.

Zapisuj i korzystaj z zewnętrznych edytorów

Zapisz ręcznie za pomocą ⌘S na macOS, Ctrl+S w Windows / Linuxie albo File → Save. Kropka obok tytułu oznacza niezapisane zmiany. Przełączenie kart je zachowuje; przy zamknięciu dokumentu lub projektu albo wyjściu z aplikacji pojawi się prośba o zapis.

Zapis normalizuje formatowanie Markdowna. Pliki możesz też utrzymywać w zewnętrznym edytorze. Jeśli plik zmieni się na dysku podczas edycji w Noea, aplikacja zaproponuje ponowne wczytanie lub zapisanie pod inną nazwą zamiast bezpośredniego nadpisania.

Zrozum znaczenie zmiany sformułowania

Dodawanie, zastępowanie i usuwanie tekstu wpływa na wymagania w różny sposób:

Usunięcie zdania „Nagroda musi być odznaką” nie musi oznaczać, że istniejąca implementacja przyznająca odznakę jest nieprawidłowa. Nadal może spełniać pozostałe założenia. Aby całkowicie wyłączyć nagrody, zapisz, że nie wolno ich już przyznawać, zamiast usuwać wyłącznie wymaganie dotyczące ich formy.

Przed edycją zapytaj agenta, jakie zachowania się zmienią i które wymagania powinny pozostać. Potraktuj odpowiedź jako podstawę rozmowy, a potem sprawdź rzeczywistą implementację i dowody.

Po zapisaniu starsze wyjaśnienia pokazują Previous text. Jeśli nowe wymaganie wymaga zmian kodu, zaimplementuj je przed analizą. Jeśli chcesz tylko sprawdzić istniejące działanie, przeprowadź analizę od razu.

Przejdź do artykułu Pracuj z agentem nad implementacją albo Dbaj o aktualność wyjaśnień.