Lernpfad 02Lektion 1 / 6

Einen klaren Auftrag für einen Agenten schreiben

Beschreiben Sie das erforderliche Verhalten, die Vorgaben und die Nachweise, bevor der Agent Code ändert.

Praxis10 minGeprüft

Veröffentlicht von Wie wir schreiben

Verständnis prüfenWelches Abnahmekriterium liefert den klarsten Nachweis für eine Exportfunktion?Übung bearbeiten
Welches Abnahmekriterium liefert den klarsten Nachweis für eine Exportfunktion?

Das lernen Sie

  • Eine allgemeine Anfrage in beobachtbare Abnahmekriterien überführen.
  • Vorgaben formulieren, ohne unnötige Implementierungsdetails festzulegen.
  • Die Informationen bestimmen, die ein Reviewer zum Abschluss braucht.

Beschreiben Sie eine Änderung, die ein Reviewer beurteilen kann

„Kundenexport hinzufügen“ lässt mehrere Entscheidungen offen. Wer darf Datensätze exportieren? Welche Datensätze und Felder gehören dazu? Was passiert, wenn eine Anfrage fehlschlägt? Ein Agent kann diese Lücken mit plausiblen Entscheidungen füllen. Für das Unternehmen können sie dennoch falsch sein.

Beginnen Sie mit dem Nutzer und dem Problem. Beschreiben Sie dann das erforderliche Verhalten. Nennen Sie die Nachweise, die zeigen, ob das Ergebnis akzeptabel ist.

Ein Auftrag sollte Unsicherheit verringern, ohne jede interne Entwurfsentscheidung festzulegen. Geben Sie eine erforderliche Datengrenze vor. Lassen Sie die Implementierung vorhandene Repository-Muster nutzen, sofern es keinen Grund gibt, sie zu ändern.

Nutzen Sie ein konkretes Beispiel

Der folgende Auftrag betrifft eine fiktive Supportanwendung. Er ist ein Lernbeispiel und keine vollständige Produktionsspezifikation.

Ergebnis: Eine Support-Führungskraft kann eine Kundenliste herunterladen.
Akteur: Eine Führungskraft in der aktuellen Organisation.
Daten: Nur aktive Kunden dieser Organisation.
Felder: Kunden-ID, Firmenname und Kontostatus.
Format: UTF-8 CSV mit Kopfzeile.
Abgewiesene Anfrage: Den vorhandenen Autorisierungsfehler zurückgeben.
Leeres Ergebnis: Eine gültige CSV nur mit Kopfzeile zurückgeben.
Umfang: Die vorhandene Exportroute und das Audit-Muster verwenden.
Ausgeschlossen: Keine neuen Rollen, Abhängigkeiten oder Deployments.
Nachweise: Tests für erlaubte, abgewiesene, leere und organisationsübergreifende Anfragen.

Dieser Auftrag benennt nützliches Verhalten und Grenzen. Er macht auch weitere Fragen sichtbar. Soll das System die Exportgröße begrenzen? Kann ein Feld eine Tabellenkalkulationsformel enthalten? Wer darf auf den Audit-Eintrag zugreifen? Klären Sie folgenreiche Fragen vor der Implementierung. Behandeln Sie das Beispiel nicht als universelle Checkliste.

Trennen Sie Anforderungen und Annahmen

Eine Anforderung beschreibt Verhalten, das die Änderung erfüllen muss. Eine Annahme ist eine noch nicht geprüfte Tatsache. Halten Sie beides auseinander.

„Verwenden Sie das vorhandene Audit-Muster“ setzt zum Beispiel voraus, dass ein geeignetes Muster existiert. Bitten Sie den Agenten, es zu finden. Gibt es keines im Repository, sollte der Agent die fehlende Voraussetzung melden, bevor er ein neues Audit-System erfindet.

Eine Vorgabe kann auch mit dem Ergebnis in Konflikt stehen. Die vorhandene Route könnte absichtlich alle Organisationen zurückgeben. Der Agent sollte den Konflikt zeigen und eine begrenzte Korrektur vorschlagen. Er sollte weder stillschweigend die Datengrenze entfernen noch aus dem Auftrag einen Architekturumbau machen.

Verlangen Sie Nachweise zum Abschluss

Fordern Sie eine Zusammenfassung an, die das endgültige Verhalten, den geänderten Umfang und die ausgeführten Prüfungen erklärt. Verlangen Sie genaue Befehle und Ergebnisse, wo sie relevant sind. Unterscheiden Sie eine bestandene Prüfung von einer Prüfung, die nicht ausgeführt werden konnte.

Der Pull Request sollte den Grund für die Änderung festhalten. Wer den Code später wartet, sieht möglicherweise nicht das ursprüngliche Gespräch. Geben Sie genug Kontext, um zu erklären, warum der Export bestimmte Felder ausschließt und wie der Zugriff durchgesetzt wird.

Googles Leitfaden für Änderungsbeschreibungen ist dafür eine nützliche Referenz. Die Beschreibung sollte Änderung und Zweck erklären. Passen Sie den Eintrag nach Review-Korrekturen an die endgültige Implementierung an.

Passen Sie den Umfang des Auftrags an

Für eine kleine Textkorrektur reicht ein kurzer Auftrag. Ein Datenexport braucht mehr Details, weil Fehler Informationen offenlegen können. Ein neuer Zahlungsablauf benötigt noch mehr Analyse und Review.

Bewerten Sie die Qualität eines Auftrags nicht nach seiner Länge. Fragen Sie, ob ein kompetenter Reviewer ein korrektes Ergebnis von einem falschen unterscheiden könnte. Wenn zwei vernünftige Implementierungen bei einem folgenreichen Verhalten voneinander abweichen würden, klären Sie dieses Verhalten zuerst.

Übung bearbeiten

Formulieren Sie „Kundenexport hinzufügen“ als klaren Auftrag. Nennen Sie den berechtigten Akteur, Datenumfang, Ausgabe, Fehlerverhalten und Prüfung. Ergänzen Sie eine Aktion, die der Agent nicht ausführen darf. Bitten Sie vor der Implementierung einen Kollegen, eine Unklarheit zu finden.

Arbeitsblatt herunterladen (Markdown)
Verständnis prüfen ↑

Weiterlernen

Quellen und weiterführende Lektüre

Passende Lektüre von Taiga