Bonnes pratiques de rédaction des notes de version

12

À la livraison de chaque version du logiciel, nous devons rédiger une note de version. Par exemple, voici quelques termes que j'ajoute lorsque j'écris une note de version:

  • Date de sortie
  • Bug résolu

Est-ce suffisant ou y a-t-il autre chose?

release CoolProgrammer
la source
Cela ressemble à un doublon de programmers.stackexchange.com/questions/66377/…
1
n'oubliez pas les fonctionnalités ajoutées
ratchet freak

Réponses:

21

Je pense que ce qui suit ouvrira la voie à de bonnes pratiques

// Date associée

  • Date de sortie

// Relatif aux fonctionnalités

  • Fonctionnalités ajoutées
  • En vedette Supprimé
  • Fonctionnalités modifiées

// Bogue lié

  • Bugs résolus
  • Bogues non résolus

// Lié à la dépendance

  • Liste des dépendances

// Tests liés

  • Résultats des tests unitaires
  • Résultats des tests d'acceptation

// Contrôle de version associé

  • Note de balise
  • Numéro de révision

Parfois, il vaut la peine de souligner les choses que l'utilisateur final peut vouloir changer dans ses configurations ou son flux de travail.

La plupart des utilisateurs finaux ne se soucient pas du résultat du test. Ils s'attendent à ce qu'il soit de haute qualité, peu importe ce que dit la note de version.

La chose la plus importante à propos des notes de publication est de savoir que chaque phrase supplémentaire perd encore 10% des lecteurs. Vous devez donc prioriser strictement ce que vos utilisateurs actuels doivent savoir sur la version.

Md Mahbubur Rahman
la source
1
il vaut aussi parfois la peine de souligner les choses que l'utilisateur final peut vouloir changer dans ses configurations ou son flux de travail
jk.
@jk. Oui, tu as raison. J'ai édité ma réponse comme votre bon commentaire.
Md Mahbubur Rahman
La plupart des utilisateurs finaux ne se soucient pas du résultat du test. Ils s'attendent à ce qu'il soit de haute qualité, peu importe ce que dit la note de version.
Henrik
Les notes de mise à jour de @Henrik peuvent être utiles pour des personnes autres que les utilisateurs finaux
jk.
5

La chose la plus importante à propos des notes de publication est de savoir que chaque phrase supplémentaire perd encore 10% des lecteurs. Vous devez donc prioriser strictement ce que vos utilisateurs actuels doivent savoir sur la version.

ddyer
la source
4
chaque ligne pourrait perdre 10% des lecteurs occasionnels, non intéressés (ou paresseux). Ces lecteurs sont ceux pour lesquels vos notes de version ne sont pas écrites. Ceux qui se soucient de ce que vous avez fait les liront tous et vous remercieront pour chaque ligne pertinente - il vous suffit de faire attention à inclure les peluches qui doivent vraiment entrer dans la documentation appropriée.
gbjbaanb