Hoe kan ik een handleiding maken

Het creëren van geschikte gebruikersdocumentatie

1. 1
   Bepaal wie uw gebruikersnaam is. Om een ​​succesvolle handleiding te schrijven, moet je een profiel van uw gebruikers te ontwikkelen, hetzij formeel, door het creëren van een schriftelijk profiel, of informeel, door het nemen van de tijd om een ​​redelijke veronderstellingen over de kenmerken van uw gebruikers. Zo'n profiel is handig wanneer je deel uitmaakt van een team het schrijven van de gebruikersdocumentatie en kan ook nuttig zijn bij het nemen van het product zelf, van concept tot de uiteindelijke vorm. Wat te denken bij het vormen van een gebruikersprofiel omvatten:
   • Waar gebruikers de gebruikershandleiding, zoals thuis, op kantoor, op een afgelegen bouwterrein zal gebruiken, of in de auto. Dit kan niet alleen de inhoud te bepalen, maar de stijl van de gebruikershandleiding neemt.
   • Hoe gebruikers zullen de gebruiksaanwijzing gebruiken. Als de handleiding is zal men ze slechts zelden te raadplegen of om informatie op te zoeken, moet het in de eerste plaats in de vorm van een referentiedocument. Als het iets gebruikers zullen regelmatig overleg in het begin, moet de referentie sectie vergezeld van een hoofdstuk "Aan de slag" en instructies op de meest voorkomende taken het product zal worden gebruikt voor.
   • Hoeveel ervaring gebruikers hebben met het product of de anderen alsof het. Als uw product is nieuw of significant verschillend van soortgelijke producten, moet u een uitleg van hoe het verschilt van andere producten, alsmede instructies over hoe te beginnen omvatten. Als het product bezig met iets wat gebruikers hebben vaak moeite met, zoals veel computer-toepassingen, moet u passende informatie en details op een begrijpelijke manier te bieden.
2. 2
   Schrijven aan de behoeften van uw gebruikers op een bepaalde manier de gebruiker kan begrijpen. Tenzij de gebruiker heeft een technische achtergrond, is het waarschijnlijk het beste om zeer technische taal in het voordeel van heldere, eenvoudige uitleg te vermijden. De tekst moet ook worden georganiseerd op een manier die de manier waarop gebruikers denken nabootst; bedrijf producteigenschappen gegroepeerd per functie maakt het vaak meer zin dan eenvoudig die het meest gebruikt.
   • Soms is er geen ontkomen met technische termen, zoals een grafiek-maken van software applicatie die Fibonacci grafieken bevat, samen met meer gemeenschappelijke taart en staafdiagrammen. In een dergelijk geval is het nuttig om de term te definiëren en geven wat achtergrondinformatie, zoals een uitleg van wat Fibonacci grafieken zijn en hun gebruik in de financiële analyse.
3. 3
   Verklaar het probleem van de gebruiker probeert op te lossen, dan presenteren de oplossing aan. Het aanbieden van een functie als de oplossing voor een algemeen probleem werkt prima bij de verkoop van het product, maar zodra de gebruiker het product, dat hij of zij nodig heeft om erachter te komen hoe zet het te gebruiken. Identificeer specifieke problemen van de gebruiker zal worden geconfronteerd, vermelden ze in de gebruiksaanwijzing en volg de instructies op te lossen.
   • Als het probleem is complex, breken in kleinere delen. Lijst elk deel met de instructies over hoe op te lossen of ermee om te gaan, en dan volgen met elk volgend deel in successie. Breken informatie naar beneden op deze manier heet "chunking."

Gebruikershandleiding onderdelen

1. 1
   Onder de juiste omslag en titelpagina's. Je krijgt een voorblad voor een gebruikershandleiding dat is meer dan een referentiekaart en een titelpagina voor elke handleiding die meer dan een opgevouwen vel papier (4 of meer pagina's in de lengte) dekt nodig.
   • Als de handleiding is auteursrechtelijk beschermd, een copyright gaat op zowel de voorkant en titelpagina.
   • Als er voorwaarden voor het gebruik van de handleiding en het product ermee verbonden zijn, plaats ze op de binnenzijde van de voorpagina.
2. 2
   Zet verwijzingen naar verwante documenten in het voorwoord. Als de gebruiker documentatie is meer dan 1 handleiding, verwijzen naar de andere documenten, met de juiste versienummers, hier. Het voorwoord is ook de plaats waar een sectie 'Hoe deze gids te gebruiken "gezet als er een is.
3. 3
   Onder meer een inhoudsopgave als de handleiding van meer dan 10 pagina's.
