Gérer les Contextes

Comment consulter, modifier, publier de nouvelles versions, restaurer des versions historiques, supprimer et auditer l'usage des Documents de contexte dans CodeCourier.

7 min lire
contextsversioningediting

Une fois que vous avez des Contextes dans votre projet, ce guide couvre le cycle de gestion complet : parcourir la liste des Contextes, modifier le contenu, publier de nouvelles versions, revenir à une version précédente, supprimer des Contextes, et comprendre quelles personas et sessions utilisent actuellement chaque Contexte.

Consulter tous les Contextes

La page de liste des Contextes à /p/{projectId}/context montre chaque Contexte du projet. Chaque ligne affiche :

  • Nom - le nom d’affichage du Contexte
  • Description - un résumé d’une ligne
  • Nombre de versions - combien de versions publiées existent
  • Dernière publication - l’horodatage de la version active la plus récente
  • Nombre d’usages - combien de personas et session types référencent ce Contexte

Cliquez sur une ligne pour ouvrir la page de détail du Contexte, où vous pouvez lire le contenu actuel, parcourir l’historique des versions et effectuer des modifications.

Modifier le contenu d’un Contexte

Ouvrez la page de détail du Contexte et modifiez le contenu markdown dans l’éditeur. Vos modifications sont enregistrées automatiquement comme brouillon. L’éditeur affiche un indicateur Modifications non publiéesdans la barre d’en-tête chaque fois que le brouillon diffère de la version actuellement active.

Modifier un brouillon n’affecte pasles sandboxes en cours d’exécution ni la version active. Les sandboxes reçoivent toujours la version publiée active. Le contenu du brouillon n’est mis en attente que pour la prochaine publication.

Enregistrement automatique

L’éditeur enregistre automatiquement votre brouillon à chaque frappe avec un court délai. Vous ne perdrez jamais de travail non enregistré si vous quittez accidentellement la page - le brouillon est stocké côté serveur et restauré lorsque vous revenez à l’éditeur.

Publier une nouvelle version

1

Effectuer vos modifications

Modifiez le contenu markdown dans l’éditeur de Contexte jusqu’à ce que vous soyez satisfait de la nouvelle version. Utilisez le panneau d’aperçu pour vérifier le formatage.

2

Cliquer sur Publier

Cliquez sur le bouton Publieren haut à droite de l’éditeur. CodeCourier va :

  1. Créer un nouvel enregistrement de version avec le statut active
  2. Passer la version précédemment active à inactive
  3. Enregistrer l’horodatage de publication et votre identité d’utilisateur
  4. Effacer l’indicateur “Modifications non publiées”
3

Confirmer la propagation

La nouvelle version est maintenant en ligne. Toute sandbox provisionnée après ce moment et liée à ce Contexte - que ce soit via une liaison de persona ou une valeur par défaut de session type - recevra le contenu nouvellement publié. Les sandboxes déjà en cours d’exécution au moment de la publication continuent avec la version avec laquelle elles ont démarré.

Effet immédiat sur les nouvelles sessions

La publication d’une nouvelle version de Contexte prend effet immédiatement pour les nouvellessessions. Si vous êtes au milieu d’un workflow run important qui dépend d’un contenu de Contexte spécifique, terminez le run avant de publier des changements cassants sur ce Contexte.

Consulter l’historique des versions

Le panneau Historique des versions sur la page de détail du Contexte liste chaque version publiée en ordre chronologique descendant. Pour chaque version, vous pouvez voir :

  • Numéro de version - un entier incrémental commençant à 1
  • Badge de statut - active (vert) ou inactive (gris)
  • Publié le - l’horodatage exact de publication de cette version
  • Publié par - le membre de l’équipe qui a cliqué sur Publier

Cliquer sur une version dans la liste ouvre une vue en lecture seule du contenu de cette version. Vous pouvez la comparer côte à côte avec le brouillon actuel pour comprendre ce qui a changé entre les versions.

Restaurer une version précédente

Si une version nouvellement publiée cause des problèmes - par exemple, un agent commence à se comporter de manière inattendue parce que le contenu du Contexte a été modifié incorrectement - vous pouvez revenir à n’importe quelle version précédente :

1

Ouvrir la version dans le panneau d'historique

Cliquez sur la version que vous voulez restaurer dans le panneau Historique des versions. Son contenu apparaît dans la vue en lecture seule.

2

Cliquer sur Restaurer cette version

Dans la vue de détail de la version, cliquez sur Restaurer cette version. Cette action copie le contenu de la version historique dans l’éditeur comme nouveau brouillon. Elle ne publie pas immédiatement - elle vous donne l’opportunité de revoir le contenu restauré avant de le mettre en ligne.

3

Publier le contenu restauré

