basisprincipes van technisch schrijven

zo nu en dan moeten we de basisprincipes van technisch schrijven herzien. Sinds we in 1997 zijn begonnen, zijn de basisprincipes van technisch schrijven hetzelfde gebleven, zelfs als de vormen van communicatie veranderen.

doel en publiek

voordat een nieuw schrijfproject wordt gestart, moet een technisch schrijver het doel van het document analyseren en het beoogde publiek identificeren. De schrijver moet vragen:

• wie zal de documentatie lezen?
• Wat zijn hun vooroordelen?
• welke verantwoordelijkheden heb ik bij het communiceren van informatie aan het publiek?

Style Guide

technische schrijvers gebruiken vaak een company style guide, indien beschikbaar, om ervoor te zorgen dat hun documentatie een gestructureerd patroon heeft. Een style guide (zoals het ap Stylebook) geeft richtlijnen voor hoe een document eruit ziet, de taal die het gebruikt, en hoe ideeën worden gerangschikt. Deze organisatie geeft continuïteit aan een document of serie documenten, zodat het publiek de informatie gemakkelijk kan begrijpen. Een technische schrijver kan bijvoorbeeld een proces chronologisch documenteren, zoals voorgeschreven in de stijlgids. Zonder die structuur zou de lezer in de war zijn en het proces niet kunnen volgen. Stijlgidsen maken het schrijven consistenter en leesbaarder.

schrijfstijl

technische schrijvers veranderen hun schrijfstijl afhankelijk van het publiek en de situatie waarover ze schrijven. Als ze technische documentatie schrijven, dan moet de stijl formeel zijn, verstoken van de emotie die je krijgt met creatief schrijven. Als ze een e-mail schrijven naar een van de senior managers die betrokken zijn bij het project, dan zou hun stijl meer conversationeel zijn.

toegang tot de informatie

toegankelijkheid is hoe gemakkelijk de informatie in een document kan worden verkregen door het beoogde publiek. Een technisch document bevat elementen zoals een inhoudsopgave, kopteksten, voetteksten en paginanummers om lezers te helpen bij het navigeren door het document en het vinden van de informatie die ze nodig hebben. Een technisch document bevat ook een specifieke structuur van rubrieken en subrubrieken om de informatie op te splitsen in relevante secties die de lezer gemakkelijk kan raadplegen.

dit zijn slechts enkele aspecten die we als technische schrijvers behandelen. Als u uw eigen technische schrijfvaardigheden wilt verbeteren, overweeg dan onze technische schrijfworkshop. Het kan worden aangepast aan de behoeften van 1 persoon of 20 personen!

als u het document niet zelf wilt schrijven en hulp nodig hebt van een ervaren technisch schrijver, kijk dan op onze dienstenpagina.

wij zijn hier om u te helpen. Neem vandaag nog contact met ons op!