Kako izraditi korisnički vodič: 12 koraka (sa slikama)

Sadržaj:

Kako izraditi korisnički vodič: 12 koraka (sa slikama)
Kako izraditi korisnički vodič: 12 koraka (sa slikama)

Video: Kako izraditi korisnički vodič: 12 koraka (sa slikama)

Video: Kako izraditi korisnički vodič: 12 koraka (sa slikama)
Video: KUNG-FU TUTORIAL #1 (NIJE TEŠKO) 2024, Svibanj
Anonim

Korisnički priručnik je priručnik u papirnatom ili elektroničkom obliku (PDF ili XPS) koji daje upute o postupku ili uporabi 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čunalima i drugim elektroničkim uređajima kao što su televizori, stereo uređaji, telefonski sustavi, MP3 playeri te kućanska i vrtna oprema. Dobar korisnički vodič educira korisnike o značajkama proizvoda i uči ih kako učinkovito koristiti te značajke. 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 učinkovitog sadržaja i oblikovanju izgleda korisničkog vodiča.

Korak

1. dio od 3: Izrada odgovarajućeg korisničkog vodiča

Napravite korisnički priručnik Korak 1
Napravite korisnički priručnik Korak 1

Korak 1. Odlučite tko ć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 kada ste dio tima za pisanje korisničkih vodiča i kada radite na željenom proizvodu od koncepta do konačnog oblika. Prilikom stvaranja korisničkog profila uzmite u obzir sljedeće čimbenike:

  • Položaj 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 pojedinosti.
Napravite korisnički priručnik Korak 2
Napravite korisnički priručnik Korak 2

Korak 2. Izradite 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 nalikuje načinu na koji korisnik misli. Navođenje značajki proizvoda grupiranih prema funkcijama često ima više smisla nego prema najčešće korištenim značajkama.

Ponekad je korištenje tehničkih izraza neizbježno, na primjer za aplikacije grafikona koje uključuju Fibonaccijeve grafikone zajedno s tortnim grafikonima i uobičajenije trakaste grafikone. U ovakvom slučaju bilo bi bolje da definirate pojmove i navedete podatke, na primjer objašnjenje što je Fibonaccijev grafikon i kako se koristi u financijskim analizama

Napravite korisnički priručnik Korak 3
Napravite korisnički priručnik Korak 3

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 za uobičajene probleme u redu je pri oglašavanju proizvoda, ali kad kupac posjeduje proizvod, mora razumjeti kako ga koristiti. Identificirajte problem s kojim će se korisnik susresti, opišite ga u korisničkom priručniku, a zatim slijedite upute za njegovo rješavanje.

Ako je problem složen, podijelite ga na manje komade. Zapišite svaki odjeljak s uputama kako ga 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

Napravite korisnički priručnik Korak 4
Napravite korisnički priručnik Korak 4

Korak 1. Izradite odgovarajuću naslovnicu i naslovnu stranicu

Trebat će vam naslovnica za bilo koji korisnički vodič koji je više od referentne kartice i naslovna stranica za vodič koji sadrži više od presavijenog lista papira (duljine 4 stranice ili više).

  • Ako je vodič zaštićen autorskim pravima, napomena o autorskim pravima mora se nalaziti na prednjoj i stražnjoj strani omota, kao i na naslovnoj stranici.
  • Ako postoje uvjeti i odredbe za korištenje vodiča i proizvoda povezanih s njim, navedite ih na unutarnjoj strani prednje korice.
Napravite korisnički priručnik Korak 5
Napravite korisnički priručnik Korak 5

Korak 2. U uvodu stavite referencu na srodni dokument

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.

Napravite korisnički priručnik Korak 6
Napravite korisnički priručnik Korak 6

Korak 3. Uključite sadržaj ako je vodič duži od 10 stranica

Napravite korisnički priručnik Korak 7
Napravite korisnički priručnik Korak 7

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 taj način korisnik može brzo pronaći informacije koje traži.

  • Postupci trebaju biti napisani u dosljednoj 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 popise za provjeru, 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.
