Discussion :

[Bill Fassinou]

Zeal : un outil permettant aux développeurs de télécharger les documentations des langages et d'y accéder hors ligne
y compris les documentations des bibliothèques, des API et d'autres ressources

Le fait de disposer d'une documentation hors ligne à jour et facilement accessible est un grand avantage pour beaucoup de développeurs. Il existe de nombreux outils qui visent à offrir cette expérience aux développeurs, mais tous ne se valent pas et certains utilitaires semblent plus complets que d'autres. L'un des outils les plus populaires au sein de la communauté des développeurs est Zeal qui prend en charge la documentation d'un grand nombre de langages, API, frameworks, bibliothèques, et bien plus encore. Les alternatives solides à Zeal comprennent : Dash (qui es disponible uniquement sur macOS), DevDocs, Devhelp, Devbook, Velocity, Zest, etc.

Zeal : un outil permettant l'accès aux documentations hors ligne sur Windows et Linux

Aujourd'hui, la plupart des développeurs doivent se fier à la documentation en ligne pour tout. Ce qui peut être un point de friction pour certains développeurs ou peut se traduire par des minutes perdues. Dans le même temps, certains développeurs plus avertis connaissent et utilisent des outils, dont Zeal, qui leur permettent de sauvegarder et de consulter hors ligne la documentation de plusieurs langages de programmation. Zeal est un navigateur de documentation hors ligne pour Windows et Linux. Pour la plateforme macOS, il existe un autre projet open source appelé Dash. Zeal se présente comme une coquille vide sans aucune documentation dès le départ.

Ainsi, une fois Zeal installé sur votre ordinateur, vous devez ensuite télécharger et installer les documentations que vous souhaitez avant de pouvoir les consulter plus tard sans une connexion Internet. Elle offre un grand nombre de documentations pour différents langages et bibliothèques de développement tels qu'Android, Apache Server, Nginx, Bash, Cmake, C++, C, CoffeeScript, ActionScript, MongoDB, NodeJS, AppleScript, Drupal, HTML, Haskell, Java, Joomla, LaTeX, Markdown, MySQL, CSS, Python, PHP, Ruby, SQLite, jQuery et bien d'autres encore. Au total, Zeal offre un peu plus de 200 ensembles de documentation et la liste continue de croître.

La liste des ensembles de documentation disponibles est accessible en lançant Zeal, en sélectionnant "Outils" puis "Jeux de documents" dans la barre de menus. Après avoir sélectionné une documentation dans la liste, il vous suffit de cliquer sur le bouton "Télécharger". La documentation sélectionnée sera alors téléchargée et installée, et disponible pour un usage hors ligne, ce qui permet de réduire les recherches en ligne. Selon le type de documentation et la taille du téléchargement, l'installation peut prendre plus ou moins de temps. Une fois que vous avez installé une documentation, il est possible d'y accéder à partir de la fenêtre Zeal.

Dash (for macOS) : un concurrent de Zeal pour les développeurs basés sur Mac

Selon son site Web, Dash est un navigateur de documentation d'API et un gestionnaire d'extraits de code (antisèches pour les initiés). Dash offre des ensembles de documentation hors ligne pour plus de 200 API, plus de 100 extraits de code et bien plus encore. Vous pouvez même générer vos propres ensembles de documentation ou demander à ce qu'ils soient inclus. Vous pouvez choisir les ensembles de documentation à télécharger et Dash s'occupera du reste, en s'assurant qu'ils sont maintenus à jour. Vous pouvez aussi demander des jeux de documentations ou télécharger des ensembles de documentations à partir de sources tierces.

Comme Zeal, Dash est libre et open source. Néanmoins, Dash dispose d'une version plus avancée que vous pouvez acheter. La version payante offre des fonctions d'intégration pour la plupart des éditeurs de code et EDI populaires. « Dash est un utilitaire formidable et je le recommande à tous. Dash donne accès à la documentation de presque tous les principaux langages/frameworks/bibliothèques avec lesquels vous pourriez travailler. Il est vraiment bien conçu, bien plus beau et beaucoup plus complet que Zeal », lit-on dans les commentaires. Rappelons que Zeal supporte également une intégration dans plusieurs éditeurs de code et EDI populaires.

