Kako napisati jasne i koncizne korisničke priručnike
Što je korisnički priručnik?
Postoje različiti nazivi za korisnički priručnik. Tehnički dokumenti, priručnici za održavanje i priručnici s uputama nazivi su koji se odnose na istu stavku. Korisnički priručnik napravljen je kako bi pomogao korisnicima da ispravno koriste vaš proizvod ili uslugu ili da riješe probleme koji se pojave tijekom korištenja. Mogu biti dostupni u tiskanom, digitalnom ili oba formata.
Priručnici za korištenje pružaju krajnjem korisniku sveobuhvatne upute korak po korak i određenu podršku za probleme. Sadržaj bi trebao biti prisutan u svakom korisničkom priručniku jer su to referentni materijali, a ne knjige koje treba pročitati od početka do kraja. Trebali biste u svoj korisnički priručnik dodati upute za brzi početak ili početak kako bi se korisnici mogli lako osjećati kada počnu koristiti proizvod.
vrste korisničkih priručnika
Za razne predmete i ciljeve mogu se izraditi korisnički priručnici. Evo nekih vaših mogućnosti, pa ih pogledajmo.
- Priručnik s uputama
Priručnik s uputama vrsta je korisničkog vodiča koji nudi jednostavne upute za korištenje proizvoda na način na koji je namijenjen. - Priručnik za obuku
Ova vrsta korisničkog vodiča nudi popis smjernica za dovršetak određenog zadatka, projekta ili posla. - Servisni priručnik
Servisni priručnici su korisnički vodiči koji opisuju kako se brinuti i održavati dio strojeva ili opreme na različitim mjestimatages njegovog životnog vijeka. - korisnički priručnik
Korisnički priručnici tehničke su publikacije koje objašnjavaju kako pravilno koristiti ili rukovati proizvodom. - Priručnik za rad
Uloge, dužnosti i postupci specifični za tvrtku ili organizaciju opisani su u operativnim priručnicima. - Priručnik o organizacijskoj politici
Priručnik o organizacijskim politikama je dokumentacija koja definira politike, prakse i najbolje prakse tvrtke. - Standardni operativni postupci (SOP) Priručnik
Korisnici imaju koristi od detaljnih uputa priručnika standardnih operativnih postupaka za provođenje utvrđenih postupaka.
Zašto su vašoj tvrtki potrebni korisnički priručnici?
Ljudi su bolje opremljeni za samostalno rješavanje problema uz pomoć korisničkog priručnika. Pristojan korisnički priručnik može dati vašim klijentima alate koji su im potrebni da brzo i učinkovito postignu vrijednost koju žele od vašeg proizvoda ili usluge u današnjoj kulturi neposrednog zadovoljstva.
Izvrsnu korisničku uslugu potrebno je nadopuniti korisničkim priručnicima. Pisanje izvrsnih korisničkih priručnika omogućit će sljedeće prednostitages za vašu tvrtku:
- Za jednostavnije ukrcavanje i obuku
Dobro napisani korisnički vodiči mogu pojednostaviti postupke uključivanja i obuke. To je točno, razvojem i implementacijom vrhunskih korisničkih priručnika, vaši zaposlenici i vaši potrošači mogu biti na dobitku.
Vaša tvrtka može koristiti korisničke vodiče kako bi pomogla novim zaposlenicima da prođu kroz neke od procesa i sustava koji su dio njihovih novih uloga, umjesto da samo postavljaju teške osobne treninge, koji zahtijevaju značajne vremenske i financijske troškove. Budući da zaposlenici mogu učiti tijekom obavljanja dužnosti povezanih s njihovim položajima zahvaljujući korisničkim vodičima, može biti manje izgubljenih sati tijekom ukrcavanja. - Za smanjenje troškova podrške
Korisnički vodiči izvrstan su dodatak vašim naporima u pružanju korisničke podrške potrošaču, ali također dobro služe vlasniku tvrtke kao komponenta sustava korisničke podrške.
Veća je vjerojatnost da će kupci odmah pronaći rješenja i manja je vjerojatnost da će morati kontaktirati tehničara ili predstavnika za specijaliziranu podršku kada im date brzi pristup pretraživom korisničkom vodiču. - Za uštedu vremena
I vaši klijenti i zaposlenici, od početničkog osoblja do uprave, mogu uštedjeti vrijeme korištenjem korisničkih priručnika. Kada su korisnički priručnici dostupni vašim klijentima, oni neće morati gubiti vrijeme pokušavajući pronaći informacije o tome kako koristiti proizvod jer će odmah imati izravan pristup tim informacijama.
Kada su vaši zaposlenici opremljeni korisnim korisničkim priručnikima, ne moraju gubiti vrijeme na samostalno traženje rješenja ili monopolizirati pozornost svojih suradnika i menadžera upitima jer imaju pristup rješenjima upravo u svom korisničkom priručniku! - Minimizirati odgovornost
Jedan pristup da pokažete da ste temeljito testirali svoj proizvod i znate kako ga sigurno koristiti je pisanje i distribucija korisničkih priručnika. To može značajno smanjiti sve obveze vezane uz proizvodnju nečega za širu javnost.
Zapisivanje upozorenja i sigurnosnih mjera opreza i dostupnost korisnicima putem korisničkog priručnika učinkovit je (iako ne i siguran) način za izbjegavanje pravnih problema povezanih s ozljedama ili drugom štetom uzrokovanom zlouporabom ako bi proizvod koji prodajete mogao biti opasan za korisnike (mislite grijalice prostora, električni alati itd.).
Koje komponente čine najbolje korisničke priručnike?
Postoje neke najbolje prakse za dokumentaciju krajnjeg korisnika kojih se treba pridržavati bez obzira na sve, iako je svaki proizvod jedinstven i trebat će različite komponente za generiranje uistinu izvrsne korisničke dokumentacije.
- Običan jezik
Ništa neće više iritirati vaše kupce—osim činjenice da ih ne nudite—od otkrivanja da je njihov korisnički priručnik prepun žargona i teško razumljivog jezika. Vaše korisničke upute teško je koristiti zbog ovih izbora jezika, koji također ne promoviraju izvanrednu korisničku uslugu. Pobrinite se da pišete za korisnika, a ne za programera, ključna je komponenta stvaranja sjajnih korisničkih vodiča. Nemojte pretpostavljati da vaš krajnji korisnik zna ili je upoznat s nečim. Akronimi, žargon i uredska terminologija učinit će da se vaši klijenti osjećaju neinformirano, frustrirano i nepripremljeno. Slatko mjesto za izradu korisničkog priručnika je postizanje ravnoteže između toga da ne pišete kao da su vaši potrošači djeca (osim, naravno, ako jesu!) i pružanja dodatne pomoći koja im je potrebna da u potpunosti razumiju kako koristiti proizvod, na jednostavan način Jezik. - Jednostavnost
Pisanje korisničkog priručnika zahtijeva jednostavnost stvari. Taj bi se koncept trebao odražavati iu sadržaju iu dizajnu. Ako svoju dokumentaciju pretrpate zamršenim slikama i dugim odlomcima teksta, izgledat će previše sofisticirano i teško razumljivo. Ova vrsta korisničkog priručnika vjerojatno će zastrašiti vašeg korisnika i navesti ga da nazove vašu liniju za pomoć umjesto da pokuša sam riješiti problem. - Vizuali
Maksima "Pokaži, ne govori" kamen je temeljac pisanja korisničkog priručnika. Snimke zaslona s komentarima, filmovi i drugi vizualni sadržaji iznimno su korisni u razumijevanju koncepata. Često je mnogo korisnije vidjeti nešto na djelu nego čitati o tome. Vizuali ne samo da razbijaju duge odlomke teksta, već također smanjuju količinu teksta u korisničkim priručnicima koji mogu biti zastrašujući. Dokazano je da ljudi vizualne informacije zadržavaju 7% brže nego pisane. U studiji Techsmitha također je pokazano da je 67% ljudi učinkovitije obavljalo zadatke kada su im dane upute koje su uključivale anotirane snimke zaslona, a ne same riječi za prenošenje informacija. - Usredotočite se na problem koji treba riješiti
Vrlo je vjerojatno da je netko kupio vaš proizvod kako bi riješio problem. Bitno je ostati usredotočen na ovo pitanje kada sastavljate korisnički priručnik koji će biti uključen u proizvod. Umjesto nabrajanja i raspravljanja o svim značajkama koje vaš proizvod nudi ili intrigantnim elementima dizajna koje ste uključili, obavijestite svoje korisnike o njima na način koji olakšava korištenje proizvoda. Stavite problem koji rješavate u kontekst značajki i prednosti vašeg proizvoda kada ih opisujete. - Logičan tijek i hijerarhija
Kako bi korisniku bilo jasno što će naučiti iz svakog odjeljka vašeg korisničkog priručnika, koristite zaglavlja i podnaslove koji slijede jasnu hijerarhijsku strukturu. Kako biste bez napora vodili svoje klijente kroz sve što trebaju znati od početka do zaključka, hijerarhija koju odaberete trebala bi slijediti logičan tok. Obavezno započnite s osnovama i uključite logičan napredak prema sofisticiranijim značajkama vašeg proizvoda. - Popis sadržaja
Vaš će korisnički priručnik biti od najveće pomoći čitateljima ako počinje sa sadržajem. Bez potrebe za kopanjem po mnogim stranicama informacija koje nisu povezane s trenutačnim problemom s kojim se suočavaju, nekome je poznat pristup brzog i jednostavnog istraživanja dokumenta. - Neka bude pretraživo
Čak i ako biste mogli ispisati svoje korisničke priručnike, vjerojatno će digitalna dokumentacija biti vaš glavni prioritet. Vrlo je vjerojatno da će se vaši korisnički priručniki najčešće koristiti u digitalnom formatu u svijetu u kojem većina ljudi uvijek ima pametni telefon sa sobom. Dodavanje značajke koja se može pretraživati u vaše digitalne korisničke priručnike promovirat će divnu jednostavnost korištenja za korisnike koji žele riješiti problem pristupom, slično kao što sadržaj služi za usmjeravanje korisnika na odgovarajuće mjesto u dokumentu za ispis. - Pristupačnost
Moguće je da bi nekima od ljudi kojima je potreban vaš korisnički priručnik mogla pomoći dodatna pomoć kako bi osigurali njegovo ispravno funkcioniranje. Bez obzira na to zahtijevaju li ih zakon, zahtjevi pristupačnosti općenito su dobra praksa. Održavanje zahtjeva pristupačnosti u vašim korisničkim priručnicima samo je izvrsna poslovna praksa. Dizajn korisničkih vodiča sa sadržajem koji je dostupan korisnicima koji bi mogli imati vizualne, zvučne ili kognitivne probleme je ključno. - Dobro dizajnirano
Uzmite u obzir svoju publiku prilikom izrade korisničkih vodiča. Bit će daleko skloniji učinkovito ga koristiti ako napravite nešto što oni uživaju gledati! Izbjegavajte korištenje dugih tekstualnih blokova i osigurajte puno bijelog prostora. Kombinacija ove dvije karakteristike može pomoći potrošačima da izgledaju manje zastrašujuće i da učenje bilo čega novoga izgleda uzbudljivije, a ne prijeteće. Pristup “pokaži, nemoj reći” koji smo ranije opisali također se primjenjuje i ovdje. I za tiskane i za digitalne korisničke priručnike, dodavanje slika i fotografija tekstu je izvrsna alternativa. Za digitalne korisničke priručnike, videozapisi i GIF-ovi nude zanimljivost i koristan element. Ako vaša tvrtka ima stilski vodič, vaš bi ga dizajn trebao slijediti; inače, ako radite bez njega, ključno je da vaš korisnički vodič bude dosljedan. Font i sheme boja koje se koriste u cijelom radu, a idealno u svim vašim korisničkim vodičima, trebaju biti dosljedni. - Komentari stvarnih kupaca ili beta testera
Nećete moći utvrditi jesu li korisnički vodiči koje ste pripremili uspješni koliko god je to moguće dok ne potražite i poslušate povratne informacije od ljudi koji će stvarno koristiti vaš proizvod. Korisnički vodiči koje razvijate za svoj proizvod trebaju uzeti u obzir probleme koje ljudi imaju s njim. Možda ćete naučiti nešto što se čini krajnje očiglednim, ali postoji puno veća šansa da ćete naučiti nešto što će vam pomoći da shvatite potrebe kupaca do kojih pokušavate doći.
Kako da napišem korisnički priručnik?
Izrada korisničkog priručnika ključni je zadatak koji može imati veliki utjecaj i na vašu tvrtku i na potrošače kojima želite služiti. Pojednostavili smo proces razvoja korisničkog priručnika tako da ga možete lako pratiti jer može biti neodoljiv.
- Identificirajte korisnike
Pronalaženje primatelja vaše komunikacije bitan je početni korak, baš kao i kod svake druge komunikacije koju generišete. Ciljana publika vašeg korisničkog priručnika pomoći će vam da odlučite o pitanjima kao što su ton, razina detalja koju treba pružiti i kako isporučiti sadržaj. Pisanje korisničkog vodiča za krajnjeg korisnika vašeg proizvoda znatno se razlikuje od pisanja za tehničkog inženjera. Prvi korak je odrediti svoju publiku. - Usredotočite se na problem
Korisnički priručnici napravljeni su kako bi pomogli u rješavanju problema ili uputili nekoga kako učiniti nešto novo. Morate točno odrediti za što je namijenjen vaš korisnički priručnik i pobrinite se da zadržite taj fokus.
Može biti primamljivo proširiti temu i razgovarati o brojnim značajkama ili primjenama vašeg proizvoda. To može frustrirati korisnike i dovesti do poziva vašoj korisničkoj podršci zamagljujući pravi odgovor koji traže.
Ako je vaš kupac potrošač koji uči koristiti proizvod ili tehničar koji ga treba popraviti, usredotočite se na točno rješenje koje će mu biti potrebno. - Primijenite sekvencijalni pristup
Upute u vašem korisničkom priručniku trebale bi biti postavljene redoslijedom koji je potreban za dovršetak posla. Navedite svaki korak kako biste započeli. Zatim se potrudite izvršiti zadatak pridržavajući se preciznih koraka koje ste zacrtali zadanim redoslijedom. Dok prolazite kroz svoj izvorni popis, moguće je, možda čak i vjerojatno, da ćete pronaći bilo koji stagkoji nedostaju. Osim toga, mogli biste otkriti da nešto za što ste nekada vjerovali da je jedan zadatak zapravo treba podijeliti u nekoliko aktivnosti radi jasnoće.
Provjerite jeste li odredili jasan ishod za svaki uzastopni korak koji ste dodijelili prije prelaska na sljedeću fazu pisanja korisničkog vodiča. Prije prelaska na sljedeću razinu, čitateljima bi trebalo biti potpuno jasno što žele postići i kako bi to trebalo izgledati. - Putovanje korisnika karte
Razumijevanje načina na koji vaši potrošači planiraju koristiti vaš proizvod i olakšavanje toga za njih su ciljevi izrade korisničkog vodiča. Morate se potruditi razumjeti problem koji potrošač pokušava riješiti ili cilj koji pokušava postići korištenjem vašeg rješenja, kao i kako se uključuje u vaše poslovanje. Možete isplanirati korake potrebne za vođenje kupca kroz proces pomoću ovih detalja kako biste vizualizirali njihov put od problema do rješenja. - Odaberite predložak
Zadatak pisanja i razvoja korisničkih priručnika može se učiniti mnogo jednostavnijim nego što biste očekivali stvaranjem niza predložaka. Vaš bi postupak mogao biti pojednostavljen, a dosljednost bi postala mnogo realniji cilj.
U svom predlošku korisničkog priručnika, osim definiranja detalja kao što su fontovi (vrsta i veličina), zahtjevi za kontrastom i sheme boja, također biste trebali uključiti sljedeće:- Područje dodijeljeno za uvod
- Različiti pododjeljci i odjeljci
- Vaš odabrani format za prenošenje niza radnji
- Oprezne napomene i upozorenja
- Područje dodijeljeno za zaključak
- Pišite jednostavan sadržaj koji se lako prati
Materijal vašeg korisničkog priručnika trebao bi biti što jasniji i jednostavniji za razumijevanje. Važno je razmisliti i analizirati format i sadržaj radi jasnoće i praktičnosti.
Pobrinite se da svaka faza procesa ocrtava samo jedan zadatak i koristi što je moguće jasniji i kraći jezik. Obavezno pravilno izmijenite svoj tekst dok ne dobijete korisnički priručnik koji sadrži samo one informacije koje su stvarno potrebne. - Pristupite svakom korisniku kao početniku
Pretpostavimo da čitatelj vašeg korisničkog priručnika nema prethodnog znanja o vašem proizvodu kada ga stvara. Pišite kao da razgovarate s laikom.
Treba izbjegavati bilo kakvu upotrebu žargona ili tehničkog jezika. Naravno, bit će trenutaka kada to treba izbjegavati, ali to bi trebala biti apsolutna iznimka. - Testirajte upute za proizvod s korisnicima početnicima
Faza testiranja procesa izrade korisničkog priručnika ključna je. Predmet eksperimentiranja ima značajan utjecaj na ishod.
Testiranje bi idealno trebalo provesti na ljudima koji nikada nisu koristili vaš proizvod ili vidjeli dokumentaciju. Dok se krećete kroz korisnički priručnik, promatrajte ih dok dovršavaju postupak i bilježite gdje su zapeli. Zatim, informacije treba ažurirati na odgovarajući način.
Vašim bi ispitivačima za rad s proizvodom trebala biti potrebna samo pomoć korisničkog priručnika. Ne bi trebali tražiti dodatnu pomoć. Vodič kroz SSSR trebao bi sadržavati sve potrebne informacije. - Izgradite sadržaj koristeći praktičan pristup
Treba se potruditi ponuditi konkretne exampdatoteke i detaljne opise svih ishoda koje bi korisnici mogli iskusiti nakon što slijede svaki korak u korisničkom priručniku. Korisnik bi trebao biti svjestan svih povratnih informacija koje bi mogao dobiti od proizvoda, kao i svih mogućih prizora ili zvukova na koje bi mogao naići na putu. - Rano objasnite simbole, ikone i kodove
Možda ćete morati upotrijebiti ikone, simbole ili kodove dok pišete korisnički priručnik kako biste pružili potrebne upute. Kako biste spriječili zbunjenost ili frustraciju čitatelja, ključno je identificirati ih što je prije moguće u vašem korisničkom priručniku.
Često postavljana pitanja u korisničkom priručniku
Što su zapravo korisnički priručnici?
Korisnička dokumentacija je informacija pružena u obliku korisničkih priručnika ili korisničkih vodiča i namijenjena je pomoći krajnjim korisnicima u uspješnoj interakciji s proizvodom.
- Koje vrste korisničke dokumentacije postoje?
Fizička dokumentacija, poput knjižica ili priručnika, tradicionalno se koristila za ponudu korisničke dokumentacije. Danas se korisnički priručnici sve češće proizvode i distribuiraju digitalno. - Što je sadržano u korisničkim priručnicima?
Priručnik s uputama ili korisnički priručnik koristi dobar dizajn, jasno pisanje i usmjeren je na rješavanje problema. Moram imati tablicu sadržaja, pridržavati se logične hijerarhije i tijeka te ponuditi sadržaj koji je dostupan. Osim toga, dobar korisnički priručnik moći će se pretraživati i uzimati u obzir zahtjeve korisnikaviews. - Kako se izrađuje korisnički dokument?
Za razvoj korisničkih priručnika mogu se koristiti jednostavni koraci. Najprije se moraju odrediti ciljevi korisničkog vodiča i mora se razviti strategija koja će omogućiti njihovo postizanje. Prije objavljivanja korisnički priručnik mora se testirati i po potrebi ažurirati. Naposljetku, važno je održavati korisnički priručnik ažuriranim, unoseći izmjene kako se dodaju nova ažuriranja ili izdanja.