Hoe om `n gebruikershandleiding te maak

Gebruikershandleidings is handleidings geskryf in gedrukte vorms (op papier) of in elektroniese dokumente (PDF of XPS) wat instruksies verskaf oor hoe om iets te maak of te gebruik. Terwyl gebruikersgidse algemeen beskou word as handleidings vir rekenaarprogramme, kan gebruikersgidse rekenaars en ander elektroniese toestelle, soos televisies, stereo-radio`s, telefoonstelsels en MP3-spelers vergesel, asook elektriese toestelle en tuinmaak toerusting. Goeie gebruikershandleidings leer die gebruiker oor die funksies van die produk terwyl hy hom leer om dit doeltreffend te gebruik en so gerangskik dat dit maklik kan lees en geraadpleeg word. Vervolgens sal hierdie artikel `n paar dinge bevat om in ag te neem wanneer u `n effektiewe inhoud skep en die uitleg vir `n gebruikershandleiding ontwerp.

conținut

Stappe
Deel 1skep die toepaslike gebruikersdokumentasie
Deel 2komponente van die gebruikershandleiding
Deel 3ontwerp `n leesbare gebruikershandleiding
Wenke
Dinge wat jy nodig het

stappe

Deel 1
Skep die toepaslike gebruikersdokumentasie

Prent getiteld Skep `n gebruikershandleiding Stap 1

Definieer wie die gebruiker is Om `n suksesvolle gebruikershandleiding te skryf, moet u `n profiel van u gebruiker ontwikkel, hetsy formeel, `n geskrewe profiel of informeel, die tyd neem om redelike aannames oor die gebruiker se eienskappe te maak. So `n profiel is nuttig as jy deel is van `n span wat die gebruikersdokumentasie skryf en kan ook help om die produk self van `n konsep na sy finale vorm te neem. Die dinge wat in gedagte gehou moet word wanneer jy `n gebruikersprofiel vorm, is:

Die plek waar gebruikers die gebruikersgids sal gebruik, soos by die huis, in die kantoor, in `n afgeleë werkplek of in die motor. Dit kan bepaal, nie net die inhoud nie, maar ook die styl wat die gebruikershandleiding neem.
Die manier waarop gebruikers die gebruikersgids sal gebruik. As gebruikers die handleiding `n paar keer raadpleeg of net om inligting te soek, moet dit in die formaat van `n navraagstuk wees. As die gebruikers die handleiding gereeld raadpleeg, moet die konsultasie afdeling vergesel word van `n gedeelte met die titel "Hoe om te begin" en instruksies vir die eenvoudigste take waarvoor die produk gebruik gaan word.
Die ervaring wat gebruikers met die produk het of met ander soortgelyke produkte. As jou produk nuut of beduidend verskil van ander soortgelyke produkte, moet jy `n verduideliking van hoe dit verskil in vergelyking met ander produkte en ook instruksies oor hoe om dit te gebruik, insluit. As die produk verband hou met iets wat dikwels problematies vir gebruikers is, soos by baie rekenaarprogramme, moet u voldoende en gedetailleerde inligting op `n verstaanbare manier verskaf.

Prent getiteld Skep `n gebruikershandleiding Stap 2

Skryf om die gebruiker se behoeftes te help op `n manier wat hy kan verstaan. Tensy die gebruiker `n tegniese agtergrond het, kan dit beter wees om baie tegniese taal te vermy om duidelike en eenvoudiger verduidelikings te verkry. Die teks moet op `n soortgelyke manier georganiseer word. Dit is dikwels meer sin om die eienskappe van die produkte wat volgens hul funksies gegroepeer word, te lys as om net diegene wat die meeste gebruik word, aan te dui.

Soms is dit onvermydelik om tegniese terme te gebruik, soos vir `n rekenaarprogram wat ontwerp is om grafika te skep wat Fibonacci-grafika bevat, benewens die staaf- en sirkelkaarte wat meer algemeen voorkom. In daardie geval is dit nuttig om die term te definieer en basiese inligting daaroor te verskaf, soos om te verduidelik wat `n Fibonacci-grafiek is en waarvoor dit gebruik word in finansiële analise.

