Comment définir le fichier robots.txt et les balises méta Robots dans votre documentation HTML ?

Comment définir le fichier robots.txt et les balises méta Robots dans votre documentation HTML ?
Catégories: articles

Les rédacteurs techniques peuvent utiliser un fichier robots.txt spécial ou définir des balises méta robots dans leur documentation HTML pour spécifier comment les moteurs de recherche courants, tels que Google ou Bing, doivent indexer et présenter les pages individuelles dans les résultats de recherche. Dans cet article, nous verrons comment mettre à jour le modèle HTML par défaut, fourni par l’outil de création d’aide HelpNDoc, pour générer un fichier robots.txt, spécifier une valeur par défaut à l’échelle du projet pour la balise méta robots et remplacer son contenu pour des pages de documentation spécifiques.

Lire la suite →

Gestion des panneaux de HelpNDoc : déplacez-les et ancrez-les où vous voulez

Gestion des panneaux de HelpNDoc : déplacez-les et ancrez-les où vous voulez
Catégories: articles

La superbe interface utilisateur de HelpNDoc a été conçue avec soin pour être aussi épurée et conviviale que possible. Elle offre le minimum nécessaire pour plus de rapidité et plus efficacité dans la rédaction et la production de fichiers d’aide, de manuels d’utilisation et de livres électroniques. Elle propose pourtant des fonctionnalités avancées pour les utilisateurs expérimentés, comme la possibilité de déplacer, redimensionner et disposer les panneaux où on le souhaite.

Lire la suite →

Comment mettre à jour les icônes de la table des matières de votre documentation HTML

Comment mettre à jour les icônes de la table des matières de votre documentation HTML
Catégories: articles

La création de la documentation la plus complète, exhaustive et actualisée est le souci premier des rédacteurs techniques. Mais les lecteurs veulent un design épuré et moderne, et les entreprises doivent souvent intégrer des sites web de documentation à leur support existant, adoptant ainsi une apparence prédéfinie. Heureusement, l’outil de création d’aide HelpNDoc vous permet d’ajouter rapidement un logo ou un code CSS sur mesure pour une personnalisation rapide, ou même de créer un tout nouveau modèle pour personnaliser entièrement vos productions.

Lire la suite →

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

Comment programmer la génération automatique de documentation ?
Catégories: articles

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.

Lire la suite →

Comment trouver et réparer les liens hypertextes cassés dans vos manuels d’utilisation, livres électroniques et fichiers d’aide

Comment trouver et réparer les liens hypertextes cassés dans vos manuels d'utilisation, livres électroniques et fichiers d'aide
Catégories: articles

Les rédacteurs techniques se servent de liens hypertextes pour organiser et référencer diverses sections de leurs manuels d’utilisation imprimés, livres électroniques ou fichiers d’aide. Il est très important de s’assurer que les liens hypertextes sont à jour, car des liens hypertextes cassés peuvent interrompre le rythme d’apprentissage de l’utilisateur. Ce dernier peut être perturbé, ne trouvant pas l’information dont il a besoin : cela peut entraîner plus de frais d’assistance si un ticket d’assistance est ouvert.

Lire la suite →

Créer un nouveau modèle HTML pour personnaliser vos projets de documentation Web

Créer un nouveau modèle HTML pour personnaliser vos projets de documentation Web
Catégories: articles

La toute dernière version de HelpNDoc 6.4 inclut un modèle amélioré HTML à page unique avec la possibilité d’optionnellement ajouter une table des matières à la documentation HTML à page unique produite. Nous avons naturellement utilisé le puissant éditeur de modèles de HelpNDoc pour modifier le modèle à page unique et nous avons pensé que ce pourrait être une bonne idée de documenter ce processus à des fins pédagogiques. Suivez les étapes décrites dans cet article pour apprendre à créer et modifier des modèles de documentation HTML grâce aux outils intégrés de HelpNDoc.

Lire la suite →

Éditer en masse les statuts des chapitres de votre projet de documentation

Éditer en masse les statuts des chapitres de votre projet de documentation
Catégories: articles

HelpNDoc 6.0 a ajouté la prise en charge des statuts de chapitres, ce qui simplifie considérablement la gestion des projets de documentation pour les rédacteurs techniques : les chapitres peuvent être étiquetés comme “Obsolètes”, “En cours”, “À réviser”, “Achevés” ou tout autre statut personnalisé. Vous pourriez être tentés d’utiliser cette fonctionnalité pour mettre à jour un vieux projet et modifier l’état de tous vos chapitres en “À réviser” pour les réviser un par un.

Lire la suite →

Clarté et concision sont le propre de la rédaction technique… Récapitulatif des articles récents sur les médias sociaux pour les rédacteurs techniques

Clarté et concision sont le propre de la rédaction technique... Récapitulatif des articles récents sur les médias sociaux pour les rédacteurs techniques
Catégories: articles

Nous sommes toujours heureux de partager les ressources précieuses de nos publications sur les médias sociaux avec les auteurs et rédacteurs techniques. Si vous avez manqué l’un de nos messages, ce récapitulatif regroupe nos publications récentes sur les trucs et astuces aidant les auteurs et rédacteurs techniques à rester au sommet de leur art. Pour rester informé des prochains messages, suivez-nous sur les médias sociaux : FaceBook, Twitter, LinkedIn, YouTube ou Google+.

Lire la suite →

Migration d’un modèle personnalisé vers une nouvelle version de HelpNDoc

Migration d'un modèle personnalisé vers une nouvelle version de HelpNDoc
Catégories: articles

HelpNDoc dispose d’un puissant gestionnaire de modèles avec lequel vous pouvez personnaliser n’importe quelle partie de la documentation générée. Vous utiliserez la plupart du temps le modèle par défaut du format de documentation à personnaliser comme point de départ. Mais, après la sortie d’une nouvelle version de HelpNDoc, le modèle par défaut peut avoir évolué avec de nouvelles fonctionnalités et des correctifs, et vous voudrez peut-être inclure ces modifications dans vos modèles personnalisés.

Lire la suite →

Fusionner automatiquement plusieurs chapitres de votre documentation en utilisant un script

Fusionner automatiquement plusieurs chapitres de votre documentation en utilisant un script
Catégories: articles

Un outil de création d’aide standard, comme HelpNDoc, est un logiciel dans lequel vous rédigez et organisez généralement le contenu afin de produire des fichiers de documentation pour les utilisateurs. Lorsque des modifications sont nécessaires, le contenu doit rester organisé et cela implique généralement beaucoup de labeur tout en étant sujet à des erreurs avec des taches telles que copier/coller du contenu à travers le projet, supprimer du contenu, déplacer et fusionner des chapitres… Heureusement, HelpNDoc dispose d’un puissant processeur de script qui peut aider à automatiser la création, la maintenance, la réorganisation, etc.

Lire la suite →