samedi 20 mars 2021

Il faut documenter : j'y reviens !


La question de la documentation est bien connue des informaticiens, qui enchaînent des lignes de programme et qui arrivent à des programmes énormes... Comment y dépister des erreurs ? Comment les modifier ultérieurement ? Quand c'est programmes ne sont ni structurés ni expliqués, c'est impossible.

Et c'est la raison pour laquelle on n'insiste jamais assez :  il faut documenter.

D'ailleurs, cette documentation n'est pas pour seulement pour les autres, mais pour soi-même, et c'est la raison pour laquelle on doit d'abord penser à un organigramme, qui consigne en français ce qui sera codé.

Puis il faudra entrer dans le détail, et indiquer par des phrases en français (des "commentaires") ce que font les opérations que l'on met en oeuvre.

Ce qui vaut pour l'informatique vaut évidemment pour le calcul algébrique, le calcul matriciel, tous les calculs en réalité.
Et insistons : il ne s'agit pas seulement de faire cela pour les autres, mais pour soi-même !

J'ai encore vu hier l'exemple de feuilles de calcul de certains amis qui enchaînaient les opérations sans aucune phrase en français... et qui étaient perdus.

Evidemment, quand ils m'ont soumis le problème qu'ils ne parvenaient pas à résoudre seuls (puisqu'ils étaient perdus), je n'y suis pas arrivé, parce que même eux ne savaient pas dire ce qu'ils avaient fait.

Il y a un point encore supplémentaire à donne,  qui est que le calcul algébrique notamment est fondé sur la pensée en langage naturel  : on n'a pas assez répété que les équations ne sont que des expressions d'idées en langage forme. Une équation correspond à une idée en langage naturel.

Bien sûr, il y a quelques génies qui  calculent comme chantent les rossignols, qui n'ont plus besoin de cette traduction, mais avant d'être un génie, il y a lieu d'apprendre à le devenir, et le seul fait que les jeunes qui apprennent fassent des erreurs montre qu'ils n'ont pas encore atteint cet état. Ils doivent donc apprendre tranquillement, et cela passe par de la documentation... qui ne doit pas se faire à posteriori, mais a priori !

Car on conservera aussi cette idée que nous devons avoir des objectifs clairs sans quoi nous ne pourrons pas trouver les chemins qui y mènent.

Oui, quand on fait un calcul il y a un objectif et on ne se lance pas au hasard vers cet objectif, mais selon un chemin qui doit avoir été prédéterminé.

Autrement dit, il faut dire en français quel est l'objectif, puis soliloquer (par écrit !) pour analyser le chemin, les étapes. Et soliloquer encore pour dire comment on parcourera les petits segments du chemin entre les étapes.

Et c'est alors amusant : souvent, ayant ainsi écrit en français, la traduction mathématique ou informatique devient évidente !

Aucun commentaire:

Publier un commentaire

Un commentaire? N'hésitez pas!
Et si vous souhaitez une réponse, n'oubliez pas d'indiquer votre adresse de courriel !