Notes de mise à jour

Date d’adoption : 
28 août 2020
Dernière mise à jour : 
2 novembre 2020

Les demandes de fusion doivent toujours s’accompagner d’une note de mise à jour, comprenant selon les besoins :

  • une description des problèmes connus;
  • la liste des fonctionnalités à venir;
  • un récapitulatif du travail en cours;
  • un récapitulatif du travail réalisé;
  • des liens de référence pour les problèmes corrigés;
  • des directives de déploiement.

Rédigez vos notes comme si elles étaient la seule forme de communication envoyée avec vos codes; assurez-vous qu’elles soient suffisamment claires pour que le destinataire puisse comprendre, valider, déployer, tester et évaluer votre travail.

Une note de mise à jour doit :

  • expliquer les codes livrés et leur fonctionnement;
  • expliquer comment installer et activer les codes;
  • signaler tout problème, obstacle ou bogue connu;
  • expliquer comment vérifier que tout fonctionne;
  • faire mention de tout autre commentaire ou point important.

Qui lit les notes de mise à jour?

Gardez en tête les différents destinataires de vos notes.

Services en ligne

Nous consultons les documents des demandes de fusion pour en comprendre le contenu et savoir à quoi nous attendre avec le déploiement.

Responsable de la revue des codes

La personne qui fera la revue aura besoin de ces notes pour saisir le contexte de vos codes. Elles l’aideront à comprendre les contraintes, la logique et les autres considérations qui s’appliquent à la mise en place des codes.

Responsable du déploiement

Les responsables du déploiement ont besoin des notes pour savoir comment activer le produit et confirmer qu’il fonctionne.

Responsable du service

Le responsable du service utilise les notes pour savoir quelles fonctionnalités analyser, tester ou prioriser. Elles lui permettent aussi de mieux comprendre la portée des fonctionnalités.