Sjabloon, een README die je opvolger en zijn agent snappen

Je hoeft niet bij nul te beginnen. Een README die werkt, beantwoordt de vragen die een nieuwe collega je anders zou mailen. En die vragen zijn verrassend voorspelbaar. Dit zijn de kopjes die ik zou gebruiken.

# [Naam van je tool]
## Wat het doet en voor wie
## Wat je nodig hebt
## Installeren en starten
## Hoe het in elkaar zit
## Instellingen en toegangen
## Wat het niet doet
## Bekende beperkingen en open vragen
## Voor de agent die hieraan verder werkt

Dat laatste kopje lijkt misschien wat vreemd. Toch wordt dat stuk waarschijnlijk het vaakst gelezen. Je opvolger vraagt zijn AI om iets aan te passen, en die AI begint met lezen.

Als member krijg je hieronder het volledige sjabloon, met per kopje wat erin hoort. Daarbij zit de prompt die je agent het laat invullen. En je krijgt een test met een verse agent, die laat zien of je README echt werkt.