Skep `n handleiding

Gebruikershandleidings is papier- of elektroniese dokumente (pdf of XPS) met instruksies om iets te doen of te gebruik. Alhoewel gebruikersgidse vinnig aan handleidings vir sagteware dink, word hulle ook gereeld voorsien van rekenaars en ander elektroniese toestelle soos televisies, stereo, telefoonstelsels en MP3-spelers, sowel as huishoudelike toestelle en tuin toerusting. Goeie gebruikershandleidings informeer gebruikers oor die funksies van `n produk en die effektiewe gebruik van daardie funksies, en is so georganiseer dat dit maklik leesbaar is en geraadpleeg kan word. Die volgende is `n paar dinge wat jy moet oorweeg wanneer jy effektiewe inhoud skep en ontwerp om die uitleg van `n gebruikershandleiding te ontwerp.

conținut

Stappe
Deel 1die skep van nuttige gebruikersdokumentasie
Deel 2dele van `n gebruikershandleiding
Deel 3ontwerp `n leesbare gebruikershandleiding
Wenke
Voorrade

stappe

Deel 1
Die skep van nuttige gebruikersdokumentasie

Prent getiteld Skep `n gebruikershandleiding Stap 1

Definieer die gebruiker. Om `n suksesvolle gebruikershandleiding te skryf, moet u `n profiel van u gebruiker ontwikkel, hetsy formeel, deur `n geskrewe profiel of informeel te skep deur tyd te neem vir redelike aannames oor die eienskappe van u gebruiker. So `n profiel is nuttig as jy deel is van `n span vir die skryf van die gebruikersdokumentasie, en dit kan ook nuttig wees om die produk van konsep tot die finale vorm te ontwikkel. Dinge om na te dink wanneer u `n gebruikersprofiel ontwikkel, sluit in:

Waar die gebruiker die handleiding sal gebruik, soos by die huis, by die kantoor, op `n afgeleë gebou of in die motor. Dit kan nie net die inhoud bepaal nie, maar ook die styl van die gebruikershandleiding.
Hoe gebruikers die handleiding gaan gebruik. As die handleiding slegs selde geraadpleeg word of slegs bedoel is om inligting te soek, moet dit hoofsaaklik in die vorm van `n verwysingsdokument wees. As dit iets is wat gebruikers in die begin dikwels sal raadpleeg, moet die verwysingsafdeling vergesel word van a "Aan die begin"afdeling en instruksies oor die mees algemene take waarvoor die produk gebruik gaan word.
Hoeveel gebruikers het ervaring met die produk of wat ander daarvan hou. As jou produk nuut of baie anders is as soortgelyke produkte, moet jy `n verduideliking in hoeverre dit verskil van ander produkte asook instruksies oor hoe om te begin. As die produk funksies het wat ander gebruikers dikwels probleme ondervind, soos verskeie rekenaartoepassings, moet u toepaslike inligting en besonderhede op `n verstaanbare manier verskaf.

Prent getiteld Skep `n gebruikershandleiding Stap 2

Wanneer jy skryf, fokus op die behoeftes van die gebruiker op `n manier wat die gebruiker kan verstaan. Tensy die gebruiker `n tegniese agtergrond het, is dit waarskynlik die beste om baie tegniese taal te vermy en om `n duidelike, eenvoudige verduideliking te kies. Die teks moet ook georganiseer word op `n manier wat die gebruiker se denkwyse naboots. Om `n lys van produkfunksies wat deur funksie gegroepeer is, is dikwels nuttiger as om die mees algemene funksies te gebruik.

Soms sal jy nie wegkom van die gebruik van tegniese terme, soos vir `n grafiese genereer sagteware toepassing met Fibonacci grafieke en die meer algemene pie en staafgrafieke. In so `n geval is dit nuttig om die term te definieer en agtergrondinligting te verskaf, soos `n verduideliking van wat Fibonacci-grafieke is en hul gebruik in finansiële analise.

