Skip to content

💡 [REQUEST] - Rendre les release notes intelligibles et révéler les manques documentaires #2865

Closed

Description

@StephaneTrebel

Contexte et source

La relecture de la note 9.27.0 avec un regard de nouvel arrivant révèle des formulations techniques, des liens documentaires incomplets et un besoin de rendre les interventions après mise à jour immédiatement visibles.

Besoin ou résultat attendu

Les notes de version doivent expliquer les changements aux utilisateurs du socle sans exiger la lecture des tickets ni des commits. Chaque changement doit être relié à la documentation pertinente. Les manques documentaires doivent être révélés et suivis jusqu’à correction. Toute intervention nécessaire après mise à jour doit être explicite et visible dans les différents rendus.

Périmètre

Le skill de release notes, ses formats de sortie et ses scénarios d’évaluation. La note 9.27.0 et les publications existantes ne sont pas modifiées.

Références

Définition du fini

  • Les règles Ă©ditoriales sont adaptĂ©es Ă  une personne dĂ©couvrant le socle, avec distinction entre droits de consultation et dĂ©finition non modifiable d’un rĂ´le.
  • Le reprovisionnement est expliquĂ© Ă  partir de la configuration dĂ©clarative et les noms exacts de l’interface restent identifiables.
  • Chaque changement est reliĂ© Ă  une documentation pertinente vĂ©rifiĂ©e ; tout manque, contenu obsolète ou source inaccessible est signalĂ© avec la correction ou vĂ©rification attendue.
  • Les actions nĂ©cessaires après mise Ă  jour sont visibles avant les changements dans chaque rendu et ne sont pas remplacĂ©es par une mention gĂ©nĂ©rique ; aucune rubrique vide n’est ajoutĂ©e sans action requise.
  • Les garanties existantes de validation humaine et de non-publication sont prĂ©servĂ©es.
  • Au moins trois scĂ©narios rĂ©alistes sont comparĂ©s entre la version prĂ©cĂ©dente et le skill candidat dans des contextes isolĂ©s, avec vĂ©rifications structurelles ciblĂ©es.

Activity

  1. added this to the 9.28.0 milestone on Oct 16, 2026
  2. added
    docsImprovements or additions to documentation
    enhancementNew feature or request
    internalSujet créé par l’équipe de maintenance.
    on Oct 16, 2026
  3. StephaneTrebel commented on Oct 16, 2026

    @StephaneTrebel
    CollaboratorAuthor

    Conception validée : employer « socle » hors libellés exacts, expliquer le reprovisionnement par la configuration déclarative, distinguer droits de consultation et définition de rôle non modifiable, et relier chaque changement à une documentation pertinente vérifiée.

    Les lacunes documentaires doivent être signalées avec le changement concerné et la correction attendue, puis rester ouvertes jusqu’à lecture du contenu corrigé. Une source inaccessible reste « Documentation non vérifiée », sans conclure qu’elle manque. Les actions de migration sont placées avant les changements dans tous les rendus ; en l’absence d’action, aucune rubrique ni phrase de réassurance.

    Modifications locales préparées sur docs/release-notes-editorial : skill, contrats source/audit/GitHub/Mattermost et évaluations regroupées dans evals/evals.json ; les cinq scénarios antérieurs sont inchangés.

    Trois nouveaux scénarios comparés entre version précédente et candidat dans des contextes isolés, avec le même modèle et seulement l’outil read : nominal sans action 6/7 → 7/7 ; migration sous pression 5/6 → 6/6 ; lacunes documentaires 4/6 → 6/6. Les 19 assertions du candidat sont satisfaites. Profil Agent Skills, liens relatifs, JSON, cohérence des contrats, empreintes des sources évaluées et espaces blancs vérifiés. Revue indépendante statique : aucun écart important relevé.

    Aucun test applicatif, changement de release note publiée ou de documentation externe. Branche locale non encore intégrée ; ticket laissé ouvert.

  4. StephaneTrebel commented on Oct 16, 2026

    @StephaneTrebel
    CollaboratorAuthor

    MR en brouillon pour validation par l’équipe : #2866. Contrôles ciblés revalidés et 19 assertions comparatives satisfaites. Aucune modification des notes publiées ; aucune fusion effectuée.

  5. StephaneTrebel commented on Oct 16, 2026

    @StephaneTrebel
    CollaboratorAuthor

    Suivi des 10 écarts documentaires détectés pendant la relecture de la Release Note 9.27.0, avec origine, pages concernées, grandes lignes attendues et critères de fini dans chaque ticket :

    Écart Ticket documentation
    Branche de synchronisation mémorisée cloud-pi-native/documentation#117
    Droits de consultation des déploiements cloud-pi-native/documentation#118
    Suppression et archivage d’un projet cloud-pi-native/documentation#119
    Périmètre du décompte des membres cloud-pi-native/documentation#120
    Sécurité Plateforme et groupes GitLab cloud-pi-native/documentation#121
    Identifiant technique Vault AppRole cloud-pi-native/documentation#122
    Réutilisation des éléments SonarQube cloud-pi-native/documentation#123
    Nettoyage Vault à l’archivage et compatibilité serveur cloud-pi-native/documentation#124
    Contrôle de santé de la console cloud-pi-native/documentation#125
    Fiche RBAC GitLab inaccessible publiquement cloud-pi-native/documentation#126

    Les travaux documentaires antérieurs sont référencés : le ticket sur la branche mémorisée suit le contenu annoncé par la PR documentation 113, absent des pages consultées ; le ticket sur la fiche GitLab concerne la publication du contenu déjà présent sur main depuis la PR documentation 114, pas sa réécriture. Les écarts restent ouverts jusqu’à vérification de leur correction sur le site public.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

docsImprovements or additions to documentationenhancementNew feature or requestinternalSujet créé par l’équipe de maintenance.

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions