Gestructureerd schrijven – Het zit ‘m niet (alleen) in de tool


Posted on May 15th, by Jana in Blog. No Comments

“En welke ‘tool’ hebben we daar dan voor nodig?” Het is vaak de eerste vraag die bedrijven stellen wanneer we hen wijzen op de voordelen van gestructureerd schrijven en gestructureerd documentatie ontwerpen. Niet onlogisch, natuurlijk, want de gebruikte softwaretool is doorgaans het meest zichtbare in een schrijfproces. Toch is die vraag niet de belangrijkste en al helemaal niet de eerste die beantwoord moet worden. Dé perfecte tool om gestructureerd te schrijven bestaat immers niet en bovendien biedt een goede tool geen garantie op goede documentatie.

Een hamertje of een zaagske?

Er bestaat niet één tool om je documentatie op een gestructureerde manier te schrijven: alles hangt af wat jij precies nodig hebt. Een timmerman gebruikt toch ook aangepast gereedschap voor elke klus? Voor we kunnen bepalen of jij een hamertje dan wel een zaagske nodig hebt, moeten we een pak andere vragen beantwoorden. Bijvoorbeeld:

  • Welk soort documentatie maken jullie precies? Uitgebreide gebruikershandleidingen stellen heel andere eisen aan een tool dan korte, interne procedures.
  • Door wie wordt de documentatie geschreven? Als er ook weinig ervaren schrijvers zullen meewerken aan de documentatie, kiezen we best voor een toegankelijk programma.
  • In welk formaat wordt de documentatie gepubliceerd? Heb je enkel een standaard PDF nodig? Of wil je je documentatie ook publiceren als onlinehulp, op een smartphone en op tablet?

Eens al die kwesties zijn uitgeklaard, kunnen we beslissen welke tool voor jou de juiste is. Misschien stellen we wel vast dat jouw bedrijf helemaal geen nieuwe software nodig heeft, maar dat je gewoon een beetje gestructureerder moet leren timmeren. Euh, schrijven.

Of toch eerder een opleiding?

De gebruikte tool is zelden de oorzaak van slecht gestructureerde documentatie. Veel vaker ligt het probleem bij de manier waarop de documentatie geschreven wordt. Als je onsamenhangende content in je tool dumpt, kan je onmogelijk verwachten dat die jouw input herkauwt tot een goed gestructureerd en helder geheel. De weg naar goede documentatie start daarom vaak met een cursus gestructureerd schrijven. Daarin leer je enkele eenvoudige schrijftechnieken, die volledig losstaan van de gebruikte tool. Je leert bijvoorbeeld hoe je informatie opdeelt in coherente blokken, hoe je die blokken in een logische volgorde plaatst en hoe je er voor zorgt dat je publiek je boodschap begrijpt. Het zijn vooral die technieken die aan de basis liggen van goede documentatie, veel meer dan een of andere gesofisticeerde tool.

Hoewel het kiezen van de juiste tool cruciaal is om je documentatie te optimaliseren, is het niet de eerste noch de belangrijkste stap in dat proces. Ook als het op schrijven aankomt, moet je dus verder kijken dan je neus lang is: “It’s not about the tool, just like it’s not about the nail.”





Leave a Reply

Your email address will not be published. Required fields are marked *



Scripto Blog

News and insights from the Scripto experts!