Bienvenue dans “Réflexions et Articles sur HelpNDoc”, votre hub dédié à tout ce qui concerne HelpNDoc, présenté dans des articles réfléchis et approfondis. Ici, nous explorons l’étendue et la profondeur du logiciel, en faisant la lumière sur ses fonctionnalités, en offrant des trucs et astuces, et en fournissant des idées sur la meilleure façon d’utiliser HelpNDoc pour créer une documentation convaincante et complète. Nos articles vont des guides pour débutants aux conseils d’experts et aux approfondissements des fonctionnalités avancées. Pour ceux qui préfèrent une expérience d’apprentissage plus pratique, nous proposons une série de guides étape par étape disponibles à la fois sous forme de texte facile à suivre et de contenu vidéo attrayant. Que vous soyez un utilisateur débutant ou un spécialiste expérimenté de la documentation, notre objectif est de vous apporter des connaissances et de vous inciter à tirer le meilleur parti de HelpNDoc. Plongez-y pour découvrir, apprendre et améliorer votre compréhension de cet outil puissant.
Les rédacteurs techniques passent énormément de temps à s'assurer de la pertinence, de la clarté et de la concision du contenu rédigé. Ils ne devraient donc pas en avoir à perdre lors de l'utilisation de leur logiciel de création d'aide favori, pour effectuer des tâches courantes comme la création de liens hypertextes. Heureusement, l'outil de création d'aide HelpNDoc offre divers moyens pour accélérer la création de liens hypertextes, aidant ainsi les rédacteurs techniques à consacrer leur temps à ce qui compte le plus : la rédaction de contenus de qualité.
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.
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. Voyons comment y parvenir dans cet article.
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. Voyons, dans cet article, comment utiliser des icônes personnalisées dans la table des matières de la documentation HTML générée.
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.
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. L'outil de création d'aide HelpNDoc inclue heureusement un analyseur de liens hypertextes dont la simplicité permet aux rédacteurs techniques de repérer et de corriger rapidement les liens hypertextes défectueux.
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.
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 vérifier un par un. Mais la mise à jour individuelle de tous les chapitres d'un grand projet prendra du temps. Heureusement, la prise en charge de scripts par HelpNDoc permet de mettre à jour la totalité des statuts du projet en une fraction de seconde. Voyons comment le faire.
Nous sommes toujours ravis de partager les précieuses ressources de nos messages 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+.
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. La solution est de comparer et fusionner le modèle par défaut (mis à jour) et le vôtre. Nous allons voir comment accomplir cette tâche sans peine et en toute sécurité
