AI-prompt: Documentatie of README schrijven
Met deze AI-prompt schrijf je als developer documentatie of een README die anderen écht verder helpt — duidelijk hoe je het installeert, gebruikt en bijdraagt, zonder de kennis die alleen jij hebt voor te veronderstellen.
Ook compatibel met:ClaudeGemini
#CONTEXT: Neem de rol aan van een developer die weet dat goede documentatie het verschil maakt tussen een project dat anderen gebruiken en een dat in de la verdwijnt — en dat de meeste docs falen omdat de schrijver kennis veronderstelt die alleen hij heeft (de "vloek van de kennis"). Je weet dat een goede README de lezer snel op weg helpt: wat is dit, wat lost het op, hoe installeer en gebruik ik het, en waar vind ik meer. Je denkt vanuit de nieuwkomer die het project voor het eerst ziet: kan die het draaiend krijgen zonder jou te bellen? Je helpt documentatie schrijven die zelfstandig verder helpt. #DOEL: Schrijf documentatie of een README die een nieuwe gebruiker zelfstandig op weg helpt: wat het is, hoe je het installeert en gebruikt, en waar meer te vinden is. #WERKWIJZE: 1. Vraag me eerst om: wat het project/de code is en doet, voor wie het is, hoe je het installeert en gebruikt (stappen, voorbeelden), en eventuele bestaande info/code. Vraag niets méér. 2. Bouw de structuur: wat is dit (en welk probleem lost het op) → installatie → gebruik (met voorbeelden) → configuratie → bijdragen/meer info. 3. Schrijf helder en zonder veronderstelde kennis; geef concrete, kopieerbare voorbeelden. 4. Markeer wat ik moet aanvullen (versies, badges, licentie) en wat ik op juistheid moet checken. #INFORMATIE VAN MIJ: - Wat het is en doet: [INVULLEN] - Voor wie: [INVULLEN] - Installatie + gebruik (stappen/voorbeelden): [INVULLEN] - Bestaande info/code (optioneel): [PLAK HIER] #OUTPUT: Documentatie/README met: wat het is + het probleem · installatie · gebruik (met voorbeelden) · configuratie · bijdragen/meer info. Met wat ik moet aanvullen gemarkeerd. Zo werkt goede documentatie (illustratief): geeft een kopieerbaar startvoorbeeld waarmee de lezer binnen vijf minuten iets werkends heeft — geen muur van proza. #BELANGRIJKE REGELS: - Schrijf voor de nieuwkomer; veronderstel geen kennis die alleen jij hebt. - Geef concrete, kopieerbare voorbeelden; toon, niet alleen vertel. - Structureer zodat de lezer snel vindt wat hij zoekt. #BEPERKINGEN: - Verzin geen commando’s of versies; markeer wat ik moet invullen/checken. - Houd het actueel; verouderde docs zijn erger dan geen docs. - Lever de documentatie; de juistheid controleer ik.
Training
Leer zelf prompts schrijven die altijd werken — niet alleen kopiëren.
Dennis Claassen
AI-trainer · 35+ teams getraind
Wanneer gebruik je deze prompt?
Goede documentatie maakt het verschil tussen een project dat anderen gebruiken en een dat in de la verdwijnt — en de meeste docs falen door veronderstelde kennis (de "vloek van de kennis"). Deze prompt schrijft een README die de nieuwkomer zelfstandig op weg helpt, met concrete, kopieerbare voorbeelden.
Code die anderen begrijpen en gebruiken. Onderdeel van de set voor developers.
Tips
- 1Tool-niveau: document / canvas, zodat je de docs kunt redigeren en in je repo zetten.
- 2Geef een kopieerbaar startvoorbeeld waarmee iemand binnen vijf minuten iets werkends heeft — dat zegt meer dan een muur tekst.
Veelgestelde vragen
Wat hoort er in een goede README?
Wat het project is en welk probleem het oplost, hoe je het installeert, hoe je het gebruikt (met kopieerbare voorbeelden), configuratie, en waar je meer vindt of kunt bijdragen. De prompt bouwt die structuur en schrijft voor de nieuwkomer, zonder veronderstelde kennis.
Waarom faalt de meeste documentatie?
Door de "vloek van de kennis": de schrijver veronderstelt wat voor hem vanzelfsprekend is, maar wat de nieuwkomer juist mist. De prompt schrijft vanuit het perspectief van iemand die het project voor het eerst ziet en geeft concrete voorbeelden in plaats van proza.
Probeer ook
Prompts die goed combineren met deze
Code · Beste in Claude
Codecommentaar of docstrings schrijven
Met deze AI-prompt voorzie je als developer je code van zinvol commentaar en docstrings — die de bedoeling uitleggen (het waarom), niet het overbodige herhalen van wat de code al zegt.
Bekijk promptCode · Beste in ChatGPT
Commit messages of PR-beschrijving schrijven
Met deze AI-prompt schrijf je als developer heldere commit messages of een PR-beschrijving — die uitleggen wát er veranderde en waaróm, zodat je teamgenoten (en je toekomstige zelf) het snappen.
Bekijk promptVan prompts naar resultaat
Wil je je team hier écht goed in maken?
Losse prompts kopiëren is een goed begin. In een hands-on training of begeleidingstraject leren we je team AI dagelijks, veilig en effectief inzetten — op jullie eigen werk, met jullie eigen voorbeelden.
- Hands-on, op jullie locatie
- Met jullie eigen casussen
- 180 dagen tevredenheidsgarantie
- Van eerste prompt tot werkproces
Dennis Claassen
AI-trainer · 35+ teams getraind
“De teams die AI goed inzetten, winnen van de teams die dat niet doen. Wij zorgen dat jullie bij de eerste groep horen.”