Inhalt der Dokumentation04 / 16

Der zentrale Arbeitsablauf04 / 16

Wichtige Absichten formulieren

Auf dieser Seite

Absichtsdokumente halten das Verhalten und die Bedingungen fest, die Ihre Software erfüllen soll. Schreiben Sie auf, was Sie entschieden haben, und verfeinern Sie es anhand neuer Erkenntnisse aus Implementierung und Nachweisen. So bleibt das Dokument lesbar und lässt dem Agenten Spielraum bei der Umsetzung.

Dauerhaft wichtige Anforderungen wählen

Absichten können verschiedene Arten von Anforderungen beschreiben:

ArtBeispiel
ProduktregelNach 7 aufeinanderfolgenden Tagen mit Check-in erhält der Nutzer eine Belohnung.
ArchitekturbedingungJede Zahlungsanfrage muss serverseitig validiert werden.
AlgorithmusanforderungDieselbe Eingabe und derselbe Startwert müssen dieselbe Reihenfolge erzeugen.
InteraktionsanforderungWenn das Sichern fehlschlägt, bleiben Nutzereingaben erhalten und ein erneuter Versuch ist möglich.

Beschreiben Sie Auslöser und beobachtbares Ergebnis. „Der Export muss zuverlässig sein“ ist schwer zu prüfen. „Wenn der Export fehlschlägt, bleiben die aktuellen Filter erhalten und ein erneuter Versuch ist möglich“ bietet eine klarere Bewertungsgrundlage.

Ist eine Implementierungsentscheidung so wichtig, dass spätere Änderungen sie respektieren müssen, nehmen Sie sie in die Absicht auf. Noch nicht entschiedene Details können Implementierungsentscheidungen bleiben.

Dauerhafte Anforderungen von der heutigen Aufgabe trennen

Absichten beschreiben, was die Software weiterhin tun muss. Sie sind keine nach Abschluss zu löschende Aufgabenliste. Behalten Sie die Anforderungen nach Fertigstellung einer Funktion bei und ändern Sie die jeweiligen Formulierungen, wenn Sie ihr Verhalten ändern möchten.

Chats enthalten auch Anweisungen für die aktuelle Arbeitsrunde. Unterscheiden Sie:

InhaltGehört wohin?
Nach 7 aufeinanderfolgenden Tagen mit Check-in eine Belohnung vergeben.Absicht: dauerhafte Belohnungsbedingung.
Bei fehlgeschlagener Belohnungsvergabe Wiederholungen ohne doppelte Vergabe ermöglichen.Absicht: dauerhaftes Verhalten bei Fehlern.
Diesmal den bestehenden Code vor Änderung der Belohnungslogik untersuchen.Aktueller Chat: Anweisung für diese Aufgabe.
Zuerst den Prototyp fertigstellen; das visuelle Design beim nächsten Mal besprechen.Aktueller Chat: Plan für diese Arbeitsphase.

Fragen Sie, was der Satz tatsächlich festlegt. „Daten vor jedem Export validieren“ definiert die Ausführungsreihenfolge der Software und gehört zur Absicht. „Diesmal zuerst das Exportmodul untersuchen“ organisiert die aktuelle Aufgabe.

Teilen Sie dem Agenten mit, welche Anweisungen dauerhaft und welche nur für diese Aufgabe gelten. Wiederholen Sie wichtige aufgabenspezifische Anweisungen bei Bedarf; gehen Sie nicht davon aus, dass ein neuer Chat sie übernimmt.

Ein Dokument erstellen und bearbeiten

Klicken Sie in der Seitenleiste auf Neue Absicht und geben Sie einen Namen ein. Noea erstellt im Stammverzeichnis des Absichtsordners eine .noea.md-Datei mit einer Überschrift erster Ebene.

Dokumente verwenden Markdown; Lesen und Bearbeiten erfolgen in derselben Ansicht. Klicken Sie auf Text, um ihn zu bearbeiten, und strukturieren Sie ihn mit Überschriften, Listen, Tabellen und Codeblöcken.

Zum Beispiel:

# Tägliche Check-ins

Nutzer können einmal pro Tag einchecken.

## Belohnungen

Nach 7 aufeinanderfolgenden Tagen mit Check-in erhält der Nutzer eine Belohnung. Innerhalb derselben Serie wird die Belohnung nur einmal vergeben.