Prent getiteld Skep `n gebruikershandleiding Stap 3

Verduidelik die probleem wat die gebruiker probeer oplos, en bied dan die oplossing voor. Die aanbied van `n funksie as `n oplossing vir `n algemene probleem werk goed met `n kommersiële produk, maar sodra die gebruiker die produk het, wil hy uitvind hoe om dit te gebruik. Identifiseer spesifieke probleme wat die gebruiker mag ondervind, dui dit aan in die gebruikershandleiding en volg instruksies om dit op te los.

As die probleem kompleks is, verdeel dit in klein stukkies. Maak `n lys van elke deel met instruksies om dit op te los of hoe om dit te hanteer en behandel dit opeenvolgend. Splitting inligting op hierdie manier heet `chunking`.

Deel 2
Dele van `n gebruikershandleiding

Prent getiteld Skep `n gebruikershandleiding Stap 4

Voeg gepaste voor- en titelbladsye by. Jy benodig `n voorblad vir elke handleiding wat meer as `n verwysingskaart bevat, en `n titelblad vir `n handleiding met meer inligting as `n gevoude vel papier (vier of meer bladsye).

As die handleiding deur kopiereg beskerm word, plaas jy `n kopieregkennisgewing op beide die voorblad en op die titelblad.
As die voorwaardes vir die gebruik van die handleiding en die ooreenstemmende produk aangeheg is, plaas dit aan die binnekant van die voorblad.

Prent getiteld Skep `n gebruikershandleiding Stap 5

Plaas verwysings na verwante dokumente in die voorwoord. As die gebruikersdokumentasie uit meer as een handleiding bestaan, verwys u na die ander dokumente hier, met die korrekte weergawe nommers. Die voorwoord is ook die plek waar `n moontlike gedeelte "Hoe om hierdie gids te gebruik" kom.

Prent getiteld Skep `n gebruikershandleiding Stap 6

Voeg `n inhoudsopgawe by indien die handleiding meer as 10 bladsye dek.

Prent getiteld Skep `n gebruikershandleiding Stap 7

Plaas die instruksies / prosedures en die verwysingsmateriaal in die kern van die handleiding. In die meeste gevalle het alle prosedures en verwysingsmateriaal elk hul eie afdelings, maar u kan die gebruiker na spesifieke inhoud van een afdeling na `n ander verwys. Op hierdie manier kan die gebruiker die inligting vind wat hy vinniger vind.

Prosedures moet in `n konsekwente struktuur in die instruksies van die handleiding geskryf word. Begin met `n oorsig van die taak, beskryf dan wat die gebruiker moet doen en wat hy of sy as gevolg daarvan moet waarneem. Stappe moet genommer en ingevoer word met aksiewoorde, soos die stappe in elke afdeling van hierdie artikel geskryf word.

Verwysingsmateriale kan lyste van opsies, wenke, oplossings en algemene vrae bevat. Woordelys en indekse kan aan die einde van die handleiding ingesluit word, hoewel `n lys van algemeen gebruikte terme aan die voorkant vertoon kan word. Die indeks kan weggelaat word as die handleiding minder as 20 bladsye bevat.

Prent getiteld Skep `n gebruikershandleiding Stap 8

Gebruik indien nodig beelde om die teks te ondersteun. Grafiese beelde of skermskote kan sekere punte in die handleiding beter illustreer as teks, veral in komplekse prosedures waar die gebruiker `n visuele bevestiging benodig dat die stappe korrek uitgevoer is. Grafiese beelde kan geproduseer word met behulp van ontwerp sagteware of grafiese sagteware, digitale kameras en foto redigering sagteware, of in die geval van skermkiekies, aangeteken met die skerm opname vermoë van jou rekenaar of `n grafiese program.

Sodra jy `n grafiese beeld geskep het, kan jy dit stoor in `n saamgeperste formaat wat geskik is vir jou woordverwerkingsprogram of DTP-program. U sal ook die fisiese grootte van die prentjie wil verminder sodat dit op die bladsy pas, sonder om besonderhede te offer. (Indien nodig, kan jy die oorspronklike prent in stukke verdeel en die relevante dele, saam met die ondersteunende teks, vertoon.)

