Kako napisati jasne i sažete korisničke priručnike
Šta je uputstvo za upotrebu?
Postoje različiti nazivi za korisnički priručnik. Tehnički dokumenti, priručnici za održavanje i uputstva za upotrebu su nazivi koji se odnose na istu stavku. Korisnički priručnik je napravljen da pomogne kupcima da pravilno koriste vaš proizvod ili uslugu ili da riješe probleme koji se javljaju tokom upotrebe. Mogu biti dostupni u štampanom, digitalnom ili u oba formata.
Priručnici za upotrebu pružaju krajnjem korisniku opsežna uputstva 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 čitati od početka do kraja. Trebali biste dodati vodič za brzi početak ili pokretanje u svoj korisnički priručnik kako bi se korisnici mogli lako osjećati kada počnu koristiti proizvod.
vrste korisničkih priručnika
Za različite teme i ciljeve mogu se izraditi korisnički priručnici. Evo nekih od vaših mogućnosti, pa hajde da ih pogledamo.
- Uputstvo za upotrebu
Priručnik za upotrebu je vrsta korisničkog vodiča koji nudi direktne upute za korištenje proizvoda na način na koji je namijenjen. - Priručnik za obuku
Ova vrsta korisničkog vodiča nudi listu smjernica za završ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 komad strojeva ili opreme u različitim stage njegovog životnog veka. - Uputstvo za upotrebu
Korisnički priručnici su tehničke publikacije koje objašnjavaju kako pravilno koristiti ili rukovati proizvodom. - Operativni priručnik
Uloge, dužnosti i procedure specifične za posao ili organizaciju opisani su u operativnim priručnicima. - Priručnik organizacione politike
Priručnik organizacione politike je dokumentacija koja definiše politiku, praksu i najbolje prakse kompanije. - Priručnik za standardne operativne procedure (SOP).
Korisnici imaju koristi od detaljnih uputstava priručnika o standardnim operativnim procedurama za provođenje utvrđenih procedura.
Zašto su vašem preduzeću potrebna uputstva za upotrebu?
Ljudi su bolje opremljeni da sami rješavaju probleme uz podršku korisničkog priručnika. Pristojan korisnički priručnik može pružiti vašim klijentima alate koji su im potrebni da brzo i efikasno postignu vrijednost koju žele od vašeg proizvoda ili usluge u današnjoj kulturi neposrednog zadovoljstva.
Odličan servis za korisnike treba dopuniti korisničkim priručnicima. Pisanje odličnih korisničkih priručnika pružit će sljedeće prednostitages za vašu kompaniju:
- Da bi uključivanje i obuku bili jednostavniji
Dobro napisani korisnički vodiči mogu pojednostaviti procedure za uključivanje i obuku. To je tačno, razvojem i implementacijom vrhunskih korisničkih priručnika, i vaši zaposleni i vaši potrošači imaju koristi.
Vaša kompanija može koristiti korisničke vodiče kako bi pomogla novim zaposlenicima da prođu kroz neke od procesa i sistema koji su dio njihovih novih uloga, umjesto da samo postavlja teške lične sesije obuke, koje zahtijevaju značajne vremenske i finansijske troškove. Budući da zaposleni mogu učiti dok obavljaju dužnosti vezane za svoje pozicije zahvaljujući korisničkim vodičima, može biti manje izgubljenih sati tokom uključivanja. - Za smanjenje troškova podrške
Korisnički vodiči su odličan dodatak vašim naporima u pružanju usluga korisnicima za potrošača, ali takođe dobro služe vlasniku preduzeća kao komponenta sistema korisničke podrške.
Vjerojatnije je da će kupci odmah pronaći rješenja i manje je vjerovatno da će morati kontaktirati tehničara ili predstavnika za specijaliziranu podršku kada im omogućite brzi pristup korisničkom vodiču koji se može pretraživati. - Za uštedu vremena
I vaši klijenti i vaši zaposleni, od osoblja na početnoj razini do menadžmenta, 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 direktan pristup tim informacijama.
Kada su vaši zaposlenici opremljeni korisnim korisničkim priručnicima, ne moraju gubiti vrijeme samostalno tražeći rješenja ili monopolizirati pažnju svojih kolega i menadžera upitima jer imaju pristup rješenjima upravo u svom korisničkom priručniku! - Minimizirati odgovornost
Jedan od pristupa da pokažete da ste temeljito testirali svoj proizvod i da znate kako ga bezbedno koristiti je pisanje i distribucija korisničkih priručnika. To može značajno smanjiti sve obaveze vezane za proizvodnju nečega za širu javnost.
Zapisivanje upozorenja i sigurnosnih mjera opreza i dostupnost korisnicima putem korisničkog vodiča je efikasan (iako nije siguran) način da se izbjegnu pravni problemi povezani s ozljedama ili drugom štetom uzrokovanom pogrešnim korištenjem 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 u dokumentaciji za krajnje korisnike kojih se treba pridržavati bez obzira na sve, iako je svaki proizvod jedinstven i trebat će mu različite komponente kako bi se stvorila zaista odlična korisnička dokumentacija.
- Običan jezik
Ništa neće više iritirati vaše kupce – osim što ga ne nude – nego što otkrijete da je njihov korisnički priručnik prepun žargona i teško razumljivog jezika. Vaša korisnička uputstva su teška za korištenje zbog ovih izbora jezika, koji također ne promoviraju izvanrednu korisničku uslugu. Osigurati 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 sa bilo čim. Akronimi, žargon i kancelarijska terminologija učinit će da se vaši klijenti osjećaju dezinformirano, frustrirano i nepripremljeno. Slatka tačka za izradu korisničkog priručnika je uspostavljanje ravnoteže između toga da ne pišete kao da su vaši potrošači djeca (osim ako, naravno, nisu!) i da im pružite dodatnu pomoć koja im je potrebna da u potpunosti razumiju kako koristiti proizvod, na jednostavan način. jezik. - Jednostavnost
Pisanje korisničkog priručnika zahtijeva da stvari budu jednostavne. Ovaj koncept treba da se odrazi i na sadržaj i na dizajn. 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 će vjerovatno zastrašiti vašeg korisnika i navesti ih da pozovu vašu liniju za pomoć umjesto da sami pokušaju riješiti svoj problem. - Visuals
Maksima “Pokaži, ne govori” je kamen temeljac pisanja korisničkih priručnika. Snimci ekrana sa komentarima, filmovi i drugi vizuelni sadržaji su izuzetno korisni u razumevanju koncepata. Često je mnogo korisnije vidjeti nešto na djelu nego čitati o tome. Vizuelni prikazi ne samo da razbijaju dugačke pasuse teksta, već i smanjuju količinu teksta u korisničkim priručnicima koji mogu biti zastrašujući. Pokazalo se da ljudi zadržavaju vizuelne informacije 7% brže nego pisane. U Techsmith studiji, takođe je pokazano da je 67% ljudi efikasnije obavljalo zadatke kada su im dali instrukcije koje su uključivale slike ekrana, a ne same reči za prenošenje informacija. - Fokusirajte se na problem koji treba riješiti
Vrlo je vjerovatno da je neko kupio vaš proizvod kako bi riješio problem. Od suštinske je važnosti da ostanete fokusirani na ovo pitanje prilikom izrade korisničkog priručnika koji će biti uključen uz proizvod. Umjesto da nabrajate i raspravljate o svim karakteristikama koje vaš proizvod nudi ili o intrigantnim elementima dizajna koje ste ugradili, obavijestite svoje korisnike o njima na način koji olakšava korištenje proizvoda. Stavite problem koji se rješava u kontekst karakteristika i prednosti vašeg proizvoda kada ih opisujete. - Logički tok i hijerarhija
Kako bi korisniku postalo jasno šta ć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 im je potrebno da znaju od početka do zaključka, hijerarhija koju odaberete treba slijediti logičan tok. Pobrinite se da počnete s osnovama i ugradite logičan napredak prema sofisticiranijim karakteristikama vašeg proizvoda. - Lista sadržaja
Vaš korisnički vodič će biti od najveće pomoći čitateljima ako počinje sa sadržajem. Bez potrebe da kopaju po mnogim stranicama informacija koje se ne odnose na trenutni problem sa kojim se suočavaju, nekome je poznat pristup brzo i lako istražiti dokument. - Učinite to pretraživim
Čak i ako biste mogli odštampati svoje korisničke priručnike, vjerovatno će vam digitalna dokumentacija biti glavni prioritet. Vrlo je vjerovatno da će se vaši korisnički priručnici najčešće koristiti u digitalnom formatu u svijetu u kojem većina ljudi uvijek ima pametni telefon sa sobom. Dodavanje funkcije za pretraživanje vašim digitalnim korisničkim priručnicima promovirat će odličnu jednostavnost korištenja za korisnike koji žele riješiti problem tako što će mu pristupiti, slično kao što sadržaj služi za usmjeravanje korisnika na pravo mjesto u dokumentu za štampanje. - Pristupačnost
Moguće je da bi neki od ljudi kojima je potreban vaš korisnički priručnik mogli imati koristi od dodatne pomoći kako bi osigurali da ispravno funkcionira. Bez obzira na to da li su propisani zakonom, zahtjevi pristupačnosti su općenito dobra praksa. Održavanje zahtjeva za pristupačnost u vašim korisničkim priručnicima je samo odlična poslovna praksa. Dizajniranje korisničkih vodiča sa sadržajem koji je dostupan korisnicima koji bi mogli imati vizualne, zvučne ili kognitivne izazove je ključno. - Dobro dizajnirano
Uzmite u obzir svoju publiku kada kreirate svoje korisničke vodiče. Biće mnogo skloniji da ga efikasno koriste ako napravite nešto u šta uživaju da gledaju! Izbjegavajte korištenje dugih blokova teksta 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 novog izgleda uzbudljivo, a ne prijeteće. Pristup “pokaži, ne pričaj” koji smo ranije opisali se također primjenjuje ovdje. I za štampane i za digitalne korisničke priručnike, dodavanje vizuelnih prikaza i fotografija u tekst je sjajna alternativa. Za digitalne korisničke priručnike, video zapisi i GIF-ovi nude interes i koristan element. Ako vaša kompanija ima vodič za stil, vaš dizajn bi ga trebao slijediti; inače, ako radite bez njega, ključno je da vaš korisnički vodič bude dosljedan. Šeme fonta i boja koje se koriste u cijelom papiru, a idealno u svim vašim korisničkim vodičima, trebaju biti dosljedne. - Komentari stvarnih kupaca ili beta testera
Nećete moći utvrditi jesu li korisnički vodiči koje ste pripremili uspješni ili ne sve dok ne potražite i saslušate povratne informacije od ljudi koji će zaista 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 izuzetno očiglednim, ali postoji mnogo veća šansa da naučite nešto što će vam pomoći da shvatite potrebe kupaca do kojih pokušavate doći.
Kako da napišem uputstvo za upotrebu?
Izrada korisničkog priručnika je ključni zadatak koji može imati veliki utjecaj i na vašu kompaniju i na potrošače kojima želite da služite. Pojednostavili smo proces izrade korisničkog priručnika tako da ga možete lako pratiti jer može biti neodoljiv.
- Identifikujte korisnike
Pronalaženje primatelja vaše komunikacije je bitan početni korak, baš kao i kod svake druge komunikacije koju generišete. Predviđena publika vašeg korisničkog priručnika pomoći će vam da odlučite o pitanjima kao što su ton, nivo detalja koji treba pružiti i kako isporučiti sadržaj. Pisanje korisničkog vodiča za krajnjeg korisnika vašeg proizvoda značajno se razlikuje od pisanja vodiča za tehničkog inženjera. Prvi korak je da odredite svoju publiku. - Fokusirajte se na problem
Korisnički priručnici su napravljeni da pomognu u rješavanju problema ili da daju upute nekome kako da uradi nešto novo. Morate precizno odrediti čemu vaš korisnički priručnik treba i pobrinuti se da zadržite taj fokus.
Može biti primamljivo proširiti temu i razgovarati o brojnim funkcijama ili aplikacijama za vaš proizvod. Ovo može frustrirati korisnike i dovesti do poziva na vašu liniju korisničke podrške tako što zamagljuje pravi odgovor koji im je potreban.
Ako je vaš kupac potrošač koji uči kako koristiti proizvod ili tehničar koji ga treba popraviti, koncentrišite se na precizno rješenje koje će mu trebati. - Koristite sekvencijalni pristup
Uputstva u vašem korisničkom priručniku trebaju biti postavljena redoslijedom koji je potreban za završetak posla. Navedite svaki korak kako biste započeli. Zatim se potrudite da izvršite zadatak držeći se preciznih koraka koje ste zacrtali datim redoslijedom. Dok prolazite kroz svoju originalnu listu, moguće je, možda čak i vjerovatno, da ćete pronaći bilo koji stage koji nedostaju. Osim toga, možda ćete otkriti da nešto za šta ste nekada vjerovali da je jedan zadatak zapravo mora biti podijeljeno u nekoliko aktivnosti radi jasnoće.
Provjerite jeste li naveli jasan ishod za svaki uzastopni korak koji ste dodijelili prije nego što pređete na sljedeću fazu pisanja korisničkog vodiča. Prije nego pređu na sljedeći nivo, čitateljima bi trebalo biti potpuno jasno šta žele da se postignu i kako bi to trebalo izgledati. - Mapa korisničkog putovanja
Razumijevanje načina na koji vaši potrošači planiraju koristiti vaš proizvod i olakšati im to su ciljevi izrade korisničkog vodiča. Morate se potruditi da shvatite problem koji potrošač pokušava riješiti ili cilj koji pokušava postići korištenjem vašeg rješenja, kao i način na koji sudjeluju u vašem poslovanju. Možete isplanirati potrebne korake da vodite kupca kroz proces koristeći ove detalje kako biste vizualizirali njihovo putovanje 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 kreiranjem niza predložaka. Vaša procedura može biti pojednostavljena, a dosljednost bi postala mnogo realističniji cilj.
U predlošku vašeg korisničkog priručnika, osim definiranja detalja kao što su fontovi (vrsta i veličina), zahtjevi za kontrastom i sheme boja, trebali biste uključiti i sljedeće:- Područje predviđeno za uvod
- Različiti pododjeljci i odjeljci
- Vaš odabrani format za prenošenje niza radnji
- Upozorenja i upozorenja
- Područje predviđeno za zaključak
- Pišite jednostavan i lak za praćenje sadržaja
Materijal vašeg korisničkog priručnika trebao bi biti što je moguće jednostavniji i razumljiviji. 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 jasniji i kraći jezik. Pobrinite se da pravilno izmijenite svoj tekst dok ne dobijete korisnički priručnik koji sadrži samo informacije koje su zaista neophodne. - Pristupite svakom korisniku kao početnik
Pretpostavite da čitatelj vašeg korisničkog priručnika nema nikakvo prethodno znanje o vašem proizvodu kada ga kreira. Pišite kao da razgovarate sa laikom.
Treba izbjegavati svaku upotrebu žargona ili tehničkog jezika. Naravno, biće trenutaka kada se to mora izbjeći, ali to bi trebao biti apsolutni izuzetak. - Testirajte upute za proizvod s korisnicima početnicima
Faza testiranja procesa kreiranja korisničkog priručnika je ključna. Predmet eksperimenta ima značajan uticaj na ishod.
Testiranje bi se idealno trebalo obaviti na ljudima koji nikada nisu koristili vaš proizvod ili vidjeli dokumentaciju. Dok se krećete kroz korisnički priručnik, gledajte ih dok završavaju proces i bilježite gdje su zapeli. Zatim, informacije treba ažurirati na odgovarajući način.
Samo pomoć korisničkog priručnika bi trebala biti neophodna da bi vaši testeri mogli koristiti proizvod. Ne bi trebali tražiti dodatnu pomoć. Vodič za SSSR bi trebao imati sve informacije koje su im potrebne. - Izgradite sadržaj koristeći praktičan pristup
Treba učiniti sve da se ponudi beton exampi detaljni opisi bilo kakvih ishoda koje bi korisnici mogli iskusiti nakon svakog koraka u korisničkom priručniku. Korisnik bi trebao biti svjestan svake povratne informacije koju bi mogao dobiti od proizvoda, kao i svih potencijalnih prizora ili zvukova na koje bi mogao naići na putu. - Rano objasnite simbole, ikone i kodove
Možda ćete morati koristiti ikone, simbole ili kodove dok pišete korisnički priručnik kako biste pružili potrebna uputstva. Kako biste spriječili zabunu ili frustraciju čitatelja, ključno je da ih identifikujete što je ranije moguće u svom korisničkom priručniku.
Često postavljana pitanja o korisničkom priručniku
Šta su zapravo korisnički priručnici?
Korisnička dokumentacija je informacija koja se pruža u obliku korisničkih priručnika ili korisničkih vodiča i namijenjena je da pomogne krajnjim korisnicima u uspješnoj interakciji s proizvodom.
- Koje vrste korisničke dokumentacije postoje?
Fizička dokumentacija, kao što su brošure ili priručnici, tradicionalno se koristi za pružanje korisničke dokumentacije. Ovih dana, korisnički priručnici se sve češće proizvode i distribuiraju digitalno. - Šta se nalazi u korisničkim priručnicima?
Uputstvo za upotrebu ili uputstvo za upotrebu koristi dobar dizajn, jasno pisanje i fokus na rešavanje problema. Moram imati sadržaj, pridržavati se logičke hijerarhije i toka i ponuditi sadržaj koji je dostupan. Dodatno, dobar korisnički priručnik će se moći pretraživati i uzimati u obzir korisničke reviews. - Kako se pravi korisnički dokument?
Jednostavni koraci se mogu koristiti za izradu korisničkih priručnika. Prvo se moraju odrediti ciljevi korisničkog vodiča i razviti strategija koja će omogućiti njihovo postizanje. Korisnički priručnik mora biti testiran i ažuriran po potrebi prije objavljivanja. Konačno, važno je održavati korisnički vodič ažuriranim, unoseći izmjene kako se dodaju nova ažuriranja ili izdanja.