Devrais-je désinstaller mes outils de documentation ?

Sur le Software documentation weblog,on peut lire

If you are a software developer and if you are writing documentation: read Bob McWhirter’s Developers Don’t Write Documentation and stop writing documentation.

Je trouve ça dur à avaler. En effet, le logiciel, du point de vue documentaire, se divise en deux groupes :

  1. Il y a un documentaliste dans l’équipe de développement, qui fournit une grosse valeur ajoutée en écrivant une documentation accessible et lisible.
  2. La documentation ne peut être écrite que par les développeurs ou les utilisateurs.

Le premier groupe peut être considéré comme chanceux. Mais, dans le second, pouvez-vous, en tant que « père » du logiciel, accepter que les utilisateurs décrivent son fonctionnement ? Personnellement, je n’y arrive pas. Donc j’ai toujours décidé qu’il vallait mieux leur fournir un brouillon. Si il y a un documentaliste souhaitant la corriger ou l’améliorer, tant mieux. Autrement, il y a au moins une documentation. Mais aucun développeur ne devrait pouvoir esquiver l’importante tâche qu’est l’écriture d’une documentation. Cette tâche a en fait plus d’un but. Bien sûr elle fournit à l’utilisateur des moyens de comprendre des logiciels parfois complexes, mais elle pousse aussi les développeurs à avoir de leur création une vue d’ensemble, afin de permettre aux débutants de mieux le comprendre. Et pour ça, cette étape est importante (même si elle ne vaut pas un essai du logiciel par un utilisateur de test).

Publicités

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s