As jy meer grafiese beelde in prosedures gebruik, gee hulle `n konsekwente formaat, met dieselfde dimensies vir lengte en breedte, of verminder op dieselfde manier. Dit sal die beelde aantrekliker maak vir die gebruiker. As jy skermkiekies maak, moet jy ook seker maak dat die rekenaar `n standaard kleurskema gebruik wanneer beelde vasgelê word, as die gebruikershandleiding skermkiekies in kleur vertoon.

Alhoewel grafiese bewerkingsprogramme soos Photoshop en Paint Shop Pro die moontlikheid bied om `n skermkiekie te neem, met spesifieke programme, soos SnagIt, kan u maklik verander, katalogiseer en onderskrifte verskaf.

Deel 3
Ontwerp `n leesbare gebruikershandleiding

Prent getiteld Skep `n gebruikershandleiding Stap 9

Kies `n paar leesbare lettertipes. Alhoewel rekenaars `n aantal verskillende lettertipes kan ondersteun, is die doel van `n gebruikersgids maklik om te lees. Om net `n klein aantal lettertipes te kies wat goed bymekaar pas, is die beste manier om hierdie doel te bereik. Fonte kan in twee soorte verdeel word: briewe briewe (serif) en sanserif letters (sans serif).

Geskrewe lettertipes beskik oor klein versierings aan die punte van die hooflyne wat die letter vorm. Serif lettertipes bevat lettertipes soos Times New Roman, Baskerville en Book Antiqua. Serif lettertipes is geskik vir groot stukkies teks in `n lettergrootte van 10 tot 12 in die hoofliggaam van `n gedrukte handleiding.
Sans serif fonts verteenwoordig slegs die lyne wat die letters vorm, sonder versiering. Sanserif lettertipes sluit in lettertipes soos Arial, Calibri en Century Gothic. Sanserif lettertipes kan gebruik word vir groot stukke teks in groottes van 8 tot 10 punte in `n PDF of aanlyn handleiding, hoewel die gebrek aan skriftelike frases wat 12 punte of groter vertoon word, dit moeiliker maak om te lees. Hulle kan egter in groter formaat effektief wees om titels en koptekste te vertoon, en hulle is ook groot in kleiner groottes vir voetnote en nommers in die kolomme en tabelle.
Gebruik algemeen algemene lettertipes soos Arial of Times New Roman vir jou gebruikershandleiding, alhoewel jy `n dekoratiewe font vir belangrike aanhalings of titels kan gebruik wanneer jy `n handleiding vir `n fantasie- of sf-speletjie skryf. (In die geval van aanhangerstekens, kan jy dikwels een van die duidelike lettertipes gebruik en die opvanger kwotasie kursiveer.)
Sodra u sekere lettertipes gekies het wat u wil gebruik, kan u `n voorbeeld bladsy op papier skep om te kontroleer of die lettertipes goed bymekaar pas. U sal ook hierdie voorbeeld wil wys aan die persoon wat die handleiding moet goedkeur voordat u dit verder skryf.

Prent getiteld Skep `n gebruikershandleiding Stap 10

Gee aandag aan die uitleg. Sodra u die fonts van die handleiding gekies het, moet u besluit waar alles op die bladsye sal verskyn.

Oor die algemeen plaas jy die titel of hoofstuk titel in die koptekst of voetskrif, moontlik met die titel op die linkerkant en die hoofstuk titel op die regte bladsy. Plaas ook bladsy nommers in die koptekst of voettekst, óf teen die grens (koptekst of voettekst) of in die middel (slegs in die voettekst). U kan elke eerste bladsy van `n afdeling of hoofstuk van die ander bladsye afwyk deur die ooreenstemmende bladsynommer onderaan die bladsy en die ander bladsye bo-aan die hoek van die bladsy te plaas.

