Ajoutez Google Analytics aux documentations HTML pour suivre les pages vues

Google Analytics (GA) est un service gratuit offert par Google qui peut collecter des informations anonymes sur les utilisateurs d’un site web, telles que les pages vues et durant combien de temps. Il peut générer de nombreux rapports détaillés sur le comportement de ces utilisateurs et est un outil clé pour comprendre les besoins et attentes de l’audience de tout matériel en ligne. L’intégration de Google Analytics dans la documentation HTML est très utile pour connaitre précisément ce que les visiteurs recherchent et peut être accomplie facilement avec le système de modèles de HelpNDoc.

Suivie des vues de la documentation HTML avec Google Analytics

Étape 1: Obtenir le code de suivi Google Analytics

Un code de suivi spécifique est nécessaire pour indiquer à Google Analytics le domaine actuellement analysé. Pour obtenir ce code pour le domaine où se trouve la documentation en-ligne, rendez-vous simplement sur la page de paramétrage de Google Analytics pour ce domaine et copiez le code fourni. Il devrait ressembler au code suivant avec une valeur personnalisée pour setAccount:

<script>

  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-123456-7']);
  _gaq.push(['_trackPageview']);

  (function() {
   var ga = document.createElement('script');
   ga.type = 'text/javascript'; ga.async = true;
   ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www')
            + '.google-analytics.com/ga.js';
   var s = document.getElementsByTagName('script')[0];
   s.parentNode.insertBefore(ga, s); })();

</script>

Étape 2: Insérez-le dans votre modèle HelpNDoc

HelpNDoc fournit un moyen très pratique pour contrôler la sortie HTML de votre documentation: créez ou éditez un modèle pour indiquer à HelpNDoc comment générer la documentation. Nous allons tirer profit de ce système en copiant le modèle HTML par défaut pour ajouter notre code de suivi là où nécessaire:

  • Il est recommandé de ne pas éditer les modèles fournis par défaut dans le répertoire d’installation de HelpNDoc: copiez simplement le modèle HTML par défaut depuis C:\Program Files\IBE Software\HelpNDoc\templates\html\default vers votre répertoire de modèles personnel Mes Documents\HelpNDoc\templates\html\default
  • Nous pouvons maintenant modifier le nom du modèle: renommez le dossier de default vers analytics et éditez le fichiers template.info pour définir un nouveau nom pour le modèle tel que Modèle HTML avec Google Analytics
  • Pour finir, ajoutez le code de suivi dans l’en-tête des chapitres HTML en éditant le fichier topics.pas.html et ajoutez le code Google Analytics récupéré précédemment dans la section head du fichier modèle HTML

Étape 3: Publiez votre documentation pour collecter les statistiques

Vous pouvez maintenant générer la documentation HTML pour n’importe quel projet HelpNDoc en spécifiant le modèle nouvellement créé dans la fenêtre de génération, l’envoyer sur le serveur web et voilà! Google Analytics collectera gratuitement des données pour vous et vous présentera des rapports puissants et faciles à lire avec une indication claire de ce que vos lecteurs font de votre documentation en ligne.

Catégories: articles