Prent getiteld Skep `n gebruikershandleiding Stap 3

Verduidelik die probleem wat die gebruiker probeer oplos en bied dan `n oplossing vir die probleem. Die aanbied van `n produk funksie as `n oplossing vir `n algemene probleem werk goed wanneer die produk bevorder word, maar sodra die gebruiker dit het, moet hy weet hoe om daardie funksie te gebruik. Identifiseer die spesifieke probleme wat die gebruiker sal ervaar, noem dit in die gebruikersgids en voeg dan die instruksies by om dit op te los.

As die probleem kompleks is, skei dit in kleiner dele. Lys elk van die dele met die instruksies om dit op te los of te hanteer en voeg dan elke opvolgende gedeelte agtereenvolgens by. Verdeel die inligting op hierdie manier heet `fragment`.

Deel 2
Komponente van die gebruikershandleiding

Prent getiteld Skep `n gebruikershandleiding Stap 4

Sluit die omslag en die toepaslike dek. U moet `n omslag insluit vir enige gebruikersgids wat groter as `n verwysingsblad is, asook `n omslag vir enige handleiding wat meer as die oppervlak van `n gevoude vel papier dek (4 of meer bladsye lank).

As die handleiding deur kopiereg beskerm word, moet `n kopieregkennisgewing op die voorblad en op die voorblad ingesluit word.
As daar voorwaardes en bepalings is om die handleiding en die produk wat daarmee gepaard gaan, te gebruik, plaas dit aan die binnekant van die omslag.

Prent getiteld Skep `n gebruikershandleiding Stap 5

Maak verwysings na die verwante dokumentasie in die voorwoord. As die gebruikersdokumentasie meer as `n enkele handleiding is, plaas die verwysings na die ander dokumente hier, met hul ooreenstemmende weergawe nommers. Die voorwoord is ook die plek waar jy moet plaas (indien enige) `n afdeling genaamd "Hoe om hierdie gids te gebruik".

Prent getiteld Skep `n gebruikershandleiding Stap 6

As die handleiding meer as 10 bladsye oorskry, bevat dit `n inhoudsindeks.

Prent getiteld Skep `n gebruikershandleiding Stap 7

Plaas die instruksies of prosedures en die verwysingsmateriaal in die handboek. In die meeste gevalle het die prosedures en verwysingsmateriaal hul eie afdelings, maar binne `n afdeling kan u die gebruiker opdrag gee om spesifieke inhoud van die ander te raadpleeg. Op hierdie manier kan die gebruiker die inligting wat hulle soek, vinniger vind.

Prosedures moet geskryf word met `n konsekwente struktuur dwarsdeur die instruksies gedeelte van die handleiding. Begin met `n opsomming van die taak, beskryf dan wat die gebruiker moet doen en watter resultate nagekom moet word. Die stappe moet genommer word en begin met verbale aksies op dieselfde manier as wat die stappe in elke afdeling van hierdie artikel geskryf word.

Die verwysingsmateriaal kan `n lys opsies, wenke vir die oplos van probleme en algemene vrae insluit. Woordelys en indekse kan by die einde van die handleiding gevoeg word, alhoewel `n lys van algemeen gebruikte terme aan die begin geplaas kan word. Die indeks kan weggelaat word as die handleiding minder as 20 bladsye bevat.

