Hoe een handleiding te maken

Het schrijven van een handleiding lijkt misschien een veeleisende taak, maar het is makkelijker dan je denkt. Deze tips kunnen worden toegepast op elke geschreven instructiehandleiding, van de eenvoudigste tot de meest gecompliceerde.

Inhoud

Stappen

Methode 1ken het onderwerp
Methode 2plan het ontwerp van uw handleiding
Methode 3begin met schrijven
Methode 4formaat

Tips

stappen

Methode 1
Ken het onderwerp

Dit is de sleutel. Het ligt voor de hand, maar kennis van het onderwerp is de sleutel tot het schrijven van een succesvol handboek. Als u bijvoorbeeld een handleiding voor een camera aan het schrijven bent, weet dan dat de F-stop en dat de sluitertijd niet alleen afzonderlijke functies zijn - omdat ze dat zijn - maar wetende hoe ze beide samenwerken, maakt de manier waarop u elke functie beschrijft veel gemakkelijker. .

Spreek met experts Als het uw rol is om gewoon schrijver te zijn in plaats van een expert in het veld te zijn, betrek mensen dan met de nodige kennis tijdens het proces en zorg ervoor dat zij uw werk beoordelen. Zijn kennis en advies zijn van onschatbare waarde.

Probeer een praktische benadering te maken. Voer, indien mogelijk, in de praktijk wat u schrijft, zo kunt u op zijn minst voelen wat de gebruiker zal leren.

Lees erover Leer praten over wat er wordt besproken en ken het product waarover je schrijft.

De handleidingen of soortgelijke producten zullen u leren hoe andere mensen het onderwerp hebben benaderd.

Zoek naar overeenkomsten tussen schrijvers, waarmee wordt aangegeven dat beide over een gemeenschappelijke functionaliteit en gemeenschappelijke benaderingen beschikken om iets te beschrijven.

Zoek verschillen die opvallen. Dit kunnen functies zijn die uniek zijn in een product. Uw product kan deze functies wel of niet hebben, of het kan andere manieren hebben om het probleem dat u kunt beschrijven op te lossen, waardoor de waarde van het product wordt vergroot. Hoewel het uw taak is om te schrijven hoe u iets moet doen, kunt u de klant laten zien dat de waarde van zijn aankoop een goede manier is om hem te motiveren om verder te lezen.

Lees vakbladen Ontdek hoe mensen deze producten dagelijks gebruiken. Ze willen misschien een functie om een bepaald probleem op te lossen, en als uw product de oplossing is, moet dit worden benadrukt.

Methode 2
Plan het ontwerp van uw handleiding

Ga stap voor stap af. Of het nu gaat om het schrijven van een stapsgewijze instructiefolder of een handleiding voor een digitale camera, het onderscheiden van elke stap heeft zijn voordelen:

Hiermee kunt u zich concentreren op afzonderlijke onderdelen. Uw doel is om de gebruiker vertrouwd te maken met het proces. U kunt desgewenst het gedeelte van de functie aan het einde van de zelfstudie laten staan of de gebruiker zelf laten ontdekken.

Volg een logische volgorde. Het zou niet goed zijn als je bijvoorbeeld beschrijft hoe de flits van een camera werkt totdat je hebt uitgelegd hoe je de lenzen plaatst of de film laadt, schakel de camera in en pas de scherpstelling aan. Dit is handig, vooral als u niet bekend bent met het onderwerp.

Gebruik dit als een model voor uw inhoudsopgave.

Controleer uw stappen. Nadat u de logische secties hebt gedefinieerd, controleert u deze om ervoor te zorgen dat u alles hebt behandeld.

Verzamel je spullen. Geef het item dat u beschrijft met de hand en klaar om te worden gebruikt terwijl u het in de handleiding beschrijft. Als je een kartonnen doos maakt, moet je papier, schaar, tape, lijm en liniaal bij de hand hebben. Als u over een camera schrijft, zorg dan dat deze is verwijderd. Indien mogelijk moet het product waarover u schrijft worden verpakt.

Methode 3
Begin met schrijven

Schrijf de introductie. Hiermee wordt de toon gezet voor de hele handleiding en krijgt de gebruiker een idee van het type handleiding dat wordt gelezen. Wordt het vermakelijk of zinloos? Het hangt af van de persoon die leest. Er is veel meer ruimte voor verbaal spel wanneer je een handleiding voor kinderen schrijft dan wanneer je een handleiding voor een arts schrijft. Stel de toon in en houd die toon in de hele handleiding.

