Technisch schrijven communiceert technische informatie over een vaardigheid of product aan lezers. Het wordt vaak gebruikt op technisch en beroepsgebied. Als technisch schrijver schrijf je vaak documenten zoals gebruikershandleidingen, API-documentatie (Application Programming Interface) en reparatie- en producthandleidingen.
Net als andere schrijfniches heeft technisch schrijven nichespecifieke richtlijnen. Door deze richtlijnen te volgen, kunt u goed gestructureerde documenten schrijven en optimaliseren hoe lezers uw werk begrijpen. Hier zijn enkele regels die u moet volgen om een goede technische schrijver te worden.
1. Definieer uw publiek
Audience-analyse is een onmisbare factor in een goed technisch document. Als u uw publiek kent, kunt u bepalen over welk soort informatie u wilt schrijven, hoe u deze moet structureren en hoe technisch uw taal is. Er zijn vier grote doelgroepen voor technisch schrijven: leidinggevenden, experts, technici en niet-specialisten.
Leidinggevenden zijn personen die het product financieren en de politieke, administratieve en economische beslissingen nemen die ervoor zorgen. Technici zijn de mensen die deze producten bouwen, bedienen en repareren. Experts ontwerpen, testen en weten alles over het product, terwijl niet-specialisten de eindgebruikers van de producten zijn. U moet rekening houden met uw publiek om de beste toon en schrijfstijl te bepalen.
2. Identificeer de behoeften van uw publiek
Naast het kennen en definiëren van uw publiek, is het van cruciaal belang dat u hun doelen, interesses en behoeften begrijpt. Het voltooien van uw doelgroepanalyse is essentieel bij het voorbereiden van documenten, omdat u minder snel zonder haperingen schrijft en de behoeften van uw publiek goed kent.
Om een goed afgeronde doelgroepanalyse uit te voeren, moet u rekening houden met de achtergrond van uw publiek, de bestaande kennis van het product, ervaring, behoeften, interesses, demografische kenmerken, cultuur en communicatievoorkeuren, en doelen. Deze informatie zal u helpen om uw ideeën zo effectief en efficiënt mogelijk te presenteren.
3. Ken de limiet van de kennis van uw publiek
Als techniek voor publieksanalyse kunt u enquêtes en vragenlijsten gebruiken om de limiet van de kennis van uw publiek te kennen. U kunt ook populaire meningen en stereotypen, persoonlijke ervaringen, brainstormsessies en feedback van het publiek opvragen bij de marketingafdeling.
Als u de hierboven genoemde tools op de juiste manier gebruikt, weet u hoeveel uw doelgroep de informatie begrijpt die u wilt overbrengen. Deze informatie zal in hoge mate de structuur, limieten en reikwijdte van uw document bepalen, waardoor u een gevoel van richting krijgt.
4. Houd uw taal eenvoudig
Technisch schrijven wordt verondersteld een te ingewikkeld onderwerp te presenteren. Het doet dit door een eenvoudige schrijfstijlgids te gebruiken. U moet ervoor zorgen dat de gemiddelde lezer uw schrijven gemakkelijk kan begrijpen.
Houd er echter rekening mee dat het begrijpen van uw publiek ook de sleutel is tot de taalstijl die u kiest. Bijvoorbeeld vakjargon in een document over interfaces voor applicatieprogrammering (API) kan geschikt zijn voor technici, maar niet voor eindgebruikers. Daarom moet u gemakkelijk te begrijpen taal gebruiken om het begrip van het publiek te bevorderen. Misschien wil je het ook leren hoe een tool als Microsoft Editor te gebruiken om uw werk te controleren en ervoor te zorgen dat het schrijven op punt is.
5. Gebruik contouren
Overzichten geven uw lezers een idee van wat ze in het document kunnen verwachten. Een document zonder opzet overweldigt lezers, omdat het hen dwingt de hele tekst te lezen als ze alleen geïnteresseerd zijn in het verwerven van specifieke kennis.
Als technisch schrijver geeft het schetsen van uw document u ook een gevoel van richting bij het schrijven. Het houdt u op het goede spoor en zorgt ervoor dat u geen relevante punten mist of onderschat. Bovendien verbetert het de structuur van uw document en dient het als feedback over wat u van plan bent te behandelen.
6. Gebruik afbeeldingen waar nodig
De aandacht van de meeste lezers wordt natuurlijk getrokken door afbeeldingen in vergelijking met tekst. In technische documenten kunnen geschikte afbeeldingen het begrip van de tekst door de lezer verbeteren door informatie duidelijk en nadrukkelijk weer te geven.
Als technisch schrijver moet u echter oppassen dat u geen afbeeldingen gebruikt om documenten te versieren. Tabellen, grafieken, diagrammen, foto's en illustraties zijn veelgebruikte afbeeldingen en ze kunnen de algemene structuur van het document verbeteren en lezers aanspreken. Dat gezegd hebbende, als je nieuw bent bij Google Docs, hier is hoe u tabellen maakt en bewerkt in Google Docs.
7. Betrek uw lezers
Hoewel u misschien technische informatie probeert over te brengen aan uw lezers, is het belangrijk dat u hen ook aanspreekt. Elk technisch document is gericht op de lezer en moet worden geschreven naar de smaak van de lezer en niet naar de schrijver. De intellectuele nieuwsgierigheid van uw lezer moet worden bevredigd om uw document bruikbaar te maken.
Je kunt je lezer actief betrekken door te schrijven om je te uiten, niet om indruk te maken, en om meteen ter zake te komen. Vermijd afkortingen en jargon, gebruik veel witruimte om de visuele presentatie te verbeteren en gebruik koppen om uw lezer te begeleiden.
8. Verwijs niet naar tijdgevoelige informatie
Het vermijden van verwijzingen naar tijdgevoelige informatie, vooral die van een vergelijkbare periode, verdient altijd de voorkeur. Het is veiliger en verstandiger om analyses te gebruiken die de tand des tijds hebben doorstaan, waardoor ze altijd groen blijven en altijd geschikt zijn voor degenen die uw document in de toekomst zullen lezen.
Houd er ook rekening mee dat het toevoegen van specifieke jaren, zoals "2019", om uw punt te benadrukken, de bruikbaarheid van uw document na verloop van tijd kan verminderen, behalve in specifieke gevallen. U kunt dit voorkomen door een breder tijdsbestek te gebruiken, zoals 'In de afgelopen zeven jaar', waardoor uw werk een zekere mate van geloofwaardigheid krijgt.
9. Gebruik relevante voorbeelden
Gebruik bij het schrijven van een technisch document live instanties om uw punten te benadrukken. Aangezien uw publiek uw schrijven leest om een vaardigheid te verwerven, een probleem op te lossen of enkele richtlijnen te leren, moet u hen praktische en herkenbare voorbeelden geven.
Deze voorbeelden verbeteren de leesbaarheid van uw werk en communiceren complexe informatie naar uw lezer, waardoor producten en processen context krijgen. Op deze manier is de kans groter dat ze de producten opzettelijk en veilig gebruiken.
10. Ontvang een beoordeling door derden voordat u publiceert
Een technisch document moet altijd een samenwerkingsproces doorlopen waarbij de schrijver en de recensent betrokken zijn. Een beoordeling door derden helpt bij het genereren van een publieksgericht, foutloos en indrukwekkend document.
Als de oorspronkelijke auteur van het document heeft u mogelijk vele concepten geschreven voordat u het definitieve document maakte. Desalniettemin, hoe goed uw document er ook uitziet, vertrouw niet alleen op uw verstand.
Word vandaag nog een professionele technische schrijver
Als u de essentiële regels voor technisch schrijven begrijpt, wordt u vaardiger en zeer gewild. Veel organisaties weten hoe belangrijk het is dat hun producten of diensten goed op de markt worden gebracht bij eindgebruikers, en hen helpen dit te bereiken is uw doel als technisch schrijver.
