Zeal ou comment avoir toutes les docs sous la main quand tu codes ?

Zeal, de quoi tu me parles encore ?

Avant de te parler de Zeal, j’espère que tu sais que notre sacro sainte devise, à nous les développeurs, c’est RTFM ?
Je ne te ferai pas l’affront de te traduire et si tu ne sais pas de quoi je te parle, Google bon sang ! 😀

Mais tu le sais aussi dans notre métier, la documentation :

• ça évolue
• il y en a une par langage, framework, librairie, etc
• chacune à son propre format

bref, ce n’est pas simple de s’y retrouver.

Tu es d’accord avec moi ?

Et que dirais tu, si je te disais qu’il est possible d’avoir toutes les documentations nécessaires pour développer sous la main ?

Oui je sais, tu ne crois pas que cela soit possible et tu me prendrais pour un commercial qui veut te vendre du rêve !

Bon on ralentit avec les gif’s car sinon je sens que je vais vous perdre.

Revenons en à notre sujet : Zeal.

Vu que de toute façon, je t’ai spoilé dans le titre de l’article, je laisse tomber le suspense. La solution s’appelle Dash dans le monde Mac et sous Windows le pendant s’appelle Zeal.

Quels sont les avantages de ZEAL ?

Le nombre de documentations couvertes

A l’heure où je t’écris cet article, Zeal concentre 196 documentations !

Pardon, le terme officiel n’est pas documentation, mais docsets !

Il t’es également possible de créer ta propre documentation.

Zeal t’assure la consultation off-line de ta documentation préférée

Autre avantage, une fois que tu installes la documentation souhaitée, elle est dispo off-line. Donc même si tu décides de partir en vacances dans un endroit sans internet, tu peux encore continuer à travailler.

Oui, au final je ne suis pas sur que dans ce cas précis, ce soit un avantage. Enfin, tu as compris le principe !

Le moteur de recherche intégré

Alors là c’est le top, un mot clé et Zeal te propose toutes les occurences correspondantes et c’est assez pertinent. Cela va t’assurer un gain de temps énorme.

Tu peux filtrer par docsets en utilisant ‘:’, par exemple :

java:BaseDAO

Tu peux également effectuer une recherche dans plusieurs docsets en les séparant par une virgule:

python,django:string

Il est intéressant de noter que tu peux lancer ta recherche documentaire via la ligne de commande :

zeal python:pprint

Les mises à jour

Zeal te permet de mettre à jour les documentations que tu as installé.

En effet, dans la fenêtre des Docsets, sur l’onglet Installed, tu trouveras en bas les boutons Update, Update all pour cela. Ils s’activeront dès qu’une documentation sera disponible pour être mise à jour.

Note que tu peux aussi supprimer une documentation dont tu n’aurais plus l’usage par exemple avec le bouton Remove.

Installer ZEAL

Si tu es convaincu que Zeal peut te rendre de fiers services, alors tu peux passer à l’installation.

Pour cela plusieurs choix s’offre à toi et cela va dépendre de ton OS (Windows ou Linux).

Installer Zeal sous Windows

Pour Windows, tu as une pléthore de possibilité :

L’installation classique via un installeur Windows

Tu télécharges le fichier .msi, tu doubles cliques dessus et puis voilà !

La méthode élégante avec Chocolatey pour installer Zeal

Chocolatey, « Choco » pour les intimes

le package manager de Windows va te permettre d’installer Zeal en une ligne de commande 😉

Une fois que l’installation est terminée et s’est bien passée : "The install of Zeal was successful.", tu peux taper sur le touche Windows (pas trop fort, hein !) et ensuite entrer Zeal, puis entrée.

Zeal va alors se lancer.

Il est également possible de lancer l’installation via Scoop qui est un installateur en ligne de commande.

Tu peux si tu le souhaites avoir une version Zeal portable, si tu souhaites l’installer sur une clé USB par exemple ou si tu ne veux pas ou ne peux pas l’installer sur un ordinateur (au travail par exemple si il y a des stratégie d’entreprise t’empêchant d’installer un logiciel).

Enfin, il est également possible d’installer les versions de développements avec les CI builds.

Et sous Linux ?

Sous Linux, tu peux tout simplement installer Zeal en ligne de commande en adaptant celle-ci en fonction de ton Linux préféré 😉

Je fais quoi, une fois que Zeal est installé ?

Toi, on peut dire que tu vas à l’essentiel, le tact ce n’est pas ton truc. 😀

Mais tu as raison, l’efficacité tout simplement.

Donc une fois que Zeal est installé, tu vas pouvoir aller installer les documentations qui te sont nécessaires, celles que tu vas utiliser au quotidien. Car oui, petite précision utile au premier lancement de Zeal aucune documentation n’est installée. Normal il ne peut pas deviner tes désirs secrets de documentation ?

Direction le menu Tools, ‘Docsets...‘, rends toi sur l’onglet ‘Available‘ et fais ton marché. Sélectionne chaque documentation qu’il t’es nécessaire et ensuite lance l’installation de la doc concernée en cliquant sur ‘Download‘.

Un café plus tard, ta documentation est installée et consultable.

Satisfait ? Oui ? Alors retournes bosser plutôt que de passer tout ton temps sur ce blog ! 😀

Attention !

A présent, tu n’auras plus la possibilité d’utiliser l’excuse n° 404 du développeur :

« Désolé chef, j’aurai bien voulu finir plus tôt, mais le site de la documentation était cassé. Par contre, j’ai updaté mes skills sur Street fighter 😉« .

Excuse 404 du développeur

Une alternative ?

ça tombe bien, Régis m’a rappelé dans les commentaires qu’il existait une solution en ligne (mais qui fonctionne aussi en hors-ligne), j’ai nommé : https://devdocs.io/

Alors attention, certaines documentations peuvent paraître obsolète, notamment la documentation de Laravel dont la documentation s’arrête à la version 5 🙁

PS : Cet article fait partie de la rubrique ‘Caisse à outils‘ qui apporte des conseils essentiels aux développeurs.