Passer au contenu principal
Pour collecter et consulter des commentaires, vous devez d’abord activer la fonctionnalité depuis la page Modules complémentaires de votre Dashboard.
L’onglet Commentaires affiche le nombre de votes positifs et négatifs que vos docs ont reçus, ainsi que tout retour qualitatif fourni par les utilisateurs. Servez-vous de ces informations pour évaluer la qualité de vos docs et les améliorer. Accédez à l’onglet Commentaires en vous rendant sur la page Insights de votre Dashboard.

Types de feedback

Les feedbacks contextuels et sur les extraits de code sont en bêta. Pour les activer sur votre site de documentation, contactez notre équipe commerciale.
L’onglet Feedback affiche des informations selon les Modules complémentaires de feedback que vous avez activés. Activez vos types de feedback préférés :
Capture d’écran des interrupteurs de feedback dans la page Modules complémentaires.
  • Évaluation par pouces uniquement : Vote simple (pouce levé/baissé) pour mesurer la satisfaction générale des pages.
  • Feedback sur les extraits de code uniquement : Feedback spécifiquement sur les extraits de code.
  • Évaluation par pouces et feedback contextuel : Vote sur la page, plus commentaires détaillés et motifs des évaluations.
  • Évaluation par pouces et feedback sur les extraits de code : Vote sur la page, plus feedback sur les exemples de code.
  • Évaluation par pouces, contextuel et sur les extraits de code : Système de feedback complet avec vote sur la page, commentaires détaillés et feedback sur les extraits de code.

Gestion des retours

Pour les retours contextuels et sur des extraits de code, vous pouvez définir le statut d’un retour et ajouter des notes internes afin de suivre l’avancement de la résolution des retours des utilisateurs.

Modifier le statut des retours

Sélectionnez le statut à côté d’un retour pour le marquer comme En attente, En cours, Résolu ou Rejeté. Bonnes pratiques pour la définition des statuts des retours :
  • En attente : le retour est en attente de revue.
  • En cours : le retour a été validé et est en cours de traitement.
  • Résolu : le retour a été résolu.
  • Rejeté : le retour a été écarté car non exploitable, non pertinent ou inexact.

Filtrer par statut

Utilisez le filtre de statut pour contrôler les commentaires affichés. Supprimez un statut pour masquer tous les commentaires ayant ce statut. Par défaut, tous les commentaires sont affichés.

Ajout de notes internes

Cliquez sur un commentaire pour ajouter une note interne. Ces notes ne sont visibles que par les personnes ayant accès à votre Dashboard. Utilisez les notes pour fournir des informations destinées à la collaboration, associer des tickets de support ou d’ingénierie pertinents, ou consigner toute autre information utile.

Exploiter les données de retours

Passez en revue vos données de retours pour :
  • Identifier le contenu efficace : Les pages qui reçoivent le plus d’avis positifs montrent ce qui fonctionne bien dans votre documentation.
    • Prioriser les améliorations : Les pages qui reçoivent le plus d’avis négatifs indiquent quels contenus nécessitent une attention particulière.
    • Passer à l’action : Mettez à jour la documentation sur la base des retours directs des utilisateurs.
I