Prent getiteld Skep `n gebruikershandleiding Stap 8

Gebruik grafiese beelde om die teks op te slaan wanneer dit nodig is. Grafiese beelde of skermkiekies kan sommige punte in die handleiding beter as `n teks illustreer, veral as dit ingewikkelde prosedures behels waarin die gebruiker `n visuele bevestiging moet hê dat hulle die stappe korrek uitvoer. Grafiese beelde geskep kan word met behulp van programme rekenaargesteunde ontwerp (CAD, vir sy afkorting in Engels) of grafiese ontwerp programme, digitale kameras en redigering programme prente of, in die geval van screenshots, kan jy gebruik maak van die van die vangs wat in die rekenaar geïnstalleer word, of `n program van hantering van grafieke met `n funksie van die vaslegging van skerms.

Sodra jy `n grafiese beeld geskep het, stoor dit in `n formaat soos saamgepers as jou woordverwerker of met jou desktop publishing program kan jy dit gebruik. U moet ook die fisiese grootte van die prentjie verminder tot een wat makliker op die bladsy pas, terwyl u die nodige besonderhede vir die gebruiker verskaf (indien nodig, moet u die prent in dele skei om die relevante dele langs die teks wat hulle ondersteun) te vertoon. ).

As jy baie grafiese beelde in die prosedures gebruik, maak hulle `n konsekwente grootte, óf in dieselfde breedte- en hoogtemetings of in dieselfde verlagingsverhouding ten opsigte van die oorspronklike grootte. Dit sal die beelde aantrekliker maak vir die gebruiker. Net so, wanneer skermskote op `n rekenaar geneem word, maak seker dat die rekenaar dieselfde kleurskema vertoon wanneer beelde vasgelê word indien die gebruikershandleiding dit in kleure sal vertoon.

Alhoewel grafiese ontwerp programme soos Photoshop of Paint Shop Pro behoorlike skermvasvangingsfunksies bied, kan gespesialiseerde vangprogramme soos Snagit jou ook maklik verander, katalogiseer en kommentaar lewer op skermkiekies.

Deel 3
Ontwerp `n leesbare gebruikershandleiding

Prent getiteld Skep `n gebruikershandleiding Stap 9

Kies `n paar leesbare bronne. Alhoewel rekenaars toelaat dat baie verskillende bronne gebruik word, is die doel van `n gebruikershandleiding maklik leesbaar. Om dit te bereik, is dit die beste om `n klein aantal bronne wat goed saam lyk, te kies. Die bronne kan in twee groepe verdeel word: serif fonts en sans serif fonts

Die serif fonts het klein lyne van versiering aan die einde van die hooflyne wat die letter vorm. Sommige serif fonts is Times New Roman, Baskerville, en Book Antiqua. Serif lettertipes werk die beste op groot stukkies teks wat in die hoofliggaam van die gebruikershandleiding in `n grootte van 10 of 12 punte gedruk word.
Die sans serif fonts het slegs beroertes wat die letters vorm, sonder versierings. Enkele sans serif fonts is Arial, Calibri en Century Gothic. Sans serif lettertipes gebruik kan word in groot dele van die teks in groottes 8-10 punte in `n PDF of `n handleiding oor die Internet, hoewel die gebrek aan serifs maak geskryf in groottes van 12 punte of meer sinne is moeilik om te lees . Hulle kan egter effektief in groter groottes vir titels en opskrifte gebruik word, en hulle is ook baie goed vir kleiner groottes vir voetnotas en nommers in kolomme en tabelle.
Oor die algemeen, moet jy eenvoudig fonts soos Arial of Times New Roman kies vir jou handleiding, hoewel jy `n dekoratiewe fontein vir afgeleë kwotasies of titels kan kies as jy `n handleiding te skryf vir `n spel met `n fantasie-tema of wetenskap fiksie (In die geval van aanhalings in die kantlyn, kan jy dikwels van die eenvoudige bronne gebruik en die aanhaling in kursief aandui).
Sodra u die bronne gekies het wat u gaan gebruik, maak `n voorbeeld bladsy om te verifieer of die bronne goed op mekaar lyk. U moet hierdie voorbeeld ook wys aan die persoon wat die voorkoms van die handleiding moet goedkeur voordat u dit voortgaan.

Prent getiteld Skep `n gebruikershandleiding Stap 10

Dink goed oor die verspreiding. Sodra u die bronne van die gebruikershandleiding gekies het, moet u besluit waar u alles op die bladsye plaas.

Gewoonlik, dit is gerieflik om die handleiding titel of hoofstuk in die kop-of voet sit deur die plasing van die handleiding titel aan die linkerkant bladsy en die titel van die hoofstuk op die regte bladsy. Dit is ook gerieflik om die bladsynommer in die kop of in die voetstuk te plaas, aan die buitekant (van die koptekst of voete) of in die middel (slegs in die voetskrif). Dit is gerieflik om die eerste bladsy van elke afdeling of hoofstuk van die ander bladsye te onderskei deur jou bladsynommer in die middel van die voetskrif en op die volgende bladsye te plaas. Plaas dit in die buitenste hoek van die kop.

Dit is gerieflik om die teks van die verwysings van die beelde in kleure of in skaduwee bokse te plaas om dit van die res van die teks te skei. Maak seker dat jy `n kleur- of skadu-vlak kies wat jou toelaat om die teks maklik te lees.

