⭐️ Les sites ci-dessous participent à mon inspiration, c’est pourquoi ils sont dans mes favoris !
🔸 Je fais de la documentation en ligne (Aide en ligne) depuis mes débuts, et en HTML depuis 2000. C’est une de mes spécialités.
Bien qu’il soit toujours possible de créer une aide en écrivant du HTML dans un éditeur de texte, personne ne le fait. L’aide se doit d’être attractive et adaptable, c’est pourquoi après avoir beaucoup utilisé de HATs (Help Authoring Tools, outils de rédaction d’aide) j’utilise désormais une combinaison générateur de site statique/fichiers Markdown (entre autres).
Une bonne aide est centrée sur les actions, structurées, facile à maintenir (mises à jours, gestion multilingue), avec une navigation fluide et un certain nombre de rubriques de base telles qu’un glossaire. Très utile pour les grosses documentation en ligne : le moteur de recherche.
Voici mes préférés :
Le present site web par exemple est une combinaison de fichiers Markdown et Yaml et d’un sympathique template Hugo.
D’autres exemples peuvent être consultés dans mon Portfolio.
🔸 J’ai beaucoup utilisé RoboHelp qui permettait de faire des aides en ligne en HTML avec moteur de recherche et index dès 1999.
Adobe RoboHelp 🔗 est toujours une solution complète qui permet de personnaliser son design, de gérer le contenu et de générer une aide immersive consultable quel que soit l’appareil ou le format.
Cependant, RoboHelp crée des fichiers en HTML et n’utilise pas Markdown.
Pour DITA, JavaDoc, Doxygen… voyez mes autres pages Favoris.