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 →

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 →

Trier rapidement (par titre) le contenu d’une aide, les chapitres d’une documentation ou d’un livre électronique

Trier rapidement (par titre) le contenu d'une aide, les chapitres d'une documentation ou d'un livre électronique
Catégories: articles

La rédaction d’un fichier d’aide en ligne, d’un manuel d’utilisation, d’un livre électronique ou de tout autre format pris en charge par HelpNDoc est généralement un processus long et non-linéaire. Souvent, au fur et à mesure que le contenu progresse, la hiérarchie générale des chapitres peut devenir peu satisfaisante et une réorganisation est nécessaire pour faciliter la lecture et la navigation dans la documentation. Même si HelpNDoc fournit des outils pour facilement réorganiser la table des matières, dans certains cas, le processus peut être long et sujet à erreurs, comme lorsqu’un tri alphabétique des chapitres est nécessaire.

Lire la suite →

Utilisation des fonctionnalités de script de HelpNDoc pour réinitialiser automatiquement tous les numéros contextuels d’aide

Utilisation des fonctionnalités de script de HelpNDoc pour réinitialiser automatiquement tous les numéros contextuels d'aide
Catégories: articles

HelpNDoc dispose d’un éditeur de script très puissant avec un accès à plusieurs méthodes API, fournissant le moyen d’automatiser presque toutes les étapes des processus de création et de maintenance de votre documentation. Nous avons déjà vu comment utiliser les fonctionnalités de script HelpNDoc pour automatiser la création de l’aide et de la documentation, mettre à jour le chemin de vos éléments multimédias externes lorsqu’ils sont déplacés et exporter les numéros d’aide et les numéros contextuels d’aide pour vos développeurs.

Lire la suite →

Mettez à jour facilement le chemin vers vos éléments médias externes lorsqu’ils sont déplacés

Catégories: articles

Vous pouvez choisir comment vos éléments de bibliothèque (images, films, documents, etc.) sont gérés par HelpNDoc: ils peuvent être inclus dans votre projet, ou ils peuvent être inclus de manière dynamique au moment de la génération, lorsque vous décidez de construire les fichiers de votre documentation finale. Lorsque vous utilisez la seconde option, vous indiquez un chemin vers vos éléments médias afin que HelpNDoc puisse les trouver et les inclure lorsque nécessaire.

Lire la suite →

Comment exporter les ID de l’Aide et les numéros de Contexte d’Aide pour vos développeurs

Catégories: articles

Une fois que vous avez rédigé votre fichier d’aide ou votre site web de documentation, vous souhaitez généralement être en mesure de l’intégrer avec vos produits existants: lorsque les utilisateurs ont des difficultés à réaliser une action quelconque, ils doivent pouvoir lancer le fichier d’aide; et le bon chapitre expliquant cette action spécifique doit leur être présenté. À cet effet, les Outils de Création d’Aide comme HelpNDoc fournissent deux identifiants uniques pour chaque chapitre: un ID d’Aide alphanumérique et un numéro de Contexte d’Aide.

Lire la suite →

Utiliser des scripts pour automatiser la création d’aides et de documentations

Catégories: articles

HelpNDoc est si facile à utiliser qu’une documentation complète multi-format et multi-device peut être réalisée en quelques minutes après avoir téléchargé et essayé HelpNDoc pour la première fois, grâce à son interface utilisateur intuitive et son éditeur de chapitre de type Microsoft Word. Il est aussi très puissant et offre de nombreux outils de pointe pour simplifier et accélérer la création de fichiers d’aide et de manuels les plus étonnants.

Lire la suite →