Verwenden Sie Überschriften für Bereiche und Absätze für einzelne Anforderungen. Eine Untersuchung behandelt eine ganze Liste als einen Inhalt. Teilen Sie Themen in separate Absätze oder Bereiche auf, wenn Sie sie unabhängig untersuchen und besprechen möchten.

Absichten im Gespräch entwickeln

Ist eine Regel noch unklar, besprechen Sie sie, bevor Sie den Agenten um einen Änderungsvorschlag bitten:

Ich möchte doppelte Check-in-Belohnungen verhindern. Hilf mir zu definieren, was hier „doppelt“ bedeutet, und warte auf meine Bestätigung, bevor du eine Absichtsänderung vorschlägst.

Sobald Sie sich entschieden haben, bitten Sie den Agenten um einen Vorschlag. Prüfen Sie die Formulierung, bearbeiten Sie bei Bedarf den neuen Text und nehmen Sie ihn an. Eine Aussage im Chat wird erst Teil des Absichtsdokuments, wenn sie dort niedergeschrieben wird.

Der Text sollte Begriffe und Sprache verwenden, die Sie verstehen. Fragen Sie nach unbekannten Begriffen oder ergänzten Anforderungen, bevor Sie sie übernehmen. Gute Formulierungen ermöglichen Ihnen, die Anforderung selbst zu erklären und bei gewünschtem anderem Verhalten den zu ändernden Satz zu finden.

Informationen zu Vorschlägen und Anmerkungskarten finden Sie unter Absichtsänderungen besprechen und prüfen.

Beziehungen mit Diagrammen darstellen

Ein Codeblock mit der Sprache mermaid kann als Diagramm dargestellt werden. Veranschaulichen Sie damit Zustandsübergänge, Abläufe oder Beziehungen zwischen Modulen.

Mit dem Bedienelement oben rechts wechseln Sie zwischen Diagramm und Quelltext. Zum Bearbeiten wechseln Sie zum Quelltext. Bei ungültiger Syntax oder nicht unterstütztem Diagrammtyp zeigt Noea den Quelltext und den Grund; das restliche Dokument bleibt lesbar.

Sichern und mit externen Editoren arbeiten

Sichern Sie manuell mit ⌘S unter macOS, Ctrl+S unter Windows / Linux oder Ablage → Sichern. Ein Punkt neben dem Titel kennzeichnet ungesicherte Änderungen. Beim Tabwechsel bleiben sie erhalten; beim Schließen von Dokument oder Projekt und beim Beenden der App werden Sie zum Sichern aufgefordert.

Beim Sichern wird die Markdown-Formatierung vereinheitlicht. Sie können Dateien auch extern bearbeiten. Ändert sich eine Datei auf dem Datenträger während der Bearbeitung in Noea, bietet die App erneutes Laden oder Sichern unter anderem Namen an, statt sie direkt zu überschreiben.

Die Bedeutung einer Textänderung verstehen

Ergänzungen, Ersetzungen und Löschungen wirken sich unterschiedlich auf Anforderungen aus:

ÄnderungBedeutung
„7 Tage“ durch „14 Tage“ ersetzen.Auslösebedingung der Belohnung ändern.
„Nur einmal innerhalb derselben Serie“ ergänzen.Eine Bedingung gegen doppelte Belohnungen hinzufügen.
„Die Belohnung muss ein Abzeichen sein“ entfernen.Die Vorgabe zur Form der Belohnung aufheben.

Das Entfernen von „Die Belohnung muss ein Abzeichen sein“ macht eine bestehende Abzeichenimplementierung nicht zwangsläufig ungültig. Sie kann die übrige Absicht weiterhin erfüllen. Wenn Sie Belohnungen vollständig entfernen möchten, schreiben Sie, dass keine mehr vergeben werden dürfen, statt nur die Anforderung an ihre Form zu löschen.

Fragen Sie vor der Bearbeitung, welches Verhalten sich ändern würde und welche Anforderungen bestehen bleiben sollen. Nutzen Sie die Antwort als Gesprächsgrundlage und prüfen Sie dann tatsächliche Implementierung und Nachweise.

Nach dem Sichern zeigen ältere Erläuterungen Vorheriger Text. Erfordert die neue Anforderung Codeänderungen, implementieren Sie sie vor der Untersuchung. Möchten Sie nur vorhandenes Verhalten prüfen, untersuchen Sie es direkt.

Weiter mit Mit einem Agenten implementieren oder Erläuterungen aktuell halten.