readthedocs fusiondirectory

 

Au début du projet FusionDirectory, nous avons choisi ce qui était le plus facile pour nous et ce que tout le monde connaissait, il y a 5 ans le choix était évident d’utiliser un wiki.

Au fur et à mesure que le projet grandissait, nous avons essayé de construire notre documentation dans différentes langues et, bien sûr, cela a échoué car il est très difficile de synchroniser votre documentation dans différentes langues.

Alors que le projet s’agrandit,  gagne en popularité et est utilisé dans de nombreux contextes de production comme des centres de recherche, établissements public, instituts, opérateur de télécommunication et parti politique, le wiki s’est avéré difficile à maintenir et en même temps incapable de fournir la documentation dans les divers formats requis par les clients .

Lors de la recherche d’une solution permettant de construire facilement la documentation et de la publier immédiatement en html, pdf epub, il y avait quelques solutions:

  • asciidoc
  • docbook
  • sphinx

Après quelques tests et en raison de la facilité d’utilisation et de la possibilité de publier la documentation en ligne sur Read The Docs intégré à notre gitlab via des hooks.

Nous avons maintenant de bons documents pour les développeurs et les utilisateurs qui sont automatiquement mis à jour chaque fois que nous apportons une correction.

Tagged with →  
Share →