Dokumentationsaktualisierungsrichtlinie: Agent-Kontextpaket
Versorgt einen KI-Coding-Agenten mit den Fakten, Regeln, Grenzen und Beispielen, die benötigt werden, um die Dokumentationsaktualisierungsrichtlinie konsistent anzuwenden. Es legt Annahmegrenzen und beobachtbare Fehlerbeweise fest und hält gleichzeitig umgebungsspezifische Limits konfigurierbar.
Paketstatus: Referenzkontext bereit zur menschlichen Überprüfung. Der Vertrag und die Testszenarien sind vollständig, es wird jedoch nicht behauptet, dass eine übernehmende Implementierung diese bestanden hat.
Entscheidung
Für die Dokumentationsaktualisierungsrichtlinie wird eine versionskontrollierte Repository-Anweisung angenommen, die nach Pfad und Aufgabe abgegrenzt ist. Das Verhalten wird durch einen autoritativen Schreibpfad, typisierte Schnittstellen, expliziten Zustand und idempotente Nebenwirkungsbehandlung implementiert. Dieses Paket ist ein Referenzvertrag: Das übernehmende Team muss numerische Grenzen, Anbieter, Rechtsgebiete und operative Verantwortliche anhand von Beweisen in der eigenen Umgebung auswählen.
Umfang
- Die Akteure, Eingaben, Ausgaben, Zustände, Richtlinien- oder Schemaversionen und extern sichtbaren Ergebnisse der Dokumentationsaktualisierungsrichtlinie, die durch diesen Implementierungsblock beschrieben werden.
- Primäre und alternative Schnittstellen, Hintergrundarbeiten, Caches, Integrationen, Supportpfade und Beweise, die dieselbe Grenze ausüben können.
- Übernahmespezifische Konfiguration, Rollout, Wiederherstellung und Verifikationsverantwortlichkeiten, die benötigt werden, um die Referenz sicher anzuwenden.
Außerhalb dieses Blocks
- Die Wahl eines universellen Anbieters, Frameworks, Rechtsgebiets, numerischen Schwellenwerts, Aufbewahrungszeitraums oder Service-Level-Objectives für jeden Übernehmer.
- Die Behauptung, dass verpackte Szenarien gegen eine nachgelagerte Implementierung ausgeführt wurden oder dass diese Referenz eine rechtliche, Sicherheits- oder Barrierefreiheitszertifizierung gewährt.
Vertrag
- Deklariere Anweisungspriorität, anwendbare Pfade, erforderliche Prüfungen, verbotene Änderungen und die erwarteten Beweise bei der Übergabe.
- Leite Befehle, Versionen, Architektur und Dateistandorte aus Repository-Quellen ab, nicht aus dem Speicher oder einem benachbarten Projekt.
- Halte ausführbare Verifikation getrennt von Prosa-Behauptungen und zeichne auf, wenn eine Prüfung nicht ausgeführt wurde oder nicht abgeschlossen werden konnte.
- Fordere den Agenten auf, nicht zusammenhängende Änderungen zu bewahren und anzuhalten, wenn Anmeldeinformationen, zerstörerischer Umfang oder Produktbefugnis fehlen.
- Validieren Sie Eingaben einmal an der Grenze und bewahren Sie die normalisierte Darstellung, die von nachgelagerter Logik verwendet wird.
- Speichere die geschäftliche Transition vor oder atomar mit einem Outbox-Datensatz; Verbraucher deduplizieren anhand einer dauerhaften Operationsidentität.
- Ordne Verhalten, API-, Konfigurations-, Schema-, Betriebs-, Sicherheits- und benutzerorientierte Änderungen zu eigenen Dokumentationszielen und Freigabe-Beweisen zu.
- Generierte Referenzausgaben stammen aus dem autoritativen Schema oder Code; handgeschriebene Anleitungen erklären Entscheidungen und werden bei Änderung der Quellversion überprüft.
Implementierungsleitfaden
- Liefere additive Speicher- und Schnittstellenänderungen zuerst aus, fülle sie beobachtbar nach, und stelle alte Pfade nach Kompatibilitätsnachweis ein.
- Modelle Eingaben, Ausgaben, Akteure, Zustände, Invarianten, Nebenwirkungen und Beweise der Dokumentationsaktualisierungsrichtlinie, bevor Framework- oder Anbieterdetails ausgewählt werden.
- Speichere den anwendbaren Vertrag oder die Richtlinienversion der Dokumentationsaktualisierungsrichtlinie mit materiellem Zustand, damit Migrationen, Wiedergabe und Supportentscheidungen zuordenbar bleiben.
- Führe den Pfad hinter kontrolliertem Rollout ein, vergleiche erwartete und beobachtete Ergebnisse und halte eine getestete Wiederherstellungsroute, bis Übernahmebeweise vollständig sind.
Fehlerbehandlung und Schutzmaßnahmen
- Konfliktierender oder veralteter Kontext wird als Blocker mit genauen Quellen angezeigt; der Agent erfindet keinen Tiebreaker, der das Projektverhalten ändert.
- Ungültiger oder widersprüchlicher Zustand der Dokumentationsaktualisierungsrichtlinie wird abgelehnt oder isoliert; die Implementierung schätzt niemals einen Wert, der Befugnisse erweitert oder Effekte dupliziert.
- Wiederholungen sind begrenzt und verwenden dauerhafte Identität; nach Erschöpfung erreicht die Arbeit einen überprüfbaren Endzustand mit verantwortlichem Eigentümer.
Verifikation und Betrieb
- Simuliere Abhängigkeitsfehler vor und nach der Persistenz und beweise, dass Wiederholungen auf ein extern sichtbares Ergebnis konvergieren.
- Überwache Erfolg, Ablehnung, Validierungsfehler, Abhängigkeitsfehler, Wiederholungsermüdung und Wiederherstellung der Dokumentationsaktualisierungsrichtlinie nach Vertragsversion ohne sensible Nutzlastdimensionen.
- Führe gepaarte positive und negative Fixtures nach Richtlinien-, Schema-, Abhängigkeits-, Migrations- oder Grenzänderungen erneut aus und bewahre die resultierenden Beweise.
Übernahmeannahmen
- Namen und Werte im Beispiel sind ein konkretes Fixture, keine universellen Standardwerte; Übernehmer ersetzen sie durch dokumentierte Beweise und Eigentum.
- Das übernehmende System kann authentifizierte Identität, dauerhafte Operationen oder Datensatzversionen, begrenzte Telemetrie und einen kontrollierten Pfad für Änderungen bereitstellen.
Die ausführbar aussehenden Beispiele in diesem Paket sind Fixtures und Akzeptanzverträge. Führen Sie den Sammlungsvalidator aus, um Struktur und Metadaten zu prüfen, übersetzen und führen Sie dann die Szenarien im Zielrepository aus, bevor Sie Implementierungsbeweise aufzeichnen.