Changelog

Introduction

Une changelog ("journal des modifications" en français) a pour objectif de présenter les modifications réalisées sur un produit en indiquant une date de publication accompagnée d'une documentation.

Suivant vos méthodes de gestion de projet et vos choix de communication, les changelogs peuvent contenir plus ou moins de détail.

L'idée dernière cet outil est d'améliorer la communication entre les équipes internes et les utilisateurs finaux impactés par les modifications. Donner de la visibilité sur les changements réalisés permet d'apporter des explications pour faciliter la prise en main des évolutions par les utilisateurs. C'est également un moyen d'améliorer les retours que ces derniers pourraient vous remonter et diminuer le temps à passer sur le support utilisateur.

Organisation des données

L'objectif de ce module est de vous permettre de créer plusieurs pages de changelogs pour les adapter aux besoins de vos utilisateurs.

Ainsi, nous avons fait le choix de créer une base centrale des éléments de changelog que vous pourrez utiliser dans un ou plusieurs changelogs.

Changelog

Une changelog correspond à la page changelog qui sera le contenant des éléments de changelog correspondants.

Pour chaque roadmap, vous pouvez définir :

• un nom qui sera repris comme titre de la page
• une description visible par l'utilisateur
• un filtre enregistré qui vous permet de limiter les éléments affichés
• une visibilité qui vous permettra prochainement de définir des roadmaps privées
• un slug pour paramétrer l'url d'accès

Élément de changelog

Vos mises à jour sont représentées par des éléments de changelog.

Vous avez la possibilité de leur définir :

• un titre
• une date de publication
• une liste de labels

Comment organiser vos changelogs

Pour qu'un changelog soit facilement utilisable par un utilisateur, il faut que ce dernier trouve facilement des informations pertinentes et utiles pour lui.

Pour les projets les plus simples, un changelog unique peut être suffisante.

Dans le cas de projets plus complexes où les utilisateurs n'utilisent que certaines parties de l'outil, un changelog unique pourrait contenir trop d'informations et il peut être judicieux d'en créer un pour chaque partie.

Dans certains cas, les mises à jour ne sont pas toutes du même type. Prenons l'exemple d'un outil qui intègre une bibliothèque de matériaux. L'ajout d'un nouveau matériau est différent du développement d'évolutions techniques.

Dernier cas de figure, si votre projet comporte plusieurs types d'utilisateurs n'ayant pas accès aux mêmes fonctionnalités, il peut être judicieux de proposer des changelogs par type de profils.

C'est pour ces cas d'usage que vous avez la possibilité de paramétrer des labels différents sur vos éléments et d'associer un filtre enregistré à vos changelog.

Comme vous pouvez le voir, l'outil roadmap de SmartPlatform a été prévu pour s'adapter à votre contexte pour vous apporter un maximum de flexibilité.