Réflexion sur les versions

[RochDLY]

La fonctionnalité de version des documents dans Stylo fait l'objet de discussions depuis plusieurs mois / semaines, que ce soit suite à des problèmes liés à la sauvegarde des écrits dans le mode collaboratif ou dans des discussions liées à d'autres fonctionnalités de Stylo (par exemple la refonte des interface d'écriture), ou encore lors d'entretiens menée auprès des utilisateurs.

À la fois non utilisée car non comprise ou parce qu'elle n'est pas présente dans certaines parties de l'interface (éditeur collaboratif), la version est une des fonctionnalités peu utilisées dans Stylo.
En ce sens, nous amorçons une réflexion sur cette fonctionnalité, à travers de nouvelles idées ou formes d'implémentation de ce concept pour Stylo.

Qu'est-ce qu'une version dans Stylo ? Actuellement, il s'agit d'une archive de la copie de travail créée à un instant donné, grâce à une action réalisée par un utilisateur (déclaration de création d'une version par le clic sur le bouton correspondant).

Les échanges et discussions autour de cette notion de version interviennent suite aux constats présentés, mais aussi suite à différents chantiers engagés dans Stylo: #1101, #1131, #1278, #1274, #1370, etc.

Les derniers échanges à ce sujet seront postés dans ce fil. Ils sont relatif à l'implémentation de la fonctionnalité des versions dans le mode d'écriture collaboratif.

@ggrossetie: 

Quel est votre avis sur quelque chose comme ça : 

@maiwann: 

Quand est-ce que cela arriverai ?

@gromettoclara :

ouah c'est vraiment bien

@ggrossetie :

Quand il y a des changements par rapport à la copie de travail qu'on a récupéré. Mon idée c'était d'enregistrer en mémoire (dans le navigateur) la copie de travail et d'actualiser ces stats en fonction des événements (un utilisateur se connecte, un utilisateur supprime/ajoute quelque chose, etc...).
À noter que les utilisateurs n'auront pas les mêmes stats car cela dépend du moment où ils arrivent dans la "session". En gros c'est les changements qui ont eu lieu à partir du moment où je me connecte.
L'idée étant d'inciter à créer une version 🙃

@gromettoclara :

Je ne sais pas si c'est possible mais ce serait pas plus pertinent que tout le monde ait les mêmes stats ?

@thom4parisot :

Ces stats ne peuvent pas être compilées côté serveur et envoyées aux utilisateurs ? Ça me semble louche de donner des infos différentes en référence à une même chose (editing session).
Est-ce qu'on sait déjà si c'est ce genre d'info qui permet de mieux comprendre les versions ? Ou bien les entretiens de Maïtané pointent dans d'autres directions, en terme de ce qui aiderait à utiliser/comprendre les versions ?

@ggrossetie :

si on a une vraie notion de "session" c'est possible mais si il n'y a pas de session ça devient compliqué
et d'après ce que j'ai compris on ne voulait plus avoir de notion de session avec une action permettant de la démarrer et de l'arrêter
peut être que supprimer cette notion ça complique les choses et qu'il faut plutôt travailler à comment faire pour qu'une session se termine ?

[gromettoclara]

Pour contexte et perspective :

"et d'après ce que j'ai compris on ne voulait plus avoir de notion de session avec une action permettant de la démarrer et de l'arrêter"

On touche à la question de la transparence du processus de versioning pour l'utilisateur : est-ce qu'on veut continuer à enregistrer l'état après chaque session d'édition, au risque que l'accumulation de ces versions très "faibles" n'aient pas de sens et écrasent les "versions fortes" qui résultent de l'action consciente de l'utilisateur (plus pertinentes si bien utilisées) ?

"peut être que supprimer cette notion ça complique les choses et qu'il faut plutôt travailler à comment faire pour qu'une session se termine"

Certes enregistrer automatiquement la session c'est "pratique" pas besoin de penser à réaliser l'action consciente d'enregistrer une version, presque tous les états du texte sont accessibles... Cependant même la notion de session d'édition n'est pas très claire pour les utilisateurs... Je me trompe @maiwann ?

Pour résumer je pense que c'est une position forte mais risquée de supprimer la notion de session... J'y adhère parce que je pense qu'on pourrait arriver à qqc de plus statisfaisant que "j'en étais là tel jour" mais j'entends aussi les arguments contre.

[thom4parisot]

J'aurais tendance à résoudre le problème des versions avant d'aller vers une solution d'affichage de diff dans les sessions collaboratives (sinon on se retrouve bloqué sur un détail en bout de chaîne).

[gromettoclara]

dans l'idée ce sera très lié car on se dirige vers la réunion des deux interfaces ... non ??

[thom4parisot]

C'est ce que je qualifierais de bikeshedding : on se focalise sur un détail qui fait passer à côté du problème principal (c'est un classique dans la gestion de Stylo). J'ai reformulé le commentaire précédent.

[ggrossetie]

J'ai utilisé la terminologie "Session d'édition" mais effectivement ce n'est pas lié aux sessions collaboratives. Et si on va un peu plus loin, on ne veut plus de session et l'édition collaborative et non collaborative ne font plus qu'un.

On a souligné l'importance de capturer les changements (afin d'avoir un historique) mais aussi que les versions ne sont pas/peu utilisées. Cette proposition s'inscrit dans ce contexte.

[lakonis]

Merci @RochDLY pour le récap, et @ggrossetie pour la proposition.

