Je me demandais pourquoi tant de codeurs ont une mauvaise organisation dans leurs documents.Un RubyGems avec documentation, gestion des sources et documentation API?
Je pense savoir pourquoi.
Comme d'habitude, cela concerne la normalisation. Si ce n'est pas standard, tout le monde doit réinventer la roue tout le temps. Donc je télécharge une gemme sur RubyGems.org. Mais ce n'était que 1/4 de tout.
- Je dois écrire un tutoriel pour elle, ce qui rend les catégories, le style de texte, la taille, la couleur etc
- je dois générer de la documentation de l'API à partir de mon code
- je dois le mettre en centre Git (jamais fait cela, mais cela devrait être correct?)
C'est un processus douloureux.
Ce ne serait pas génial si chaque gemme suivait la même structure de documentation. Vous téléchargez votre gemme, vous écrivez une documentation pour que tout le monde puisse la modifier, la documentation de l'API a été générée aussi, peut-être créée automatiquement, si vous avez fourni vos informations de compte par exemple.
Un bon processus.
Je pense que cela stimulerait la bonne collaboration et l'environnement que chaque gemme a sa propre structure (mauvaises documentations) et mettre la documentation de l'API ici et là.
Vous n'êtes pas d'accord?
Nah , github n'est pas une exigence, mais c'est bien d'avoir. –
Il existe un projet de norme pour l'emballage Ruby: http://chneukirchen.github.com/rps/ Vous pouvez également consulter cette question: http://stackoverflow.com/questions/3307209/what-is-the- moderne-façon-à-structure-a-ruby-gem – Telemachus