Wat is de beste aanpak voor het maken van gebruikershandleidingen?
Gebruikershandleidingen begeleiden het monteren, installeren en gebruiken van een product. Gebruikershandleidingen kunnen verschillende vormen hebben, zoals gebruikersinstructies, gebruikershandleidingen, snelstartgidsen, handleidingen om aan de slag te gaan of technische documentatie.
Wie is betrokken bij technisch schrijven en hoe wordt dat gedaan?
Er zijn doorgaans drie manieren waarop bedrijven technisch schrijven produceren, inclusief gebruikershandleidingen en instructiehandleidingen. Laten we eens kijken welke aanpak de beste is en hoe u het beste uit elke methode kunt halen.
1. Vraag het technisch personeel om de gebruikershandleiding te schrijven
Veel bedrijven hebben de neiging om één of een team van technische mensen aan te wijzen om het schrijfwerk te doen. Dat klinkt misschien als een slim idee.
Dit team bestaat uit productingenieurs, ontwikkelaars en ontwerpers. Zij zijn de vaders, de scheppers. Ze weten dus alles (zo niet iedereen afzonderlijk, maar misschien wel allemaal). Kortom, zij zijn de vakexperts. En als er een bug of een fout is, zijn ze ook de beste referentie. 
Waarom zou je tenslotte de moeite nemen om een extra medewerker aan te werven en te betalen als de beste middelen er gewoon zijn? Dit is niet het beste idee, noch het meest economische. Hoewel de technische staf een van de referenties voor een handleiding is, zijn zij niet noodzakelijkerwijs de beste mensen om een trainingshandleiding te maken. Dit is waarom:
Allereerst: zijn het goede schrijvers? Veel technische mensen wier primaire taak het ontwerpen en ontwikkelen van een product is, zijn niet geïnteresseerd in schrijven en documenteren; om dezelfde reden hebben ze het schrijven niet professioneel gevolgd. Ze denken misschien dat ze andere urgente dingen te doen hebben, wat waar is, gezien hun primaire taken en verantwoordelijkheden. Daarom zijn het misschien geen bekwame schrijvers en zijn ze niet bereid om die vaardigheden te verwerven. Als uw technische mensen echter goede schrijvers zijn of geïnteresseerd zijn in schrijven, heeft u geluk. Toch is dat niet alles.
Ten tweede hebben mensen die betrokken zijn bij de technische ontwikkeling van een product er verschillende opvattingen over. Ze zijn geneigd te veronderstellen dat veel informatie voor de hand ligt, terwijl een nieuwe gebruiker zeker verduidelijkingen nodig heeft. Ze lopen waarschijnlijk in deze valkuil van technisch schrijven en geven gedetailleerde technische informatie waarvan ze denken dat deze essentieel is, maar die niet nuttig is voor een gebruiker.
Sommige details zijn cruciaal voor ingenieurs, maar helpen de gemiddelde gebruiker niet. Wat voor gebruikers van belang is, zijn de resultaten van het technische proces en de manier waarop het aan hun behoeften voldoet, en niet wat er achter het proces schuilgaat.
Handleidingen moeten beknopt en gereserveerd zijn wat betreft technische details, terwijl ze genereus zijn in het geven van instructies en waarschuwingen. Experts op het gebied van het onderwerp zullen waarschijnlijk ook technische woorden en jargon gebruiken en denken dat dit oké is. Ze kunnen de terminologie zelfs uitleggen door naar andere woordenschat te verwijzen, wat voor verwarring zorgt.
Tips om deze methode te laten werken:
Als je je huidige technische staf wilt vragen de handleiding te schrijven, betrek dan het hele team erbij. Zo zorg je ervoor dat verschillende perspectieven worden toegepast.
2. Vraag de technische staf om de handleiding te schrijven en laat deze door een redacteur/schrijver proeflezen.
Dit is hoe het gaat. Technische mensen schrijven een concept en overhandigen dit aan een redacteur/technisch schrijver. Op deze manier is de kans groter dat aan de schrijfnormen wordt voldaan. De schrijver zal sommige delen vereenvoudigen, jargon vervangen door gewonere woorden, de hele stijl verenigen, enkele trucjes toepassen en deze aantrekkelijker maken.
Deze methode klinkt veel beter. Maar kunt u ervoor zorgen dat de redactie de gaten opvult die de technische staf überhaupt heeft gecreëerd? Ze kunnen waarschijnlijk niet alle ontbrekende onderdelen raden en verbeteren wat ze hebben ontvangen.
Tips om het meeste uit deze methode te halen:
- Een goede samenwerking kan resulteren in het ontstaan van een professional. Zorg ervoor dat u de vakexperts (uw technische team) verbindt met de schrijver/redacteur en vraag niet zomaar willekeurige schrijvers om een document zonder achtergrondinformatie te redigeren.
- Zorg ervoor dat de schrijver regelmatig contact kan opnemen met het technische team om verschillende onderdelen te bespreken of als er een vraag is. En laat het technische team het bewerkte document ook beoordelen om er zeker van te zijn dat de technische inhoud correct is waargenomen en gecommuniceerd.
3. Laat een technisch schrijver het werk doen in nauwe samenwerking met het technische team
Het inhuren van een technisch schrijver klinkt als de ideale methode. Het hebben van een technisch schrijver die de handleiding vanaf het allereerste begin maakt en tegelijkertijd de mogelijkheid heeft om nauw samen te werken met het technische team, het product te gebruiken, testen en bestuderen, is het ontbrekende ingrediënt voor een perfect vervaardigde gebruikershandleiding. Het wordt ten zeerste aanbevolen dat u een technisch schrijver recruteert om de handleiding te schrijven. Onderwerpsexperts kunnen de functies en kenmerken van het product beoordelen, becommentariëren, uitleggen en bewerken terwijl ze de functies en kenmerken van het product bespreken.
Samen schrijven is de magische truc.
In alle drie de benaderingen is samenwerking de sleutel tot beter geschreven schrijven. Documentatietools die zich richten op teamwerk en ruimte bieden voor effectieve samenwerking kunnen dit proces vergemakkelijken. Veel online tools proberen het gemakkelijker te maken. Het stimuleren van samenwerking omvat veel meer dan alleen de mogelijkheid om verschillende onderdelen te delen, te becommentariëren en te bespreken. 
Sonat is zich steeds meer gaan richten op het bevorderen van samenwerkend schrijven door de workflowfuncties te verbeteren waarmee u een geautomatiseerd proces kunt definiëren. In dit proces. Iedereen in een organisatie kan betrokken worden en het is mogelijk om verschillende taken en toegangsniveaus toe te wijzen terwijl automatische regels worden toegepast; Het resultaat is dat het veel bewerkingstijd bespaart.
Met Sonat kunt u voorkomen dat documenten van lage kwaliteit en zonder toezicht worden gepubliceerd, terwijl u uw redacteuren en experts veel tijd bespaart.