Gestire i Contesti
Come visualizzare, modificare, pubblicare nuove versioni, ripristinare versioni storiche, eliminare e verificare l'utilizzo dei Documenti di contesto in CodeCourier.
Una volta che hai dei Contesti nel tuo progetto, questa guida copre l’intero ciclo di gestione: sfogliare l’elenco dei Contesti, modificare il contenuto, pubblicare nuove versioni, tornare a una versione precedente, eliminare Contesti e capire quali persona e sessioni stanno attualmente usando ogni Contesto.
Visualizzare tutti i Contesti
La pagina elenco dei Contesti in /p/{projectId}/context mostra ogni Contesto del progetto. Ogni riga mostra:
- Nome - il nome visualizzato del Contesto
- Descrizione - un riepilogo di una riga
- Numero di versioni - quante versioni pubblicate esistono
- Ultima pubblicazione - il timestamp della versione attiva più recente
- Numero di utilizzi - quante persona e session type referenziano questo Contesto
Clicca su una riga qualsiasi per aprire la pagina di dettaglio del Contesto, dove puoi leggere il contenuto corrente, sfogliare la cronologia delle versioni e apportare modifiche.
Modificare il contenuto di un Contesto
Apri la pagina di dettaglio del Contesto e modifica il contenuto markdown nell’editor. Le tue modifiche vengono salvate automaticamente come bozza. L’editor mostra un indicatore Modifiche non pubblicatenella barra dell’intestazione ogni volta che la bozza differisce dalla versione attualmente attiva.
Modificare una bozza non influisce sulle sandbox in esecuzione né sulla versione attiva. Le sandbox ricevono sempre la versione pubblicata attiva. Il contenuto della bozza viene solo messo in coda per la prossima pubblicazione.
Salvataggio automatico
Pubblicare una nuova versione
Apporta le tue modifiche
Modifica il contenuto markdown nell’editor del Contesto finché non sei soddisfatto della nuova versione. Usa il pannello di anteprima per verificare la formattazione.
Clicca su Pubblica
Clicca sul pulsante Pubblicain alto a destra dell’editor. CodeCourier:
- Crea un nuovo record di versione con stato
active - Imposta la versione precedentemente attiva su
inactive - Registra il timestamp di pubblicazione e la tua identità utente
- Rimuove l’indicatore “Modifiche non pubblicate”
Conferma la propagazione
La nuova versione è ora live. Qualsiasi sandbox provisionata dopo questo momento e collegata a questo Contesto - sia tramite un binding di persona sia tramite un default di session type - riceverà il contenuto appena pubblicato. Le sandbox già in esecuzione al momento della pubblicazione continuano con la versione con cui sono state avviate.
Effetto immediato sulle nuove sessioni
Visualizzare la cronologia delle versioni
Il pannello Cronologia delle versioni nella pagina di dettaglio del Contesto elenca ogni versione pubblicata in ordine cronologico decrescente. Per ogni versione puoi vedere:
- Numero di versione - un intero incrementale a partire da 1
- Badge di stato -
active(verde) oinactive(grigio) - Pubblicata il - il timestamp esatto di pubblicazione di questa versione
- Pubblicata da - il membro del team che ha cliccato su Pubblica
Cliccando su una versione nell’elenco si apre una vista in sola lettura del contenuto di quella versione. Puoi confrontarla fianco a fianco con la bozza corrente per capire cosa è cambiato tra le versioni.
Ripristinare una versione precedente
Se una versione appena pubblicata causa problemi - per esempio, un agente inizia a comportarsi in modo inatteso perché il contenuto del Contesto è stato modificato in modo errato - puoi tornare a qualsiasi versione precedente:
Apri la versione nel pannello di cronologia
Clicca sulla versione che vuoi ripristinare nel pannello Cronologia delle versioni. Il suo contenuto appare nella vista in sola lettura.
Clicca su Ripristina questa versione
Nella vista di dettaglio della versione, clicca su Ripristina questa versione. Questa azione copia il contenuto della versione storica nell’editor come nuova bozza. Non pubblica immediatamente - ti dà l’opportunità di rivedere il contenuto ripristinato prima di renderlo live.
Pubblica il contenuto ripristinato
Una volta confermato che il contenuto ripristinato è corretto, clicca su Pubblica per creare una nuova versione (con il numero di versione sequenziale successivo) contenente il contenuto ripristinato. La nuova versione diventa attiva, e tutte le versioni precedenti rimangono nella cronologia per scopi di audit.
I ripristini creano nuove versioni
Eliminare un Contesto
Per eliminare un Contesto, apri la sua pagina di dettaglio e seleziona Eliminadal menu delle azioni (il menu a tre puntini nell’intestazione della pagina). L’eliminazione è una eliminazione soft- il Contesto viene spostato nel cestino del progetto e non è più visibile nell’elenco dei Contesti, ma i suoi dati vengono conservati per un periodo di grazia.
Cosa succede all’eliminazione
- Il Contesto non appare più nell’elenco dei Contesti attivi
- Qualsiasi binding di session type che referenziava questo Contesto viene rimosso automaticamente
- I binding di persona che referenziavano questo Contesto vengono rimossi automaticamente
- Le sandbox esistenti che hanno già ricevuto il contenuto del Contesto non vengono influenzate
- Il Contesto e tutta la sua cronologia delle versioni vengono spostati nel cestino
Recuperare dal cestino
I Contesti eliminati possono essere recuperati dalla sezione Cestinodel progetto, accessibile dalla sidebar del progetto. Ripristinare un Contesto dal cestino lo riporta nell’elenco dei Contesti attivi con tutta la sua cronologia delle versioni intatta. I binding di session type e persona che sono stati rimossi all’eliminazione non vengono ristabiliti automaticamente - dovrai ricollegare il Contesto dopo averlo ripristinato.
Eliminazione permanente
Analisi dell’utilizzo del Contesto
Il tab Utilizzosu ogni pagina di dettaglio del Contesto mostra esattamente quali parti del tuo progetto stanno attualmente referenziando quel Contesto. Questo è essenziale per capire il raggio d’impatto di una modifica prima di pubblicare una nuova versione.
Binding di session type
Il tab Utilizzo elenca tutti i session type che hanno questo Contesto impostato come loro default:
- Ogni voce mostra il session type (answering, issues, learning, merging, evaluator, judge)
- Un link diretto al tab di setup corrispondente nelle Impostazioni del progetto
- Quando il binding è stato aggiornato l’ultima volta
Binding di persona
Il tab Utilizzo elenca anche tutte le persona che hanno questo Contesto impostato come loro override a livello persona:
- Nome e tipo della persona
- Un link diretto alla pagina di dettaglio della persona
- Quando la persona è stata aggiornata l’ultima volta per usare questo Contesto
Se nessuna persona o session type è elencato nel tab Utilizzo, il Contesto non viene attualmente iniettato in nessuna sessione. Puoi pubblicare modifiche o archiviarlo in sicurezza senza influenzare i workflow attivi.
Best practice per la gestione dei Contesti
- Mantieni i Contesti mirati- Un Contesto per area di dominio (architettura, sicurezza, test) invece di un unico documento gigante. I Contesti mirati sono più facili da aggiornare e l’agente li usa in modo più preciso.
- Rivedi l’utilizzo prima di pubblicare - Controlla il tab Utilizzo per capire quali session type e persona saranno influenzati da una nuova versione prima di pubblicarla.
- Scrivi una descrizione per ogni versione- Il pannello di cronologia delle versioni aiuta i futuri membri del team a capire l’evoluzione di un Contesto. Trattalo come una cronologia commit.
- Verifica dopo grandi modifiche alla codebase - Quando migri un framework, cambi le convenzioni sui file, o aggiungi una dipendenza importante, verifica tutti i Contesti per assicurarti che il contenuto rifletta ancora accuratamente la codebase.
- Usa Contesti separati per layer tecnologico - Un Designer frontend non ha bisogno della documentazione API backend. Mantieni i Contesti piccoli e specifici per layer, poi collega solo il Contesto rilevante a ciascuna persona.
Prossimi passi
Panoramica dei Contesti
Rivedi la panoramica concettuale dei Contesti, del versioning e dei binding di sessione.
Creare Contesti
Guida passo passo per creare il tuo primo Documento di contesto.
Impostazioni del progetto
Configura i binding di Contesto per i session type dalle Impostazioni del progetto.
Configurazione delle persona
Collega un Contesto a una persona specifica per un override per persona.