Le codeur écrivain

L'entêté auteur

La salle est vide. Un être s'avance sur scène et s'exclame.

J'ai vu beaucoup d'auteur dans des fichiers de code et la plupart ont reconnu une chose : il fallait faire vite, j'ai fait sale.

Étant l'auteur de cette pièce, je vais donc m'arrêter là et prendre mon cachet. J'ai estimé que le sujet était traité et au besoin, on reviendra vers moi. J'ai mis des prospectus avec # author: leparefou un peu partout. Les gens me retrouveront.

Enfin. Si on reste en contact et que je ne quitte pas la scène.

La chaîne du retard

Imaginons simplement que mon sujet s'arrêtait au premier point et qu'un autre artiste reprenait la scène. Qu'elle ne serait pas sa surprise de voir que le sujet étudié était si pauvrement maltraité. Il m'en aurait voulu pour lui avoir laissé une telle... immondice !

De quoi parle-t-on ? Quels sont les axes du discours ? Les positions à adopter ? Où dois-je aller ? Qu'attendez-vous de moi sur ce sujet ? - Seraient probablement les premières interrogations de ce pauvre être.

Des échanges, des rencontres, des pauses-café lui auront alors permis de comprendre que le sujet principal de cette pièce est, qu'en tant que codeur, nous sommes avant tout des auteurs.

Des auteurs de code certes, mais qui sera relu, reformulé, réétudié par nos pairs afin de répondre à une seule et unique chose : un problème posé.

Posons-nous maintenant sur la longueur de ce discours en cet instant et comparons là à celle du premier point. Comprenez-vous désormais pourquoi ce second point est nommé ainsi ? Vous venez de perdre plus de temps sur le même sujet sans pour autant être avancé sur ce que l'auteur veut vous dévoiler. Et pourtant, dans le fond, vous savez où il veut en venir.

L'affreux virus du doc

Afin que cette chaîne de retard perde un peu de ses maillons, un docteur est arrivé avec une solution miracle. Ne sachant la nommée autrement, il instaura le terme de documentation.

Les êtres, alors habitué à écrire du code, furent stupéfaits. Enchaîner des mots pour répondre à un problème qu'ils risquent de générer par le simple fait d'écrire du code les a abattus. Alors qu'écrire du code permet d'avoir un résultat factuel, une documentation est sujette à interprétation. L'indécence indécision s'immisce alors sur ce que la documentation doit documenter. Toujours est-il qu'elle doit désormais être intégrée à la livraison.

Hésitant et sans rigueur, un premier jet sera proposé au client. Ce dernier ne comprenant pas les hiéroglyphes de son livreur demandera des éclaircissements sur ce que ce colis décrit. Par des échanges divers et variés, le colis est remodelé et façonné afin que le besoin ainsi exprimé soit validé.

Supposons un autre cas, où le temps est passé à tel point qu'on en oublie qui, du client ou du codeur, à documenter l'écrit. Le client et le codeur lisent attentivement le manuscrit de leur côté pour se retrouver plus tard à la même assemblée. Le client indiquera alors que ce besoin est un sac de noeud. Le codeur acquiesça également. Les temps changent, les technos se meurent, ce qui semblait clair hier s'est obscurcie au fil du temps. Un maillon supplémentaire s'ajoute alors, faisant muter la chaîne du retard.

Le codeur et ses compagnons

Coder, tester, documenter, relire, reformuler semble une routine assez simple. Alors pour faciliter encore plus le travail de notre valeureux sujet, nous lui ajoutons d'autres compagnons dans son aventure.

Ses compagnons vont relire son travail, faire des études de suivi, faire des statistiques sur lui et vont se demander si finalement un autre codeur ne pourrait pas venir l'aider. Le projet n'allant pas assez vite.

Un relecteur certifié va examiner le document et indiquer à nos heureux compères que le style du paragraphe à la page 12 n'est pas conforme. Étant relecteur, il n'est en rien correcteur. La responsabilité impute donc aux auteurs de document d'être plus rigoureux et conforme.

Le fraîchement arrivé vient avec une idée. Rien d'intelligent, mais avec beaucoup d'artifice, un nouvel outil intègre la suite du projet. Cet outil analyse le code, la documentation, le contexte. Plusieurs itérations sont alors réalisées sur ce magnifique outil, à tel point qu'on doit aussi le documenter pour en connaître les cas d'usages.

Fraîchement arrivé, rapidement parti, le compère s'enfuit et nous laisse alors avec son outil. La documentation de son outil est alors relu par le relecteur qui nous indique que la tournure des phrases est familière. N'étant plus que le seul sur le projet, notre sujet se retrouve contraint et forcé d'ajouter à sa besace ce brumeux programme.

C'est à ce moment-là que cela se produit. Le sujet rempli de sentiment refoulé s'écria : STOP ! Ces collègues le regardèrent apeurer, un effet de contraste venait de se réaliser. Habitué à le voir écrire, le voilà désormais en train de s'exprimer en parlant.Je pars, indiqua-t-il avec son ton sans émotion.

Cet être qui était là depuis le début. Qui était là à chaque modification. Qui était là sans rien dire, quitte enfin la scène. Laissant derrière lui un vent de panique que l'encre ne pouvait décrire.

L'aparté

Mesdames, Mesdemoiselles et Messieurs, cher lecteur, chère lectrice, laissez-moi à mon tour terminer cet écrit.

Ce que vous venez de lire, vous l'aurez compris, parle de l'effort à apporter sur ce qui est attendu d'une documentation. Ces petites mises en scène ne sont que de simple étude de cas. Je n'aurai pas l'impolitesse de vous décrire les différents points défendus.

Pour ma part, je rédige toujours au plus simple. Je commence par expliquer l'objectif du projet, à quoi il est censé répondre comme problème. Je rédige la solution en sachant pertinemment qu'elle sera relue en première par mes successeurs et successeuses. Pas de drapeau, pas de nombre magique, pas d'effet de bord - en somme du clean code.

Si cette notion de clean code ne vous ait pas familière, je vous invite à lire le livre en anglais de Robert C.Martin.

Pour ce qui est de la conformité des gabarits, je les vois comme des textes à trous. Mes écrits ayant déjà comblé l'essentiel.

Merci à vous de m'avoir lu. Je vous souhaite de bonnes rédactions.

L'être réalise un salut.

Les rideaux se ferment.