L’un des principaux formats de fichiers d’aide générés par l’outil de création d’aide HelpNDoc est le format de documentation HTML : des sites web de documentation fonctionnels pouvant être hébergés par tout serveur web pour un accès rapide et en libre-service à la documentation, simplifiant ainsi l’accès aux clients et le travail du service d’assistance. Les agents du service clientèle doivent souvent partager des URL contextuelles avec les clients afin de décrire des tâches spécifiques, mais ces dernières sont souvent trop longues et difficiles à retenir et à saisir. Heureusement, chaque chapitre créé dans HelpNDoc peut avoir un nombre illimité d’alias d’URL : voyons comment les définir dans l’interface utilisateur de HelpNDoc.

Aide HTML contextuelle

Chaque chapitre obtenu avec le modèle par défaut de HelpNDoc est contextuel : il dispose d’une URL unique pouvant être partagée pour y accéder.

Context sensitive HTML URLs

Le générateur de documentation HTML de HelpNDoc utilise la propriété ID d’Aide de chaque chapitre pour obtenir son nom unique. Par exemple, un chapitre dont l’ID d’aide est défini comme étant MonChapitreExemple, hébergé sur le domaine https://exemple.com, est accessible au moyen de l’URL https://exemple.com/MonChapitreExemple.html.

La propriété contexte d’aide du chapitre peut également être utilisée pour y accéder directement. En utilisant le même nom de domaine exemple https://exemple.com, un chapitre avec 42 comme numéro de contexte sera accessible en utilisant l’URL https://exemple.com/context/42.html.

Définir les alias du chapitre

Certains chapitres sont plus populaires que d’autres ; en leur attribuant un alias facile à retenir, vous pouvez accélérer considérablement l’assistance technique et améliorer l’expérience utilisateur.

HTML topic aliases

Une fois un chapitre sélectionné dans la table des matières de HelpNDoc, le panneau “Propriétés du chapitre” peut être utilisé pour définir ses différents alias :

  • Cliquez dans l’éditeur de la propriété Alias pour afficher le bouton “…”
  • Cliquez sur le bouton “…” pour ouvrir l’“Éditeur de liste”
  • Dans l’“Éditeur de liste”, cliquez sur “Ajouter” et saisissez un nom pour ajouter un nouvel alias pour le chapitre concerné
  • Ajoutez autant d’alias que nécessaire, puis cliquez sur “OK” pour fermer l’Éditeur de liste

Une fois le site web de documentation HTML généré par HelpNDoc, ce chapitre sera accessible au moyen de n’importe lequel de ces alias.

Par exemple, le chapitre “FAQ et Dépannage” pourrait avoir pour alias (qui redirigeront tous vers le chapitre approprié) :

  • /faq.html créera l’alias https://exemple.com/faq.html
  • /faq/index.html créera les alias https://exemple.com/faq/ et https://exemple.com/faq/index.html
  • /troubleshooting.html créera l’alias https://exemple.com/troubleshooting.html
  • /troubleshooting/index.html créera les alias https://exemple.com/troubleshooting/ et https://exemple.com/troubleshooting/index.html

Les fonctionnalités innovantes de génération HTML font de HelpNDoc l’outil de création d’aide idéal pour réaliser des sites web de documentation agréables à utiliser, avec des options avancées telles que des URL contextuelles et un nombre illimité d’alias de chapitres. Téléchargez votre version gratuite maintenant pour vous faire une idée par vous-même.

Voir aussi...

Produire du MarkDown avec l'outil de création d'aide HelpNDoc [markdown] [featured]
Équilibrer la sécurité et la facilité d'utilisation : Les meilleurs formats de documentation pour le partage interne

Le partage efficace et sécurisé de la documentation est essentiel sur le lieu de travail moderne. Que vous distribuiez des manuels internes, de la documentation sur des projets ou des directives …

Lire la suite →
Illustration de l'analyseur de caractères de HelpNDoc [illustration] [Featured]
L'arme secrète des rédacteurs techniques : les avantages uniques de l'analyseur de caractères de HelpNDoc

HelpNDoc est une solution de choix pour les professionnels qui cherchent à créer une documentation de haute qualité, attrayante et conviviale. Cependant, ce n’est pas seulement son interface …

Lire la suite →
Un rédacteur technique heureux d'utiliser HelpNDoc [happy] [Featured]
Obtenir le meilleur de HelpNDoc : Comment la fonctionnalité "Conserver les fichiers temporaires" peut-elle aider les rédacteurs techniques ?

Lorsque l’on travaille sur de la documentation technique, chaque outil et chaque fonctionnalité à notre disposition peut faire une grande différence en termes de productivité et d’efficacité. L’une de …

Lire la suite →
Conversion de l'ancienne version de WinHelp HLP en documentation moderne [converting] [Featured]
Revitalisez vos fichiers d'aide : Convertir les anciens fichiers WinHelp HLP en documentation moderne avec HelpNDoc

À une époque où l’information est consommée sur une pléthore d’appareils et de plateformes, les fichiers WinHelp HLP classiques - autrefois la norme en matière de documentation d’aide basée sur …

Lire la suite →

Catégories: articles