Agenten lesen Ihren Code. Kontext ist der Ort, an dem Sie das unterbringen, was der Code nicht ausdrücken kann – die Entscheidungen, Einschränkungen und Konventionen, die außerhalb des Codes existieren.
Die Begründung dafür, was hierher gehört, finden Sie unter Projektkontext in den Konzepten. Diese Seite behandelt die Verwaltung desselben.
Kontext hinzufügen
Öffnen Sie den „ Kontext “-Abschnitt des Projekts und fügen Sie einen Eintrag hinzu. Jeder Eintrag enthält einen Titel und einen Textinhalt und kann später bearbeitet oder gelöscht werden.
Gute Einträge sind kurz, spezifisch und beständig. Architekturentscheidungen, Stilkonventionen, API-Verträge, Zuständigkeitsbereiche und explizite Verbote gehören dazu. Onboarding-Beschreibungen sowie alles, was bereits aus dem Repository ersichtlich ist, nicht.
Einträge getrennt halten und benennen
Ein Eintrag pro Thema, betitelt nach dem Inhalt. „Konventionen zur Fehlerbehandlung“ und „Gefrorene Module“ sind leicht auffindbar; ein einzelner Eintrag namens „Notizen“, der beides enthält, hingegen nicht.
Das ist wichtig, weil der Kontext selektiv je nach aktueller Aufgabe geladen wird – siehe Progressive Fähigkeiten. Gut getrennte Einträge sorgen dafür, dass der richtige Eintrag für die jeweilige Aufgabe geladen wird.
Referenzen
Neben schriftlichen Einträgen können Sie auch Referenzen anfügen – Links und Dokumente, die auf externes Material verweisen. Nutzen Sie diese, wenn die autoritative Version in einer Wiki oder Design-Tool liegt und Sie keine zweite, veraltete Kopie erstellen möchten.
Aufgabenspezifischer Kontext
Der Projektkontext gilt für alles im Projekt. Material, das nur für eine bestimmte Arbeit relevant ist – ein Ticket, ein Kundenbericht, ein Entwurfsdokument –, sollten Sie stattdessen dieser Aufgabe zuordnen. Eine aufgabenspezifische Notiz im Projektkontext wird bei jeder zukünftigen Aufgabe zum Störfaktor.
Aktualität bewahren
Veralteter Kontext ist schlimmer als fehlender Kontext, denn Agenten betrachten ihn als autoritativ. Wenn sich eine Konvention ändert, aktualisieren Sie den Eintrag im selben Änderungszyklus wie den Code.
Vorhandenen Kontext überprüfen
Lesen Sie Ihren Kontext gelegentlich, als wären Sie neu dabei. Einträge sammeln sich an, und die während einer vor einem Jahr abgeschlossenen Migration erstellten Einträge sind mittlerweile irreführend.