Partager
Partager
Partager

Remplissez le formulaire suivant et nous communiquerons avec vous d’ici les 24 prochaines heures.

Merci. Votre message a été envoyé. Nous communiquerons avec vous sous peu.

Les bénéfices de la doc pour vos projets Web

En quoi la rédaction d’un document peut-il être un élément déterminant dans le succès d’un projet ? La documentation des ressources et des développements sont la plupart du temps de mauvaises qualités ou plus souvent inexistantes. Les utilisateurs et collaborateurs sont souvent bloqués et perdent du temps à chercher l’information. Cet article met l’accent sur l’importance de documenter,  partager  et maintenir celle-ci dans un travail collaboratif.

Quand tout le reste échoue, lisez la documentation pour vous aider.

L’injonction de lire la documentation a une histoire longue et colorée. Les utilisateurs sont réprimandés de ne pas avoir consulté la documentation, mais, dans de nombreux cas, l’utilisateur peut difficilement être blâmé. La documentation est souvent de mauvaise qualité, incomplète, mal organisée,  et n’est pas toujours présente.

Comme les documents baissent de qualité, les utilisateurs cessent de se tourner vers eux et les collaborateurs cessent de les maintenir. Tous ces acteurs n’accordent plus de temps dans la rédaction des documents techniques ou des documents fonctionnels et se résignent à l’idée que de toute façon ils ne seront pas lus. C’est en effet une tendance inquiétante, documenter des processus se fait rare voire plus ! Considérant que c’est une perte de temps ou que c’est facile, les gens stipulent qu’ils n’ont pas besoin de documentation !

Une des croyances les plus pernicieuses dans l’industrie du logiciel est la conviction que, si un programme est bien conçu ou écrit, il n’y aura pas besoin de documents.

Seulement, pour expérience personnelle dans le monde du développement d’applications informatique, il est crucial de documenter ces actions. Souvent je pose ces questions avec de moins en moins d’espérance : les besoins sont-ils listés dans un document ? Existe-il un document technique sur l’architecture du projet ? Les processus que vous avez mis en place dans l’accomplissement de vos développements sont explicités dans un document ?

Souvent une quelconque documentation se rapprochant de mes demandes est inexistante. De ce fait, si personne n’a de réponses à toutes mes interrogations, je perds du temps à trouver l’information. Également si une personne parmi mes collaborateurs a la réponse je vais lui amputer de son temps pour qu’il me transmette son savoir.

La communication orale rend l’information volatile alors qu’un document écrit est figé.

Aujourd’hui obtenir l’information rapidement est déterminant, et on dispose de plusieurs outils pour maintenir et partager celle-ci. Il est important de reconsidérer la base qu’est de documenter ces processus pour ne pas perdre et partager nos connaissances. C’est aussi un gain de temps pour tous les acteurs. En effet, de nouveaux collaborateurs peuvent arriver au fil de l’eau et s’intégrer rapidement dans un projet et appréhender les outils utilisés en se référant aux documents associés.

Le document composé d’un sommaire peut être historisé et versionné. Il est intéressant de connaître tous les collaborateurs qui ont interagis et fait évoluer celui-ci. Savoir leur fonction et les parties qu’ils ont rédigées. Par conséquent, si le lecteur a besoin de réponses, il connait les acteurs concernés.

Au final la documentation est importante. Elle fait gagner de l’argent et un temps considérable, à ne plus négliger dans la maintenance et l’évolution d’un projet. Cependant, de nombreuses entreprises ont même cessé d’essayer de l’écrire.

© 2019 Pixel Circus. Tous droits réservés
Pixel Circus | Stratégie Web Design