Meer informatie over "Wat is technical writing?"

Een technical writer schrijft teksten die instructies, richtlijnen of uitleg bieden over een bepaald onderwerp. Technical writing heeft een heel ander doel en andere kenmerken dan schrijfstijlen zoals creative writing, academisch schrijven of business writing.

Technical writing betekent met andere woorden dat je ‘technische’, vaak complexe informatie vertaalt naar een duidelijke, makkelijk leesbare tekst. Mogelijke eindproducten van technical writing zijn bijvoorbeeld:

  • contract
  • script voor de klantendienst
  • demonstratie
  • ontwerpdocument
  • FAQ
  • ‘How-to’ video
  • instructies
  • artikel voor een kennisbank
  • embedded help
  • beleidsnota
  • workflow
  • projectdocument
  • productcataloog
  • productverpakking
  • voorstellen
  • release notes
  • referentiegids
  • requirement specifications
  • simulatie
  • traingins- en cursusmateriaal
  • gebruikershandleiding
  • waarschuwingslabel
  • websites
  • whitepapers

Wat is het verschil met copywriting?

  • De schrijfstijl is objectief, zonder emotioneel of gekleurd taalgebruik.
  • De doelstelling van de tekst is heel concreet (een handeling uitvoeren in een softwareprogramma, een product correct gebruiken …) en de stappen om dat doel te bereiken zijn duidelijk afgelijnd.
  • Je weet met zekerheid wie je tekst zal lezen en hoeveel kennis die lezer heeft over het onderwerp.

Hoe gaat een Technical Writer te werk?

STAP 1: Doelstelling en doelpubliek

De doelstelling van technical writing is om de lezer te helpen een bepaald doel te bereiken:

  • software leren gebruiken
  • een machine leren bedienen
  • verpakt voedsel veilig consumeren
  • een medische conditie correct inschatten
  • een wet volgen

Slechts in enkele gevallen is het doelpubliek van technical writing de gewone consument. Daarom is het erg belangrijk om rekening te houden met je doelgroep:

  • Welke kennis heeft de lezer?
  • Welke terminologie kent hij?
  • Welk doel hoopt hij te bereiken?

STAP 2: Informatie verzamelen tijdens een interview

Omdat technical writing over complexe onderwerpen gaat, is het vaak nodig om een expert te interviewen. Tijdens zo’n interview kom je alle informatie te weten die je nodig hebt om de tekst te schrijven. Enkele tips:

Voorbereiding:

  • Spreek af in persoon indien mogelijk. Gaat dat niet, kies dan voor videochat of een telefoongesprek.
  • Bereid je vragen voor en stuur er al een paar door naar de expert. Zo heeft hij tijd om na te denken over wat hij precies wil vertellen en wat hij zeker niet mag vergeten.
  • Denk aan je doelgroep: hoeveel kennis heeft de lezer over het onderwerp? Welke van de gebruikte termen kent hij en welke niet?
  • Plan voldoende tijd in. Zo ben je zeker dat je de tijd zal hebben om al je vragen te stellen én door te vragen als je iets niet snapt.
  • Bepaal duidelijk je doelstelling: Welk doel wil je lezer bereiken? Welke informatie heeft hij daarvoor nodig, en in welke volgorde?

Tijdens het interview zelf:

  • Pas op voor het ‘happy path’: het zal niet altijd van een leien dakje lopen. Wat als er iets fout loopt? Ook zulke vragen moet je stellen.
  • Herhaal de antwoorden van de expert af en toe in je eigen woorden. Zo ben je zeker dat je het juist begrepen hebt.
  • Formuleer je vragen op een neutrale manier. Stel dus geen leading questions(suggestieve vragen).
  • Wees niet bang om door te vragen en domme’ vragen te stellen. Als je het zelf niet snapt, dan kan je het ook zeker niet uitleggen.
  • Sluit het interview af met de vraag: ‘Wat is het ene ding dat de lezer moet onthouden?’

STAP 3: Een ruwe structuur maken

Heb je alle informatie verzameld, dan is het tijd om die in een gestructureerde, vlotte tekst te gieten. Enkele vuistregels:

  • Schrap onnodige details. Stel jezelf de vraag: dit relevant voor de lezer?
  • Begin bij de belangrijkste informatie.
  • Focus op de inhoud en pas het formaat aan de inhoud aan, niet omgekeerd.
  • Structureer de informatie volgens hoe de lezer een taak zal uitvoeren.

Een goede methode om grote hoeveelheden informatie te verwerken tot een duidelijke, gestructureerde tekst is information mapping. Lees hier meer over deze methode.

STAP 4: De tekst uitschrijven

Tijd om je tekst uit te schrijven. Maak je tekst aangenaam om te lezen en toegankelijk voor je doelgroep:  

  • Gebruik enkel taal die je lezer begrijpt (geen vakjargon dat hij niet kent).
  • Geef concrete voorbeelden en analogieën om complexe concepten te illustreren.
  • Maak je tekst scanbaar met bullets of genummerde lijsten en accurate titels. Zo vindt ook een oppervlakkige lezer snel wat hij zoekt.

Enkele veelgemaakte fouten om te vermijden:

  • Vermijd om de tijden van je werkwoorden continu te veranderen: gebruik consequent de tegenwoordige tijd.
  • Vermijd de naamwoordstijl: gebruik actieve werkwoorden waar mogelijk.
  • Vermijd passieve zinnen (tenzij je een goede reden hebt).
  • Vermijd vaag taalgebruik:
    • onduidelijke verwijswoorden, bijvoorbeeld “Deze activeert die modus’.
    • ambigue en vage termen en uitdrukkingen (enkele minuten, binnenkort, een tijdje later …
  • Vermijd gekleurd/emotioneel taalgebruik: hou het neutraal en objectief.

STAP 5: Feedback

  • Laat indien mogelijk de expert je tekst nalezen om zeker te zijn dat alles inhoudelijk klopt.
  • Laat ook een buitenstaander je tekst nalezen:
    • Zijn er passages niet duidelijk?
    • Is de tekst aangenaam om te lezen?
    • Zal je lezer zijn doel kunnen bereiken?
  • Vraag indien mogelijk je gebruikers om feedback.

Op zoek naar een technical writer die de knepen van het vak kent? We gaan voor jou op zoek naar een match.