Cette page a été traduite du néerlandais à l'aide de l'IA.
Modèle, un README que votre successeur et son agent comprennent
Votre outil fonctionne, et vous voulez le mettre en ligne. Seulement, les explications sont encore dans votre tête, et dispersées dans une discussion de la semaine dernière. Ce modèle donne à votre agent une forme fixe pour le manuel : un README en Markdown. Et vous recevez les prompts avec pour le lui faire remplir. Ensuite, vous le testez avec un agent qui n'a jamais vu votre outil. Comptez un petit quart d'heure, dans la session où vous avez construit l'outil.
L'ossature d'un bon README
Vous n'avez pas besoin de partir de zéro. Un README qui fonctionne répond aux questions qu'un nouveau collègue vous enverrait autrement par e-mail. Et ces questions sont étonnamment prévisibles. Voici les titres que j'utiliserais.
# [Nom de votre outil]
## Ce qu'il fait et pour qui
## Ce dont vous avez besoin
## Installation et démarrage
## Comment il est structuré
## Paramètres et accès
## Ce qu'il ne fait pas
## Limites connues et questions ouvertes
## Pour l'agent qui continuera à travailler dessusCe dernier titre peut paraître un peu étrange. Pourtant, cette partie sera probablement la plus lue. Votre successeur demande à son IA de modifier quelque chose, et cette IA commence par lire.
En tant que Member, vous recevez ci-dessous le modèle complet, avec ce qui doit figurer sous chaque titre. Il est accompagné du prompt qui permet à votre agent de le remplir. Et vous recevez un test avec un nouvel agent, qui montre si votre README fonctionne vraiment.
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.
Consultez votre boîte mail
0 appréciationsPas 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 connexionPas encore de commentaires. Que retenez-vous ?