4. 4
   Zet instructies / procedures en referentiemateriaal in het lichaam van de handleiding. In de meeste gevallen, procedures en vindplaats materialen moeten elk respectieve onderdelen, maar kan de gebruiker vertellen om te verwijzen naar specifieke inhoud in een sectie van de andere. Op deze manier kan de gebruiker de informatie die hij of zij zoekt sneller vinden.
   • Procedures dienen op een consistente structuur worden geschreven door de sectie instructies van de handleiding. Beginnen met een overzicht van de taak, dan beschrijven wat de gebruiker moet doen en welk resultaat hij of zij zou moeten zien. Stappen moeten genummerd zijn en beginnen met actie werkwoorden, zoals de stappen in elke sectie van dit artikel worden geschreven.
   • Referentiematerialen kunnen bevatten lijsten van opties, het oplossen van problemen tips en veelgestelde vragen. Woordenlijsten en indexen kunnen worden toegevoegd aan het eind van de handleiding, maar een lijst van vaak gebruikte termen kunnen worden aan de voor. De index kan worden weggelaten indien de handmatige loopt minder dan 20 bladzijden.
5. 5
   Gebruik grafische afbeeldingen als nodig om de tekst te ondersteunen. Grafische afbeeldingen of screenshots, kunnen bepaalde punten te illustreren in de handleiding beter dan tekst, met name in complexe procedures waarbij gebruikers moeten visuele bevestiging hebben dat ze de stappen correct uitvoeren bent. Grafische afbeeldingen kunnen worden geproduceerd met behulp van computer-aided opstellen (CAD) of grafische editing software, digitale camera's en foto-editing software, of in het geval van screenshots, hetzij ingebouwde screen capture mogelijkheid van uw computer of een grafisch programma met screen capture-mogelijkheid.
   • Zodra u een grafisch beeld te creëren, op te slaan in als een gecomprimeerd formaat als uw tekstverwerker of desktop publishing-programma zal u toelaten om te gebruiken. U zult ook willen om de fysieke grootte van uw afbeelding verkleinen tot iets dat gemakkelijker zal op de pagina passen, terwijl het toch voldoende detail voor de gebruiker. (Indien nodig, moet u de originele afbeelding gesneden in delen en tonen de relevante onderdelen, samen met de ondersteunende tekst.)
   • Als u meerdere grafische afbeeldingen in procedures, maken ze een consistent formaat, hetzij in dezelfde afmetingen van lengte en breedte of in dezelfde proportionele vermindering van hun oorspronkelijke grootte. Dit zal de beelden aantrekkelijker voor de gebruiker. Ook bij het maken van screenshots van een computer, zorg ervoor dat de computer is het weergeven van een standaard kleurenschema bij het vastleggen van beelden als de handleiding van de screenshots in kleur wordt weergegeven.
   • Hoewel grafische bewerkingsprogramma's zoals Photoshop en Paint Shop Pro aanbieding fatsoenlijke screen capture-mogelijkheden, toegewijde screen capture programma's zoals SnagIt ook over de mogelijkheid om eenvoudig te wijzigen, catalogus, en annoteren screen captures.

Het ontwerpen van een leesbare handleiding

1. 1
   Kies een paar leesbare lettertypes. Hoewel computers kan een aantal verschillende lettertypes ondersteunen, het doel van een handleiding is om een ​​gemakkelijk leesbaar. Het kiezen van slechts een klein aantal lettertypen die samen goed uitzien is de beste manier om dit doel te bereiken. Lettertypen kunnen worden onderverdeeld in 2 types: met schreef of schreefloos lettertype.
   • Schreeflettertypen hebben kleine versiering lijnen aan de uiteinden van de hoofdlijn van de letter vormen. Serif lettertypen bevatten zoals lettertypes zoals Times New Roman, Baskerville, en Book Antiqua. Serif lettertypen het beste werken voor grote stukken tekst weergegeven in 10 tot 12 puntgrootte in het hoofdgedeelte van een gedrukte handleiding.
   • Sans serif fonts alleen de slagen die de letters zonder verfraaiing vormen. Schreefloze lettertypen bevatten zoals lettertypes als Arial, Calibri, en Century Gothic. Schreefloze lettertypen kunnen worden gebruikt voor grote stukken tekst in de maten van 8 tot 10 punt in een PDF-of web-based handleiding, hoewel het ontbreken van schreven maakt zinnen weergegeven in de maten 12 punten of groter moeilijker te lezen. Ze kunnen echter effectief worden toegepast in grotere maten tot titels en koppen weer te geven, en ze zijn ook grote in de kleinere maten voor voetnoten en getallen in de kolommen en tabellen.
   • U dient in het algemeen kiezen vlakte lettertypes zoals Arial of Times New Roman voor uw handleiding, hoewel je misschien wilt een decoratief lettertype voor pull quotes of voor titels gebruiken als je het schrijven van een handleiding voor een video game met een fantasie of science fiction setting. (In het geval van pull quotes, krijgt u vaak door met een van de vlakte lettertypen en geeft de pull citaat cursief.)
   • Als je eenmaal hebt besloten op de lettertypen die u wilt gebruiken, maakt u een steekproef om te controleren of uw lettertypen gaan goed samen op papier. U zult ook willen om dit monster te tonen aan wie toestemming is dan het uitzicht van de handleiding heeft voordat u verder te gaan met het schrijven ervan.
