Korisnički priručnik je priručnik u papirnatom ili elektroničkom obliku (PDF ili XPS) koji daje upute o proceduri ili upotrebi nečega. Iako su "korisnički priručnici" često povezani s vodičima za računalne aplikacije, korisnički vodiči također su opremljeni računarima i drugim elektroničkim uređajima kao što su televizori, stereo uređaji, telefonski sistemi, MP3 uređaji za reprodukciju i kućna i vrtna oprema. Dobar korisnički vodič educira korisnike o karakteristikama proizvoda i uči ih kako učinkovito koristiti te funkcije. Korisnički priručnik je strukturiran na takav način da je jednostavan za čitanje i upućivanje. Evo nekoliko koraka koje morate uzeti u obzir pri razvoju efikasnog sadržaja i dizajniranju izgleda korisničkog vodiča.
Korak
1. dio od 3: Kreiranje odgovarajućeg korisničkog vodiča
Korak 1. Odlučite ko će koristiti vodič
Da biste napisali dobar korisnički vodič, morate razviti korisnički profil, bilo formalno stvaranjem pisanog profila ili neformalno, odvajajući vrijeme za razumne pretpostavke o karakteristikama korisnika. Takvi su profili korisni ako ste dio tima za pisanje vodiča za korisnike i kada radite na željenom proizvodu od koncepta do konačnog oblika. Prilikom stvaranja korisničkog profila uzmite u obzir sljedeće faktore:
- Lokacija korisnika će se koristiti vodičem, na primjer kod kuće, u uredu, na udaljenom radnom mjestu ili u automobilu. Ovaj faktor ne određuje samo sadržaj, već i stil pisanja koji će vodič usvojiti.
- Kako će korisnik koristiti vodič. Ako ga rijetko koriste ili im je potreban samo za pronalaženje informacija, najbolje je da vodič bude u obliku referentnog dokumenta. S druge strane, ako će ga korisnik u početku redovito koristiti, referentni odjeljak trebao bi biti popraćen odjeljkom “Kako započeti” i uputama o najčešćim funkcijama koje će proizvod obavljati.
- Koliko iskustva korisnik ima s proizvodom ili sličnom stavkom. Ako je proizvod nov ili se jako razlikuje od sličnih proizvoda, morate priložiti objašnjenje po čemu se razlikuje od drugih i upute o tome kako ga koristiti. Ako se proizvod bavi nečim što korisnicima često otežava, poput računalne aplikacije, morate na razumljiv način pružiti odgovarajuće informacije i detalje.
Korak 2. Kreirajte vodič koji odgovara potrebama korisnika na način koji oni razumiju
Ako korisnici nisu tehnički potkovani ljudi, vjerojatno je najbolje izbjegavati izrazito tehnički jezik i ponuditi jasna i jednostavna objašnjenja. Tekst bi također trebao biti organiziran na način koji liči na način na koji korisnik misli. Navođenje karakteristika proizvoda grupiranih prema funkcijama često ima više smisla nego prema karakteristikama koje se najčešće koriste.
Ponekad je korištenje tehničkih izraza neizbježno, na primjer za aplikacije grafikona koje uključuju Fibonačijeve grafikone zajedno sa tortnim grafikonima i uobičajenije trakaste grafikone. U ovakvom slučaju bilo bi bolje da definirate pojmove i pružite informacije, na primjer objašnjenje o tome šta je Fibonačijev grafikon i kako se koristi u finansijskim analizama
Korak 3. Opišite problem koji korisnik pokušava riješiti, a zatim ponudite rješenje za taj problem
Ponuda značajki kao rješenja uobičajenih problema u redu je pri oglašavanju proizvoda, ali jednom kada kupac posjeduje proizvod, mora razumjeti kako ga koristiti. Identificirajte problem s kojim će se korisnik susresti, opišite ga u korisničkom priručniku, nakon čega slijede upute za njegovo rješavanje.
Ako je problem složen, podijelite ga na manje komade. Zapišite svaki odjeljak s uputama kako to riješiti ili se nositi s njim, a zatim slijedite jedno drugo redom. Razbijanje informacija na ovaj način poznato je kao metoda grupiranja ili razdvajanja
Dio 2 od 3: Komponente vodiča za korisnike
Korak 1. Kreirajte odgovarajuću naslovnicu i naslovnu stranicu
Trebat će vam naslovnica za bilo koji korisnički vodič koji nije samo referentna kartica i naslovna stranica za vodič koji sadrži više od presavijenog lista papira (dužine 4 stranice ili više).
- Ako je vodič zaštićen autorskim pravima, napomena o autorskim pravima mora biti navedena na prednjoj i zadnjoj korici, kao i na naslovnoj stranici.
- Ako postoje uvjeti i odredbe za korištenje vodiča i proizvoda koji su s njim povezani, molimo vas da ih uvrstite na unutarnju stranu prednje korice.
Korak 2. Stavite referencu na srodni dokument u uvodu
Ako postoji više od jednog vodiča za korisnike, ovdje se pozivajte na drugi dokument, uključujući točan broj verzije. Predgovor je također mjesto za postavljanje odjeljka “Kako koristiti ovaj vodič” ako ga ima.
Korak 3. Uključite sadržaj ako je vodič duži od 10 stranica
Korak 4. Postavite upute/postupke i referentne materijale na tijelo vodiča
U većini slučajeva, i postupak i referentni materijal trebali bi imati svaki svoj odjeljak. Međutim, možete reći korisnicima da se u jednom odjeljku pozivaju na određeni sadržaj i razlikuju ga od ostalih odjeljaka. Na ovaj način korisnik može brzo pronaći informacije koje traži.
- Postupci bi trebali biti napisani u konzistentnoj strukturi kroz upute u priručniku. Počnite s pregledom funkcionalnosti proizvoda, zatim objasnite što bi korisnik trebao učiniti i kakve će rezultate postići ili vidjeti. Koraci bi trebali biti numerirani i započeti glagolom radnje, kao što su koraci zapisani u svakom odjeljku ovog članka.
- Referentni materijal može uključivati kontrolne liste, savjete za rješavanje problema i često postavljana pitanja. Pojmovnik i indeks mogu se dodati na kraju vodiča, iako se na početku može navesti rječnik često korištenih pojmova. Indeks se može izostaviti ako vodič ima manje od 20 stranica.
Korak 5. Koristite grafičke slike po potrebi za podršku tekstu
Grafičke slike ili snimke zaslona mogu bolje ilustrirati određene točke u vodiču nego tekst, posebno u složenim postupcima gdje je korisnicima potrebna vizualna potvrda kako bi bili sigurni da pravilno slijede korake. Grafički crteži mogu se kreirati pomoću računarski podržanih nacrta (CAD) ili aplikacija za uređivanje grafike, digitalnih fotoaparata i aplikacija za obradu fotografija, ili ako želite koristiti snimke ekrana, upotrijebite funkcije snimljenih ekrana ugrađene u vaš računar ili grafički program sa mogućnostima snimanja ekrana.
- Nakon što stvorite grafičku sliku, spremite je u komprimiranom formatu kako biste je mogli koristiti u aplikaciji za obradu teksta ili objavljivanje na računaru. Također morate smanjiti veličinu slike kako bi bolje odgovarala stranici, ali i dalje pružati potpune detalje korisniku. (Ako je potrebno, možete izrezati originalnu sliku u odjeljke i prikazati relevantne odjeljke zajedno s pratećim tekstom).
- Ako u postupku koristite više grafičkih slika, pobrinite se da su slike stvorene u konzistentnoj veličini, bilo u istim dimenzijama dužine i širine ili proporcionalno veličini izvorne slike. Na taj će način slika korisnicima izgledati privlačnija. Isto važi i za snimanje ekrana sa računara; uverite se da računar prikazuje standardnu šemu boja prilikom snimanja slika, u suprotnom će čarobnjak prikazati snimak ekrana u boji.
- Iako aplikacije za uređivanje slika, poput Photoshopa i Paint Shop Pro -a, imaju dobre mogućnosti snimanja slika, programi namijenjeni snimanju zaslona poput Snagita također nude mogućnost jednostavnog mijenjanja, katalogiziranja i označavanja snimaka zaslona.
Dio 3 od 3: Dizajniranje korisničkog vodiča za upotrebu
Korak 1. Odaberite neke fontove koji se lako čitaju
Iako računar podržava brojne fontove, svrha stvaranja korisničkog vodiča je laka za čitanje. Odabir više odgovarajućih fontova najbolji je način za postizanje tog cilja. Fontovi se mogu grupirati u dvije vrste: serif i sans serif.
- Serifni fontovi imaju male ukrasne linije na krajevima glavnih linija koje čine slova. Fontovi sa serifom uključuju Times New Roman, Baskerville i Book Antiqua. Serif fontovi savršeni su za većinu teksta prikazanih u veličinama 10-12 u glavnom tijelu za vodiče za ispis.
- Fontovi bez serifa sadrže samo linije koje čine slova, bez ukrasa. Fontovi koji pripadaju sans serif grupi uključuju Arial, Calibri i Century Gothic. Fontovi bez serifa mogu se koristiti za većinu veličina teksta 8 do 10 u PDF datotekama ili mrežnim vodičima, iako bez ukrasa otežava čitanje rečenica prikazanih u fontovima 12 ili većim. Međutim, fontovi se mogu učinkovito koristiti u većim veličinama za prikaz naslova i naslova, a u manjim veličinama savršeni su za fusnote i brojeve u kolonama i tablicama.
- Općenito, najbolje je odabrati jednostavan font poput Arial ili Times New Roman za svoj vodič, iako možete koristiti ukrasni font za citate ili naslove ako pišete vodič za videoigru postavljenu u fantastičnoj ili naučnofantastičnoj postavci. (U slučaju navoda, često možete koristiti jednostavan font i prikazati cijeli citat u kurzivu).
- Nakon što odlučite koje fontove ćete koristiti, stvorite uzorke stranica kako biste provjerili izgledaju li dobro na papiru. Također biste trebali pokazati ovaj uzorak stranice osobi odgovornoj za davanje odobrenja za prikaz vodiča prije nego nastavite s pisanjem.
Korak 2. Razmislite o izgledu
Nakon što odaberete font za vodič, morat ćete odlučiti kako strukturirati sadržaj na vrhu stranice.
- Općenito, naslov dokumenta ili naslov poglavlja vjerojatno biste trebali postaviti u zaglavlje ili podnožje, možda koristeći naslove vodiča s lijeve strane stranice i naslove poglavlja s desne strane stranice. Broj stranice morate postaviti u zaglavlje ili podnožje, bilo van (zaglavlje ili podnožje) ili centrirano (samo u podnožju). Možda ćete također morati razlikovati prvu stranicu svakog odjeljka ili poglavlja od drugih stranica postavljanjem broja stranice u sredinu podnožja i sljedeće stranice u vanjski kut zaglavlja.
- Možda ćete morati unijeti umetnuti tekst u okvir u boji ili okvir u bloku kako biste ga razlikovali od ostatka teksta. Odaberite boju ili razinu blokiranja kako tekst ne bi bio otežan za čitanje.
- Ostavite prilično široku marginu sa svih strana, s dodatnim prostorom na rubovima koji će se vezati.
Korak 3. Razmotrite vrstu sveske za korisnički vodič
Ako je vodič duži od 4 stranice, stranice moraju biti uvezane na određeni način. Iako se interni dokumenti mogu spajati heftalicom u kutu stranice, vanjski korisnički vodič koji je isporučen s proizvodom obično se spaja jednom od sljedeće 3 metode:
- Metoda bočnog spajanja (spojena sa stranica stranice heftalicom) za vodiče štampane na presavijenom papiru 21 x 27,5 cm, 21 x 35 cm ili 27,5 x 42,5 cm. Većina jeftinih vodiča od 48 stranica ili manje uvezani su na ovaj način.
- Metoda šivanja sedlom (prošivena sa strane stranice) češće se koristi za referentne vodiče trećih strana nego vodiči uključeni u proizvode osim automobila, iako su neki duži vodiči povezani na ovaj način. (Vodič za Paint Shop Pro prvobitno je uključivao vodič za šivanje sedla, dok ga je još uvijek proizvodila kompanija JASC Software).
- Spiralni povez je najprikladniji za vodiče koji se koriste u teškim okruženjima, poput vani (u tom slučaju metode bočnog spajanja i šivanja sedla nisu dovoljno jake da uzrokuju klizanje stranica). Neki vodiči sa spiralnim povezom mogu imati i stranice koje su laminirane plastikom kako bi se spriječilo njihovo oštećenje pri vlaženju ili izlaganju blatu.
Korak 4. Napravite predložak dokumenta za smjernice
Mnoge aplikacije za obradu teksta i desktop objavljivanje nude mogućnost stvaranja predložaka dokumenata za korisničke vodiče. Dakle, dok kucate, tekst će se automatski pojaviti sa fontom koji ste odabrali za dio čarobnjaka na kojem radite. (Zapravo, ovaj članak je izvorno napisan pomoću Microsoft Word predloška). Većina ovih programa također uključuje standardni skup predložaka koje možete mijenjati po potrebi kako ne biste morali stvarati vlastite od nule.
