Het schrijven van een handleiding lijkt misschien een moeilijke taak, maar het is makkelijker dan u denkt! Deze stappen gelden voor alle schriftelijke instructie, uit de zeer eenvoudige (Hoe Clap) aan de intens gecompliceerde (Hoe maak je een Semiconductor bouwen.)
Stappen
Krijgen tot het onderwerp weten
- 1Dit is de sleutel. Het lijkt misschien vanzelfsprekend, maar kennis is de sleutel tot het schrijven van een succesvolle handleiding. Bijvoorbeeld, als je het schrijven van een handleiding van de camera, in de wetenschap dat er een f-stop en de sluitertijd zijn niet alleen 2 aparte functies-ze-maar weten hoe ze omgaan met elkaar zal het veel gemakkelijker voor u om elke te beschrijven fungeren als het gaat om het geheel.
- 2Praat met deskundigen. Als uw rol is gewoon de schrijver in plaats van het onderwerp expert, betrekken geïnformeerde mensen gedurende het gehele proces en zorg ervoor dat ze je werk beoordelen. Hun kennis en advies is van onschatbare waarde.
- 3Probeer een hands-on aanpak. Indien mogelijk, het doen van het ding je schrijft over zal, op zijn minst, geeft je een gevoel voor wat de gebruiker zal willen leren.
- 4Lezen over het onderwerp. Leer om het gesprek praten, en worden vertrouwd in het artikel te schrijven over.
- Handboeken van soortgelijke producten zal u tonen hoe andere schrijvers het onderwerp hebben aangepakt. # ** Kijk voor overeenkomsten tussen de schrijvers, die zowel de gemeenschappelijke functionaliteit en een gemeenschappelijke aanpak geeft om iets te beschrijven.
- Kijk voor verschillen die opvallen. Deze zijn waarschijnlijk functies die uniek zijn voor een bepaald product. Uw product kan wel of niet onder deze functies, of kunnen alternatieve manieren van het oplossen van het probleem dat je kunt omschrijven, het verbeteren van de waarde van uw product. Terwijl je baan kan worden het schrijven van een how-to, waarin de klanten de waarde van hun aankoop is een geweldige manier om hen aan te moedigen verder te lezen.
- Verslinden vakbladen. Ontdek hoe de mensen die gebruik maken van de producten werken met hen dag-tot-dag. Zij kunnen wou dat er een functie die hun specifieke probleem opgelost, en als uw product is de oplossing, die moet worden gemarkeerd.
- Handboeken van soortgelijke producten zal u tonen hoe andere schrijvers het onderwerp hebben aangepakt. # ** Kijk voor overeenkomsten tussen de schrijvers, die zowel de gemeenschappelijke functionaliteit en een gemeenschappelijke aanpak geeft om iets te beschrijven.
Plan uw handleiding layout
- 1Af te breken. Of het nu een eenvoudige stap-voor-stap instructies, of een handleiding voor een 35mm digitale camera, het af te breken in verteerbare brokken heeft een aantal voordelen:
- Het laat je concentreren op afzonderlijke onderdelen van het geheel. Je doel is om de gebruiker vertrouwd te maken met hoe het proces te leren. Hoe ook de functie kan worden over voor een handleiding einde, indien gewenst, en links de gebruiker te ontdekken op hun eigen.
- 2Volg een logische volgorde. Het zou geen goed doen, bijvoorbeeld, om te beschrijven hoe de flits op een camera werkt tot je hebt laten zien hoe je de lens hechten, laadt de film, zet de camera aan, en pas de scherpstelling. Dit is vooral handig als je niet goed kent het onderwerp.
- 3Gebruik dit als uw sjabloon voor de inhoudsopgave.
- 4Bekijk uw stappen. Zodra u de logische secties hebt gedefinieerd, beoordelen hen om ervoor te zorgen dat alles is gedekt.
- 5Verzamel uw leveringen. Hebben de items die je beschrijft bij de hand en klaar voor gebruik, zoals beschreven in de handleiding. Als je het maken van een papieren doos, heb papier, schaar, plakband, lijm en een liniaal handig. Als je schrijft over een camera, zorg ervoor dat uw camera is gedemonteerd. Indien mogelijk, dient het product dat u aan het schrijven bent over terug in de doos te zijn op dit punt.
Beginnen met het schrijven
- 1Schrijf de introductie. Dit zal de toon van de gehele handleiding te stellen, en zal de gebruiker een idee over wat voor soort handleiding ze over te verteren geven. Zal het licht en amusant, of eenvoudig en no-nonsense? Het hangt af van uw lezerspubliek. Er is veel meer ruimte voor verbale spelen onderwijzen van kinderen om een papieren doos te maken dan er is het onderwijzen van een arts hoe verder te gaan met een open-hart operatie. Stellen de toon vroeg en houden die toon in de hele handleiding.
- 2Voer elke stap als je schrijft. Niet alleen heeft dit geeft uw schrijven de sfeer van eerlijkheid en authenticiteit, je er ook voor zorgen niets krijgt weggelaten.
- Indien, om wat voor reden, is het niet haalbaar is om de stappen te doen, dat ze door grondig en raadpleeg iemand die een expert is.
- 3Nummer de stappen. Dit maakt het makkelijker voor mensen om mee te volgen, en om terug te verwijzen naar moeten ze hun plaats verliezen.
- Als je het schrijven op papier, zeker om ruimte te laten voor toevoegingen tussen elke stap. Vergeet niet om hernummeren je stappen als u meer inch voegen
- 4Onder meer tips en waarschuwingen. Als je aan het schrijven bent, kan je je realiseert dat als de gebruiker een stap uitvoert onzorgvuldig, kan dit een probleem veroorzaken.
- Omgekeerd, als er een beetje kennis dat de taak van de gebruiker gemakkelijker of interessanter zal maken, voeg deze binnen
- 5Test het uit. Met alleen uw schriftelijke instructies, doe het ding je schrijft over. Mocht u plaatsen waar uw instructies ontbreken, voegt de nodige informatie. Herhaal deze stap totdat u alle stappen en kunt doen wat je leert zonder notities toe te voegen.
- Overweeg dan om een vriend of twee gebruik maken van de handleiding. Bekijk ze nauw als ze leren hoe het product te gebruiken. Zien waar ze zip via het. Zien waar ze verloren, verward, of niet op de taak. Luister naar wat ze te zeggen hebben, dan is uw handleiding dienovereenkomstig aan te passen.
- 6Nagelezen uw handleiding. Je wilt niet dat uw uiteindelijke proeflezer sturen (zijn dat uw kantoor of uw echtgenoot) een handleiding vol flagrante fouten.
Formatteren
- 1Beginnen op het hoogste niveau. Zodra u alle noodzakelijke stappen beschreven hebben, gaan door uw handleiding voor de hand liggende categorie hoofden vinden.
- Titel hen, en noteer hun locaties.
- 2Schrijf een inhoudsopgave, indien van toepassing. Kijk naar de manier waarop Google wordt als voorbeeld aangelegd. De hoofdpagina biedt vele sectie hoofden. Wanneer u een sectie, maar noemt vele subcategorieën, en de subcategorieën lijst artikelen. Hoe gedetailleerder uw handleiding is, de meer categorieën en subcategorieën die u nodig heeft. (Behoeften none, Hoe Carve een fluitje heeft een paar, en hoe te spelen de fluit heeft vele!)
- 3Nagelezen weer. Ja, je deed het goed al eens. Doet het een tweede keer zal ongetwijfeld vangen een paar kleine fouten of plaatsen waar uw handleiding is gewoon niet duidelijk.
- Voor een meer uitgebreide handleiding, kunt u ook van deze gelegenheid gebruik om op te merken alle kleine onderwerpen, en die informatie gebruiken om een index te creëren.
- 4Selecteer een titel.
Tips
- Indien mogelijk, uw instructies! Als u geen foto's kunt plaatsen, zie je studenten om iets gemeen als een voorbeeld. Bijvoorbeeld, in opmaak, stap 2 van deze instructies, is het uiterlijk van lay-out van Google gebruikt om te illustreren hoe een inhoudsopgave kan worden gecreëerd.
- Als je kunt, een beginnende doe een test van uw handleiding en noteer elke vraag die ze stellen! Dit zal u helpen vullen de lege plekken en maak uw handleiding veel nuttiger.
- Zelfs als iets lijkt vanzelfsprekend voor je, schrijf de stappen! Het zal u helpen voorkomen verdoezelen iets wat je gebruiker niet weet. Het is beter om te zetten in extra informatie in plaats van weg te laten belangrijke stappen.
- Als u het schrijven van een zeer gedetailleerde handleiding die hoofdstukken, zoals hoe je moet de fluit spelen, kan uw eerste stap daadwerkelijk te zijn om alle hoofdstukken, zoals het selecteren van een fluit, Vergadering en zorg, toonvorming, Methods of Vingeren, uw eerste stuk, etc. Je zou dan gelden de basisregels voor het schrijven van een handleiding om elk hoofdstuk omdat elk hoofdstuk is als een aparte handleiding op zich!
- Het schrijven van elk hoofdstuk op een aparte pagina (of op een computer) zal het bewerken te vergemakkelijken. U kunt gemakkelijker herschikken als u nog ruimte om te werken en kan uw bewerkte vinden. Op de computer, laat 3 of 4 regels (door het slaan voer meerdere malen) tussen elke stap, zodat u kunt eenvoudig de pauzes.