Hello Tout le monde,

ça fais quelques semaines que je developpe un webservice assez balaise pour mon entreprise, et mon patron m'a demander d'y implémenter un système de documentation et de le proposer eventuellement en open source.

Voilà donc le sujet, selon vous est-ce une bonne idée ?

Ce système permettrait, à l'image de read the docs ou autre d'installer comme un cms ce système là afin de creer votre documentation de A à Z avec un backoffice, en passant par un menu builder, jusqu'a la création de page avec sections ancrée et tables des matières. Sous un design agréable bien entendu. J'aimerais avoir vos avis sur la question. Si ça manque de précisions, je vous en apporterais d'avantage avec plaisir.

17 réponses


Un peu comme gitbook ?

Sur la papier un petit peu, mais gratuit et en open sources

L'idée est bonne, gitbook et spectacle ont une approche de création de doc sous forme one-page, un systeme de build aussi, avec ou sans hebergement.
Ton projet est ma fois une bonne idée, en plus du open-source tu seras bien aidé par la communauté.

Exactement, dans ce cas, d'ici les jours qui viennent je posterais quelques screens ainsi que les visuels et pour terminer une démo de test. Ayant déjà commencé depuis un petit moment j'ai déjà finalisé pas mal de petite chose, liste non exhaustive:

  • Authentification
  • CRUD pour les pages de doc
  • CRUD pour les 2 menu (top-bar et side-bar)
  • Table des matières représentant les sections des pages
  • Menu builder Drag & Drop
  • Traductions de l'administration (en / fr) n'est pas complète pour le moment
  • Application Modulaire, en soit j'utilise la lib de nwidart pour faire des modules, notemment pour l'administration
  • Sections order dans les pages Drag & Drop
  • Système d'installation ( à améliorer)

Il manque un point important sur l'édition des pages, c'est l'ajout et suppression des sections liés

Il reste pas mal de petites choses à voir, et si vous avez d'autres idées à rajouter ou bien contribuer, n'hésitez pas

Une première démo serai déjà pas mal pour voir ce qu'il pourrait être amélioré :)
En tout cas je suis de prés !

Quel timing ;) je suis en train de finalisé les derniers détail pour lancer une démo en pré alpha. Faut juste que je rajoute un systeme de page dite "homepage" pour laisser le choix à l'utilisateur d'avoir une page d'accueil par défaut obligatoire.
Il va me manquer cependant quelques traductions et diverse choses à améliorer

C'est un hasard hein :p

Est ce que en attendant des screens te donnerais une idée ?

Oui volontié ! :)
Tu utilises un framework css en particulier pour ce projet ?

Je t'envoie ça dès que j'ai finis un truc, oui j'utilise bootstrap

  • Voilà pour l'ajout de page (partie back et front)

Si tu veux voir autre chose suffit de me dire

La page d'exemple est superbe ! *.*
La partie administration gère bien le responsive pour les petits écrans ?

En tout cas je suis déjà sous le charme, je pense utiliser ton appli quant il sera fini :)

Merci :)
La page d'admin est responsive, hors cas ou tu as les éléments dropable, faut que je trouve une solution pour cela

la partie menu builder, sobre mais intuitive

Toujours commencer par simple, il tourne sous qu'elle langague/framework ? (c'est pas précisé)
Disposes-tu déjà d'un repository github pour ce projet ?

Il tourne sous laravel 5.4

Pour le moment j'ai qu'un gitlab privé qui est un peut plus orienté pour la démo que je vais mettre en ligne, je vais faire un repo clean assez rapidement en public

D'accord, c'est cool en tout cas, je te félicite pour un telle projet !
Je n'est pas encore appris laravel mais je me débrouille bien avec PHP, si jamais je peux contribuer je le ferait sans hésiter ;)
#FanBoy

C'est gentil merci :D j'espère avoir le retour d'autre personnes tout de même.
dans un projet on peut tous contribuer; en passant du wording, jusqu'a l'algo le plus compliqué ;)