Erläuterungen und Nachweise lesen — Noea Code Dokumentation

Implementierungserläuterungen helfen Ihnen, von einer Absicht ausgehend den Code zu verstehen und Nachweise dafür zu finden. Achten Sie auf Verhalten, Belege und Fragen, die weiterhin Ihre Beurteilung erfordern.

Absatzbezogene und lokale Erläuterungen öffnen

Klicken Sie auf Dokumenttext, um ihn zu bearbeiten. Klicken Sie innerhalb eines Absatzes auf eine freie Fläche außerhalb des Texts, um seine absatzbezogene Erläuterung mit der Kennzeichnung L1 zu öffnen.

Manche Erläuterungen beziehen sich auf ein Wort oder eine Wendung. Bewegen Sie den Zeiger über den Absatz, um kurze Unterstreichungen einzublenden, und klicken Sie darauf, um die lokale Erläuterung mit der Kennzeichnung L2 zu lesen.

Auch Listen, Tabellen und Codeblöcke können Erläuterungen besitzen. Eine ganze Liste wird gemeinsam untersucht; Überschriften werden nicht eigenständig untersucht.

Sie können Randnotizen mehrerer Absätze geöffnet halten. Pro Absatz wird jeweils eine absatzbezogene oder lokale Erläuterung angezeigt. In einem schmalen Fenster kann die Notiz unter dem Absatz erscheinen.

Die drei Bereiche lesen

Bereich	Beantwortete Frage	Worauf Sie achten sollten
Umsetzung	Wie erfüllt die Implementierung diese Absicht?	Verhalten, Schritte, Sonderfälle und Implementierungsentscheidungen.
Nachweis	Was stützt die Erläuterung?	Codeverweise, Tests, Befehlsausgaben und andere prüfbare Unterlagen.
Hinweise	Was erfordert weitere Beurteilung?	Lücken, Implementierungsentscheidungen, Risiken und Vorschläge.

„Umsetzung“ ist standardmäßig aufgeklappt. Öffnen Sie „Nachweis“ bei Bedarf. „Hinweise“ wird ausgeblendet, wenn keine Hinweise vorliegen.

Bei einer Belohnung nach 7 aufeinanderfolgenden Check-ins könnte die Erläuterung beschreiben, wie Tage gezählt werden, auf die zuständige Funktion und Tests verweisen und auf den Umgang mit Zeitzonenreisen hinweisen. Der tatsächliche Inhalt hängt von der Untersuchung Ihres Projekts ab.

Nachweise prüfen

Codeverweise öffnen Dateien in der Standardanwendung des Systems. Bilder können in der Randnotiz angezeigt und vergrößert werden. Beschriftungen von Materialien wie Befehlsausgaben oder Code-Diffs öffnen einen neuen Tab. Noea meldet, wenn das Material nicht mehr verfügbar ist.

Fragen Sie bei jedem Verweis, ob er Ihre Frage beantwortet, welche Bedingungen ein Test abdeckt und ob seine Ergebnisse die Schlussfolgerung stützen. Fehlt ein wichtiger Fall, fragen Sie zum Absatz nach und verlangen Sie weitere Untersuchung oder Prüfung.

Unterscheiden Sie insbesondere drei Arten von Nachweisen:

Material	Was es belegt	Was es nicht belegt
Implementierungs- oder Testcode	Verwendete Logik und in Tests definierte Szenarien.	Vorhandene Tests bedeuten nicht, dass sie ausgeführt wurden oder bestanden haben.
Frühere Ausführungsergebnisse	Was damals ausgeführt wurde und wie es damals ausging.	Spätere Codeänderungen können diese Ergebnisse unzutreffend machen.
Tatsächlich jetzt ausgeführte Prüfung	Ergebnis für Umgebung und Umfang dieser Ausführung.	Erfolgreiche abgedeckte Szenarien beweisen nicht die Korrektheit ungeprüfter Fälle.

