La documentationsuit le code.
Écris la documentation de ce module à partir du code.
- Documente le module de facturation
- Lit les fichiers du module
- Écrit la note, exemples d’appel inclus
- Note rangée dans le projet, à relire
Module export-factures
Rôle
Génère le PDF d’une facture à partir de son numéro.
Appel
exporter(numero) rend le chemin du fichier.
Suppose une facture déjà validée.
Reconstitution sur des données fictives.
Comment faire écrire la documentation d’un module par une IA ?
Dans Nexus, vous nommez le module.
- L’agent lit le code du dépôt, repère ce qu’il fait, comment l’appeler et ce qu’il suppose, puis écrit une documentation dans une note du projet.
- Elle sert ensuite à l’équipe et aux prochaines sessions.
- Vous la relisez et la corrigez avant de la partager : l’agent peut se tromper sur un détail.
Ce qui se passe, dans l’ordre.
Nommer le module
Vous indiquez le module ou le dossier à documenter. L’agent travaille sur le dépôt du projet.
Lire le code
Il parcourt les fichiers, les fonctions et les tests pour comprendre le rôle du module et ses dépendances.
Écrire la note
Il rédige une note : rôle, utilisation, exemples d’appel et points d’attention, rangée dans le projet.
Relire et partager
Vous relisez, vous corrigez ce qui est faux, puis vous décidez de la partager avec l’équipe.
Dites-le
à votre façon.
Questions fréquentes sur ce cas
La documentation reflète le code tel qu’il est lu : une intention jamais écrite n’y sera pas. Relisez avant de la partager.
Une autre question ? Écrivez-nous →Où est rangée la documentation ?
Dans une note du projet, avec les tâches et les décisions. Les prochains agents s’en servent comme repère.
L’agent met-il des mots de passe dans la note ?
Non, il documente les noms des variables sans les valeurs. Les accès restent dans le coffre-fort.
Dans le même esprit
Un outil interne en une phrase.
La vôtre et Agent
Vos parcours testés.
Navigateur et Note
Une décision retrouvée.
Projets et Note