Synthèse Exercice 14 / 15

Documenter la solution — documentation technique

Situation professionnelle. Documentation technique. Une procédure contient cinq étapes, mais l'étape de validation finale manque.

Compétence ciblée. Classer, documenter et versionner les modèles.

Mission. Rédigez la fiche de maintenance du prompt, incluant propriétaire, version, usages autorisés, variables, limites et historique.

Exigence spécifique. Renseignez ID, titre, catégorie, responsable, version, statut, variables, tests et historique.

Travail demandé. Présentez votre production concrète, justifiez vos choix et indiquez comment vérifier qu'elle respecte le besoin.

Voir la correction

Résultat attendu : Une fiche de bibliothèque réutilisable.Le statut « validé » requiert une preuve de validation ; un fichier enregistré n'est pas nécessairement approuvé.

Étape 1 — Lire le dossier et cadrer le besoin

Le document de travail est : « Une procédure contient cinq étapes, mais l'étape de validation finale manque. ». Il faut traiter ce contenu tel qu'il est, sans compléter les informations manquantes par supposition.

Étape 2 — Appliquer la technique du cours

Utiliser des métadonnées, des statuts et un historique des modifications. Renseignez ID, titre, catégorie, responsable, version, statut, variables, tests et historique.

Exemple de démarche recevable : Le statut « validé » requiert une preuve de validation ; un fichier enregistré n'est pas nécessairement approuvé.

Étape 3 — Résoudre la mission

  • Attribuez un identifiant stable et une version datée ; le titre doit annoncer l'usage.
  • Documentez les variables à remplir et les données qu'il ne faut pas transmettre.
  • Consignez les tests effectués et laissez le statut « en test » tant qu'ils ne sont pas exécutés.

Étape 4 — Contrôler et interpréter

Le résultat doit satisfaire l'objectif « Une fiche de bibliothèque réutilisable. ». Vérifiez les informations à partir du dossier initial, puis contrôlez la forme et la limite propre à la technique. Une réponse élégante mais comportant un fait inventé n'est pas acceptable.

Erreur fréquente : confondre une consigne de présentation avec une preuve de fiabilité. Une vérification indépendante reste nécessaire dès que la décision présente un enjeu.

📘 Revoir le cours : Organiser une bibliothèque de prompts