Avec le module Projets
Lier les rapports du module Rétroaction aux fiches de la feuille de route du module Projets, prévenir leurs auteurs quand une fiche avance, et ce qui reste en phase entre les deux modules.
Un rapport dit ce qu'une personne a vu. Une fiche du module Projets dit ce que l'équipe va faire. Avec les deux modules, l'équipe lit chaque rapport dans une fiche : « Export CSV », « Export Excel » et « Télécharger toutes mes factures » deviennent une seule fiche, « Export des factures », avec trois rapports. Les auteurs suivent la fiche sans rien faire de plus.
Les deux modules ne s'importent pas : ils passent par le registre @fraza/core/integrations. Chacun fonctionne seul. Chaque intégration déclare un numéro de contrat, contract : un module dont le partenaire déclare un autre contrat l'ignore, comme s'il était absent, avec un avertissement unique dans le journal. Mettre alors les deux modules à jour. Voir API, et le même lien vu du côté de Projets dans Avec le module Rétroaction.
| Sans Projets | Avec Projets | |
|---|---|---|
| Projets | Ceux de la rétroaction, gérés dans ses Options. | Ceux de Projets, gérés dans Projets. |
| Boîte de réception | Trier, répondre, fermer. | La même, avec l'onglet « Liés » et la fiche de chaque rapport. |
| Page d'un rapport | Pas de bloc Fiche. | Le bloc « Fiche de la feuille de route », et Lier à une fiche. |
| Courriels à l'auteur | L'accusé de réception et les réponses. | Aussi ceux de la fiche, envoyés par Projets. |
| Formulaire | Après l'envoi, il ne mène qu'au suivi. | Pendant la saisie, il montre les fiches proches. Après l'envoi, il propose aussi la feuille de route. |
| Conservation | Compte depuis la fermeture. | Pour un rapport lié, depuis la fin de sa fiche. |
Mettre en place
- Installer et activer le module Projets. Voir Projets.
- Créer les projets dans l'admin de Projets. Voir Administration de Projets.
Il n'y a rien à choisir dans les options de la rétroaction : chaque projet de Projets a son projet dans la rétroaction, dont les rapports se lient à ses fiches.
Les projets viennent de Projets
Avec le module Projets, ses projets sont la seule liste. La rétroaction garde un projet à elle par projet de Projets, son reflet, pour ce qui lui appartient : les rapports, leurs étiquettes et l'adresse du formulaire.
| Dans Projets | Dans la rétroaction |
|---|---|
| Slug | Le même, sauf s'il est déjà pris par un autre projet de la rétroaction : un suffixe le rend unique. nouveau et suivi deviennent nouveau-projet et suivi-projet. Le slug ne change plus ensuite. |
| Nom | Le même, repris à chaque changement. |
| Visibilité | La même. Un projet interne n'a pas de formulaire public. |
| Archivage | Le même, sauf pour le projet principal. Un projet archivé garde ses rapports, mais n'a plus de formulaire public et la feuille de route ne propose plus le sien. |
| Projet mis en avant | Le projet principal de la rétroaction, celui de /za/feedback/nouveau. Il n'est jamais archivé : quand son projet de Projets l'est, il reste ouvert jusqu'à ce qu'un autre projet soit mis en avant. Archiver le projet mis en avant dans Projets en met un autre en avant, et le projet principal le suit. |
La première fois qu'un projet de Projets est reflété, un projet de la rétroaction qui a le même slug et ne nomme encore aucun projet de Projets devient son reflet : ses rapports restent où ils sont. Sinon, un nouveau projet est créé, à la fin de la liste.
Les projets se créent, se renomment, changent de visibilité et s'archivent dans Projets. Dans la rétroaction :
- les Options ne montrent pas la carte Projets, sauf pour les projets qui ne reprennent aucun projet de Projets. Voir plus bas ;
- le sélecteur de projet ne propose pas Nouveau projet ;
- les routes qui créent ou réordonnent un projet répondent 409 avec le code
projects_managed, comme celles qui modifient ou suppriment un projet qui reprend un projet de Projets. Voir API.
Projets prévient la rétroaction de chaque enregistrement et de chaque suppression d'un projet. La tâche feedback-retention relit aussi toute la liste de Projets chaque heure, ce qui rattrape un enregistrement ou une suppression manqués. Juste après l'installation de Projets, quand aucun projet n'est encore repris, la liste des projets de l'admin la relit une fois, sans attendre la tâche. Un projet archivé qui n'a aucun rapport n'apparaît pas dans le sélecteur.
Un projet supprimé dans Projets emporte son reflet s'il n'a aucun rapport. Sinon, le reflet reste, archivé, et ne nomme plus aucun projet de Projets : aucun rapport n'est perdu. Le projet principal n'est jamais supprimé ni archivé ainsi.
Un projet de la rétroaction qui ne reflète aucun projet de Projets, par exemple un projet créé avant l'installation de Projets sous un slug que Projets n'a pas, reste dans la liste avec ses rapports. Ses rapports ne se lient à aucune fiche. Les Options le listent dans la carte « Projets sans équivalent dans Projets », où il se renomme, change de visibilité et, une fois vide, se supprime : déplacer ses rapports vers un autre projet, puis le supprimer. Le projet principal n'y paraît jamais.
Sans le module Projets, rien de cela ne s'applique : les projets de la rétroaction se gèrent dans ses Options. Voir Configuration.
Lier un rapport à une fiche
Sur la page d'un rapport, le bloc Fiche de la feuille de route prend un de trois états.
| État | Ce qu'il montre |
|---|---|
| Lié | Le titre de la fiche, qui mène à sa page dans l'admin de Projets, sa colonne, et le badge « Interne » si le site ne la montre pas. Changer la remplace, Détacher retire le rapport de la fiche : un rapport lié retourne dans la boîte de réception, un rapport fermé le reste. |
| Pas encore lié | Lier à une fiche. |
| Projet sans feuille de route | Le projet du rapport ne reflète aucun projet de Projets : aucune fiche à proposer. Lier le rapport est refusé avec le code projects_unset : le déplacer d'abord vers un projet qui en reflète un. |
Lier à une fiche ouvre une fenêtre :
- Une fiche existante : les fiches ouvertes du projet de Projets, hors des colonnes terminées, chacune avec sa colonne et la mention « interne » s'il y a lieu ;
- Une nouvelle fiche : son titre reprend celui du rapport et se modifie. Elle commence dans la colonne par défaut du projet de Projets, créée au nom de la personne connectée. Elle prend le type du rapport : un bug devient un bug, une idée une idée, une question une tâche.
Le rapport passe à « Lié » et quitte l'onglet « Nouveaux ». Un rapport fermé que l'on lie se rouvre, sans courriel « Message rouvert » à son auteur, et quitte son original s'il était un doublon. Un rapport ne se lie qu'à une fiche du projet de Projets que nomme son projet.
Un rapport marqué « Touche à la sécurité » ne se lie qu'à une fiche interne. Une nouvelle fiche créée depuis lui est interne, et la fiche ne peut plus devenir publique tant qu'il y est lié. Voir Un rapport qui touche à la sécurité.
Dans l'admin de Projets
La page d'une fiche montre ses rapports liés, avec leur type et leur statut, chacun menant à sa page dans la Rétroaction. Il faut feedback.view pour les lire. Chaque fiche du tableau porte son nombre de rapports. Voir Administration de Projets.
Prévenir les auteurs
Le module Projets envoie les courriels d'une fiche : quand elle entre dans une colonne qui prévient, et quand l'équipe publie une mise à jour en cochant la case qui l'envoie. Il les adresse aux comptes qui ont voté, et ce module lui ajoute les auteurs des rapports liés. Chaque adresse reçoit le courriel une fois.
L'auteur d'un rapport n'est pas prévenu quand :
- le rapport touche à la sécurité : l'équipe lui répond directement ;
- la conservation a effacé ses données ;
- il n'a laissé aucune adresse, ni compte.
L'adresse d'un compte est lue au moment de l'envoi. Le contenu de ces courriels et leurs règles sont décrits dans Administration de Projets.
Côté site
- La feuille de route publique d'un projet de Projets propose le formulaire de son projet dans la rétroaction, si celui-ci est public et pas archivé.
- Le slug du formulaire d'un projet peut différer de celui du projet de Projets : un projet de la rétroaction portait déjà ce slug, ou le slug est réservé (
nouveau,suivi). Un site qui construit sa feuille de route lit ce chemin avecgetPublicProjectLinksde Projets, jamais en le recomposant. Voir Intégrer au site de Projets. - Le dernier écran du formulaire propose Voir la feuille de route, et l'espace client Feuille de route, quand cette feuille de route est publique. Sur un site sans comptes clients, seul le premier existe.
- Le suivi d'un rapport et l'espace client montrent la fiche, sa colonne et un lien vers sa page publique, quand elle en a une. Pour une fiche interne, ils ne montrent ni son titre ni sa colonne : « Ce message est pris en charge par l'équipe : En traitement. », ou « Terminé ».
Voir Pages publiques de Projets.
Ce qui reste en phase
| Dans Projets | Effet sur les rapports |
|---|---|
| Une fiche change de projet | Ses rapports suivent vers le projet de la rétroaction qui nomme le nouveau, et perdent leur étiquette s'ils changent de projet. Si aucun ne le nomme, ils restent où ils sont, quittent la fiche et redeviennent « Nouveau ». |
| Une fiche est supprimée | Ses rapports la quittent. Un rapport lié retourne dans la boîte de réception, un rapport fermé le reste. |
| Un projet est créé ou modifié | Son projet dans la rétroaction suit : nom, visibilité, archivage, projet principal. |
| Un projet est supprimé | Son projet dans la rétroaction est supprimé s'il n'a aucun rapport, sinon archivé et détaché. |
| Une fiche devient publique | Refusé tant qu'un rapport de sécurité y est lié. |
| Une fiche disparaît sans que la rétroaction en soit prévenue | La tâche feedback-retention retire ses rapports de la fiche à son passage suivant, dans l'heure. Un rapport lié retourne dans la boîte de réception, un rapport fermé le reste. |
Dans l'autre sens, un rapport déplacé vers un autre projet de la rétroaction quitte sa fiche, qui reste où elle est.
Conservation
Un rapport lié est terminé quand sa fiche entre dans une colonne terminée. Le délai de FRAZA_MODULE_FEEDBACK_RETENTION_DAYS part de ce moment. Voir Conservation.
Retirer le module Projets
Les rapports gardent leur lien en base, sans clé étrangère. Lier à une fiche disparaît. La page d'un rapport encore lié montre une carte « Fiche de la feuille de route » qui dit que le module Projets n'est plus actif, avec Détacher : le rapport quitte la fiche, et retourne dans la boîte de réception s'il n'est pas fermé.
La conservation ne touche plus aux rapports liés : l'état de leur fiche ne se lit plus. Les fermer pour que le délai parte de leur fermeture, ou les détacher pour les trier de nouveau.
Les projets repris de Projets restent dans la liste et servent comme avant. Ce sont alors des projets ordinaires de la rétroaction, gérés dans ses Options. Réinstaller Projets les reprend : chacun nomme encore son projet de Projets.
Déjà sur la feuille de route ?
Pendant qu'on tape la phrase d'un bug ou d'une idée, le formulaire montre les fiches publiques de la feuille de route qui partagent des mots avec elle, trois au plus. Chacune mène à sa fiche : un vote vaut mieux qu'un doublon dans la boîte de réception.
- La recherche est celle du français : « factures » trouve « facture », et les petits mots (« le », « de », « mes ») ne comptent pas. Un mot en commun suffit, la fiche la plus proche vient d'abord, puis la plus votée.
- Seules comptent les fiches que la feuille de route publique montre, dans le projet de Projets que le projet du formulaire nomme.
- Le formulaire attend une courte pause de la frappe, à partir de quatre caractères. Une question n'en montre pas.
- La fonction vient de l'intégration
projects(similarItems). Avec une version de Projets qui ne l'a pas, le formulaire n'en montre pas et fonctionne comme avant.