Dans le monde de l’IT, on parle beaucoup d’outils, de méthodes agiles, ou encore de technologies, mais la documentation reste souvent la grande oubliée. Pourtant, elle est essentielle pour le bon fonctionnement des projets, qu’ils soient techniques ou fonctionnels.
𝗣𝗿𝗼𝗯𝗹𝗲̀𝗺𝗲𝘀
Il est tout à fait possible d’avoir une documentation technique :
– Frameworks et open-source : Ces projets ont souvent une documentation riche et à jour, car ils reposent sur une large communauté qui y contribue.
– Outils modernes : Il existe des solutions pour autogénérer de la documentation (ex. Swagger pour les APIs).
Pourtant, dès qu’il s’agit d’applications legacy ou internes, et surtout celles qui n’ont pas vocation à être centrales, les budgets « doc » sont souvent inexistants. Résultat : pas de documentation technique ou à base de : « t’inquiète, je commente mon code » (oui, en même temps c’est le minimum :)).
La documentation fonctionnelle, un chantier encore plus délaissé :
– Les spécifications initiales : Cahiers des charges, specs fonctionnelles et techniques sont souvent produits… Mais rarement maintenus à jour. Une fois les évolutions en place, ces documents deviennent obsolètes.
– La formation en guise de documentation : On se contente parfois de formations utilisateurs pour couvrir les besoins. Ces formations se concentrent souvent sur l’usage visible et non sur les processus sous-jacents ou les implications concrètes des actions.
Résultat : Pas de documentation officielle, potentiellement on peut retrouver les informations si on a accès à l’ensemble des documents produits depuis la création du projet et avec beaucoup de courage.
𝗟𝗲𝘀 𝗰𝗼𝗻𝘀𝗲́𝗾𝘂𝗲𝗻𝗰𝗲𝘀
Sans documentation claire, voici ce qui arrive fréquemment :
– Manque de liaison entre fonctionnel et technique : Les deux camps avancent en silos, créant des incompréhensions.
– Bugs et irritants : Lors d’évolutions, les impacts fonctionnels ou techniques non anticipés génèrent des problèmes.
– Tensions : Ces dysfonctionnements entraînent frustration et tensions.
𝗦𝗼𝗹𝘂𝘁𝗶𝗼𝗻
La solution, il faut :
– Considérer la documentation comme un élément stratégique, pas un luxe.
– Mettre en place des processus pour maintenir.
– Créer une liaison claire entre les aspects techniques et fonctionnels.
…Mais bon, ceci est une utopie dans 99% des projets…
Article d’origine : voir mon post Linkedin.