Inhoud
- Zet jezelf in de schoenen van de lezer
- Wat u moet begrijpen over uw lezers
- Je lezers zijn al gefrustreerd
- Een opmerking voordat u instructies gaat schrijven
- De magische formule voor het schrijven van instructies
- The Magic Formula: The Given-New Method
- Nu bent u klaar om goede instructies te schrijven
- Laatste schoonmaak
- Bruikbaarheid Test uw instructies
- Conclusies en generalisaties
Laura is een technisch schrijver. Ze houdt van piano spelen, reizen, kunst maken en sieraden maken.
Zet jezelf in de schoenen van de lezer
Om betere computer-instructies of procedures te schrijven, moet u zich eerst in de lezer of in de schoenen van de gebruiker plaatsen.
De gebruiker weet niets over uw website of stukje software en zal niet (en zou ook niet moeten) de tijd nemen om de volledige set instructies te lezen voordat hij aan zijn werk begint. De gebruiker gebruikt uw product gewoon om een bepaald doel te bereiken (een aankoop doen, informatie opzoeken, enzovoort).
Wat u moet begrijpen over uw lezers
Eerste dingen eerst. U moet het feit accepteren dat uw lezers hoogstwaarschijnlijk niet willen lezen wat u hebt geschreven. Dit betekent dat u, om effectieve, nuttige instructies te schrijven, eerst alle volgende waarheden moet accepteren:
- Uw lezers / gebruikers willen niet leren hoe ze uw product / dienst moeten gebruiken; ze willen een eigen taak of doel bereiken.
- Ze lazen de documentatie alleen in wanhoop, nadat wat ze probeerden te doen mislukte.
- Ze zijn nu gefrustreerd.
- Ze weten niet hoe ze verder moeten om hun doel / taak te voltooien.
Je lezers zijn al gefrustreerd
Als schrijver van instructies begin je in een slechte situatie omdat gebruikers (die je waarschijnlijk niet kent en nooit zult ontmoeten) al gefrustreerd zijn over je product / dienst tegen de tijd dat ze de instructies opvolgen waarop je hebt geschreven hoe elke taak te volbrengen. Dus wees aardig voor ze en geef ze duidelijke, beknopte, definitieve en nauwkeurige instructies die ze weer op weg helpen om hun doel zo snel mogelijk te bereiken: het is een vorm van goede klantenservice!
Het patroon wordt vrij eenvoudig en is van toepassing op de meeste soorten stapsgewijze instructies, niet alleen op computerinstructies.
Een opmerking voordat u instructies gaat schrijven
Voordat u begint met het schrijven van instructies, moet u weten in welke stijl ze moeten worden geschreven.
Vraag eens rond naar een "Huisstijlgids" (de marketingafdeling is een goede plek om te beginnen) en ontvang het laatste exemplaar van de Microsoft Style Manual of Style for Technical Publications.Maar hoe zit het met Apple Macintosh-gebruikers? Ze zijn ofwel al bekend met de schrijfstijl van Microsoft, of ze zullen er niet door in de war raken, omdat je de schrijfstijl consequent in de hele handleiding toepast.
Een woordenboek en een thesaurus doen ook nooit pijn, hoewel deze ook op internet te vinden zijn, en welke te gebruiken (en) gespecificeerd moet worden in de Huisstijlgids. Gebruik bij twijfel Merriam Webster, de "gouden standaard" van woordenboeken.
De magische formule voor het schrijven van instructies
| Waar ben ik? | Wat moet ik doen? | Wat is er gebeurd? |
|---|---|---|
Vertel de lezer waar ze zijn → | Vertel ze wat ze moeten doen → | Beschrijf de resultaten van hun acties |
The Magic Formula: The Given-New Method
Nu kent u een van de basisprincipes van technische communicatie, of u nu een professionele schrijver bent of niet. Het staat ook bekend als de gegeven-nieuw-methode omdat je begint met de lezer iets te vertellen dat hij al weet, een "gegeven", en dan geef je hem iets "nieuws". Duidelijke titels / koppen zijn hier de sleutel tot succes.
Merk op dat deze methode de reeds gefrustreerde lezer / gebruiker helpt snel te begrijpen of uw specifieke procedure van toepassing is op hun situatie omdat u deze een duidelijke titel hebt gegeven, of ze zich op de juiste startplaats bevinden (omdat u hen heeft verteld waar ze moeten beginnen), wat ze moeten doen doen op dat punt, en hoe de resultaten eruit zouden moeten zien.
Nu bent u klaar om goede instructies te schrijven
Nu u de regels voor schrijven kent, kunt u beginnen met het schrijven van de instructies, waarbij u te allen tijde het perspectief van de gebruiker in gedachten houdt.
Je noemt de instructies "Hoe taak ABC te doen", waarbij je ervoor zorgt dat de instructies onder deze kop allemaal te maken hebben met het volbrengen van taak ABC (en niets anders). Nu ben je klaar om de instructies zelf te schrijven.
Het eerste dat u moet doen, is de gebruikers oriënteren: vertel de gebruikers waar ze zijn en wat ze op hun scherm zouden moeten zien, zoals de naam van het venster waarnaar ze zouden moeten kijken. Vertel ze vervolgens op welke knop (pen) ze in het huidige venster moeten drukken en / of welke tekst ze in welk veld (en) moeten typen. Vertel ze vervolgens hoe ze bij de volgende stap / locatie kunnen komen en beschrijf wat ze op het scherm zouden moeten zien als ze die actie ondernemen.
Bijvoorbeeld:
- Van de Hoofd venster, selecteer alle opties die u wilt activeren. Klik OKDe Tweede venster wordt weergegeven met de huidige status van de door u geselecteerde opties.
- Op de Tweede venster, controleer of alle geselecteerde opties correct zijn.
- Als alle opties correct zijn, klikt u op Activeer OptiesDe Derde venster verschijnt.
- Als de opties niet allemaal correct zijn, klikt u op Terug om terug te keren naar de Hoofd venster en selecteer verschillende opties.
Laatste schoonmaak
Als u klaar bent met schrijven, voert u de spelling- en grammaticacontrole uit en laat u een of meer vakexperts (MKB) - mensen die het product kennen - het document nakijken. Breng eventuele wijzigingen aan, voer de spelling- en grammaticacontrole opnieuw uit en laat iemand het document proeflezen / bewerken.
Als u eenmaal wijzigingen heeft aangebracht die de editor heeft aangebracht, bent u doorgaans klaar (tenzij uw bedrijf een formeel documentvrijgaveproces heeft dat u moet volgen).
Merk op dat de wijzigingen die zijn aangebracht door de materiedeskundigen en de redacteur (de materiaalexport op de exacte bewoording en stijl) vrijwel zonder twijfel moeten worden geaccepteerd: het is hun baan om hun vakgebied te kennen. als jij sterk het niet eens zijn met een wijziging, breng deze dan pas onder de aandacht van de KMO of de redacteur, al naargelang het geval. Breng anders de voorgestelde wijzigingen aan.
Bruikbaarheid Test uw instructies
Als je eenmaal een heel goed concept hebt, rekruteer dan verschillende mensen om je instructies te testen - om ze van begin tot eind te doorlopen en noteer (en laat je noteren) op welke gebieden ze verdwalen of in de war raken of waar de instructies niet kloppen.
Idealiter zijn bruikbaarheidstesters de echte klanten / gebruikers van het product / de website die u hebt gedocumenteerd. In een mum van tijd is het echter beter dan niets om een paar mensen uit het kantoor te werven die niet bekend zijn met waarover u hebt geschreven en hen het document te laten testen. Houd er in dit geval rekening mee dat de testers de materiedeskundige gebruikers zijn, dus hun wijzigingen zijn net zo waardevol als die van uw product-KMO's en redacteur (KMO).
Bruikbaarheidstesten zelf is een hele discipline die te breed is om in dit artikel te behandelen.
Als u echter eenmaal wijzigingen heeft aangebracht in het testen van de bruikbaarheid, voert u de wijzigingen door de editor en, indien van toepassing, uw product / dienst MKB-bedrijven: misschien zou een kleine wijziging in het product / de dienst, nu of in een toekomstige release, een groot verschil maken. aan de gebruikers.
Conclusies en generalisaties
We kunnen de volgende conclusies en generalisaties trekken over het schrijven van software-instructies:
- Lezers zijn gefrustreerd als ze je werk lezen.
- U moet de lezer op zijn gemak stellen door hem te vertellen waar hij is, wat hij moet doen en waar hij terecht zal komen.
- U moet experts uw document laten beoordelen op productnauwkeurigheid en schrijfnauwkeurigheid.
- U moet de wijzigingen accepteren die door uw experts zijn aangebracht, tenzij u aanzienlijk niet mee eens, praat in dat geval met de betreffende deskundige over de kwestie.
- Bruikbaarheidstesten zijn de beste manier om ervoor te zorgen dat uw document een succes wordt en voldoet aan de behoeften van de gebruikers / lezers. Het kan zelfs leiden tot productverbeteringen!
Dit artikel is nauwkeurig en waar voor zover de auteur weet. De inhoud is alleen bedoeld voor informatieve of amusementsdoeleinden en vervangt geen persoonlijk advies of professioneel advies op zakelijk, financieel, juridisch of technisch gebied.