J'ai tendance à dire que les versions à la Stylo (commit style) sont une vraie plus-value par rapport aux pratiques du type "mon-article-v2-final.docx", ou à ce que propose gg Doc ou même Hedgedoc en terme de versionning, c'est-à-dire un historique non identifié et difficile à naviguer.

Donc essayons d'encourager la pratique de versionning déclaratif ou documenté. Pour cela, je trouve la proposition de @ggrossetie super intéressante, car les données chiffrées/colorées visibilisent les modifications et deviennent une incitation forte à déclarer ce qui a été fait.

Je lance une idée de fonctionnalités ici car c'est en lien avec notre discussion, même si ca pourrait faire l'objet d'une autre discussion/issue : Dans le mode édition, on pourrait proposer un mode "avec suivi de modification" qui présenterait toutes les modifications, et qui revient exactement je crois à la comparaison entre version de travail et version précédente. Mais en l'appelant "suivi de modification", on amplifie la visibilisation des modifs (en plus des données chiffrées de @ggrossetie) et on incite d'autant plus à créer une version.

Du coup je comprends mieux l'intérêt du label "capture changes in a version".

[RochDLY]

Petite question/idée sur une tension que j'ai perçu dans des discussions précédentes entre sauvegarde automatique de session (lorsque la session est fermée) et version déclarée par les usagers.

Est-ce que les sauvegardes des "sessions d'écriture" ne pourraient-elles pas exister que jusqu'au moment où une version est créée ?

Exemple: Je rédige l'introduction d'un article et j'attends qu'une première ébauche de cette introduction soit réalisée pour versionner (ce qui fait sens d'un point de vue écriture/édition). Le truc c'est que ma rédaction est fragmentée en plusieurs phases d'écriture (disons 4), que j'étale sur une journée ou deux. Chacun de ces moments fait donc l'objet d'une sauvegarde automatique.

À la fin de la rédaction de l'introduction, je crée une version mineure et je me retrouve avec un historique composé de 5 éléments.

Est-ce que ce serait envisageable de supprimer les 4 sauvegardes et ne garder que la version (est-ce qu'elle contiendrait toutes les modifications des sauvegardes + version ?)

Est-ce que ce fonctionnement n'encouragerait pas à versionner régulièrement pour éviter de se retrouver avec des versions obèses?

Après ce détour, je reboucle sur ta proposition @ggrossetie : serait-il intéressant que le compteur des modifications ne concerne pas la session (ou les modifs effectuées sur la dernière copie de travail), mais les modifications réalisées depuis la dernière version déclarée ? (en accumulant les modifs des sauvegardes entre les versions)

[lakonis]

En effet. De mon côté, j'ai une autre pratique. Je versionne beaucoup, et je ne suis pas inquiet d'avoir 60 versions. Dans un mode collaboratif ou éditorial, c'est plutôt utile.
Je suis d'accord avec toi, ca serait une chouette fonctionnalité, mais je crains qu'elle introduise une nouvelle complexité, de développement déjà, mais aussi d'usage, là où l'usage de base n'est pas bien compris encore.
Ca demanderait aussi une certaine négociation de droits. Est-ce que je peux écraser les versions des autres dans une nouvelle version dont je serais l'auteur ?
Peut-être que l'on pourrait plutôt exploiter l'idée des mineures et majeures et proposer une visualisation arborescente et dépliable de ces versions : j'affiche les majeures par défaut, je peux déplier sur les mineures si j'ai besoin. Qu'en penses-tu ?

[RochDLY]

Je ne suis pas inquiet non plus du nombre de versions, je parle vraiment d'écraser les "sauvegardes" générées justement lorsqu'un utilisateur quitte une session sans avoir versionné.
L'idée est de donner plus d'importance à la version (quitte en a avoir 60) plutôt qu'à la sauvegarde, qui est un comportement qu'on a initialement introduit pour répondre au fonctionnement de la session collaborative.
Si, à l'avenir, la session collaborative == session solo (et qu'on change tout un tas de bidules, de trucmuches et tutti quanti), la sauvegarde n'aura plus vraiment d'intérêt à part de gonfler la base de données.

[RochDLY]

Oui pour l'exploitation des mineures et des majeures !

[RochDLY]

@lakonis je parle de ces choses là: "Editing session ended last year"

[lakonis]

Ok, je comprends mieux en effet. Donc on conserverait les sauvegardes, mais dès qu'une version est créée, les sauvegardes successives seraient squashed dans la version. Effectivement ça a du sens. Mais il y a le risque de faire plusieurs sessions en mars. Puis revenir en mai pour travailler autre chose. Et à la création de version suivante, tout le travail de mars à mai serait rassemblé dans une seule version.
je trouve que, dans le versionning, la marque du temps est assez essentielle. J'aurais presque envie de conserver l'historique des sauvegardes à l'intérieur des versions déclarées (comme des majeures/mineures), pour faire un entre-deux.

[ggrossetie]

Désolé d'avoir remis une pièce dans la machine mais ce n'est pas encore très clair pour moi 😓
J'ai l'impression qu'il y a une attente forte sur le fait de conserver un historique, ce qui est un peu paradoxal car dans les entretiens utilisateurs assez peu de personnes utilisent les versions. J'ai aussi l'impression que le fait d'avoir un éditeur unique et ouvert à la collaboration renforce ce besoin d'avoir un historique.