Faire encore plus simple…
En 2006, j'ai mis en place un CMS (Système de gestion de contenu) basé sur Joomla afin d'y accueillir toute la documentation technique nécessaire au bon fonctionnement de notre système d'informations.
A l'époque, Joomla me paraissait être le bon cheval, tant sur sa modularité que sur sa facilité de mise en œuvre et de plus, avec peu d'effort on arrivait à faire un "site" joli, agréable à consulter, agréable à utiliser.
L'objectif consistait alors à réunir toute la documentation technique du service (Plan d'adressage IP, Fiche "serveur", tutoriels d'installation des applications « métier », etc...). Côté développement (on en fait beaucoup...) la documentation est restée sur Redmine qui est beaucoup adapté à cette activité.
Après 8 années de bons et loyaux services et plus de 500 articles rédigés, je viens de décider d'abandonner Joomla et ce, pour diverses raisons :
- les migrations de version, afin de rester " up-to-date " sont de plus en plus contraignantes, surtout à cause des problèmes de compatibilité des plugins et pourtant j'en utilise peu,
- le back-office, permettant de créer de nouveaux articles reste "compliqué" à manier – on peut le faire aussi via le front-office mais ce n'est pas très "pratique" -
- le moteur de recherche présente des résultats moyens et plus il y a d'articles et plus les résultats sont mauvais.
Pour toutes ces raisons et, au fil du temps, mes collaborateurs ont rechigné à l'écriture de nouveaux articles et la mise à jour des articles existants devenus obsolètes. J'étais devenu quasiment le principal contributeur...
Et pourtant, la documentation interne est un point important de notre métier et il en va de la qualité du service rendu aux utilisateurs si celle-ci n'est pas correctement maintenue ! J'ai beau le crier sur tous les toits mais toutes les excuses sont bonnes (pour mes collaborateurs...) quant il s'agit de ne pas mettre à jour une documentation ou d'en créer une nouvelle... J'en conclus donc que l'outil ne plaît plus et qu'il n'est plus adapté...
Mais comment faire plus simple – puisque c'est principalement là que le bât blesse - tout en conservant une dynamique de rédaction et de mise à jour ainsi qu'une appropriation par tous les métiers du service (Techniciens, SysAdmin, Chefs de projet...etc) ?
La solution que j'ai retenue : DokuWiki ! Pourquoi ?
- Parce que je connais l'outil depuis de longues années pour l'avoir utilisé sur d'autres types de projets, et qu'un Wiki représente certainement l'outil le plus adapté à ce genre de documentation,
- Parce que ce projet, en open-source, existe depuis de longues et, est très bien maintenu,
- Parce que la prise en main de l'outil et son installation demeurent très rapides, même pas besoin de base de données, le contenu est organisé sous la forme de fichiers "texte",
- Parce que le projet DokuWiki a très bien évolué dans le sens où il est devenu plus "user-friendly" tout en conservant sa simplicité,
- Parce que la mise à jour ou la création d'un contenu se font directement en front-office, pas besoin de se connecter au back-office qui ne contient que des paramètres essentiellement liés à l'installation ou à l'après-installation,
- Parce que les quelques thèmes disponibles sont largement suffisants (et ils sont stables...) pour héberger une documentation technique agréable à consulter,
- Parce que les plugins proposés (beaucoup moins nombreux que ceux proposés par d'autres CMS) sont largement suffisants pour ce que l'on a faire dans ce genre de projet,
- Parce que le moteur de recherche donne de très bons résultats...
Pour ma part, voilà quelques détails sur la configuration que j'ai retenue et sur la base de la dernière version stable de DokuWiki...
Le thème : CodoWiki (très épuré avec un look très "pro") et disposant d'une "sidebar" c'est à dire d'un menu sous la forme d'une colonne que l'on place à droite ou à gauche de l'écran.
les plugins que j'ai ajouté, en plus des plugins installés de base :
- Dw2Pdf qui permet d'obtenir votre article dans un "joli" PDF, bien présenté, bien complet avec, cerise sur le gâteau, un QR code correspondant à l'URL de la page,
- DokuWiki Upgrade qui prend en charge automatiquement les upgrades de version de DokuWiki (à noter que les plugins se mettent automatiquement à jour via le gestionnaire de plugins intégré de base),
- Edittable qui rend la création et l'édition de tableaux très facile (c'était un des points faibles de DokuWiki auparavant).
Autres plugins intéressants mais que je n'utiliserai pas au final car je n'en ai pas besoin :
- Numbered headings qui permet d'ajouter une numérotation hiérarchique dans vos titres et sous-titres en fonction des niveau (ex : 1, 1.1, 1.1.1 …),
- Publishing qui permet de mettre en place une notion de validation des articles par des administrateurs avant publication,
- Bookcreator qui permet de créer un PDF en compilant plusieurs articles de votre choix et afin d'obtenir un « livre ».
Je joins à cet article deux copies d'écrans de la maquette que j'ai effectuée avant de me lancer...
Alors si vous n'avez pas encore créé votre documentation technique en ligne et que celle-ci se trouve encore disséminée dans des dizaines (voire des centaines !) de documents Word et Excel (Ooohh non...), difficilement accessibles...car jamais rangés au bon endroit...il est donc grand temps de passer à la vitesse supérieure, en toute simplicité et efficacité ! Côté hébergement, ne vous cassez pas la tête, utilisez un de vos serveurs web existant ou bien installez une petite machine Linux avec un apache ou un Nginx et c'est tout ! En un après-midi, vous aurez installé la bête et vous l'aurez prise en main et concocté votre première maquette, alors … désormais vous n'avez plus d'excuses pour ne pas y aller !
Quelques liens :
https://www.dokuwiki.org/fr:dokuwiki
http://fr.wikipedia.org/wiki/Wiki
http://fr.wikipedia.org/wiki/Syst%C3%A8me_de_gestion_de_contenu
Bonjour LeCastillan,
Article très intéressant et qui soulève la problématique de gestion des documentations techniques en entreprise.
Comme vous le dites dans l’article, il est temps de supprimer la gestion des docs sous format Word… J’ai cette idée de DokuWiki dans un coin de ma tête depuis un bon moment et j’espère prochain pouvoir mettre tout cela en pratique !
L’outil semble vraiment adapté à ce type d’utilisation et en plus si l’on peut éditer directement depuis le front-office, l’utilisation est encore plus légère et plus rapide. Un bon point lorsque l’on a pas trop le temps de faire la doc et que l’on doit procéder rapidement.
A la semaine prochaine 🙂
Florian
Bonjour,
Je suis actuellement, en Licence Pro en informatique, j’ai mis en place la solution DOKUWIKi sur un serveur web IIS ( installation facile au passage), pour centraliser la documentation technique du service informatique dans le lequel je fais mon apprentissage. De plus, couplé à du SSO la gestion des accès aux articles est très facile. Je recommande vivement ce produit, qui est gratuit et facile d’installation et d’administration.
Merci pour cet article, comme toujours du contenu de qualité sur it-connect.fr !
Bonjour,
Article très intéressant, au passage DokuWiki existe également en package sur NAS Synology.
Cependant je cherche un Plugin ou une solution très similaire permettant d’y intégrer des copie coller d’image.
Merci .it-connect
Bonsoir Mickro,
Il est désormais très facile d’incorporer une image ou une copie d’écran dans un article Dokuwiki directement via le gestionnaire de média… Certes il faut « uploader » l’image depuis son propre poste de travail (le copier/coller n’est pas possible) mais tout cela se fait en même temps que l’on rédige l’article. Les images sont à stocker dans un « namespace » (sorte de dossier où l’on range les articles d’une même section) ce qui permet de ne pas mettre le bazar partout et de ranger les images dans le « namespace » correspondant à un domaine en particulier. De plus, l’importation d’images est agrémentée de quelques petits outils très sympas permettant de redimensionner l’image à la volée ou de la caler directement à droite, au cente ou à gauche. Voilà !
Très intéressant de lire ce genre d’article sur une problématique bien connue.
Sympathique la maquette ou on aperçoit la catégorisation des articles.