[WIKI][Débat] Utilisation d'un wiki pour la documentation technique
Bonjour,
Lors de mes missions, j'ai eu de nombreux problèmes avec la documentation technique. Souvent, elle était purement et simplement absente. D'autres fois, elle était au contraire inexploitable parce que surabondante et non indexée. Il y a eu aussi les fois où elle n'était pas à jour. Celles où elle était erronée. Celles où elle était incomplète. Celle ou il y avait une version à jour, mais personne ne savait laquelle. Celle où un document était à jour sur une partie, obsolète sur une autre, alors qu'un autre document donnait les renseignements manquant dans le premier tout en étant lui même obsolète sur les parties où le premier était exact. Celle où on l'a perdue. Et aussi, celle où elle était à jour, exact, complète et exploitable. Euh non, en fait je n'ai jamais vu ce dernier cas...
D'où ma dernière idée : utiliser un wiki. Ca a l'air d'une bonne idée. La gestion de version (date, auteur, archivage, etc...) est automatique. C'est un outil prévu depuis le départ pour l'écriture collaborative, hors les développements complexes sont l'oeuvre de plusieurs intervenants. Il est facile d'y corriger une erreur, d'ajouter une note de bas de page. On pourrait même imaginer des fonctions additionnelles de génération automatique de documentation, basée sur les outils de type Javadoc où modélisation de données, et des outils de saisie adaptés (diagramme UML). On n'a pas à créer une nouvelle copie à chaque changement, on peut donc éditer le wiki pour une modification mineure. Le gain de temps représenté permettrait enfin de disposer d'une documentation pertinente sans effort important. De plus, la documentation en ligne est immédiatement disponible.
J'ai donc effectué une recherche pour trouver des retours d'expérience, et des moteurs de wiki dédiés à ce type d'application. Et là stupeur : je ne trouve rien.
J'ai donc décidé de lancer ce sujet. Tout d'abord, quand j'ai une idée originale, c'est toujours pour m'apercevoir que quelqu'un l'a eu avant, et je manque souvent de chance dans mes recherches. Si vous êtes au courant d'une expérience de ce type, merci de m'aiguiller.
Ensuite, qu'en pensez-vous? D'après vous, est-ce que ça permettrait de disposer d’une meilleure documentation? Tout en y consacrant moins d'efforts?
Quel moteur de wiki serait le plus adapté?
Y aurait-il des réticences de la part des directions, attachées à des processus définis par les normes iso?
La mise en place poserait-elle des problèmes particuliers?
Merci d'avance.
(Note aux modérateurs : j'ai relu six fois la liste des forums sans être sûr que c'est le forum approprié. Je pensais au début au forum débat. Si je me suis trompé, merci de déplacer ce sujet dans le forum approprié.)
Répondre avec citation
Envoyé par Laplix
Partager