2. 2
   Nadenken over de lay-out. Zodra u lettertypen van uw gebruikershandleiding's hebt gekozen, moet u beslissen waar alles gaat op de pagina's.
   • Over het algemeen, wil je titel of de titel van een hoofdstuk van de handleiding we in de kop-of voettekst, eventueel met behulp van de handleiding titel op de linkerpagina en titel van het hoofdstuk over de rechterpagina. U wilt de pagina nummers in de kop-of voettekst ook, hetzij aan de buitenkant (kop-of voettekst) of in het midden (alleen voettekst). Misschien wilt u de eerste pagina van elke sectie of hoofdstuk verschillen van de andere pagina's door het plaatsen van het paginanummer in het centrum van de voettekst en de daaropvolgende pagina's in de buitenste hoek van de header.
   • Misschien wilt u hebben bijschrift tekst in gekleurde of gearceerde vakjes om het te scheiden van de rest van de tekst. Zorg ervoor dat u een kleur of het niveau van arcering dat de tekst niet overweldigen kiezen.
   • Laat redelijk ruime marges aan alle kanten, met extra ruimte op de randen die aan elkaar gebonden zal zijn.
3. 3
   Overweeg het type binden voor de handleiding. Als uw gebruikershandleiding loopt meer dan 4 pagina's, worden de pagina's moeten samen worden gebonden op een bepaalde manier. Hoewel de interne documenten bij elkaar kunnen worden geniet op de hoek, zijn externe gebruikershandleidingen dat het schip met een product meestal gebonden in een van de 3 manieren:
   • Side-nieten is geschikt voor handleidingen samengesteld uit gevouwen 8,5 x 11 inch (21 x 27.5 cm), 8,5 x 14 inch (21 x 35 cm) of 11 x 17 inch (27,5 x 42,5-cm) lakens van papier. Meest goedkope handboeken van 48 pagina's of minder gebonden zijn op deze manier.
   • Zadel-stitching wordt vaker gebruikt voor derden naslagwerken dan voor gebruikershandleidingen dat schip met uitzondering van auto's producten, hoewel sommige langere gebruikershandleidingen zijn gebonden op deze manier. (Paint Shop Pro oorspronkelijk geleverd met een rughechtingen gebonden gebruikershandleiding toen het werd geproduceerd door JASC Software.)
   • Spiraal binding is geschikt voor de gebruiker gidsen ontworpen om te worden gebruikt in meer robuuste instellingen, zoals het buiten, waar zij-geniete of rugnietjes handleidingen uit elkaar zou vallen. Sommige spiraal gebonden handleidingen kan ook gelamineerd pagina's om te voorkomen dat ze worden geruïneerd als de handleiding nat of modderig.
4. 4
   Bouwen van een template document voor uw handleiding. Veel tekstverwerking en desktop publishing-programma's bieden u de mogelijkheid om een ​​template document voor uw handleiding te maken, zodat het typen, wordt de tekst automatisch weergegeven in het lettertype dat u voor het gedeelte van de handleiding die u bezig bent geselecteerd. (Dit artikel, in feite, werd aanvankelijk geschreven met behulp van een Microsoft Word-sjabloon.) De meeste van deze programma's bevatten ook een set van vooraf gedefinieerde sjablonen die u kunt aanpassen voor uw behoeften, in plaats van het creëren van de sjabloon van de grond af.
   • Tekstverwerking en desktop publishing-programma's bieden ook de mogelijkheid om te creëren "stijlen," preset lettertype en point-size formaten voor kopteksten, voetteksten, koppen en hoofdtekst. U kunt een van de gedefinieerde stijl namen (bv, "Kop 1", "Normal", "Quote") te selecteren of maak uw eigen stijl met een eigen naam. Zo veel mogelijk, volg de conventies voor gevestigde stijl namen als u meerdere stijlen voor dezelfde klasse van de tekst. (Bijvoorbeeld Microsoft Word labels tekst stijlen voor koppen als 'Kop 1', 'Heading2, "enz. voor de rubrieken van de hoofdlijn door verschillende niveaus van subkoppen.) Probeer om alle stijlen die je nodig hebt vooraf zodat u niet te maken' t moet stoppen en ze te maken tijdens het eigenlijke schrijfproces.