Schrijven met AI

Belangrijkste principe: De schrijver heeft de eindredactie. Je kunt het schrijven van delen van de documentatie overlaten aan AI, maar je bent zelf verantwoordelijk voor het controleren, aanpassen en samenvoegen.

Deze pagina behandelt het gebruik van AI (zoals ChatGPT) bij het schrijven van technische documentatie. We hergebruiken hier relevante stukken uit de Workshop Prompt Engineering, maar richten ons specifiek op het schrijven van documentatie.

Inhoudsopgave

De schrijver heeft eindredactie

Het belangrijkste principe bij het gebruik van AI voor schrijven is: jij bent de schrijver, jij hebt de eindredactie. Dit betekent:

  • Je kunt AI gebruiken om delen van je documentatie te schrijven
  • Je kunt AI gebruiken om teksten te herschrijven of te verbeteren
  • Maar: jij bent verantwoordelijk voor de uiteindelijke kwaliteit
  • Jij controleert of alles klopt
  • Jij past aan waar nodig
  • Jij voegt alles samen tot een coherent geheel

AI is een hulpmiddel, geen vervanging voor je eigen verantwoordelijkheid als schrijver.

Kwaliteitscriteria blijven gelden

Alle onderdelen en kwaliteitscriteria waar we het op de pagina Technisch schrijven over hebben, blijven gelden - ongeacht of je zelf schrijft of AI gebruikt. Dit betekent dat je moet controleren op:

  • Actieve vorm - de tekst staat in de actieve vorm, niet lijdend
  • Doelgroepgericht - de tekst is geschikt voor je doelgroep
  • Structuur - de tekst heeft een goede structuur met duidelijke koppen
  • Diagrammen - diagrammen hebben toelichting en zijn niet te groot
  • Spelling en grammatica - geen fouten (maximaal 3 per pagina)
  • APA-bronvermelding - correcte bronvermelding waar nodig (voor onderbouwing van uitspraken)
  • Geen bijvoeglijke naamwoorden/bijwoorden - technische teksten moeten objectief zijn

Of je nu zelf schrijft of AI gebruikt: jij controleert of het aan alle criteria voldoet.

Wanneer gebruik je AI, wanneer schrijf je zelf?

Het is belangrijk om te leren wanneer het handig is om AI te gebruiken, en wanneer het beter is om zelf te schrijven. Dit hangt af van verschillende factoren:

Wanneer AI gebruiken

  • Eerste opzet - AI kan helpen met een eerste opzet van een tekst
  • Herschrijven - AI kan helpen om teksten te herschrijven naar actieve vorm
  • Spelling en grammatica - AI is goed in het corrigeren van spellings- en grammaticafouten
  • Samenvattingen - AI kan helpen bij het schrijven van samenvattingen
  • Routineuze delen - voor standaard onderdelen zoals inleidingen of conclusies (maar controleer altijd!)

Wanneer zelf schrijven

  • Specifieke technische inhoud - als je specifieke technische kennis moet overdragen die AI niet heeft
  • Je eigen onderzoek - voor beschrijvingen van je eigen onderzoek of bevindingen
  • Complexe relaties - wanneer je complexe relaties tussen concepten moet uitleggen
  • Als controle teveel tijd kost - soms is het sneller om zelf te schrijven dan uitgebreid te controleren

De balans vinden

De komende jaren zullen nieuwe AI's en technische mogelijkheden blijven verschijnen. Het is belangrijk dat je als student zelf beeld krijgt van wat op dat moment het handigste is. Maar je zult ook ontdekken dat het op een gegeven moment handiger is sommige stukken zelf te schrijven.

Of in ieder geval een uitgebreide prompt te schrijven aan de AI om zaken aan te passen en bepaalde stukken in te voegen (waarbij het laatste weer als nadeel heeft dat je vervolgens ook moet controleren of de AI dit allemaal goed gedaan heeft; want daar kun je eigenlijk nooit echt van uitgaan).

Prompt engineering voor documentatie

"Eén prompt is geen prompt" - je moet vaak meerdere prompts gebruiken en itereren om goede resultaten te krijgen.

Basisprincipes voor prompts

  1. Geef context - vertel de AI wat je doelgroep is, wat het doel van de tekst is, en welke stijl je wilt
  2. Geef voorbeelden - laat zien wat je wel en niet wilt
  3. Wees specifiek - vraag niet om "een goede tekst", maar om "een technische tekst voor ICT studenten, in actieve vorm, zonder bijvoeglijke naamwoorden"
  4. Itereer - gebruik de output als input voor een nieuwe prompt om te verbeteren

Voorbeeld prompts

Slechte prompt:

Schrijf een inleiding over Kubernetes.

Betere prompt:

Schrijf een inleiding over Kubernetes voor ICT studenten die al bekend zijn met Docker. De tekst moet:

  • In actieve vorm zijn geschreven
  • Geen bijvoeglijke naamwoorden of bijwoorden bevatten
  • Maximaal 150 woorden lang zijn
  • Objectief en feitelijk zijn, geen marketing taal

Uitgebreide prompts voor aanpassingen

Soms is het handig om een uitgebreide prompt te schrijven aan de AI om zaken aan te passen en bepaalde stukken in te voegen. Dit heeft echter als nadeel dat je vervolgens ook moet controleren of de AI dit allemaal goed gedaan heeft - want daar kun je eigenlijk nooit echt van uitgaan.

Voorbeeld uitgebreide prompt:

Pas de volgende tekst aan:

  1. Herschrijf alle lijdende zinnen naar actieve vorm
  2. Verwijder alle bijvoeglijke naamwoorden zoals "essentieel", "cruciaal", "onmisbaar"
  3. Voeg na paragraaf 2 een nieuwe paragraaf in over [specifiek onderwerp]
  4. Verwijder de laatste zin van paragraaf 3

[hier volgt de tekst]

Na zo'n prompt moet je altijd controleren of de AI alles correct heeft uitgevoerd.

Veelvoorkomende problemen met AI-generatie

1. Hallucinaties

ChatGPT en andere AI's kunnen "hallucineren" - ze verzinnen feiten die niet kloppen, maar die wel goed overkomen. Dit kun je proberen te beperken door een algemene prompt te geven:

Lieg niet! Als iets niet zeker is, zet dit er dan bij, of laat feiten geheel weg als ze erg onzeker zijn of niet kloppen.

Maar dit geeft geen garanties - je moet altijd controleren.

2. Marketing taal

ChatGPT heeft de neiging om "jubelende" teksten te schrijven met veel bijvoeglijke naamwoorden en bijwoorden:

  • ❌ "deze essentiële tool ..."
  • ❌ "dit is voor DevOps-ontwikkelaars absoluut onmisbaar"
  • ❌ "tool X fungeert als cruciale pijler"
  • ❌ "tool X is een uiterst waardevol instrument"
  • en "van vitaal belang".

Zulke zinsnede zijn niet acceptabel. Laat ChatGPT dit omschrijven. En als deze dat niet kan of wil, dan moet je het zelf doen. Kennelijk heeft ChatGPT een bias waardoor deze nogal positief uit de hoek komt. Deze toon is niet passend in een blog waarmee je objectiviteit uit wil stralen.

Alleen als je na je onderzoek tot de conclusie komt dat de tool inderdaad fantastisch, geweldig of onmisbaar is, dan kun je dat eventueel zo benoemen in je conclusie, maar als je inleiding al van (op dat moment nog ongefundeerd) enthousiasme aan elkaar hangt, kom je minder geloofwaardig over.

3. Lijdende vorm

ChatGPT schrijft vaak in de lijdende vorm. Je moet dit expliciet vragen om te herschrijven naar actieve vorm, en daarna controleren of het gelukt is.

4. Wollige teksten

AI kan soms heel wollig gaan schrijven, terwijl dit niks toevoegt - hoogstens goede input verwatert. Controleer of de tekst nog steeds duidelijk en relevant is.

5. Hoofdlijnen missen

AI kan soms belangrijke hoofdlijnen missen. Controleer of de tekst compleet is en alle belangrijke punten behandelt.

Controleren en samenvoegen

Controleren

Na het gebruik van AI moet je altijd controleren:

  1. Inhoudelijke correctheid - klopt wat er staat?
  2. Volledigheid - zijn alle belangrijke punten behandeld?
  3. Stijl - voldoet het aan de kwaliteitscriteria (actieve vorm, geen marketing taal, etc.)?
  4. Consistentie - past het bij de rest van je documentatie?
  5. Bronvermelding - zijn bronnen correct vermeld waar nodig?

Samenvoegen

Bij het samenvoegen van AI-gegenereerde teksten met je eigen teksten:

  1. Zorg voor consistentie - gebruik dezelfde terminologie en stijl
  2. Controleer overgangen - zorgen de overgangen tussen AI-tekst en eigen tekst logisch?
  3. Herlees het geheel - lees het complete document door om te zien of het als één geheel werkt
  4. Pas aan waar nodig - pas AI-teksten aan zodat ze naadloos aansluiten bij je eigen teksten

Iteratief proces

Schrijven met AI is een iteratief proces:

  1. Prompt - geef een goede prompt aan de AI
  2. Genereer - laat de AI tekst genereren
  3. Controleer - controleer de output
  4. Pas aan - pas aan waar nodig (zelf of met nieuwe prompt)
  5. Herhaal - herhaal tot je tevreden bent

Tot slot

AI kan een krachtig hulpmiddel zijn bij het schrijven van documentatie, maar het is geen vervanging voor je eigen verantwoordelijkheid als schrijver. Je moet altijd controleren, aanpassen en samenvoegen. De kwaliteitscriteria voor technisch schrijven blijven gelden, ongeacht of je AI gebruikt of niet.

Zoals Edsger Dijkstra al zei:

"some still seem to equate "the ease of programming" with the ease of making undetected mistakes." - Edsger Dijkstra (1979)

Dit geldt ook voor schrijven: gemakkelijker schrijven betekent niet automatisch beter schrijven. Je moet altijd kritisch blijven.

Bronnen

Last change: 2025-12-05