Het vermijden verwarrend jargon en te concentreren op een duidelijke, nauwkeurige beschrijving van de technologie die u beschrijft kunt u een eenvoudige , intuïtieve handleiding te creëren , ongeacht het onderwerp natuur . Voor het schrijven van de handleiding , de voorbereiding van de inhoud zorgvuldig plannen hoe je het in educatieve proza ​​zal ontwikkelen en oordelen over de mate van detail . Wees altijd voorzichtig niet om de lezer het gevoel overspoeld door complexe , overwerkt beschrijving . First Impressions

Een lelijke , zware , felgekleurde handleiding met veel illustraties , grappen en onnodige details zullen de meeste lezers afschrikken zelfs het openen van het naar de gewenste pagina . Als zodanig , de dekking , de grootte en het ontwerp van de handleiding , en de eerste paar pagina's een belangrijke rol spelen . Maak een eenvoudige, informatieve deksel en introductie en houden de algemene lezer in het achterhoofd te allen tijde. Een effectieve handleiding zal een goed geschreven , makkelijk te gebruiken inhoud van de pagina te hebben met een nauwkeurige lijst van relevante hoofdstukken , paginanummers en onderafdelingen voor snel en gemakkelijk zoeken .
Details van ontwerp en lay-out

Papieren handleidingen met eenvoudige , ruime , zwart- wit lay-outs zijn het makkelijkst te lezen en te verteren . Een handleiding moet voldoende informatie om de lezer om alle noodzakelijke taken in verband met het product of de taak in kwestie (bijvoorbeeld instructies om te werken en repareren van een magnetron ) voltooien bevatten , maar het mag niet zo groot en technisch gedetailleerd dat het wordt wel zwaar en dus moeilijk te vervoeren rond het huis . Streven ernaar om de juiste balans tussen design en inhoud te bereiken; niet in de val van het creëren van een prachtig ontworpen handleiding met slecht doordachte concepten en slechte schrijfvaardigheid . Hetzelfde principe geldt voor enig diagrammen en afbeeldingen : Houd ze eenvoudig, duidelijk , goed gepositioneerd op de pagina en relevant. PNG-bestanden hebben kleine , beheersbare bestandsgrootte , maar vergeet niet om het gereproduceerde beeld controleren op duidelijkheid en leesbaarheid .
Ken Uw Onderwerp

We kunnen niet allemaal hebben gebruikt dezelfde magnetron , computer of puntenslijper . Ontwikkel een duidelijk begrip van hoe een of twee modellen van de apparatuur op het werk , dan beginnen na te denken over de beste manier u elke component kunt beschrijven . Gebruik standaard terminologie , en nooit make-up namen voor de verschillende onderdelen . Altijd behandelen potentiële lezers alsof ze kennis hebben van het item op een bepaald niveau , maar extra hulp met de details nodig hebben; anders , zou je het risico vervreemden ze door beledigen hun intelligentie . Voeg zoveel mogelijk details , maar presenteren het gewoon en in een vriendelijke , behulpzame manier .
Kleur
Coding

Als je denkt dat je de basis bij te voegen u hebt gemaakt , zacht kleur - code bepaalde feiten en hun verbinding in de gehele tekst . ( Geen fluorescerend roze gebruiken ; vasthouden aan lichte , eenvoudige kleuren zoals pastel groene en blauwe tinten . ) Deze koppeling is een soort van " indexering " en maakt gebruik van de mensen de cognitie en de psychologie van het lezen. Het stelt hen in staat om een ​​beter inzicht in de werking en de functies van een apparaat te ontwikkelen in plaats van het geven van hen een simplistische of " platte" landschap van het denken.
Verschillende stijlen van Prose

ontwikkelen en de effectiviteit van uw handleiding te verbeteren door te experimenteren met lichtjes verschillende stijlen van schrijven. Breek elke sectie en subsectie beneden in een korte beschrijvende paragraaf voor de invoering , het geven van een eenvoudige beschrijving van de betrokken elementen , en voeg vervolgens een stap -voor-stap reeks instructies na de eerste paragraaf aan de lezer precies vertellen hoe je een bepaalde voltooien reparatie of functie . Deze techniek zorgt ervoor dat de handleiding vloeiende en interessant , terwijl het meegeven van de meeste kennis in een korte tijd . Zelfs wanneer het proberen geavanceerde technieken voor het maken van een handleiding, altijd terug naar de basis te gaan : Controleer uw spelling , grammatica , consistentie , taal en opmaak op een regelmatige basis

.