U kan verduidelikende teks in gekleurde of skadu-blokkies aandui om hulle van die res van die teks te onderskei. Kies `n kleur of vlak van skaduwee sonder die degraderende leesbaarheid.

Kies redelik ruim marges aan alle kante, met ekstra spasie by die rande wat saam vasgemaak sal word.

Prent getiteld Skep `n gebruikershandleiding Stap 11

Dink aan die tipe binding vir die gebruikershandleiding. As u gebruikershandleiding meer as 4 bladsye dek, moet die bladsye op `n sekere manier vasgebind word. Alhoewel `n stapelvoedsel in die hoek moontlik is vir interne dokumente, word eksterne gebruikershandleidings wat saam met `n produk kom, gewoonlik op 3 maniere gebind:

Stapel is geskik vir handleidings wat bestaan uit voue velle papier: 21 x 27.5 cm, 21 x 35 cm of 27.5 x 42.5 cm. Die goedkoop vervaardigde handleidings van 48 bladsye of minder word op hierdie manier saamgevoeg.

Die saalsnag word meer algemeen gebruik vir verwysingsgidse van derde party as vir gebruikershandleidings wat met ander produkte as motors voorsien word. Alhoewel meer uitgebreide gebruikershandleidings op hierdie manier gebind word, word dit gebruik. (Paint Shop Pro is oorspronklik afgelewer met `n saalstaafgebonde gebruikershandleiding wanneer dit nog deur JASC Software uitgereik is.)

Spiraalbinding is geskik vir die gebruikershandleidings wat ontwerp is om in meer moeilike omgewings gebruik te word, soos buitelug, waar gekapte of saalstewige handleidings uitmekaar val. Sommige spiraalgebonde handleidings het gelamineerde bladsye om te verhoed dat hulle misluk as die handleiding nat of modderig word.

Prent getiteld Skep `n gebruikershandleiding Stap 12

Skep `n sjabloon dokument vir jou handleiding. Baie woordverwerkings- en dtp-programme laat jou toe om `n sjabloon dokument vir jou gebruikersgids te skep, sodat die teks outomaties verskyn in die skrif wat jy gekies het vir die deel van die handleiding waaraan jy werk. (In werklikheid was dit artikel in die eerste instansie geskryf met behulp van `n Microsoft Word-sjabloon.) Die meeste van hierdie program bevat ook `n Versameling vooraf gedefinieerde templates wat jy aan jou behoeftes kan aanpas, in plaas van die sjabloon van die grond af op om te bou.

Woordverwerkers en lessenaaruitgeweringsprogramme bied ook die vermoë om style, vooraf gedefinieerde lettertipes en groottes vir koptekste, voetnote, opskrifte en gewone teks te skep. U kan een van die name van vooraf gedefinieerde style kies (byvoorbeeld `Kop1,` `Normale`, `Kwotasie`), of skep u eie styl met u eie naam. Probeer om die konvensies van bestaande stylname so veel as moontlik te volg as jy verskeie style vir dieselfde teksklas gebruik. (Byvoorbeeld Microsoft Word labelt teksstyl vir koppe as `Kop1,` `Kop2,` ens, van die belangrikste kop tot die verskillende vlakke van subkoppen.) Probeer alle style vooraf te maak, sodat jy die skryfproses nie hoef te onderbreek om hulle dan nog te maak.

wenke

Gebruik veldkodes of teksveranderlikes waar moontlik. U kan die waarde van die veldkodes, soos die naam van `n produk, die handleiding of die titel van `n hoofstuk, toewys, en plaas dit in u dokument, in plaas van die teks wat genoem word. Wanneer u die handleiding voorskou of die handleiding druk, word die veranderlike vervang deur die teks. As die naam van die produk verander of as jy die naam van die handleiding of `n hoofstuk verander, is dit makliker om die inligting te verander deur die waarde van die teksveranderlike aan te pas, dan deur te soek en te vervang.