Kontexte verwalten

So sehen Sie Kontext-Dokumente in CodeCourier an, bearbeiten sie, veröffentlichen neue Versionen, stellen historische Versionen wieder her, löschen sie und prüfen ihre Nutzung.

7 min Lesezeit
contextsversioningediting

Sobald Sie Kontexte in Ihrem Projekt haben, deckt diese Anleitung den vollständigen Verwaltungs-Lebenszyklus ab: Durchsuchen der Kontextliste, Bearbeiten von Inhalten, Veröffentlichen neuer Versionen, Zurücksetzen auf eine frühere Version, Löschen von Kontexten und Verständnis dafür, welche Personas und Sessions jeden Kontext derzeit verwenden.

Alle Kontexte ansehen

Die Kontext-Listenseite unter /p/{projectId}/context zeigt jeden Kontext im Projekt. Jede Zeile zeigt:

  • Name - der Anzeigename des Kontexts
  • Beschreibung - eine einzeilige Zusammenfassung
  • Versionsanzahl - wie viele veröffentlichte Versionen existieren
  • Zuletzt veröffentlicht - der Zeitstempel der jüngsten aktiven Version
  • Nutzungsanzahl - wie viele Personas und Session-Typen diesen Kontext referenzieren

Klicken Sie auf eine beliebige Zeile, um die Kontext-Detailseite zu öffnen, auf der Sie den aktuellen Inhalt lesen, die Versionshistorie durchsuchen und Bearbeitungen vornehmen können.

Kontext-Inhalt bearbeiten

Öffnen Sie die Kontext-Detailseite und ändern Sie den Markdown-Inhalt im Editor. Ihre Bearbeitungen werden automatisch als Entwurf gespeichert. Der Editor zeigt in der Kopfleiste einen Indikator Nicht veröffentlichte Änderungen, sobald sich der Entwurf von der derzeit aktiven Version unterscheidet.

Das Bearbeiten eines Entwurfs wirkt sich nicht auf laufende Sandboxes oder die aktive Version aus. Sandboxes erhalten immer die aktive veröffentlichte Version. Entwurfsinhalte werden nur für die nächste Veröffentlichung bereitgestellt.

Automatisches Speichern

Der Editor speichert Ihren Entwurf bei jedem Tastendruck mit einer kurzen Verzögerung automatisch. Sie verlieren keine ungespeicherte Arbeit, wenn Sie versehentlich wegnavigieren - der Entwurf wird serverseitig gespeichert und wiederhergestellt, wenn Sie zum Editor zurückkehren.

Eine neue Version veröffentlichen

1

Änderungen vornehmen

Bearbeiten Sie den Markdown-Inhalt im Kontext-Editor, bis Sie mit der neuen Version zufrieden sind. Verwenden Sie die Vorschau-Ansicht, um die Formatierung zu überprüfen.

2

Auf Veröffentlichen klicken

Klicken Sie oben rechts im Editor auf die Schaltfläche Veröffentlichen. CodeCourier wird:

  1. Einen neuen Versions-Datensatz mit Status active erstellen
  2. Die zuvor aktive Version auf inactive setzen
  3. Den Veröffentlichungs-Zeitstempel und Ihre Benutzeridentität protokollieren
  4. Den Indikator „Nicht veröffentlichte Änderungen“ entfernen
3

Verbreitung bestätigen

Die neue Version ist jetzt live. Jede Sandbox, die nach diesem Zeitpunkt bereitgestellt wird und an diesen Kontext gebunden ist - entweder über eine Persona-Bindung oder eine Session-Typ-Vorgabe - erhält den neu veröffentlichten Inhalt. Sandboxes, die zum Zeitpunkt der Veröffentlichung bereits liefen, fahren mit der Version fort, mit der sie gestartet wurden.

Sofortige Wirkung auf neue Sessions

Das Veröffentlichen einer neuen Kontext-Version tritt für neue Sessions sofort in Kraft. Wenn Sie sich mitten in einem wichtigen Workflow-Lauf befinden, der von bestimmten Kontext-Inhalten abhängt, schließen Sie den Lauf ab, bevor Sie brechende Änderungen an diesem Kontext veröffentlichen.

Versionshistorie ansehen

Das Panel Versionshistorie auf der Kontext-Detailseite listet jede veröffentlichte Version in absteigender chronologischer Reihenfolge auf. Für jede Version sehen Sie:

  • Versionsnummer - eine inkrementierende Ganzzahl, beginnend bei 1
  • Status-Badge - active (grün) oder inactive (grau)
  • Veröffentlicht am - exakter Zeitstempel der Veröffentlichung dieser Version
  • Veröffentlicht von - das Teammitglied, das auf Veröffentlichen geklickt hat

Ein Klick auf eine Version in der Liste öffnet eine schreibgeschützte Ansicht des Inhalts dieser Version. Sie können sie nebeneinander mit dem aktuellen Entwurf vergleichen, um zu verstehen, was sich zwischen den Versionen geändert hat.

Eine frühere Version wiederherstellen

Falls eine neu veröffentlichte Version Probleme verursacht - zum Beispiel, weil ein Agent sich unerwartet verhält, da der Kontext-Inhalt falsch geändert wurde - können Sie auf jede vorherige Version zurückrollen:

1

Version im History-Panel öffnen

Klicken Sie im Panel Versionshistorie auf die Version, die Sie wiederherstellen möchten. Ihr Inhalt erscheint in der schreibgeschützten Ansicht.

2

Auf Diese Version wiederherstellen klicken

Klicken Sie in der Versions-Detailansicht auf Diese Version wiederherstellen. Diese Aktion kopiert den Inhalt der historischen Version als neuen Entwurf in den Editor. Sie veröffentlicht nicht sofort - sie gibt Ihnen die Möglichkeit, den wiederhergestellten Inhalt zu überprüfen, bevor Sie ihn live schalten.