Napravite korisnički priručnik Korak 8
Napravite korisnički priručnik Korak 8

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, osobito u složenim postupcima gdje je korisnicima potrebna vizualna potvrda kako bi bili sigurni da pravilno slijede korake. Grafički crteži mogu se stvoriti pomoću računalno potpomognutih nacrta (CAD) ili aplikacija za uređivanje grafike, aplikacija za digitalnu kameru i obradu fotografija, ili ako želite koristiti snimke zaslona, upotrijebite značajke snimki zaslona ugrađene u vaše računalo ili grafički program s mogućnostima snimanja zaslona.

  • Nakon što stvorite grafičku sliku, spremite je u komprimiranom formatu kako biste je mogli koristiti u aplikaciji za obradu teksta ili stolno objavljivanje. 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 izvornu sliku u odjeljke i prikazati relevantne odjeljke zajedno s pratećim tekstom).
  • Ako u postupku koristite više grafičkih slika, provjerite jesu li slike izrađene u konzistentnoj veličini, bilo u istim dimenzijama duljine i širine ili proporcionalno veličini izvorne slike. Na taj će način slika korisnicima izgledati privlačnija. Isto vrijedi i za snimanje zaslona s računala; provjerite da li računalo prikazuje standardnu shemu boja pri fotografiranju, u protivnom će čarobnjak prikazati snimku zaslona u boji.
  • Iako aplikacije za uređivanje slika poput Photoshopa i Paint Shop Pro imaju dobre mogućnosti snimanja slika, programi namijenjeni snimanju zaslona poput Snagita također nude mogućnost jednostavnog mijenjanja, katalogiziranja i označavanja snimki zaslona.

Dio 3 od 3: Dizajniranje korisničkog vodiča za korištenje

Napravite korisnički priručnik Korak 9
Napravite korisnički priručnik Korak 9

Korak 1. Odaberite neke fontove koji se lako čitaju

Iako računalo može podržati 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 crte na krajevima glavnih linija koje čine slova. Fontovi serifa 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.
  • Sans serifni fontovi 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 stupcima i tablicama.
  • Općenito, za vodič je najbolje odabrati jednostavan font poput Arial ili Times New Roman, iako možete koristiti ukrasni font za citate ili naslove ako pišete vodič za videoigru postavljenu u fantasy ili znanstvenofantastičnoj postavci. (U slučaju navoda često možete koristiti jednostavan font i cijeli citat prikazati u kurzivu).
  • Nakon što odlučite koje fontove ćete koristiti, izradite 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.
Napravite korisnički priručnik Korak 10
Napravite korisnički priručnik Korak 10

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 izvan (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 tako da broj stranice postavite u sredinu podnožja, a sljedeću stranicu u vanjski kut zaglavlja.
  • Možda ćete morati umetnuti tekst unutar okvira u boji ili okvira za blok kako biste ga razlikovali od ostatka teksta. Odaberite boju ili razinu blokiranja kako tekst ne bi bio otežan za čitanje.
  • Ostavite prilično širok rub sa svih strana, s dodatnim prostorom na rubovima koji će biti ukoričeni.
Napravite korisnički priručnik Korak 11
Napravite korisnički priručnik Korak 11

Korak 3. Razmotrite vrstu sveske za korisnički priručnik

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 (stegnutom sa strana stranice spajalicom) za vodiče ispisane 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 koji nisu automobili, iako su neki duži vodiči povezani na ovaj način. (Vodič za Paint Shop Pro izvorno je sadržavao vodič za šivanje sedla dok ga je još uvijek proizvodila tvrtka JASC Software).
  • Spiralni povez najprikladniji je za vodiče koji se koriste u oštrijim okruženjima, poput vani (u tom slučaju metode bočnog spajanja i šivanja sedlom nisu dovoljno jake da uzrokuju klizanje stranica). Neki vodiči sa spiralnim povezom mogu imati i stranice koje su laminirane plastikom kako se ne bi oštetile pri mokrenju ili izloženosti blatu.
Napravite korisnički priručnik Korak 12
Napravite korisnički priručnik Korak 12

Korak 4. Izradite predložak dokumenta za smjernice

Mnoge aplikacije za obradu teksta i stolno objavljivanje nude mogućnost stvaranja predložaka dokumenata za korisničke vodiče. Dakle, dok tipkate, tekst će se automatski pojaviti s fontom koji ste odabrali za dio čarobnjaka na kojem radite. (Zapravo, ovaj je članak izvorno napisan pomoću predloška Microsoft Word). Većina ovih programa također uključuje standardni skup predložaka koje možete mijenjati prema potrebi kako ne biste morali stvarati vlastite od nule.

Aplikacije za obradu teksta i objavljivanje na stolnim računalima također nude mogućnost stvaranja "stilova", unaprijed postavljenih veličina fonta za zaglavlje, podnožje, zaglavlje i tekst. Možete odabrati jedan od unaprijed definiranih naziva stilova (na primjer, Naslov, Normalno, Citat) ili stvoriti vlastiti stil s vlastitim imenom. Kad god je to moguće, slijedite konvenciju za stvaranje naziva stilova ako imate više stilova za istu vrstu teksta. (Na primjer, nazivi stilova koje Microsoft Word usvaja za naslove su Heading1, Heading2 itd. Za glavne naslove do nekoliko razina podnaslova). Pokušajte unaprijed stvoriti sve stilove koji vam trebaju kako ne biste morali stati i stvarati ih usred samog procesa tipkanja

Preporučeni: