Cluedoc : une compétence d’agent pour rédiger une documentation qui aide à comprendre une base de code

Vous êtes peut-être épuisé par le code que les agents de programmation produisent à la chaîne ? Au point d’avoir renoncé à comprendre votre logiciel ?

Quand un agent écrit du code, le comprendre devient l’essentiel. Vous n’avez pas tapé une seule ligne vous-même et la base de code change en permanence : comment savoir ce que fait réellement le système, et si la prochaine modification est sûre ? Même si l’agent travaille à votre place, vous devez avoir une compréhension minimale du système que vous construisez pour l’orienter dans la bonne direction.

C’est pour cela que nous avons créé Cluedoc. Cluedoc est une Agent Skill qui permet aux agents de programmation de rédiger des documents faciles à lire par des humains. Les documents de Cluedoc sont conçus pour être lus. Ils laissent de côté les détails techniques et se concentrent sur les concepts de haut niveau.

Cluedoc considère le système comme un arbre de fonctionnalités (features) et rédige un document (paper) pour chacune d’elles. Les documents vivent dans la base de code en pur Markdown et restent toujours à jour au fil de la boucle de travail. Pas besoin de serveur, ni de base de données.

La landing page liée est elle-même un document Cluedoc consacré à Cluedoc. Vous y trouverez aussi des exemples de documents générés pour Flask, Cobra et Commander : n’hésitez pas à y jeter un œil.