Laat je agent de handleiding schrijven voor je uitrolt

Je hebt met je agent een tooltje gebouwd en het werkt. Je collega's willen het ook gebruiken. En dan komt de vraag die niemand graag hoort: hoe installeer ik dat? Je weet het zelf nog ongeveer, want je zat erbij. Maar binnen drie maanden weet je het misschien ook niet meer. En wie er na jou aan verder werkt, weet het al helemaal niet.

In een vibe coding-opleiding vertelde ik over een organisatie met oude software. Ze wilden daar met AI makkelijker mee werken, en ik bouwde voor hen een paar tools. Het bouwen was eigenlijk maar de helft van het werk. Andere mensen moesten later ook kunnen lezen hoe die tools werken. En bij uitbreiding ook hun agents. Dus moest alles gedocumenteerd zijn.

Kopieer de prompt onderaan dit artikel. Daarmee laat je je agent de documentatie schrijven voor je iets live zet.

Cartoon

Documentatie is een stap voor het deployen

Vroeger was documenteren een klus die je uitstelde tot het nooit meer gebeurde. Je moest alles zelf uitschrijven, en dat deed niemand graag. Vandaag hoeft dat niet meer. Je zegt gewoon tegen je agent: voor we deployen, schrijf de documentatie.

Ik zou die vraag op een vast moment stellen, net voor je iets live zet. Dan weet je agent nog alles, want hij heeft het net gebouwd. Hij kent de structuur, de keuzes en de stappen om het te installeren. En dan schrijft hij dat op in gewone taal, in een Markdown-bestand.

Op GitHub zie je dat mooi. Zet je een README in je repo, dan staat die meteen op de homepage van die repo. Wie de repo opent, leest dus eerst wat de tool doet. Bij die organisatie stonden daar de tools zelf, de volledige structuur en een handleiding om alles te installeren. Zo konden de mensen intern er makkelijk zelf mee aan de slag.

Veelgestelde vragen

Wanneer laat ik mijn agent de documentatie schrijven?

Net voor je iets live zet. Dan weet je agent nog alles over de structuur en de keuzes, want hij heeft het net gebouwd.

Wat is een README?

Een README is een Markdown-bestand in de hoofdmap van je project. Op GitHub verschijnt het meteen op de homepage van je repo, zodat iedereen eerst leest wat de tool doet en hoe je hem installeert.

Waarom documenteren als ik de enige gebruiker ben?

Tools die werken, gaan vaak rond in een organisatie. En wie er later aan verder werkt, mens of agent, moet kunnen lezen hoe alles in elkaar zit.

Waar kan ik dit oefenen?

In de opleiding ‘Vibe Coding met AI’ bouw je zelf een tool, van het eerste idee tot het deployen. Kijk bij Workshops & Events of bij de AI Builder Hackathon.

Lees gratis verder

Registreer gratis met je e-mailadres en lees verder. Met je account open je de gratis artikels in de leerruimte; de rest is voor abonnees, vanaf Learn Plus.

Al geregistreerd? Nog geen account?

Nog geen reactiesLees de reacties

Reacties

Leden reageren hier en lezen elkaars reacties. Registreer gratis of log in om mee te praten.

Registreer gratis of log in

Nog geen reacties. Wat neem jij mee?

    QR-code van deze pagina

    coachsteff.live/laat-je-agent-de-handleiding-schrijven

    Scan met je telefoon om de pagina te openen.