Professioneel en technisch schrijven/instructies

Vermijd bij het schrijven van instructies opdringerig taalgebruik en kies voor een taakgerichte benadering. Houd de tekst beknopt en duidelijk en stel de gebruiker in staat de taak tot een goed einde te brengen.

Volg in het algemeen de volgende richtlijnen:

Concisie en duidelijkheid

Houd de zinnen kort en begrijpelijk. Gebruik waar mogelijk algemene terminologie. Vermijd het gebruik van idiomen, slang, jargon, bijnamen, afkortingen en acroniemen. Als u toch terminologie gebruikt die nieuw of verwarrend kan zijn, geef dan een duidelijke definitie van elke term wanneer deze voor het eerst in de instructies voorkomt.

Publiek

Het is belangrijk dat u uw publiek kent wanneer u instructies schrijft, zodat u alle noodzakelijke informatie opneemt en overbodige informatie uitsluit. Als u uw publiek kent, kunt u redelijke en goed geïnformeerde veronderstellingen maken op basis van de vermoedelijke achtergrond, ervaring en bekendheid van het publiek met het onderwerp. Als u bijvoorbeeld instructies schrijft voor een groep senioren in de plaatselijke bibliotheek, is het misschien niet veilig om aan te nemen dat zij vertrouwd zijn met de basisbeginselen van het openen van een specifieke softwaretoepassing. Als u echter instructies schrijft voor een groep softwareontwikkelaars binnen een professionele organisatie, kan het veilig zijn om aan te nemen dat zij bekend zijn met de grondbeginselen van het openen van een specifieke softwaretoepassing.

Wanneer u beslist welke informatie u wel en niet in instructies wilt opnemen, is het belangrijk om duidelijk vast te stellen wie uw publiek is en wat hun waarschijnlijke vaardigheid is met het onderwerp van de instructies en de bijbehorende achtergrondinformatie.

Als een publiek waarschijnlijk een breed scala aan ervaring en kennis heeft, met verschillende niveaus van bekendheid en deskundigheid, kunt u verschillende technieken gebruiken om elke set instructies beknopt te houden en te richten op een enkele taak, terwijl u toch de noodzakelijke informatie verstrekt. U kunt bijvoorbeeld afzonderlijke instructies maken voor vereiste informatie en uw publiek de middelen geven om snel en gemakkelijk toegang te krijgen tot de afzonderlijke instructies (via hyperlinks, bijlagen, enz.).

Graphics

Pictures speak louder than words. Het toevoegen van afbeeldingen om uw gedachten over te brengen kan effectiever zijn dan de woorden zelf. Instructies die goed geïllustreerd zijn en uw schriftelijke instructies vergezellen, zijn meestal zeer succesvol. Het voegt een extra niveau van begrip toe en stelt de lezer in staat om problemen door te nemen of op te lossen. Afbeeldingen voegen een extra dimensie toe die de lezer in staat stelt het eindproduct te visualiseren. Ook moet u bij het gebruik van afbeeldingen rekening houden met visueel ingestelde leerlingen en de afbeeldingen aanpassen.

Hoewel afbeeldingen geweldig zijn, moet u oppassen dat u geen foto’s of illustraties opneemt die verwarrend zijn of geen verband houden met de eigenlijke schriftelijke instructies. Als u een slechte foto aan uw instructies koppelt, kunt u de lezer stress bezorgen of verwarring zaaien wanneer hij probeert te ontcijferen wat u bedoelt.

Ook wanneer u foto’s neemt, moet u ervoor zorgen dat de ruimte goed verlicht is en dat de foto’s helder en duidelijk zijn. Donkere of wazige foto’s zijn vaak moeilijk te volgen. Zorg ervoor dat u het onderwerp telkens in dezelfde richting fotografeert om verwarring te voorkomen en overweeg het gebruik van een statief.

De grootte is ook belangrijk bij het gebruik van afbeeldingen in instructies. Een foto die te klein is om te zien, is net zo nutteloos als een onscherpe foto.

Om krachtig en begrijpelijk te zijn, moeten de tekst en de afbeelding voor elke stap duidelijk corresponderen met die stap van de instructies.

Opmaak

Bedenk dat de lezers de taak daadwerkelijk zullen uitvoeren terwijl ze meelezen met de instructies. Gebruik dus geen grote blokken kleine, moeilijk te ontcijferen tekst. Zorg voor een ontwerp en een lay-out voor uw pagina met instructies die gemakkelijk leesbaar zijn en een esthetische kwaliteit hebben. Door de pagina eenvoudig te houden, maar met een duidelijke hiërarchie, wordt de lezer geholpen bij het voltooien van de stappen van de instructies.

Bij het ontwerpen van uw pagina is een solide hiërarchie belangrijk voor de scanbaarheid. Het gebruik van vetgedrukte koppen, cursief en romeinse cijfers helpt de lezer zijn plaats gemakkelijk te vinden en draagt bij aan de algehele visuele uitstraling.

Rangorde

Het is belangrijk dat uw instructies in een logisch verloop worden gepland. Zorg ervoor dat u het probleem duidelijk op de eerste bladzijde vermeldt. Laat uw problemen volgen door een reeks specifieke stappen die aangeven hoe het voorgestelde probleem moet worden opgelost. Technische instructies moeten in een logisch patroon verlopen. Als u bijvoorbeeld een tafel in elkaar zet, zou het niet goed zijn als u de laatste hand aan de tafel legt voordat u alle schroeven op hun plaats hebt. Zoals gezegd moeten er ook duidelijke afbeeldingen zijn waar dat nodig is om de handeling te verduidelijken. Denk eraan, een beeld zegt meer dan duizend woorden.

Testen en verifiëren

We weten allemaal dat instructies moeilijk te schrijven zijn en dat het op papier soms goed klinkt, maar wanneer u daadwerkelijk probeert de instructies in praktijk te brengen, kunt u tot de ontdekking komen dat uw formulering voor anderen onbegrijpelijk is. Wat voor u heel gewoon of vanzelfsprekend is, kan voor uw lezers een raadsel zijn, dus ken uw publiek. Test uw instructies niet alleen op uzelf, maar laat ze ook testen door iemand die niets van uw product afweet. Dit wordt een bruikbaarheidsonderzoek genoemd. Maak aantekeningen over wat werkte en wat niet en pas dan je instructies aan. Op de lange termijn geldt: hoe meer mensen uw instructies testen, hoe effectiever de uiteindelijke set zal zijn.

Geef een antwoord

Het e-mailadres wordt niet gepubliceerd.