Laat redelik wye marges aan die kante, met ekstra spasie op die rande waarop u al die bladsye gaan aansluit.

Prent getiteld Skep `n gebruikershandleiding Stap 11

Kies die tipe binding vir die gebruikershandleiding. As die gebruikershandleiding meer as 4 bladsye het, sal dit nodig wees om die bladsye op een of ander manier te koppel. Alhoewel dokumente vir interne gebruik aan die hoeke vasgekram kan word, kan gebruikershandleidings vir eksterne gebruik wat met `n produk afgelewer word, op een van die volgende 3 maniere gebind word:

Stapel aan die sye is geskik vir handleidings wat bestaan uit gevoude papiervelle van 21 x 27,5 cm (21 x 35 cm) of 27,5 x 42, 5 cm (11 x 17 duim). Die meeste goedkoop handleidings van 48 bladsye of minder is so gebind.

Dit is meer algemeen om perdry te gebruik vir verwysingsgidse vir derde partye as vir gebruikershandleidings wat met ander produkte as motors afgelewer word, alhoewel sommige gebruikersgidse op hierdie manier gebind word (aanvanklik wanneer JASC-sagteware het die Paint Shop Pro vervaardig, gebonde gebruikershandleidings afgelewer deur te perd te stiksels).

Spiraalbinding is die beste geskik vir gebruikersgidse wat ontwerp is vir meer vyandige omgewings soos buite, waar handboeke wat vasgemaak word met krammetjies of na perde toegewerk word, ontwapen word. Sommige spiraalgebonde handleidings kan ook gelamineerde bladsye hê om die handleiding te verwoes as dit nat of vuil word.

Prent getiteld Skep `n gebruikershandleiding Stap 12

Ontwerp `n dokument sjabloon vir jou gebruikershandleiding. Baie woordverwerkers en desktop publishing programme bied die moontlikheid van die skep van dokument templates vir handleidings, so as jy tik, is die teks outomaties vertoon op die bron wat jy gekies het vir die deel van die handleiding waarin jy besig (Trouens, hierdie artikel is aanvanklik geskryf met behulp van `n Microsoft Word-sjabloon). Die meeste van hierdie programme bevat ook `n stel vooraf gedefinieerde templates wat u kan verander soos benodig, in plaas daarvan om die sjabloon van die begin af te skep.

Teksverwerkers en programme vir desktopuitgewers bied ook die moontlikheid om "style" te skep, wat vooraf gedefinieerde skriftipes en -groottes is vir titels, voetnote, koptekste en die inhoud van die teks. U kan een van die vooraf gedefinieerde style name kies (byvoorbeeld, "Header1", "Normal", "Appointment") of skep u eie styl met u eie naam. As jy baie style vir dieselfde teks tipe het, volg die konvensies vir stylname so veel as moontlik (byvoorbeeld, Microsoft Word noem teksstyle vir titels soos "Title1", "Title2", ens.), vir alle titels van die hoof na verskeie onderskrifvlakke). Probeer vooraf al die style wat jy nodig het, te skep, dus jy hoef nie op te hou om dit te skep terwyl jy die handleiding werklik skryf nie.

wenke

Gebruik veldkodes of teksveranderlikes indien moontlik. U kan waardes, soos die naam van die produk, die handleiding of die titel van die hoofstuk toewys, en gebruik dit in die dokument in plaas van die werklike teks te skryf. Wanneer u die handleiding voorskou of druk, sal die teks in plaas van die veranderlike verskyn. As die produk se naam verander, of as jy die naam van die boek of hoofstuk te verander, sal dit makliker wees om die inligting te verander deur die verandering van die waarde van die veranderlike teks soek en vervang woorde in die dokument.