„Erläutern“ und „Untersuchung“ lesen normalerweise Code und bestehende Nachweise, statt jedes Mal Tests, Builds oder die App neu auszuführen. Sie prüfen Fakten bei Bedarf, wenn Lesen allein einen wesentlichen Beurteilungspunkt nicht klärt. Bewerten Sie den Prüfumfang anhand dessen, was tatsächlich ausgeführt wurde.

Um einen bestimmten Test erneut auszuführen, bitten Sie den Agenten im Chat darum und um einen Bericht zu Umfang und Ergebnis. Untersuchen Sie anschließend den betreffenden Absatz erneut.

Entscheiden, welche Entscheidungen zur Absicht gehören

„Die Implementierung verwendet derzeit lokalen Speicher“ beschreibt den heutigen Ansatz; es verpflichtet künftige Versionen nicht dazu. Dauerhafte Anforderungen gehören ins Absichtsdokument.

Überlegen Sie, ob eine Entscheidung Nutzererlebnis, Kosten, Datenschutz, Risiken oder künftige Entscheidungen beeinflusst. Sobald Sie sie verstanden haben, gibt es häufig zwei Möglichkeiten:

Der aktuelle Ansatz ist akzeptabel, und spätere Änderungen sollen möglich bleiben: Nutzen Sie ihn weiter, ohne ihn als Bedingung festzuschreiben.
Der Ansatz muss auch künftig gelten: Formulieren Sie die Anforderung ausdrücklich und prüfen Sie die daraus entstehenden Einschränkungen.

Vielleicht akzeptieren Sie heute lokalen Speicher für Check-in-Einträge. Wird Offline-Nutzung unverzichtbar, schreiben Sie „Nutzer können auch ohne Netzwerkverbindung einchecken“ und untersuchen Sie die Umsetzung dieses Verhaltens. Das gewünschte Verhalten zu formulieren ist meist leichter zu pflegen als eine detaillierte Implementierungsbeschreibung zu übernehmen.

Hinweise verstehen

Hinweise werden als Lücken, Implementierungsentscheidungen, Risiken oder Vorschläge eingeordnet. Sie unterscheiden fehlendes Verhalten von aktuellen Designentscheidungen und weiterführenden Gesprächsthemen.

Die Hinweismarkierung rechts am Absatz öffnet die entsprechende Erläuterung. Ihre Zahl zählt Erläuterungsbereiche mit Hinweisen, nicht einzelne Probleme. Bei einer Lücke erhält die Markierung eine auffälligere Farbe.

Verstehen Sie zunächst die Auswirkungen, bevor Sie Code korrigieren, Prüfungen ergänzen, Absichten ändern oder das aktuelle Verhalten beibehalten. Nicht jeder Hinweis muss zur Anforderung werden. Eine fehlende Markierung bedeutet lediglich, dass die aktuelle Erläuterung keine Hinweise aufführt.

Verhaltensdarstellungen ausprobieren

Manche Erläuterungen enthalten eine kleine interaktive Verhaltensdarstellung. Sie können sie ausprobieren, zurücksetzen oder ihren Quelltext ansehen.

Diese Darstellungen laufen in einer isolierten Sandbox ohne Zugriff auf App oder Netzwerk und speichern keinen Interaktionszustand. Sie erläutern eine Regel; ob die tatsächliche Software ihr folgt, muss weiterhin anhand von Code und Prüfnachweisen beurteilt werden.

Prüfen, ob eine Erläuterung noch gilt

Vorheriger Text bedeutet, dass die Erläuterung die Absicht vor Ihrer Bearbeitung behandelt. Möglicherweise veraltet bedeutet, dass von der Erläuterung gelesene oder zitierte Dateien seit der Untersuchung geändert wurden. Beides ist ein Anlass zur erneuten Untersuchung.

Randnotizen sind schreibgeschützt. Bearbeiten Sie die Absicht, um eine Anforderung zu ändern; nutzen Sie „Untersuchung“ oder Erneut untersuchen, um eine Erläuterung zu prüfen. Siehe Erläuterungen aktuell halten.