Doe elke stap terwijl je het aan het schrijven bent. Het geeft je niet alleen wat eerlijkheid en authenticiteit bij het schrijven, maar je zorgt er ook voor dat je geen losse eindjes maakt.

Als het om een of andere reden niet mogelijk is om de stap uit te voeren, analyseer het dan grondig en raadpleeg een expert.

Maak een lijst van de stappen. Dit maakt het gemakkelijker voor de lezer om uw instructies te volgen en voor enige referentie in de toekomst als deze verloren is.

Als u op een stuk papier schrijft, moet u spaties achterlaten om annotaties toe te voegen in elke stap. Vergeet niet om de naam te wijzigen als u meer stappen toevoegt

Bevat advies en waarschuwingen. Terwijl u schrijft, kunt u zich realiseren dat als de gebruiker een stap zonder zorg doet, dit een probleem kan veroorzaken.

Als er een advies is dat de gebruiker helpt een taak te vergemakkelijken of het interessanter te maken, voegt u het toe.

Stel het op de proef. Gebruik je schriftelijke instructies om het op de proef te stellen. Als u zich realiseert dat er iets ontbreekt in uw instructies, voegt u de nodige informatie toe. Herhaal deze stap totdat iedereen klaar is en je kunt doen wat je probeert te onderwijzen zonder notities te hoeven toevoegen.

Overweeg om een vriend of twee de handleiding te laten gebruiken. Observeer ze zorgvuldig wanneer ze leren het product te gebruiken. Kijk of ze op een bepaald moment verloren zijn, in de war raken of falen. Luister naar wat ze te zeggen hebben en pas dan de handleiding aan.

Bevestig je handleiding. U wilt uw handboek (een agentschap of uw vrouw) niet met een aantal fouten verzenden.

Methode 4
formaat

Begin vanaf het begin Als u alle gedetailleerde stappen hebt uitgevoerd, bekijkt u de handleiding om de voor de hand liggende koppen te vinden.

Plaats titels en noteer je locatie.

Schrijf indien nodig de inhoudsopgave. Zie hoe wikiHow het als een voorbeeld doet, de startpagina biedt veel kopgedeelten. Wanneer u elke sectie opent, worden verschillende subcategorieën weergegeven en worden in de subcategorieën artikelen vermeld. Hoe gedetailleerder uw handleiding, hoe meer categorieën en subcategorieën u nodig heeft. (Hoe te fluiten, je hebt er geen behoefte aan, terwijl je een fluitje moet fluiten dat je nodig hebt en hoe je een fluit moet spelen, je hebt er veel nodig.)

Ga terug om nog een keer te corrigeren. Ja, je hebt het al een keer gedaan. Als je het voor de tweede keer doet, maak je ongetwijfeld kleine fouten of plaatsen waar je handleiding niet duidelijk genoeg duidelijk is.

Om een beter begrijpbare handleiding te maken, kunt u deze gelegenheid aangrijpen om kleine onderwerpen op te schrijven en die informatie te gebruiken om een index te maken.

Selecteer de titel

tips

Als je een gedetailleerde handleiding schrijft die hoofdstukken vereist, zoals "Hoe speel je de fluit", dan is de eerste stap om de hoofdstukken op te sommen, zoals "Selecteer de fluit, assemblage en zorg, gebruik je vingers, je eerste muziekstuk" enz. U kunt de basisregel toepassen om in elk hoofdstuk een handleiding te schrijven, omdat elk hoofdstuk hetzelfde is als het schrijven van een afzonderlijke handleiding.
Zelfs als iets je duidelijk lijkt, noteer het dan in de stappen. Voorkom lege ruimte op iets dat de gebruiker niet kent. Het is beter om extra informatie op te nemen in plaats van belangrijke stappen over te slaan.
Noteer waar mogelijk uw instructies. Als u geen afbeeldingen kunt bijvoegen, raadpleegt u de lezer als voorbeeld. Bijvoorbeeld in Formaat, stap 2 In deze instructies wordt het wikiHow-ontwerp gebruikt om de inhoudsopgave te illustreren.
Als je kunt, laat een leerling je handleiding testen en schrijf elke vraag op die je hebt. Dit zal u helpen de lege ruimtes in te vullen en uw handleiding nuttiger te maken.
Door elke sectie op afzonderlijke bladen (of op een computer) te schrijven, wordt het bewerken eenvoudiger. Je kunt het gemakkelijk repareren als je voldoende ruimte hebt om te werken en je je merktekens kunt vinden. Laat op de computer 3 tot 4 regels tussenin (wanneer u meerdere keren Enter invoert), op deze manier kunt u notities toevoegen.

Delen op sociale netwerken:

Verwant