Navodila za uporabo so priročnik v papirni ali elektronski obliki (PDF ali XPS), ki vsebuje navodila o postopku ali uporabi nečesa. Čeprav so "priročniki za uporabo" pogosto povezani z vodniki po računalniških aplikacijah, so uporabniški priročniki opremljeni tudi z računalniki in drugimi elektronskimi napravami, kot so televizorji, stereo, telefonski sistemi, MP3 predvajalniki ter gospodinjska in vrtna oprema. Dober priročnik za uporabnike izobražuje uporabnike o značilnostih izdelka in jih nauči, kako učinkovito uporabljati te funkcije. Navodila za uporabo so sestavljena tako, da jih je enostavno brati in se nanje sklicevati. Tukaj je nekaj korakov, ki jih morate upoštevati pri razvoju učinkovite vsebine in oblikovanju postavitev vodnikov.
Korak
1. del od 3: Ustvarjanje ustreznega uporabniškega priročnika
Korak 1. Odločite se, kdo bo uporabil vodnik
Če želite napisati dober uporabniški priročnik, morate razviti uporabniški profil, bodisi formalno z ustvarjanjem pisnega profila ali neformalno, tako da si vzamete čas za razumne predpostavke o značilnostih uporabnikov. Takšni profili so uporabni, če ste del skupine za pisanje navodil za uporabo in ko delate na predvidenem izdelku od ideje do končne oblike. Pri ustvarjanju uporabniškega profila upoštevajte naslednje dejavnike:
- Lokacija uporabnika bo uporabila vodnik, na primer doma, v pisarni, na oddaljenem delovnem mestu ali v avtu. Ta dejavnik ne določa le vsebine, ampak tudi slog pisanja, ki ga bo vodnik prevzel.
- Kako bo uporabnik uporabil priročnik. Če ga le redko uporabljajo ali ga potrebujejo le za iskanje informacij, je najbolje, da je vodnik v obliki referenčnega dokumenta. Po drugi strani pa, če ga bo uporabnik na začetku redno uporabljal, mora referenčni razdelek spremljati razdelek »Kako začeti« in navodila o najpogostejših funkcijah, ki jih bo izdelek opravljal.
- Koliko izkušenj ima uporabnik z izdelkom ali podobnim izdelkom. Če je izdelek nov ali se zelo razlikuje od podobnih izdelkov, morate priložiti razlago, kako se razlikuje od drugih, in navodila za uporabo. Če izdelek obravnava nekaj, kar uporabnikom pogosto predstavlja težave, na primer računalniško aplikacijo, morate na razumljiv način posredovati ustrezne informacije in podrobnosti.
Korak 2. Ustvarite vodnik, ki ustreza potrebam uporabnika na način, ki ga razumejo
Če uporabniki niso tehnično podkovani ljudje, se je verjetno najbolje izogniti zelo tehničnemu jeziku in ponuditi jasne in preproste razlage. Besedilo mora biti tudi organizirano tako, da je podobno načinu razmišljanja uporabnika. Naštevanje funkcij izdelka, razvrščenih po funkcijah, je pogosto bolj smiselno kot pri najpogosteje uporabljenih funkcijah.
Včasih je uporaba tehničnih izrazov neizogibna, na primer za aplikacije za grafikone, ki vključujejo Fibonaccijeve grafikone skupaj s tortnimi in pogostejšimi stolpčnimi grafikoni. V takem primeru bi bilo bolje, če bi opredelili izraze in podali informacije, na primer razlago, kaj je Fibonaccijeva lestvica in kako se uporablja pri finančni analizi
Korak 3. Opišite težavo, ki jo poskuša rešiti uporabnik, nato pa podajte rešitev za to težavo
Ponudba funkcij kot rešitev za pogoste težave je v redu pri oglaševanju izdelka, toda ko je kupec lastnik izdelka, mora razumeti, kako ga uporabljati. Opredelite težavo, s katero se bo uporabnik srečal, jo opišite v uporabniškem priročniku in sledite navodilom za njeno odpravo.
Če je težava zapletena, jo razdelite na manjše koščke. Zapišite vsak razdelek z navodili, kako ga rešiti ali se z njim spopasti, nato pa sledite drug drugemu po vrsti. Razčlenjevanje informacij na ta način je znano kot metoda združevanja ali razdelitve
2. del od 3: Komponente priročnika za uporabo
Korak 1. Ustvarite ustrezno naslovnico in naslovno stran
Potrebovali boste naslovnico za vsak uporabniški priročnik, ki je več kot referenčna kartica, in naslovno stran za vodnik, ki vsebuje več kot zložen list papirja (dolžine 4 strani ali več).
- Če je vodnik zaščiten z avtorskimi pravicami, mora biti obvestilo o avtorskih pravicah vključeno na sprednjo in zadnjo platnico, pa tudi na naslovno stran.
- Če obstajajo določila in pogoji za uporabo priročnika in z njim povezanih izdelkov, jih vključite na notranjo stran sprednje platnice.
Korak 2. V uvodu se sklicujte na sorodni dokument
Če obstaja več navodil za uporabo, se tukaj sklicujte na drug dokument, vključno s pravilno številko različice. Predgovor je tudi kraj za razdelek »Kako uporabljati ta priročnik«, če obstaja.
Korak 3. Vključite kazalo, če je vodnik daljši od 10 strani
Korak 4. Na telo navodil položite navodila/postopke in referenčne materiale
V večini primerov morata imeti tako postopek kot referenčni material vsak svoj razdelek. Uporabnikom pa lahko poveste, naj se v enem razdelku sklicujejo na določeno vsebino in jo razlikujejo od drugih razdelkov. Na ta način lahko uporabnik hitro najde informacije, ki jih išče.
- Postopki morajo biti zapisani v dosledni strukturi skozi vsa navodila v priročniku. Začnite s pregledom funkcionalnosti izdelka, nato razložite, kaj mora uporabnik narediti in kakšne rezultate bo dobil ali videl. Korake je treba oštevilčiti in začeti z glagolom dejanja, tako kot so koraki zapisani v vsakem razdelku tega članka.
- Referenčno gradivo lahko vključuje kontrolne sezname, nasvete za odpravljanje težav in pogosta vprašanja. Na koncu vodnika je mogoče dodati slovarček in kazalo, čeprav je na začetku lahko naveden slovar pogosto uporabljanih izrazov. Kazala lahko izpustite, če ima vodnik manj kot 20 strani.
Korak 5. Uporabite grafične slike za podporo besedila
Grafične slike ali posnetki zaslona lahko bolje prikažejo določene točke v priročniku kot besedilo, zlasti v zapletenih postopkih, kjer uporabniki potrebujejo vizualno potrditev, da se prepričajo, da pravilno sledijo korakom. Grafične risbe lahko ustvarite z uporabo računalniško podprtega pripravljanja (CAD) ali aplikacij za urejanje grafik, digitalnih fotoaparatov in aplikacij za obdelavo fotografij, ali če želite uporabiti posnetke zaslona, uporabite funkcije posnetkov zaslona, vgrajene v vaš računalnik, ali grafični program z možnostmi zajema zaslona.
- Ko ustvarite grafično sliko, jo shranite v stisnjeni obliki, da jo boste lahko uporabili v programu za urejanje besedil ali namiznem založništvu. Prav tako morate zmanjšati velikost slike, da se bolje prilega strani, vendar uporabniku vseeno zagotovite popolne podrobnosti. (Po potrebi lahko izvirno sliko obrežete na odseke in prikažete ustrezne razdelke skupaj s podpornim besedilom).
- Če v postopku uporabljate več grafičnih slik, poskrbite, da bodo slike ustvarjene v konsistentni velikosti, bodisi v enakih dimenzijah po dolžini in širini ali v sorazmerju z velikostjo izvirne slike. Tako bo slika videti privlačnejša za uporabnike. Enako velja pri posnetkih zaslona iz računalnika; poskrbite, da bo računalnik med fotografiranjem prikazal standardno barvno shemo, sicer bo čarovnik prikazal barvni posnetek zaslona.
- Medtem ko imajo aplikacije za urejanje slik, kot sta Photoshop in Paint Shop Pro, dobre zmogljivosti zajemanja slik, programi, namenjeni snemanju zaslona, kot je Snagit, ponujajo tudi možnost enostavnega spreminjanja, katalogiziranja in označevanja posnetkov zaslona.
3. del od 3: Oblikovanje uporabniškega priročnika, ki je enostaven za uporabo
Korak 1. Izberite nekaj enostavno berljivih pisav
Čeprav lahko računalnik podpira številne pisave, je namen ustvarjanja uporabniškega priročnika enostaven za branje. Izbira več ujemajočih se pisav je najboljši način za dosego tega cilja. Pisave lahko združimo v dve vrsti: serijske in brez serifne.
- Krsne pisave imajo majhne okrasne črte na koncih glavnih vrstic, ki sestavljajo črke. Zrnate pisave vključujejo Times New Roman, Baskerville in Book Antiqua. Pisave s črkami so kot nalašč za večino besedil, prikazanih v velikostih 10-12 v glavnem delu za vodnike za tiskanje.
- Pisave brez serifov vsebujejo samo črte, ki sestavljajo črke, brez okraskov. Pisave, ki pripadajo skupini brez serifov, vključujejo Arial, Calibri in Century Gothic. Pisave brez serifov se lahko uporabljajo za večino velikosti besedila od 8 do 10 v datotekah PDF ali spletnih vodnikih, čeprav so brez okraskov težje berljivi stavki, prikazani v pisavah 12 ali več. Pisave pa je mogoče učinkovito uporabiti v večjih velikostih za prikaz naslovov in naslovov, v manjših velikostih pa so kot nalašč za opombe in številke v stolpcih in tabelah.
- Na splošno je najbolje, da za vodnik izberete preprosto pisavo, kot sta Arial ali Times New Roman, čeprav lahko za citate ali naslove uporabite dekorativno pisavo, če pišete vodnik za videoigre, nastavljene v fantazijski ali znanstvenofantastični nastavitvi.. (V primeru navedb lahko pogosto uporabite preprosto pisavo in celoten citat prikažete v poševni pisavi).
- Ko se odločite, katere pisave boste uporabili, ustvarite vzorčne strani, da preverite, ali so videti dobro na papirju. Preden nadaljujete s postopkom pisanja, morate to vzorčno stran pokazati tudi osebi, odgovorni za odobritev prikaza vodnika.
Korak 2. Razmislite o postavitvi
Ko izberete pisavo za vodnik, se boste morali odločiti, kako strukturirati vsebino na vrhu strani.
- Na splošno bi morali naslov dokumenta ali naslov poglavja postaviti v glavo ali nogo, po možnosti z naslovi vodnikov na levi strani in naslovi poglavij na desni strani. Številko strani morate postaviti v glavo ali nogo, bodisi zunaj (glava ali noga) ali na sredino (samo v nogi). Morda boste morali razlikovati tudi prvo stran vsakega razdelka ali poglavja od drugih strani, tako da številko strani postavite na sredino noge in naslednjo stran v zunanji kot glave.
- Za razlikovanje od preostalega besedila boste morda morali vstaviti besedilo v barvno polje ali polje. Izberite barvo ali raven blokiranja, da besedilo ne bo oteženo pri branju.
- Na vseh straneh pustite dokaj širok rob, na robovih pa je treba vezati dodaten prostor.
Korak 3. Upoštevajte vrsto nosilca za uporabniški priročnik
Če je vodnik daljši od 4 strani, morajo biti strani vezane na določen način. Čeprav so notranji dokumenti speti s spenjalnikom v kotu strani, je zunanji priročnik za uporabo, ki je priložen izdelku, običajno spet na enega od naslednjih 3 načinov:
- Metoda stranskega spenjanja (pritrjena na stranice strani s spenjalnikom) za vodila, natisnjena na zloženem papirju velikosti 21 x 27,5 cm, 21 x 35 cm ali 27,5 x 42,5 cm. Večina poceni vodnikov s 48 stranmi ali manj je vezanih na ta način.
- Metoda šivanja sedla (prišita na stran strani) se pogosteje uporablja za referenčne vodnike tretjih oseb kot vodila, ki so priložena izdelkom, razen avtomobilom, čeprav so na ta način vezani nekateri daljši vodili. (Vodnik Paint Shop Pro je prvotno vseboval vodnik za šivanje sedla, medtem ko ga je še proizvajala programska oprema JASC).
- Spiralna vezava je najbolj primerna za vodila, ki se uporabljajo v težjih okoljih, na primer na prostem (v tem primeru metode stranskega spenjanja in šivanja sedla niso dovolj močne, da bi zdrsnile strani). Nekatera vodila s spiralno vezavo imajo lahko tudi stranice, laminirane s plastiko, da se preprečijo, da bi se poškodovale, ko so mokre ali izpostavljene blatu.
Korak 4. Ustvarite predlogo dokumenta za vodenje
Številne aplikacije za obdelavo besedil in namizno založništvo ponujajo možnost ustvarjanja dokumentov s predlogami za uporabniške vodnike. Tako se bo med tipkanjem samodejno pojavilo besedilo s pisavo, ki ste jo izbrali za del čarovnika, na katerem delate. (Pravzaprav je bil ta članek prvotno napisan s predlogo Microsoft Word). Večina teh programov vključuje tudi standardni nabor predlog, ki jih lahko po potrebi spremenite, tako da vam ni treba ustvarjati lastnih iz nič.
