Comment faire de la doc ?

Personnellement, Je n’ai jamais trouvé que l’agilité donnait une réponse précise à cette question 🙂

Par contre, j’ai trouvé une forme de réponse coté Lean. En effet, si le prend le point de vue de l’utilisateur final, la documentation qui n’est pas lue par l’utilisateur final peut souvent être considérée comme du « gâchis » et je considère qu’il y a donc une opportunité de réduction des coûts de production.

Depuis quelques temps, chaque fois que quelqu’un veut écrire un document, je lui pose la question suivante:

  • QUI VA LA LIRE ?

Les réponses sont le plus souvent l’une des suivantes:

  1. Untel la lit et l’utilise
  2. Je n’en sais rien mais quelqu’un devrait le faire
  3. Ce document est contractuel
  4. Notre processus dit qu’il faut la produire

Sur la réponse 1, je réponds : « C’est Ok, ce document est utile ».

Sur la réponse 2, je réponds simplement : « Mais pourquoi l’écris-tu ? », et bien souvent ce document est abandonné

Sur la réponse 3, je dis : « Ok, mais as-tu essayé de la réduire au strict minimum ? », car il y a souvent une volonté de bien faire alors que le juste nécessaire suffit souvent.

Sur la réponse 4, je dis : « Viens avec moi on va voir le responsable de ce processus pour voir si on peut le modifier ».

2 réflexions sur « Comment faire de la doc ? »

  1. Puisque tu te lances sur ce sujet quid du :
    1) quand est-ce que j’ecris le document : le jour ou untel en a besoin, le jour ou j’ai le temps, ou en meme temps que la spec/code ?
    2) Quid de la mise a jour ?
    Ecrire un document n’est pas forcement couteux, mais le maintenir a jour peut l’etre.

    3) courage !!! deja qqes articles sur ton blog !!! continues !!!

  2. 1- Si Untel en a besoin, le document est utile et la tâche de rédaction est donc à mettre dans le backlog. Sa priorité dépendra du contexte du projet.
    2- C’est généralement la mise à jour qui est couteuse, mais si le document est utile au projet … cf. point 1

    Je n’ai rien contre les documents jetables qui permettent de faire progresser la réflexion à un instant donné (comme par exemple un schéma sur un tableau blanc) … tant qu’ils restent jetables (une photo par exemple) !

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *