English
Blogserie “Technische documentatie en de kracht van AI”
Het is hét gespreksonderwerp van dit moment: Artificial Intelligence, oftewel AI. Bij de koffieautomaat met je collega’s, tijdens het avondeten met je gezin – overal gaat het over hoe razendsnel AI zich ontwikkelt. Over de enorme impact die het nú al heeft én de ongekende mogelijkheden (én uitdagingen) die nog voor ons liggen. Wat betekent dat allemaal voor ons werk, en voor het dagelijks leven?
Ook bij Foxiz zitten we vol vragen én ideeën. Voor onze technisch schrijvers, tekenaars, vertalers en consultants is AI inmiddels niet meer weg te denken. We willen die ontdekkingsreis graag met je delen. Maar we willen zóveel vertellen dat één blog gewoonweg niet volstaat. Daarom hebben we een complete blogserie over AI geschreven, waarin we de verschillende onderdelen van ons werk belichten, evenals de impact die AI erop heeft. Lees je met ons mee?
Nr. 1: Slimme prompts schrijven met AI
Handig voor wie net begint, maar ook nuttig voor schrijvers die al vaker met AI werken. AI-tools zoals ChatGPT, Copilot, etc. kunnen technisch schrijvers enorm helpen. Zo kunnen ze bijvoorbeeld complexe teksten versimpelen, de tone of voice aanpassen, of zorgen dat je handleiding voldoet aan richtlijnen en normen. Maar het resultaat is niet altijd meteen even goed, dit staat of valt namelijk met de kwaliteit van je prompt. Met andere woorden: wat je vraagt, bepaalt wat je krijgt.
Hoe optimaliseer je AI-tools voor technische documentatie?
Hoe moet het niet?
Laten we eerst een kijkje nemen naar het effect van een simpele, korte prompt. Onderstaande afbeelding hebben we gegenereerd met AI en we willen een bedieningselement duidelijker weergeven. Dat doen we met de volgende prompt:
“Markeer de bedieningselementen onder het radarscherm met een rood kader [schip.png].”
Hoe schrijf je nu een “goede” prompt voor AI?
Hier heeft iedereen een eigen mening over en met elke nieuwe AI-versie verandert er wel wat. Er is echter één punt waar iedereen het over eens is: AI heeft kaders nodig. Hieronder staan de meestgebruikte kaders om betere antwoorden en resultaten te krijgen:
Rol: Geef AI een rol mee, dit geeft AI een duidelijk uitgangspunt.
Doel of taak: Een duidelijk omschreven doel of taak zorgt voor betere output.
Context en achtergrond: Beschrijf de situatie en achtergrond zodat de AI wat context heeft om de vraag te plaatsen.
Voorbeeld van de output: Geef een concreet voorbeeld van het gewenste resultaat.
Formaat van de output: Geef aan in welke vorm je het antwoord wilt ontvangen.
Vraag om bevestiging: Werken met AI is een iteratief proces, bespaar tijd en geld door minder contentanalyses.
Dat klinkt allemaal leuk en aardig, maar hoe ziet zo’n prompt er in de werkelijkheid
dan uit?
Laat de rest van de afbeelding ongewijzigd.
Is het GPS-scherm en de bediening duidelijk geïdentificeerd?
Is het PNG-formaat mogelijk en de gewenste stijl duidelijk?
Laat het me weten als iets onduidelijk is.
Wat is het effect van deze nieuwe prompt voor AI?
Er is direct verschil te zien. De stuurkolom is op zijn plaats gebleven, het gps-scherm en de knoppen zijn niet voorzien van een rood vlak en de bedieningselementen onder het radarscherm zijn voorzien van een rood kader, precies zoals we gevraagd hebben.
Voorbeelden van goede en slechte prompts
Het is handig om een eigen lijstje met je favoriete prompts te maken en deze telkens aan te passen per situatie. Zo bouw je je eigen AI-stijlboek als technisch schrijver. Hieronder een handig overzicht dat je meteen kunt gebruiken:
| Slechte prompt | Waarom onduidelijk? | Betere prompt |
|---|---|---|
| “Maak een handleiding.” | Geen onderwerp, doelgroep of lengte. | “Schrijf een korte handleiding (max. 200 woorden) voor een koffiemachine, gericht op dagelijks gebruik door consumenten.” |
| “Leg dit uit.” | Geen context: wat moet worden uitgelegd, aan wie? | “Leg in eenvoudige B1-taal uit hoe een monteur een brandblusser inspecteert. Gebruik maximaal 5 stappen.” |
| “Herschrijf dit.” | Te vaag, geen doel of stijl. | “Herschrijf deze tekst in duidelijke instructies, gebruik actieve zinnen en een opsomming met max. 4 bullets.” |
| “Vertaal dit.” | Niet duidelijk naar welke taal, of met welke tone of voice. | “Vertaal dit naar Engels en behoud de formele toon. Houd de zinnen kort (max. 12 woorden).” |
Tot slot: praktische tips voor betere AI-output
Begin eenvoudig, maar wees duidelijk
Een prompt is niets anders dan een instructie. Hoe specifieker je bent, hoe groter de kans dat de output bruikbaar is.
Werk iteratief
Een prompt hoeft niet in één keer perfect te zijn. Zie het als een gesprek:
- Start met een eerste versie.
- Kijk wat er goed is en wat niet.
- Vraag gericht om aanpassingen.
Voorbeeld:
- “Kun je de tekst korter maken en de opsomming in 3 bullets zetten?”
- “Gebruik actieve zinnen in plaats van passieve.”
- “Vertaal dit naar het Duits, maar behoud de opmaak.”
Experimenteer met rollen
Je kunt AI vragen een bepaalde rol aan te nemen. Dit helpt vooral bij technische documentatie.
Voorbeelden:
- “Stel je voor dat je een ervaren veiligheidsinspecteur bent. Leg uit hoe je een gasdetector test.”
- “Doe alsof je een eindgebruiker bent en stel kritische vragen over de handleiding.”
Dit levert vaak verrassend goede inzichten op.
Vraag om structuur
Als technisch schrijver wil je vaak gestructureerde output. Je kunt dat afdwingen met je prompt.
Voorbeelden:
- “Geef de output in dit format: Titel, Introductie, Stappenplan, Waarschuwingen.”
- “Gebruik een tabel met kolommen: Stapnummer, Actie, Opmerking.”
Zo voorkom je rommelige antwoorden en bespaar je tijd bij het bewerken.
Beperk of vergroot de creativiteit
Soms wil je een feitelijke tekst, soms juist creatieve variaties.
Voorbeelden:
- Feitelijk: “Geef alleen een opsomming van de stappen, zonder extra toelichting.”
- Creatief: “Bedenk 5 alternatieve koppen voor deze paragraaf, met een luchtige toon.”
Door dit expliciet te zeggen, stuur je de output.
Denk aan taal en stijl
Als technisch schrijver ben je vaak bezig met toon, helderheid en consistentie. AI kan dat voor je bewaken, als je dat expliciet vraagt.
Voorbeelden:
- “Herschrijf dit in eenvoudig B1-Nederlands.”
- “Gebruik korte zinnen (max. 12 woorden).”
- “Vermijd vakjargon en leg termen uit in één zin.”
Foxiz en AI
Bij Foxiz zetten we AI verstandig, effectief en slim in als hulpmiddel voor onze specialisten in technische documentatie en vertalingen. Daarmee creëren we technische content van hoge kwaliteit. Zo combineren we het beste uit twee werelden!
Heb je goede technische documentatie nodig bij je product of systeem? Wil je eens sparren over hoe je jouw documentatie én de vertaling daarvan kunt verbeteren? Of heb je interesse in een baan als technisch documentalist? Neem contact met ons op! We bekijken graag hoe we jou kunnen helpen.
TIP: In onze volgende blog stellen we de vraag of en hoe je informatie kunt inwinnen met AI. Stay tuned!