Ontwikkel een Prompt Template voor AI-Generatie van Technische Documentatie
description
Met deze prompt kan ik snel en effectief een aangepaste template ontwikkelen die AI helpt om gestructureerde en begrijpelijke technische documentatie te genereren. Dit lost het probleem op van tijdrovend handmatig schrijven en zorgt voor consistente kwaliteit en duidelijkheid. Het is effectiever dan algemene schrijfprompts omdat het specifiek focust op het technische karakter en de doelgroep van de documentatie.
prompt
Help me een krachtige prompt template te maken die AI begeleidt bij het genereren van technische documentatie voor mijn product: <beschrijf het product of de technologie>. Voeg variabelen toe zoals documentatietype: <type documentatie zoals handleiding, API-documentatie, o ...
try_prompt
generate_helper
disclaimerOnPageApi
tags
ai_answers
provider: openai
model: gpt-4.1-nano
Natuurlijk! Hier is een krachtige prompt-template voor het genereren van technische documentatie voor jouw product, inclusief variabelen en een voorbeeld:
**Prompt-template:**
---
"Maak een {documentatietype} voor het product: {doelgroep}. Het gewenste detailniveau is: {niveau}. Zorg dat de inhoud duidelijk, technisch accuraat en geschikt is voor de doelgroep. Gebruik een professionele, begrijpelijke toon en structuur de informatie logisch. Vermeld belangrijke functies, installatie-instructies, gebruiksaanwijzingen en onderhoudstips indien relevant."
**Variabelen:**
- {documentatietype} (bijvoorbeeld Handleiding, Technische specificaties, FAQ)
- {doelgroep} (bijvoorbeeld eindgebruikers, technische monteurs, installateurs)
- {niveau} (bijvoorbeeld Basis, Geavanceerd, Uitgebreid)
---
**Voorbeeld van een effectieve prompt:**
"Maak een Handleiding voor het product: Slimme thermostaat X100. Het gewenste detailniveau is: Basis. Zorg dat de inhoud duidelijk, technisch accuraat en geschikt is voor eindgebruikers. Gebruik een professionele, begrijpelijke toon en structuur de informatie logisch. Vermeld belangrijke functies, installatie-instructies, gebruiksaanwijzingen en onderhoudstips indien relevant."
---
**Waarom deze prompt geschikt is:**
Deze prompt is specifiek en gestructureerd, waardoor de AI gericht wordt op het genereren van duidelijke, relevante en goed georganiseerde technische documentatie. Door de variabelen te gebruiken, kun je snel verschillende documentatievormen aanpassen aan je doelgroep en detailniveau, wat de kwaliteit en toepasbaarheid van de output verbetert. De instructie om een professionele en begrijpelijke toon te gebruiken zorgt voor teksten die geschikt zijn voor jouw doelgroep en het product.
provider: deepseek
model: deepseek-chat
Zeker, hier is een krachtige prompt template in het Nederlands, inclusief een uitgewerkt voorbeeld en uitleg.
---
### **Krachtige Prompt Template voor Technische Documentatie**
**Template:**
"Handel als een ervaren technisch schrijver gespecialiseerd in consumentenelektronica. Je hoofdtaak is het genereren van [[documentatietype]] voor het product [[productnaam + model]].
De primaire doelgroep is [[doelgroep]].
Het detailniveau moet [[detailniveau]] zijn.
Houd je aan de volgende richtlijnen:
1. **Structuur:** Gebruik een logische, hiërarchische opbouw met duidelijke kopjes (bijv. Inhoud, Introductie, Veiligheid, Bediening, Probleemoplossing).
2. **Tone of Voice:** Houd de toon formeel, instructief, neutraal en geruststellend. Vermijd jargon waar mogelijk; leg technische termen desnoods kort uit.
3. **Focus:** Richt je op heldere, actiegerichte instructies en essentiële informatie voor de eindgebruiker.
4. **Formattering:** Gebruik opsommingen, genummerde lijsten en vetgedrukte tekst voor belangrijke waarschuwingen of kernhandelingen.
5. **Doel:** De gebruiker moet in staat zijn het product veilig en efficiënt te gebruiken zonder externe hulp.
Genereer nu de documentatie voor het volgende onderdeel: [[specifiek onderwerp of sectie]]."
---
### **Voorbeeld van een Effectieve Prompt**
**Invulling van de template:**
"Handel als een ervaren technisch schrijver gespecialiseerd in consumentenelektronica. Je hoofdtaak is het genereren van een **Handleiding** voor het product **Slimme thermostaat X100**.
De primaire doelgroep is **eindgebruikers (thuisgebruikers zonder technische achtergrond)**.
Het detailniveau moet **Basis** zijn.
Houd je aan de volgende richtlijnen:
1. **Structuur:** Gebruik een logische, hiërarchische opbouw met duidelijke kopjes.
2. **Tone of Voice:** Houd de toon formeel, instructief, neutraal en geruststellend. Vermijd jargon waar mogelijk; leg technische termen desnoods kort uit.
3. **Focus:** Richt je op heldere, actiegerichte instructies en essentiële informatie voor de eindgebruiker.
4. **Formattering:** Gebruik opsommingen, genummerde lijsten en vetgedrukte tekst voor belangrijke waarschuwingen of kernhandelingen.
5. **Doel:** De gebruiker moet in staat zijn het product veilig en efficiënt te gebruiken zonder externe hulp.
Genereer nu de documentatie voor het volgende onderdeel: **"Eerste installatie en aansluiten op stroom."**"
---
### **Waarom deze prompt geschikt is voor duidelijke technische teksten**
Deze prompt is effectief omdat hij de AI op een gestructureerde manier begeleidt en alle cruciale elementen voor goede technische documentatie specificeert:
1. **Roldefinitie (`Handel als een ervaren technisch schrijver...`):**
* **Waarom:** Dit geeft de AI direct de juiste context en expertise. Het dwingt het model om te putten uit informatie en een schrijfstijl die bij die rol past, in plaats van een generieke, mogelijk onnauwkeurige reactie.
2. **Specifieke Invulvariabelen (`Handleiding`, `Slimme thermostaat X100`, `Basis`):**
* **Waarom:** Dit voorkomt ambiguïteit. De AI weet exact welk type document, welk product en voor wie het moet schrijven. "Basis-detailniveau" is een cruciale instructie die ervoor zorgt dat de output niet overladen raakt met technische specificaties die de doelgroep niet nodig heeft of begrijpt.
3. **Duidelijke Richtlijnen (Punten 1 t/m 5):**
* **Waarom:** Deze fungeren als een kwaliteitscontrole-checklist voor de AI. Ze dicteren niet alleen *wat* er geschreven moet worden, maar ook *hoe* het geschreven moet worden (structuur, toon, focus). Dit is het belangrijkste onderdeel om een consistente, professionele en gebruiksvriendelijke output te garanderen. De focus op "actiegerichte instructies" is essentieel voor een handleiding.
4. **Focus op een Concreet Onderdeel (`Eerste installatie en aansluiten op stroom`):**
* **Waarom:** Dit maakt de taak behapbaar voor de AI en zorgt voor diepgang. In plaats van een vage, oppervlakkige handleiding te vragen, levert dit een gedetailleerde, bruikbare sectie op. Je kunt deze prompt hergebruiken voor elk hoofdstuk van je documentatie (bv. "Koppelen met de app", "Dagelijkse bediening", "Veelvoorkomende problemen oplossen").
5. **Definitie van het Doel (`De gebruiker moet in staat zijn...`):**
* **Waarom:** Dit herinnert de AI constant aan het ultieme doel van de tekst: functionaliteit en gebruiksvriendelijkheid. Elke zin moet bijdragen aan dit doel, wat overbodige informatie en uitweidingen minimaliseert.
Kortom, deze prompt neemt de giswerk weg voor de AI. Het geeft duidelijke randvoorwaarden, richtlijnen voor stijl en een concreet doel, wat resulteert in een nauwkeurige, goed gestructureerde en direct bruikbare technische tekst die perfect is afgestemd op je product en doelgroep.