3

Wiederhergestellten Inhalt veröffentlichen

Sobald Sie bestätigt haben, dass der wiederhergestellte Inhalt korrekt ist, klicken Sie auf Veröffentlichen, um eine neue Version (mit der nächsten fortlaufenden Versionsnummer) zu erstellen, die den wiederhergestellten Inhalt enthält. Die neue Version wird aktiv, und alle vorherigen Versionen bleiben für die Prüfung in der Historie erhalten.

Wiederherstellungen erzeugen neue Versionen

Das Wiederherstellen einer früheren Version erzeugt einen neuen Versions-Eintrag in der Historie, statt den Versions-Zähler zurückzusetzen. Dies bewahrt das vollständige Audit-Protokoll: Sie sehen, dass eine Wiederherstellung stattgefunden hat und wann genau, statt dass die Historie still überschrieben wird.

Einen Kontext löschen

Um einen Kontext zu löschen, öffnen Sie seine Detailseite und wählen Sie Löschen aus dem Aktionsmenü (dem Drei-Punkte-Überlauf-Menü in der Kopfzeile der Seite). Das Löschen ist ein Soft-Delete - der Kontext wird in den Papierkorb des Projekts verschoben und ist in der Kontextliste nicht mehr sichtbar, seine Daten werden aber für eine Karenzzeit aufbewahrt.

Was beim Löschen passiert

  • Der Kontext erscheint nicht mehr in der aktiven Kontextliste
  • Alle Session-Typ-Bindungen, die diesen Kontext referenziert haben, werden automatisch entfernt
  • Persona-Bindungen, die diesen Kontext referenziert haben, werden automatisch entfernt
  • Bestehende Sandboxes, die den Kontext-Inhalt bereits erhalten haben, sind nicht betroffen
  • Der Kontext und seine gesamte Versionshistorie werden in den Papierkorb verschoben

Aus dem Papierkorb wiederherstellen

Gelöschte Kontexte können aus dem Bereich Papierkorb des Projekts wiederhergestellt werden, der über die Projekt-Sidebar erreichbar ist. Das Wiederherstellen eines verworfenen Kontexts bringt ihn mit seiner vollständigen Versionshistorie in die aktive Kontextliste zurück. Session-Typ- und Persona-Bindungen, die beim Löschen entfernt wurden, werden nicht automatisch wiederhergestellt - Sie müssen den Kontext nach der Wiederherstellung neu verknüpfen.

Permanente Löschung

Elemente im Papierkorb werden nach der Aufbewahrungsfrist (in der Regel 30 Tage) endgültig gelöscht. Sobald sie endgültig gelöscht sind, können der Kontext und alle seine Versionen nicht wiederhergestellt werden. Wenn Sie unsicher sind, stellen Sie den Kontext aus dem Papierkorb wieder her, statt ihn ablaufen zu lassen.

Kontext-Nutzungsanalysen

Der Tab Nutzung auf jeder Kontext-Detailseite zeigt genau, welche Teile Ihres Projekts diesen Kontext derzeit referenzieren. Dies ist entscheidend, um den Wirkungsradius einer Änderung zu verstehen, bevor Sie eine neue Version veröffentlichen.

Session-Typ-Bindungen

Der Nutzungs-Tab listet alle Session-Typen auf, die diesen Kontext als Vorgabe gesetzt haben:

  • Jeder Eintrag zeigt den Session-Typ (answering, issues, learning, merging, evaluator, judge)
  • Einen direkten Link zum entsprechenden Setup-Tab in den Projekteinstellungen
  • Wann die Bindung zuletzt aktualisiert wurde

Persona-Bindungen

Der Nutzungs-Tab listet auch alle Personas auf, die diesen Kontext als ihren Persona-spezifischen Override gesetzt haben:

  • Persona-Name und -Typ
  • Einen direkten Link zur Detailseite der Persona
  • Wann die Persona zuletzt aktualisiert wurde, um diesen Kontext zu verwenden

Wenn keine Personas oder Session-Typen im Nutzungs-Tab aufgeführt sind, wird der Kontext derzeit in keine Sessions eingespeist. Sie können sicher Änderungen veröffentlichen oder ihn archivieren, ohne aktive Workflows zu beeinträchtigen.

Best Practices für die Kontext-Verwaltung

  • Halten Sie Kontexte fokussiert - Ein Kontext pro Domänenbereich (Architektur, Sicherheit, Tests) statt eines riesigen Dokuments. Fokussierte Kontexte sind einfacher zu aktualisieren, und der Agent nutzt sie präziser.
  • Prüfen Sie die Nutzung vor dem Veröffentlichen - Sehen Sie sich den Nutzungs-Tab an, um zu verstehen, welche Session-Typen und Personas von einer neuen Version betroffen sein werden, bevor Sie sie veröffentlichen.
  • Schreiben Sie eine Beschreibung für jede Version - Das Versions-History-Panel hilft künftigen Teammitgliedern, die Entwicklung eines Kontexts zu verstehen. Behandeln Sie es wie eine Commit-Historie.
  • Prüfen Sie nach größeren Codebasis-Änderungen - Wenn Sie ein Framework migrieren, Datei-Konventionen ändern oder eine größere Abhängigkeit hinzufügen, prüfen Sie alle Kontexte, um sicherzustellen, dass der Inhalt die Codebasis weiterhin korrekt widerspiegelt.
  • Verwenden Sie separate Kontexte pro Technologie-Schicht - Ein Frontend-Designer benötigt keine Backend-API-Dokumentation. Halten Sie Kontexte klein und schichtspezifisch und binden Sie dann nur den relevanten Kontext an jede Persona.

Nächste Schritte