Let your agent write the manual before you deploy

You have built a little tool with your agent and it works. Your colleagues want to use it too. And then comes the question nobody likes to hear: how do I install that? You still roughly know it yourself, because you were there. But in three months you might not know it anymore either. And whoever continues working on it after you, certainly will not know.

In a vibe coding training I talked about an organisation with old software. They wanted to work with it more easily using AI, and I built a few tools for them. Building was actually only half the work. Other people had to be able to read how those tools work later on. And by extension their agents too. So everything had to be documented.

Copy the prompt at the bottom of this article. With it you let your agent write the documentation before you put something live.

Documentation is a step before deploying

In the past, documenting was a chore you postponed until it never happened. You had to write everything out yourself, and nobody liked doing that. Today that is no longer necessary. You simply say to your agent: before we deploy, write the documentation.

I would ask that question at a fixed moment, just before you put something live. Then your agent still knows everything, because it has just built it. It knows the structure, the choices and the steps to install it. And then it writes that down in plain language, in a Markdown file.

You see that nicely on GitHub. If you put a README in your repo, it is immediately on the homepage of that repo. Whoever opens the repo, therefore first reads what the tool does. At that organisation, the tools themselves, the complete structure and a manual to install everything were there. That way the people internally could easily get started with it themselves.

Frequently asked questions

When do I let my agent write the documentation?

Just before you put something live. Then your agent still knows everything about the structure and the choices, because it has just built it.

What is a README?

A README is a Markdown file in the root folder of your project. On GitHub it immediately appears on the homepage of your repo, so that everyone first reads what the tool does and how you install it.

Why document if I am the only user?

Tools that work often go around in an organisation. And whoever continues working on it later, human or agent, must be able to read how everything is put together.

Where can I practise this?

In the 'Vibe Coding with AI' training you build a tool yourself, from the first idea to deploying. Look at Workshops & Events or at the AI Builder Hackathon.

Keep reading for free

Register free with your e-mail address and read on. Your account opens the free articles in the learning space; the rest is for subscribers, from Learn Plus up.

No comments yetRead the comments

Comments

Members comment here and read each other's comments. Register for free or sign in to join the conversation.

No comments yet. What do you take away?