Laissez votre agent écrire le manuel avant de déployer

Vous avez construit un petit outil avec votre agent et il fonctionne. Vos collègues veulent aussi l'utiliser. Et puis vient la question que personne n'aime entendre : comment est-ce que j'installe cela ? Vous le savez encore à peu près, car vous étiez là. Mais dans trois mois, vous ne le saurez peut-être plus. Et la personne qui continuera à y travailler après vous ne le saura pas du tout.

Lors d'une formation en vibe coding, j'ai parlé d'une organisation avec d'anciens logiciels. Ils voulaient travailler plus facilement avec l'IA, et j'ai construit quelques outils pour eux. La construction n'était en fait que la moitié du travail. D'autres personnes devaient pouvoir lire plus tard comment ces outils fonctionnent. Et par extension, leurs agents aussi. Tout devait donc être documenté.

Copiez le prompt au bas de cet article. Il vous permet de laisser votre agent écrire la documentation avant de mettre quelque chose en ligne.

La documentation est une étape avant le déploiement

Autrefois, documenter était une corvée que l'on repoussait jusqu'à ce qu'elle ne soit jamais faite. Il fallait tout écrire soi-même, et personne n'aimait faire cela. Aujourd'hui, ce n'est plus nécessaire. Vous dites simplement à votre agent : avant de déployer, écris la documentation.

Je poserais cette question à un moment fixe, juste avant de mettre quelque chose en ligne. À ce moment, votre agent sait encore tout, car il vient de le construire. Il connaît la structure, les choix et les étapes pour l'installer. Et puis il écrit cela en langage courant, dans un fichier Markdown.

Sur GitHub, vous voyez cela très bien. Si vous placez un README dans votre dépôt, il se trouve immédiatement sur la page d'accueil de ce dépôt. Quiconque ouvre le dépôt lit donc d'abord ce que fait l'outil. Dans cette organisation, on y trouvait les outils eux-mêmes, la structure complète et un manuel pour tout installer. Ainsi, les personnes en interne pouvaient facilement s'y mettre elles-mêmes.

Questions fréquentes

Quand dois-je laisser mon agent écrire la documentation ?

Juste avant de mettre quelque chose en ligne. À ce moment, votre agent sait encore tout sur la structure et les choix, car il vient de le construire.

Qu'est-ce qu'un README ?

Un README est un fichier Markdown dans le dossier principal de votre projet. Sur GitHub, il apparaît immédiatement sur la page d'accueil de votre dépôt, afin que tout le monde lise d'abord ce que fait l'outil et comment l'installer.

Pourquoi documenter si je suis le seul utilisateur ?

Les outils qui fonctionnent circulent souvent dans une organisation. Et quiconque y travaille plus tard, humain ou agent, doit pouvoir lire comment tout est structuré.

Où puis-je m'exercer à cela ?

Dans la formation « Vibe Coding avec l'IA », vous construisez vous-même un outil, de la première idée au déploiement. Regardez dans Workshops & Événements ou dans le AI Builder Hackathon.

Continuez à lire gratuitement

Inscrivez-vous gratuitement avec votre adresse e-mail pour continuer la lecture. Votre compte vous ouvre les articles gratuits de l'espace d'apprentissage ; la suite est réservée aux abonnés, à partir de Learn Plus.

Pas encore de réactionsLire les réactions

Commentaires

Les membres réagissent ici et lisent les réactions des autres. Inscrivez-vous gratuitement ou connectez-vous pour participer.

Inscription gratuite ou connexion

Pas encore de commentaires. Que retenez-vous ?