Rétroaction
Rapports de bugs, idées et questions envoyés par un formulaire d'un seul écran, boîte de tri dans l'admin, réponses par courriel et page de suivi. Avec le module Projets, les rapports se lient aux fiches de sa feuille de route.
@fraza-pro/module-feedback donne aux visiteurs d'un site un moyen simple de signaler un bug, de proposer une idée ou de poser une question. L'équipe trie ce qui arrive dans l'admin, répond à l'auteur par courriel, garde ses notes et ferme le rapport. L'auteur suit la suite sur une page de suivi, ou dans son espace client quand il l'a envoyé depuis un compte client.
npm i @fraza-pro/module-feedback| Paquet | @fraza-pro/module-feedback |
|---|---|
| Licence | Fraza Pro. Voir Licence et propriété. |
| Registre | https://registry.fraza.ca/, avec la clé du projet. Voir Modules Pro. |
| Activation | FRAZA_MODULE_FEEDBACK=true |
| Module facultatif | @fraza-pro/module-projects, pour lier les rapports aux fiches d'une feuille de route. |
Un rapport
Un rapport, c'est ce qu'une personne envoie : « Le bouton Payer ne répond pas sur iPhone ». Il a un type : bug, idée ou question. Il reste privé : seuls l'équipe et son auteur le voient.
Un rapport est nouveau tant que l'équipe ne l'a pas traité. Elle lui répond, le classe avec une étiquette, puis le ferme avec une raison : réglé, doublon, pas retenu ou indésirable. Son auteur peut répondre depuis sa page de suivi tant qu'il est ouvert, et reçoit un courriel quand il est fermé ou rouvert.
Avec le module Projets
La feuille de route publique, ses fiches, ses votes et ses courriels d'avancement appartiennent au module Projets. Les deux modules se complètent sans s'importer l'un l'autre.
- Sans Projets, la boîte de réception trie, répond et ferme. Un rapport ne se lie à aucune fiche.
- Avec Projets, ses projets sont la seule liste : la rétroaction garde un projet à elle par projet de Projets, et ses rapports sont lus dans ce projet. Un rapport se lie alors à une fiche : plusieurs rapports peuvent mener à la même. Son auteur est prévenu quand la fiche avance, et la feuille de route propose le formulaire.
Voir Avec le module Projets.
Projets de la rétroaction
Un site commence avec un seul projet, « Principal », et n'en voit pas la notion : l'admin ne montre aucun sélecteur, et ni les pages ni les notifications ne nomment ce projet. Le deuxième se crée dans la carte Projets des Options. Dès lors, chaque projet a sa boîte de réception, son formulaire et ses étiquettes, et un sélecteur en haut à droite des pages d'admin choisit le projet sur lequel travailler. Voir Configuration.
Ces projets sont ceux de la rétroaction, dans la table fraza_feedback_project. Avec le module Projets, ils reflètent les siens : chaque projet de Projets a son projet dans la rétroaction, qui garde ses rapports, ses étiquettes et l'adresse de son formulaire. Les projets se créent, se renomment et s'archivent alors dans Projets. Voir Avec le module Projets.
Pages de cette section
| Page | Contenu |
|---|---|
| Installation | Installer le module, créer les tables, recevoir un premier rapport. |
| Configuration | Variables d'environnement, permissions, entrée d'admin, tâche planifiée. |
| Administration | La boîte de réception, la page d'un rapport, les options. |
| Pages publiques | Le formulaire, le suivi, l'espace client, les courriels. |
| Modèle de données | Les tables fraza_feedback_*, les migrations et la conservation des données. |
| API | Routes HTTP, l'intégration feedback et les fonctions importables. |
| Intégrer au site | Construire le formulaire et le suivi dans le design du site. |
| Avec le module Projets | Lier les rapports aux fiches d'une feuille de route. |
Ce que le module apporte
| Partie | Détail |
|---|---|
| Tables | fraza_feedback_project, _report, _message, _attachment, _tag, _storage_deletion. |
| Admin | Une section « Rétroaction » : Boîte de réception, page d'un rapport, Options (projets et étiquettes ; avec Projets, les étiquettes et les projets sans équivalent dans Projets). |
| Pages publiques | /za/feedback/nouveau (formulaire) et /za/feedback/suivi/<jeton> (suivi). Avec plusieurs projets, les autres projets ajoutent leur slug : /za/feedback/<projet>/nouveau. |
| Espace client | Une section « Rétroaction » sous /compte/retroaction, visible pour un compte client qui a envoyé un rapport. Aucune section sur un site sans comptes clients (sans FRAZA_CLIENTS=true). Voir Le site, l'espace client et l'admin. |
| Courriels | L'accusé de réception, la réponse de l'équipe, la fermeture et la réouverture d'un rapport. Les courriels d'une fiche sont ceux du module Projets. |
| Notifications | Un nouveau rapport, ou un message de son auteur, arrive dans la cloche de l'admin des personnes qui ont feedback.manage. |
| Tâche planifiée | feedback-retention, chaque heure : remet à jour les projets repris de Projets, renvoie dans la boîte de réception les rapports dont la fiche n'existe plus, efface les données personnelles des rapports terminés, jamais traités ou indésirables, et retire du stockage les captures supprimées. |
| Intégration | feedback, publiée pour le module Projets. Voir API. |