DevDocs, plateforme de documentation technique

 (devdocs.io)
3 points par GN⁺ 2024-01-14 | 1 commentaires | Partager sur WhatsApp

Présentation de DevDocs

  • DevDocs est un site web qui regroupe diverses documentations d’API dans une interface rapide, structurée et consultable par recherche.
  • Les utilisateurs peuvent activer davantage de documentations et personnaliser l’interface via les paramètres de préférence.
  • Le site peut être utilisé efficacement avec des raccourcis clavier, sans recourir à la souris.

Fonction de recherche

  • La recherche prend en charge le fuzzy matching : par exemple, si l’on saisit "bgcp", "background-clip" apparaît.
  • Pour rechercher une documentation précise, il suffit de saisir le nom du document ou son abréviation, puis d’appuyer sur la touche Tab.
  • Il est également possible d’apprendre à effectuer des recherches en utilisant la barre d’adresse du navigateur.

Informations supplémentaires

  • DevDocs fonctionne aussi hors ligne, peut être utilisé sur mobile et installé comme application web.
  • Pour suivre les dernières actualités, il est possible de suivre @DevDocs.
  • DevDocs est gratuit et disponible en open source.
  • Pour les personnes qui débutent dans le code, il est recommandé de consulter le cursus open source de freeCodeCamp.

L’avis de GN⁺

  • DevDocs est un outil essentiel pour les développeurs, car il permet de retrouver facilement en un seul endroit la documentation de nombreux langages de programmation et frameworks.
  • Les raccourcis clavier et la recherche par fuzzy matching sont des fonctionnalités importantes qui améliorent l’efficacité des développeurs.
  • L’accès hors ligne et la compatibilité mobile rendent DevDocs encore plus utile en permettant d’accéder aux informations partout.

À lire aussi

1 commentaires

 
GN⁺ 2024-01-14
Avis sur Hacker News

  • Avis de l’un des mainteneurs :

    • Mettre à jour la documentation pour une nouvelle release est facile, sauf si le système de documentation ou le design est réécrit.
    • Certains projets changent régulièrement de système de documentation.
    • Le générateur de documentation crée des noms de classe arbitraires, ce qui rend l’organisation de la documentation fastidieuse.
    • Une liste des documentations obsolètes est générée automatiquement chaque mois, et ils ont besoin d’aide.

  • Avis d’un utilisateur revenu sur un billet de blog à propos de la documentation hors ligne :

    • Il se demande s’il existe des technologies qui facilitent la consultation de la documentation hors ligne.
    • Il demande s’il existe un format standardisé, ou quelque chose qu’il ne connaît pas encore.

  • Avis d’un utilisateur qui vérifie sa checklist avant un long voyage :

    • Il partage des outils permettant d’accéder facilement hors ligne à de la documentation sur les langages et les API.
    • Il prévoit de développer avec Zig et Vulkan.

  • Avis d’un utilisateur qui a trouvé cela utile pour programmer en déplacement :

    • C’est particulièrement utile lorsque le WiFi est instable.
    • Intégrer la documentation dans une interface standard unique améliorerait fortement la productivité.

  • Avis d’un utilisateur surpris qu’un besoin fondamental des programmeurs ne soit pas satisfait de manière systématique :

    • devdocs n’inclut pas des bibliothèques qu’il utilise régulièrement.
    • Il a essayé Dash, mais n’a pas pu obtenir directement la documentation d’openai.

  • Avis d’un utilisateur qui a utilisé cet outil pendant un vol de 14 heures pour en faire une journée productive :

    • C’est très utile, car la documentation peut répondre aux questions sans distraction.

  • Avis d’un utilisateur à propos de dedoc, un outil CLI hors ligne :

    • Il permet d’éviter le changement de contexte vers le navigateur, et de télécharger, rechercher et lire devdocs depuis le CLI.
    • Il est compilé statiquement en Rust, ce qui permet d’installer le binaire en le téléchargeant.

  • Avis d’un utilisateur sur un outil open source de type Dash :

    • C’est très bien.

  • Avis de remerciement à propos de cet outil :

    • C’est bien meilleur qu’un moteur de recherche web lorsqu’on veut uniquement des résultats issus de la documentation officielle.
    • Il prévoit de le copier en local pour l’exécuter ou l’héberger.

  • Avis d’un utilisateur qui l’utilise chaque jour via un package Emacs :

    • Le workflow est bien plus fluide que des solutions comme Dash.