Une fois que vous avez confirmé que le contenu restauré est correct, cliquez sur Publierpour créer une nouvelle version (avec le numéro de version séquentiel suivant) contenant le contenu restauré. La nouvelle version devient active, et toutes les versions précédentes restent dans l’historique à des fins d’audit.

Les restaurations créent de nouvelles versions

Restaurer une version précédente crée une nouvelleentrée de version dans l’historique plutôt que de faire reculer le compteur de versions. Cela préserve la piste d’audit complète : vous pouvez voir qu’une restauration a eu lieu et exactement quand, plutôt que d’avoir un historique écrasé silencieusement.

Supprimer un Contexte

Pour supprimer un Contexte, ouvrez sa page de détail et sélectionnez Supprimer depuis le menu d’actions (le menu à trois points dans l’en-tête de la page). La suppression est une suppression douce- le Contexte est déplacé vers la corbeille du projet et n’est plus visible dans la liste des Contextes, mais ses données sont conservées pendant une période de grâce.

Ce qui se passe lors de la suppression

  • Le Contexte n’apparaît plus dans la liste des Contextes actifs
  • Toute liaison de session type qui référençait ce Contexte est effacée automatiquement
  • Les liaisons de persona qui référençaient ce Contexte sont effacées automatiquement
  • Les sandboxes existantes qui ont déjà reçu le contenu du Contexte ne sont pas affectées
  • Le Contexte et tout son historique de versions sont déplacés vers la corbeille

Récupérer depuis la corbeille

Les Contextes supprimés peuvent être récupérés depuis la section Corbeille du projet, accessible depuis la sidebar du projet. Restaurer un Contexte mis à la corbeille le ramène dans la liste des Contextes actifs avec tout son historique de versions intact. Les liaisons de session type et de persona qui ont été effacées lors de la suppression ne sont pasautomatiquement rétablies - vous devrez relier le Contexte après l’avoir restauré.

Suppression permanente

Les éléments dans la corbeille sont définitivement supprimés après la période de rétention (généralement 30 jours). Une fois supprimé définitivement, le Contexte et toutes ses versions ne peuvent pas être récupérés. En cas de doute, restaurez le Contexte depuis la corbeille plutôt que de le laisser expirer.

Analyses d’usage des Contextes

L’onglet Usagesur chaque page de détail de Contexte montre exactement quelles parties de votre projet référencent actuellement ce Contexte. C’est essentiel pour comprendre le rayon d’impact d’un changement avant de publier une nouvelle version.

Liaisons de session type

L’onglet Usage liste tous les session types qui ont ce Contexte défini comme valeur par défaut :

  • Chaque entrée montre le session type (answering, issues, learning, merging, evaluator, judge)
  • Un lien direct vers l’onglet de configuration correspondant dans les Paramètres du projet
  • La date de dernière mise à jour de la liaison

Liaisons de persona

L’onglet Usage liste également toutes les personas qui ont ce Contexte défini comme leur override au niveau persona :

  • Le nom et le type de la persona
  • Un lien direct vers la page de détail de la persona
  • La date de dernière mise à jour de la persona pour utiliser ce Contexte

Si aucune persona ni session type n’est listé dans l’onglet Usage, le Contexte n’est actuellement injecté dans aucune session. Vous pouvez publier des modifications ou l’archiver en toute sécurité sans affecter les workflows actifs.

Bonnes pratiques pour la gestion des Contextes

  • Gardez les Contextes ciblés- Un Contexte par domaine (architecture, sécurité, tests) plutôt qu’un document géant unique. Les Contextes ciblés sont plus faciles à mettre à jour et l’agent les utilise plus précisément.
  • Vérifiez l’usage avant de publier- Consultez l’onglet Usage pour comprendre quels session types et personas seront affectés par une nouvelle version avant de la publier.
  • Rédigez une description pour chaque version- Le panneau d’historique des versions aide les futurs membres de l’équipe à comprendre l’évolution d’un Contexte. Traitez-le comme un historique de commits.
  • Auditez après des changements majeurs de la codebase - Lorsque vous migrez un framework, modifiez des conventions de fichiers, ou ajoutez une dépendance majeure, auditez tous les Contextes pour vous assurer que le contenu reflète toujours fidèlement la codebase.
  • Utilisez des Contextes séparés par couche technologique- Un Designer frontend n’a pas besoin de la documentation API backend. Gardez les Contextes petits et spécifiques à une couche, puis ne liez que le Contexte pertinent à chaque persona.

Étapes suivantes

Vue d'ensemble des Contextes

Revoyez la vue d'ensemble conceptuelle des Contextes, du versioning et des liaisons de session.

Créer des Contextes

Guide étape par étape pour créer votre premier Document de contexte.

Paramètres du projet

Configurez les liaisons de Contexte des session types depuis les Paramètres du projet.

Configuration des personas

Liez un Contexte à une persona spécifique pour un override par persona.