This page was translated from Dutch with AI.
Template, a README that your successor and their agent understand
Your tool works, and you want to put it live. Only the explanation is still in your head, and scattered across a chat from last week. This template gives your agent a fixed format for the manual: a README in Markdown. And you get the prompts to let it fill it in. Afterwards you test it with an agent that has never seen your tool before. Count on about fifteen minutes, in the session where you built the tool.
The skeleton of a good README
You do not have to start from scratch. A README that works answers the questions a new colleague would otherwise email you. And those questions are surprisingly predictable. These are the headings I would use.
# [Name of your tool]
## What it does and for whom
## What you need
## Installing and starting
## How it is put together
## Settings and access
## What it does not do
## Known limitations and open questions
## For the agent continuing this workThat last heading might seem a bit strange. Yet that part is probably read the most. Your successor asks their AI to adjust something, and that AI starts by reading.
As a Member you get the full template below, with what belongs under each heading. Included is the prompt that makes your agent fill it in. And you get a test with a fresh agent, which shows if your README really works.
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.
Check your inbox
0 likesNo comments yetRead the comments
Comments
Members comment here and read each other's comments. Register for free or sign in to join the conversation.
Register for free or sign inNo comments yet. What do you take away?