Handleiding Schrijven Technieken

Schrijven technische of handleidingen vraagt ​​om beknopte , gemakkelijk te begrijpen taal en presentatie. Er zijn een aantal basis technieken die bijdragen aan het creëren van dit soort presentatie . Elk helpt presenteren de informatie duidelijk in de handleiding. Echter , het proces van het schrijven van effectieve handleidingen begint met effectieve onderzoek van het onderwerp . Begrijp het onderwerp en vervolgens gebruik maken van deze technieken om de informatie zo goed mogelijk te presenteren . Inleiding

De intro definieert de handleiding. Uitleggen wie het document moet lezen en voor wie is het niet bedoeld voor , welke informatie wordt opgenomen en onder welke omstandigheden is het nuttig . Voor gebruiksaanwijzingen, aannemen dat de lezer heeft het product gekocht en is klaar om te leren hoe het te gebruiken . Houd de introductie kort zodat de gebruiker krijgt om de technische aspecten van de handleiding zo snel mogelijk .
Contouren

Technische handleidingen worden vaak uitgevoerd in secties en subsecties gelegd , die ook een ideale omtrek maken . Een lijst van alle geplande secties voor de handleiding en opgenomen gedetailleerde onderafdelingen waar nodig . Wees niet bang om de secties te herschikken als je vooruitgang . Alleen maar omdat je dacht van onderwerp A heeft eerst niet dat de lezer moet dat stukje informatie als eerste. De definitieve volgorde van de secties moet de natuurlijke progressie van de gebruiker zal maken tijdens het leren van het onderwerp weer te geven . Gebruik een zelfstandig naamwoord en werkwoord in de sectie op weg naar het item en actie binnen de sectie definiëren .
Be Active

Elke stap in een technische handleiding wordt aangegeven dat de lezer in een actie die , wanneer deze wordt uitgevoerd met andere stappen , tot het totale actie . Nummer de stappen of grafische " kogels " om de stappen aan te geven . In sommige situaties kan de trede substappen aangeduid met nummers of letters onder de fasen. Schrijvers hebben enige vrijheid in hoe ze stappen te identificeren, maar consequent door de handleiding zou moeten zijn.
Keep It Simple

Gebruik de eenvoudigste taal die volledig recht aan de informatie. Je weet niet wie de handleiding en hoe goed ze zijn thuis in het technische jargon van het onderwerp zal lezen . Geen hoge detail of details niet nodig om de informatie over te brengen . Lange zinnen , meer dan 20 woorden , hebben de neiging om de lezers te ontmoedigen . Straffen van minder dan 10 woorden kan het document een hakkende geluid te geven .
Illustreer het Topic

Gebruik foto's , diagrammen of grafieken om het onderwerp te illustreren. Deze beelden kunnen de moeite waard zijn dan duizend woorden en hebben de neiging om de ogen van de lezer te trekken . Als grafische beelden zijn niet mogelijk, gebruik beschrijvende zinnen . Verbale voorbeelden en illustraties laat ook de lezer om het onderwerp te visualiseren .