Zeal et Dash sont des applications autonomes qui s'exécutent en tant qu'applications natives sur votre système d'exploitation. De nombreux développeurs décrivent Zeal comme une version simplifiée de Dash. En effet, Zeal n'offre qu'une documentation hors ligne pour la plupart des langages/bibliothèques/frameworks populaires. Mais il ne prend pas en charge les feuilles de calcul ni les extraits de code (que certains développeurs trouvent très utiles, selon les commentaires).

Quelques alternatives populaires à Zeal et Dash

Bien sûr, Zeal et Dash (for macOS) ne sont pas les seuls navigateurs de documentation hors ligne disponibles sur le marché. Il existe plusieurs alternatives à Zeal et Dash, dont certains sont moins complets et d'autres propres à un langage donné. En voici quelques-unes :

• DevDocs : cet outil combine plusieurs documentations de développeurs dans une interface Web propre et organisée avec une recherche instantanée, un support hors ligne, une version mobile, un thème sombre, des raccourcis clavier, et plus encore. DevDocs a été créé par Thibaut Courouble et est géré par freeCodeCamp. Il est possible d'installer directement DevDocs sur votre ordinateur comme une application Web progressive ;
• Velocity : il donne à votre bureau Windows un accès hors ligne à plus de 150 ensembles de documentation sur les API. Si vous avez déjà vu ou utilisé Dash sur Mac, vous avez une bonne idée de ce qu'est Velocity, sauf pour Windows. Les mêmes documents que ceux utilisés dans Dash sont également disponibles dans Velocity ;
• Devhelp : c'est un navigateur GTK+/GNOME pour la documentation des API. Il fonctionne nativement avec gtk-doc (qui est le format de référence des API pour la documentation GTK+/GNOME) ;
• Rust Search Extension : il s'agit d'une extension de navigateur pratique pour rechercher les documents Rust, les caisses, etc. dans la barre d'adresse instantanément ;
• Zest : il s'agit d'un outil de recherche hors ligne pour les développeurs. Trouvez ce dont vous avez besoin sans avoir besoin d'un accès à Internet ;
• Devbook : il s'agit d'un moteur de recherche pour les développeurs qui les aide à trouver les ressources dont ils ont besoin et à répondre à leurs questions plus rapidement. Rapide, accessible directement à partir d'un éditeur de code, et entièrement contrôlable à l'aide d'un simple clavier ;
• PHP Function Index : l'index des fonctions PHP (PHPfi) est un visualiseur de documentation très rapide qui permet de rechercher n'importe quelle fonction PHP.

Source : Zeal

Et vous ?

Quel est votre avis sur le sujet ?
Que pensez-vous des outils permettant d'accéder aux documentations hors ligne ?
Quel outil d'accès aux documentations hors ligne utilisez-vous ? Qu'est-ce qui justifie votre choix ?
Quelle comparaison faites-vous entre les utilitaires Zeal et Dash ? Lequel recommandez-vous ?

Voir aussi

La version 2.0 de Docusaurus, un générateur de site statique qui convertit les fichiers Markdown en site Web de documentation, est disponible, avec un système de plug-ins et la thématisation

Dash est banni de l'App Store : Apple accuse le développeur d'avoir payé pour de faux commentaires, la situation provoque une vague de mécontentement

70 % des développeurs d'applications ne parviennent pas à favoriser l'innovation en raison de contraintes temporelles, selon une étude d'Onymos

Le coût de développement d'un logiciel serait-il beaucoup plus abordable si le code était écrit par GPT-4 ?

[Fagus]

J'ai découvert Zeal il y a quelques semaines. Ça marche, c'est bien pour avoir la doc hors ligne avec la recherche. Ça rappelle le bon temps des fichiers d'aide compilés avant que tout ne soit qu'en ligne.
Je n'ai pas de mac, mais Zeal se présente ± comme un clone linux moins complet. Par ex, Zeal télécharge la doc officielle du cloud de Dash, mais ne donne pas accès aux paquets contribués par les utilisateurs de dash (ou bien je n'ai pas compris comment). Par ex, on peut ajouter toutes les doc au format Sphinx via un script peu documenté et j'ai dû faire diverses manip fastidieuses pour générer les fichiers, alors que sous Dash c'est en quelques clics.