Hoe ingenieus een uitvinder, programmeur of rationalist ook is, soms kunnen zijn creaties gewoon niet worden gebruikt voor het beoogde doel. De reden hiervoor is de onjuist opgestelde handleiding of het volledig ontbreken ervan. Maar zelfs ingenieuze uitvinders schrijven soms zulke instructies dat, afgezien van enge specialisten, niemand deze papieren kan lezen. Dus hoe stel je zo'n noodzakelijk document goed op?
Het is nodig
- - honderd procent kennis van het apparaat of softwareproduct waarvoor de handleiding wordt geschreven;
- - kennis op het gebied van taalkunde;
- - schrijfvaardigheden.
instructies:
Stap 1
Een gebruikershandleiding of, met andere woorden, een bedieningshandleiding is een document dat is ontworpen om gebruikers te helpen bij het gebruik van een bepaald systeem. Om een gebruikershandleiding samen te stellen, moet je het beschreven systeem honderd procent kennen, maar bekijken door de ogen van een onwetende student. Stel dat er een gebruikershandleiding is geschreven voor een softwareprogramma dat nog geen analogen heeft. Stel je voor dat dit de eerste keer is dat je dit programma gebruikt. Waar begin je? Wat is het eerste dat u moet weten? Organiseer deze kennis in categorieën van belang.
Stap 2
Door alle informatie over je creatie in groepen te verdelen, heb je een plan opgesteld voor het schrijven van een gebruikershandleiding. Begin met het vanaf het begin beschrijven van het werk in uw programma en laat voor het laatst de moeilijkste details achter, zoals het herprogrammeren van functies of het omgaan met kritieke fouten. In dit stadium moet u de inhoud van de gebruikershandleiding gereed hebben - een van de vereiste onderdelen van dit document.
Stap 3
Als de handleiding die u aan het maken bent, bedoeld is voor gebruik in een groot bedrijf, moet u letten op de bedrijfsnormen die daar worden gehanteerd. In veel Russische bedrijven worden gebruikershandleidingen bijvoorbeeld niet geaccepteerd zonder illustratieve ondersteuning, met andere woorden, afbeeldingen die uitleggen wat er is geschreven. Naast de inhoud moet de gebruikershandleiding andere verplichte onderdelen bevatten: - annotatie, dat wil zeggen een uitleg van de algemene doelstellingen van de handleiding en het beschreven product; - een inleiding, waarin de documenten met betrekking tot de gebruikershandleiding worden beschreven en hoe om de handleiding te gebruiken; - secties waarin het gebruik van het product wordt uitgelegd in verschillende stadia van het gebruik, bijvoorbeeld eerste stappen, reparatie of onderhoud; - sectie met veelgestelde vragen en antwoorden daarop; - woordenlijst of onderwerpindex.
Stap 4
Meestal is een technisch schrijver betrokken bij het maken van een gebruikershandleiding - een persoon die over alle benodigde kennis beschikt, zowel in de taal als in het product dat wordt beschreven. Als technisch schrijver zonder opleiding zijn er een paar regels om in gedachten te houden. Ten eerste mag u geen misbruik maken van speciale termen die voor een gewone gebruiker niet te begrijpen zijn. Ten tweede moet elke gebruikte term gedetailleerd en uitgelegd worden. Ten derde moet je zo duidelijk en beknopt mogelijk schrijven. Ten slotte moet een technisch schrijver in staat zijn om door de ogen van een gewone gebruiker naar zijn eigen tekst te kijken om de tekortkomingen van zijn eigen tekst te zien.
Stap 5
Het is goed om de afgewerkte tekst van de gebruikershandleiding in de praktijk te testen door deze aan te bieden aan een persoon die niets met het beschreven product te maken had. Door gezamenlijke inspanningen is het mogelijk om alle tekortkomingen en valkuilen van het document te elimineren.
