Une documentation qui se contrôle

À propos de ce projet

La documentation pourrit en silence. Une page annonce huit modules, le code en compte treize, et personne ne le remarque jusqu'à ce qu'un nouveau venu s'y fie. Nous en avions assez de cet échec discret : nous l'avons rendu mesurable.

L'outil lit trois choses à la fois : ce que contient réellement le code, les notes que nous écrivons à côté, et la documentation telle que publiée. Il cartographie leurs liens, consigne ce qui fonde chaque affirmation, et signale ce qui ne colle plus. Modifiez un module et vous pouvez demander quelles pages viennent de devenir fausses.

Il n'écrit jamais de prose. Il se contente de comparer et de compter, et c'est précisément ce qui le rend digne de confiance, et pourquoi notre propre outillage IA l'interroge plutôt que de deviner la base de code. La formulation et la traduction viennent par-dessus, là où se tromper se corrige à peu de frais.

Points forts

• Compare le code, nos notes et la documentation publiée en une seule passe
• Consigne ce qui fonde chaque affirmation : rien ne repose sur la mémoire
• Signale les pages qui ne correspondent plus au code
• Modifiez un module, voyez quelles pages viennent de vieillir
• Il compare et compte, n'écrit jamais : les outils peuvent s'y fier