URL: https://linuxfr.org/users/trivial/journaux/documentation-collaborative Title: Documentation collaborative Authors: jm trivial Date: 2009年02月24日T14:50:27+01:00 Tags: Score: 2 Bonjour cher journal, ça fait un moment que je ne t'ai pas écrit, mais aujourd'hui, j'ai besoin de ton avis sur une idée qui me taraude. On ne peut pas le nier, le monde du libre regorge de librairies très complètes qui répondent souvent à des problèmes pointus, et permettent de gagner un temps fou en développement. Cependant, un des freins à la diffusion de certaines librairies auprès de développeurs pressés ou peu désireux de lire du code source toute la journée est le manque de documentation. Bien sûr, l'incontournable doxygen permet de générer des documentations complètes, on peut aussi noter les efforts faits en [programmation lettrée](http://fr.wikipedia.org/wiki/Programmation_lettrée). Cependant, si ces outils sont pratiques, ils nécessitent un effort important de la part du développeur, ou l'implication forte d'utilisateurs. Ce mode de fonctionnement est souvent centralisé (du moins l'intégration au gestionnaire de version est possible par une petite poignée de participants), et ne facilite pas la participation massive des utilisateurs. Or dans d'autres domaines, par exemple le domaine de la traduction ou de la rédaction de manuels, les outils en ligne collaboratifs commencent à faire légion. Il est alors surprenant de n'avoir pas rencontré jusqu'ici d'outil de documentation doxygen collaborative. Cher journal, imagine l'outil suivant : - il s'appuierait sur une interface web collaborative, où chacun pourrait améliorer la description des différentes fonctions d'une librairie - il permettrait, par exemple à l'aide d'un jeu de couleurs (rouge, orange, vert) de mesurer l'avancée et la qualité de la documentation de la librairie - il proposerait l'intégration automatique des commentaires au code source initial, suivant la syntaxe doxygen (ou tout autre format plus pertinent que tu connaîtrais, cher journal). Les intérêts seraient multiples, puisque ça rendrait plus simple d'accès la participation à un projet, l'aspect collaboratif permettant aux moins sûrs d'entre nous d'apporter leur pierre, il élargirait ainsi le nombre d'intervenants et permettrait de converger vers une documentation développeur de qualité. Alors, journal, tu connais des projets qui proposent ce genre d'outil ? Pour ma part, je n'en connais pas.