Comment programmer la génération automatique de documentation ?

Les rédacteurs techniques doivent fréquemment actualiser leurs documentations, manuels d’utilisation ou sites web pour les partager avec les collègues ou les fournir aux utilisateurs. Ce processus peut être long et nécessite une attention particulière pour s’assurer que la version souhaitée est régulièrement mise à jour. Heureusement, l’outil de création d’aide HelpNDoc peut être configuré pour que la génération programmée de la documentation soit automatique. Voyons comment le faire.

Utilisation de l’interface en ligne de commande de HelpNDoc

Depuis une invite de commande ou PowerShell, il est possible d’automatiser le processus de génération de documentation de HelpNDoc, pour obtenir tout format pris en charge par l’outil de création d’aide.

HelpNDoc intègre une puissante interface en ligne de commande pouvant servir à générer n’importe quel format de documentation pris en charge, sans aucune intervention de l’utilisateur. Par exemple, la ligne de commande suivante génère toutes les constructions paramétrées et activées dans un projet nommé MyProject.hnd :

hnd6.exe MyProject.hnd build

La ligne de commande build offre diverses options pour décider du format de documentation à générer, spécifier les balises à affecter, remplacer les variables, etc. La ligne de commande suivante, par exemple, ne génèrera que les chapitres indiqués comme Complet (prêt pour un usage public) du format de documentation HTML :

hnd6.exe MyProject.hnd build -only="Build HTML documentation" -statuses="Build HTML documentation:Complete"

Vous pouvez consulter la documentation HelpNDoc sur les lignes de commande pour découvrir toutes les options disponibles et utiliser les lignes de commande adaptées à vos besoins spécifiques. Une fois cette étape achevée, nous pouvons continuer et programmer une tâche de génération de documentation.

Automatisation de la génération de la documentation

Une fois la ligne de commande souhaitée définie, nous pouvons créer une tâche planifiée afin de l’exécuter périodiquement et de nous assurer que la documentation générée reste en permanence à jour.

Il existe de nombreux outils d’“intégration continue” ou systèmes de compilation disponibles pour exécuter des lignes de commande programmées ou provoquées. Nous utiliserons le “Planificateur de tâches” de Windows pour produire quotidiennement une nouvelle version de la documentation HTML, par exemple. Voyons ici comment le faire :

• Cliquez sur le logo Windows dans la barre des tâches.
• Saisissez “Planificateur de tâches” et cliquez dessus pour exécuter le programme.
• Dans le menu “Action”, cliquez sur “Créer une tâche de base…”.
• Spécifiez un “Nom”, et éventuellement une “Description”, puis cliquez sur “Suivant”.
• Sélectionnez le “Déclencheur” souhaité (quotidien, par exemple), ensuite cliquez sur “Suivant”.
• Personnalisez les options du déclencheur, comme l’heure de démarrage, et cliquez sur “Suivant”.
• Sélectionnez l’action “Démarrer un programme” et cliquez sur “Suivant”.
• Indiquez le chemin d’accès complet vers HelpNDoc dans le champ “Programme/script”. C’est habituellement : "C:\Program Files (x86)\IBE Software\HelpNDoc 6\hnd6.exe"
• Dans le champ “Ajouter des arguments “, entrez le reste de la ligne de commande définie précédemment. Par exemple :
  MyProject.hnd -verysilent build -only="Build HTML documentation" -statuses="Build HTML documentation:Complete"
  Note : L’argument en ligne de commande -verysilent a été ajouté pour éviter d’afficher une invite de commande lorsque HelpNDoc fonctionne.
• Saisissez le chemin d’accès complet du fichier de votre projet HelpNDoc dans le champ “Commencer dans”. Par exemple C:\Documentation\. Cliquez sur “Suivant”.
• Vérifiez, cliquez sur “Terminer” et c’est fait ! La tâche de génération de la documentation est planifiée.

Avec l’interface en ligne de commande intégrée de HelpNDoc, le Planificateur de tâches Windows (ou tout autre système de traitement automatisé) peut être utilisé pour, facilement et rapidement, automatiser la génération de la documentation. Cela peut aider les rédacteurs techniques à gagner beaucoup de temps et d’efforts, afin de fournir une documentation à jour aux utilisateurs et aux collaborateurs.

Voir aussi

• Combler le fossé entre les enseignants et les élèves : Exploiter la puissance des outils d'aide à la rédaction pour une création de contenu engageante
• Comment les rédacteurs techniques peuvent inclure du code PHP dans leur documentation en ligne
• Comment créer un fichier d'aide CHM : utilisez un logiciel moderne de création d'aide au lieu du dépassé HTML Help Workshop
• Pourquoi préférer un outil de création d'aide à Microsoft Word pour produire une documentation de qualité ?
• Comment configurer et mettre à jour les propriétés des images à travers vos projets de documentation