Quand l’utiliser

Publiez des notes de version à chaque version livrée, qu’il s’agisse d’une version majeure ou d’un petit correctif. Utilisateurs et administrateurs les lisent pour décider quand mettre à jour, et les équipes support les lisent pour répondre aux questions ensuite. Une copie PDF est utile aux clients qui ont besoin d’une documentation de version pour des audits, une validation de changement ou une archive hors ligne.

Ce qu’il contient

• Un titre avec un champ à remplir pour votre projet, suivi du numéro de version et de la date de publication.
• Les points forts, puis des listes séparées d’ajouts, d’améliorations et de corrections, dans l’ordre habituel d’un journal des modifications.
• Des notes de mise à jour numérotées, une section problèmes connus et une ligne de retours avec un champ à remplir pour votre e-mail.

Conseils pour un meilleur document

• Décrivez les corrections par le comportement que les utilisateurs verront désormais, pas par la cause interne. Ils se soucient du fait que les exports n’échouent plus, pas de savoir quelle fonction a été corrigée.
• Placez tout ce qui demande une action, comme une sauvegarde ou un changement de configuration, dans les notes de mise à jour et mentionnez-le aussi dans les points forts. Le style Technique garde les numéros de version et les commandes faciles à repérer.