Premier aperçu de Rails-Doc.org

Fabio Cevasco nous propose une visite de Rails-Doc.org  (en anglais), qui cherche à améliorer l’interface de la documentation Rails grâce à deux fonctions clés : une recherche documentaire puissante, rapide et utile, et la possibilité d’ajouter des notes à la documentation.

Rails est extrêmement puissant et je partage l’avis de Fabio lorsqu’il dit : “Quand vous avez décidé d’apprendre Ruby on Rails, si c’est le cas, vous avez probablement acheté un livre. Moi aussi, à vrai dire : il existe après tout de nombreux ouvrages très intéressants et assez complets. Pourtant, je n’avais jamais acheté de livre pour apprendre PHP. Pourquoi ? Pour deux raisons simples : le manuel PHP se consulte facilement grâce à sa recherche et fournit généralement assez de documentation ; et lorsque celle-ci ne suffit pas, de nombreux commentaires de développeurs expérimentés viennent toujours vous sauver la mise.”

Rails-Doc.org (source d’origine indisponible) propose une interface claire et épurée pour la documentation de Ruby on Rails, avec une recherche au fil de la saisie et, bien sûr, des commentaires au bas de chaque page. Et reconnaissons-le : c’est ce qui fait la qualité de la documentation PHP !

Fabio propose un entretien avec Mikael Roos, de Nodeta, l’équipe qui développe Rails-Doc.org, et termine par ce bilan : “Rails-Doc.org est assurément un projet intéressant, qui a tout le potentiel pour devenir un service puissant propulsé par Rails. Certes, il n’est pas open source, ce qui peut décevoir certains ; mais après tout, les utilisateurs se sont rués sur GitHub à son ouverture, non ? Les capacités de recherche de Rails-Doc.org constituent indéniablement une avancée majeure pour rendre la documentation Rails plus accessible et plus facile à utiliser, mais la fonction phare reste la possibilité d’ajouter des notes, à condition d’en faire bon usage.”