Kā uzrakstīt skaidras un kodolīgas lietotāja rokasgrāmatas
Kas ir lietotāja rokasgrāmata?
Lietotāja rokasgrāmatai ir dažādi nosaukumi. Tehniskie dokumenti, apkopes rokasgrāmatas un instrukciju rokasgrāmatas ir nosaukumi, kas attiecas uz vienu un to pašu preci. Lietotāja rokasgrāmata ir izveidota, lai palīdzētu klientiem pareizi izmantot jūsu produktu vai pakalpojumu vai atrisināt problēmas, kas rodas lietošanas laikā. Tie var būt pieejami drukātā, digitālā vai abos formātos.
Lietošanas rokasgrāmatas sniedz galalietotājam visaptverošas, soli pa solim sniegtas instrukcijas un zināmu atbalstu problēmu risināšanai. Satura rādītājam ir jābūt katrā lietotāja rokasgrāmatā, jo tie ir atsauces materiāli, nevis grāmatas, kas jāizlasa no sākuma līdz beigām. Lietotāja rokasgrāmatā ir jāpievieno īss lietošanas pamācība vai palaišanas pamācība, lai lietotāji varētu justies ērti, sākot lietot produktu.
veidu lietotāja rokasgrāmatas
Par dažādiem priekšmetiem un mērķiem var izstrādāt lietotāja rokasgrāmatas. Šeit ir dažas no jūsu iespējām, tāpēc apskatīsim tās.
- Lietošanas pamācība
Lietošanas pamācība ir lietotāja rokasgrāmatas veids, kurā ir sniegti vienkārši norādījumi par produkta lietošanu tā, kā tas bija paredzēts. - Apmācības rokasgrāmata
Šāda veida lietotāja rokasgrāmata piedāvā vadlīniju sarakstu noteikta uzdevuma, projekta vai darba pabeigšanai. - Servisa rokasgrāmata
Servisa rokasgrāmatas ir lietotāja rokasgrāmatas, kurās aprakstīts, kā rūpēties un uzturēt kādu mašīnu vai aprīkojumu dažādās vietāstages no tā kalpošanas laika. - Lietotāja rokasgrāmata
Lietotāja rokasgrāmatas ir tehniskas publikācijas, kurās ir paskaidrots, kā pareizi lietot vai darbināt produktu. - Ekspluatācijas rokasgrāmata
Uzņēmumam vai organizācijai raksturīgās lomas, pienākumi un procedūras ir aprakstītas darbības rokasgrāmatās. - Organizācijas politikas rokasgrāmata
Organizācijas politikas rokasgrāmata ir dokumentācija, kas nosaka uzņēmuma politiku, praksi un labāko praksi. - Standarta darbības procedūru (SOP) rokasgrāmata
Lietotāji gūst labumu no standarta darbības procedūru rokasgrāmatas detalizētām instrukcijām noteikto procedūru veikšanai.
Kāpēc jūsu uzņēmumam ir nepieciešamas lietotāja rokasgrāmatas?
Cilvēki ir labāk sagatavoti, lai paši risinātu problēmas, izmantojot lietotāja rokasgrāmatu. Pienācīga lietotāja rokasgrāmata var sniegt jūsu klientiem nepieciešamos rīkus, lai mūsdienu tūlītējā gandarījuma kultūrā ātri un efektīvi sasniegtu jūsu produkta vai pakalpojuma vērtību.
Lieliska klientu apkalpošana ir jāpapildina ar lietotāja rokasgrāmatām. Lielisku lietotāja rokasgrāmatu rakstīšana sniegs šādu priekšrocībutages jūsu uzņēmumam:
- Lai padarītu iestāšanos un apmācību vienkāršāku
Labi uzrakstītas lietotāja rokasgrāmatas var vienkāršot uzņemšanas un apmācības procedūras. Tas ir pareizi, izstrādājot un ieviešot augstākās klases lietotāja rokasgrāmatas, ieguvēji ir gan jūsu darbinieki, gan patērētāji.
Jūsu uzņēmums var izmantot lietotāja rokasgrāmatas, lai palīdzētu jaunajiem darbiniekiem veikt dažus procesus un sistēmas, kas ir daļa no viņu jaunajām lomām, nevis tikai izveidot sarežģītas klātienes apmācības, kurām ir ievērojami laika un finanšu izdevumi. Tā kā darbinieki var mācīties, pildot pienākumus, kas saistīti ar viņu amatiem, pateicoties lietotāja rokasgrāmatām, uzņemšanas laikā var tikt zaudēts mazāk stundu. - Lai samazinātu atbalsta izdevumus
Lietotāja rokasgrāmatas ir lielisks papildinājums jūsu klientu apkalpošanas centieniem patērētājiem, taču tās kalpo arī uzņēmuma īpašniekam, kā arī klientu atbalsta sistēmas sastāvdaļai.
Klienti, visticamāk, uzreiz atradīs risinājumus, un viņiem mazāka iespēja, ka viņiem būs jāsazinās ar tehniķi vai pārstāvi, lai saņemtu specializētu atbalstu, ja jūs viņiem ātri piekļūstat meklēšanas lietotāja rokasgrāmatai. - Lai taupītu laiku
Gan jūsu klienti, gan darbinieki, sākot no sākuma līmeņa darbiniekiem līdz vadībai, var ietaupīt laiku, izmantojot lietotāja rokasgrāmatas. Kad lietotāja rokasgrāmatas ir pieejamas jūsu klientiem, viņiem nebūs jātērē laiks, lai atrastu informāciju par produkta lietošanu, jo viņiem būs tieša piekļuve šai informācijai uzreiz.
Kad jūsu darbinieki ir aprīkoti ar noderīgām lietotāja rokasgrāmatām, viņiem nav jātērē laiks, patstāvīgi meklējot risinājumus vai monopolējot savu kolēģu un vadītāju uzmanību ar jautājumiem, jo viņiem ir piekļuve risinājumiem tieši savā lietotāja rokasgrāmatā! - Lai samazinātu atbildību
Viena no metodēm, kā pierādīt, ka esat rūpīgi pārbaudījis savu produktu un zināt, kā to droši lietot, ir rakstīt un izplatīt lietotāja rokasgrāmatas. Tas var ievērojami samazināt pienākumus, kas saistīti ar kaut ko plašākai sabiedrībai.
Brīdinājumu un drošības pasākumu pierakstīšana un pieejamība lietotājiem, izmantojot lietotāja rokasgrāmatu, ir efektīvs (lai gan ne drošs) veids, kā izvairīties no juridiskām problēmām, kas saistītas ar traumām vai citiem bojājumiem, kas radušies nepareizas lietošanas rezultātā, ja jūsu pārdotais produkts var būt bīstams lietotājiem (domājiet telpu sildītāji, elektroinstrumenti utt.).
Kādi komponenti veido labākās lietotāja rokasgrāmatas?
Ir dažas galalietotāju dokumentācijas paraugprakses, kas jāievēro neatkarīgi no tā, lai gan katrs produkts ir unikāls un tam būs nepieciešami atsevišķi komponenti, lai izveidotu patiesi izcilu lietotāja dokumentāciju.
- Vienkārša valoda
Nekas vairāk nekaitinās jūsu klientus, izņemot to, ka to nepiedāvājat, kā atklājot, ka viņu lietotāja rokasgrāmata ir pārpildīta ar žargonu un grūti saprotamu valodu. Jūsu lietotāja norādījumus ir grūti izmantot šo valodu izvēles dēļ, kas arī neveicina izcilu klientu apkalpošanu. Lai nodrošinātu, ka rakstāt lietotājam, nevis izstrādātājam, ir izšķiroša nozīme lielisku lietotāja rokasgrāmatu izveidē. Nedomājiet, ka jūsu galalietotājs kaut ko zina vai zina. Akronīmi, žargons un biroja terminoloģija liks jūsu klientiem justies dezinformētiem, neapmierinātiem un nesagatavotiem. Lietotāja rokasgrāmatas izstrādes ideālā vieta ir līdzsvars starp to, ka nerakstiet tā, it kā jūsu patērētāji būtu bērni (ja vien viņi, protams, nav!), un papildu palīdzības sniegšanu, kas viņiem nepieciešama, lai pilnībā saprastu, kā lietot produktu. valodu. - Vienkāršība
Lai uzrakstītu lietotāja rokasgrāmatu, lietas ir jāsaglabā vienkārši. Šī koncepcija jāatspoguļo gan saturā, gan dizainā. Ja pārpildīsiet savu dokumentāciju ar sarežģītiem attēliem un garām teksta daļām, tā šķitīs pārāk sarežģīta un grūti saprotama. Šāda lietotāja rokasgrāmata, visticamāk, iebiedēs jūsu lietotāju un liks viņam zvanīt jūsu palīdzības dienestam, nevis mēģināt pašiem noskaidrot savu problēmu. - Vizuālie materiāli
Maksimums “Rādīt, nestāsti” ir lietotāja rokasgrāmatas rakstīšanas stūrakmens. Anotēti ekrānuzņēmumi, filmas un cits vizuālais saturs ir ārkārtīgi noderīgi, lai izprastu jēdzienus. Bieži vien ir daudz noderīgāk kaut ko redzēt darbībā, nekā lasīt par to. Vizuālie materiāli ne tikai sadala garas teksta daļas, bet arī samazina teksta daudzumu lietotāja rokasgrāmatās, kas var būt biedējoši. Ir pierādīts, ka cilvēki vizuālo informāciju saglabā par 7% ātrāk nekā rakstisko informāciju. Techsmith pētījumā arī tika parādīts, ka 67% cilvēku veica uzdevumus efektīvāk, ja viņiem tika sniegti norādījumi, kas ietvēra anotētus ekrānuzņēmumus, nevis tikai vārdus, lai sniegtu informāciju. - Koncentrējieties uz risināmo problēmu
Ļoti iespējams, ka kāds ir iegādājies jūsu produktu, lai atrisinātu problēmu. Izstrādājot lietotāja rokasgrāmatu, kas tiks pievienota izstrādājumam, ir svarīgi koncentrēties uz šo jautājumu. Tā vietā, lai uzskaitītu un apspriestu visas jūsu produkta piedāvātās funkcijas vai intriģējošos dizaina elementus, ko esat iekļāvis, informējiet lietotājus par tiem tādā veidā, kas atvieglo produkta lietošanu. Aprakstot tos, novietojiet risināmo problēmu sava produkta funkciju un priekšrocību kontekstā. - Loģiskā plūsma un hierarhija
Lai lietotājam būtu skaidrs, ko viņš iemācīsies no katras lietotāja rokasgrāmatas sadaļas, izmantojiet galvenes un apakšvirsrakstus, kas atbilst skaidrai hierarhiskai struktūrai. Lai bez piepūles iepazīstinātu klientus ar visu, kas viņiem jāzina no sākuma līdz beigām, jūsu izvēlētajai hierarhijai ir jāseko loģiskai plūsmai. Noteikti sāciet ar pamatiem un iekļaujiet loģisku virzību uz sava produkta sarežģītākām funkcijām. - Satura saraksts
Jūsu lietotāja rokasgrāmata būs visvairāk noderīga lasītājiem, ja tā sākas ar satura rādītāju. Neizrakstot daudzas informācijas lapas, kas nav saistītas ar pašreizējo problēmu, ar kuru viņi saskaras, tā ir pazīstama pieeja, kā ātri un viegli izpētīt dokumentu. - Padariet to meklējamu
Pat ja jūs varētu izdrukāt lietotāja rokasgrāmatas, visticamāk, digitālā dokumentācija būs jūsu galvenā prioritāte. Ļoti iespējams, ka jūsu lietotāja rokasgrāmatas visbiežāk tiks izmantotas digitālā formātā pasaulē, kur lielākajai daļai cilvēku vienmēr ir līdzi viedtālrunis. Meklējamas funkcijas pievienošana savām digitālajām lietotāja rokasgrāmatām veicinās apburošu lietošanas vienkāršību lietotājiem, kuri vēlas atrisināt problēmu, piekļūstot tai, līdzīgi kā satura rādītājs kalpo, lai novirzītu lietotājus uz pareizo vietu drukātā dokumentā. - Pieejamība
Iespējams, ka daži cilvēki, kuriem nepieciešama jūsu lietotāja rokasgrāmata, varētu gūt labumu no papildu palīdzības, lai nodrošinātu tās pareizu darbību. Neatkarīgi no tā, vai tās ir noteiktas likumā, pieejamības prasības parasti ir laba prakse. Pieejamības prasību ievērošana lietotāja rokasgrāmatās ir tikai lieliska uzņēmējdarbības prakse. Ļoti svarīgi ir izstrādāt lietotāja rokasgrāmatas ar saturu, kas ir pieejams lietotājiem, kuriem var būt vizuālas, dzirdamas vai kognitīvas problēmas. - Labi izstrādāts
Veidojot lietotāja rokasgrāmatas, ņemiet vērā savu auditoriju. Viņi to izmantos daudz vairāk, ja pagatavosiet kaut ko tādu, uz ko viņiem patīk skatīties! Izvairieties no garu teksta bloku izmantošanas un nodrošiniet daudz brīvas vietas. Šo divu īpašību apvienošana var palīdzēt patērētājiem šķist mazāk biedējoša un padarīt kaut ko jaunu apguvi aizraujošu, nevis draudīgu. Iepriekš aprakstītā pieeja “rādi, nestāsti” attiecas arī uz šo. Gan drukātajām, gan digitālajām lietotāja rokasgrāmatām vizuālo materiālu un fotoattēlu pievienošana tekstam ir lieliska alternatīva. Digitālajām lietotāja rokasgrāmatām videoklipi un GIF piedāvā interesi un noderīgu elementu. Ja jūsu uzņēmumam ir stila rokasgrāmata, jūsu dizainam tas ir jāievēro; pretējā gadījumā, ja strādājat bez tā, ir ļoti svarīgi saglabāt lietotāja rokasgrāmatas konsekvenci. Visā papīrā un ideālā gadījumā visās lietotāja rokasgrāmatās izmantotajām fontu un krāsu shēmām ir jābūt konsekventām. - Faktisko klientu vai beta testētāju komentāri
Jūs nevarēsit noteikt, vai jūsu sagatavotās lietotāja rokasgrāmatas ir pēc iespējas veiksmīgākas, kamēr nebūsiet noskaidrojis un uzklausījis atsauksmes no cilvēkiem, kuri faktiski izmantos jūsu produktu. Lietotāja rokasgrāmatās, ko izstrādājat savam produktam, jāņem vērā problēmas, kas cilvēkiem rodas ar to. Jūs varētu uzzināt kaut ko, kas šķiet ārkārtīgi acīmredzams, taču pastāv daudz lielāka iespēja, ka jūs uzzināsit kaut ko tādu, kas palīdzēs izprast to klientu vajadzības, kurus mēģināt sasniegt.
Kā uzrakstīt lietotāja rokasgrāmatu?
Lietotāja rokasgrāmatas izveide ir ļoti svarīgs uzdevums, kas var būtiski ietekmēt gan jūsu uzņēmumu, gan patērētājus, kurus vēlaties apkalpot. Mēs esam vienkāršojuši lietotāja rokasgrāmatas izstrādes procesu, lai jūs varētu viegli sekot līdzi, jo tas var būt satriecoši.
- Identificējiet lietotājus
Jūsu saziņas adresāta atrašana ir būtisks sākotnējais solis, tāpat kā jebkura cita jūsu izveidotā komunikācija. Lietotāja rokasgrāmatā paredzētā mērķauditorija palīdzēs jums izlemt par tādiem jautājumiem kā tonis, sniedzamā detalizācijas pakāpe un satura piegādes veids. Lietotāja rokasgrāmatas rakstīšana produkta galalietotājam būtiski atšķiras no tās rakstīšanas tehnoloģiju inženierim. Pats pirmais solis ir noteikt savu auditoriju. - Koncentrējieties uz problēmu
Lietotāja rokasgrāmatas ir paredzētas, lai palīdzētu atrisināt problēmas vai sniegt norādījumus kādam, kā darīt kaut ko jaunu. Jums precīzi jānosaka, kas ir paredzēts jūsu lietotāja rokasgrāmatai, un noteikti saglabājiet šo fokusu.
Var būt vilinoši paplašināt tēmu un apspriest daudzas jūsu produkta funkcijas vai lietojumprogrammas. Tas var apgrūtināt lietotājus un novest pie zvaniem uz jūsu klientu atbalsta līniju, aptumšojot viņiem nepieciešamo patieso atbildi.
Ja jūsu klients ir patērētājs, kurš mācās lietot produktu, vai tehniķis, kuram tas ir jāsalabo, koncentrējieties uz precīzo risinājumu, kas viņam būs nepieciešams. - Izmantojiet secīgu pieeju
Jūsu lietotāja rokasgrāmatas instrukcijas ir jāizklāsta secīgā secībā, kas nepieciešama, lai pabeigtu darbu. Uzskaitiet katru soli, lai sāktu. Pēc tam pielieciet pūles, lai izpildītu uzdevumu, vienlaikus ievērojot precīzās darbības, kuras esat norādījis norādītajā secībā. Pārskatot savu sākotnējo sarakstu, iespējams, pat iespējams, ka jūs atradīsiet jebkuru stages, kas trūkst. Turklāt jūs varētu atklāt, ka kaut kas, ko kādreiz uzskatījāt par vienu uzdevumu, skaidrības labad ir jāsadala vairākās aktivitātēs.
Pirms pāriet uz nākamo lietotāja rokasgrāmatas rakstīšanas posmu, pārliecinieties, ka esat norādījis skaidru iznākumu katram noteiktajam secīgajam solim. Pirms pāriet uz nākamo līmeni, lasītājiem ir jābūt pilnīgi skaidram par to, ko viņi vēlas paveikt un kā tam vajadzētu izskatīties. - Kartes lietotāja ceļojums
Lietotāja rokasgrāmatas izveides mērķis ir saprast, kā patērētāji plāno izmantot jūsu produktu, un atvieglot to. Jums ir jāpieliek pūles, lai izprastu problēmu, ko patērētājs mēģina atrisināt, vai mērķi, ko viņš cenšas sasniegt, izmantojot jūsu risinājumu, kā arī to, kā viņš sadarbojas ar jūsu uzņēmumu. Varat plānot darbības, kas nepieciešamas, lai klientu vadītu šajā procesā, izmantojot šo informāciju, lai vizualizētu viņa ceļu no problēmas līdz risinājumam. - Izvēlieties veidni
Lietotāja rokasgrāmatu rakstīšanas un izstrādes uzdevumu var padarīt daudz vienkāršāku, nekā jūs varētu gaidīt, izveidojot virkni veidņu. Jūsu procedūra var būt racionalizēta, un konsekvence kļūtu par daudz reālāku mērķi.
Lietotāja rokasgrāmatas veidnē papildus tādas informācijas definēšanai kā fonti (veids un izmērs), kontrasta prasības un krāsu shēmas ir jāiekļauj arī tālāk norādītā informācija.- Ievadam atvēlēta platība
- Atsevišķas apakšnodaļas un sadaļas
- Jūsu izvēlētais formāts darbību sērijas pārraidīšanai
- Brīdinājuma piezīmes un brīdinājumi
- Platība, kas atvēlēta slēdzienam
- Rakstiet vienkāršu un viegli izsekojamu saturu
Jūsu lietotāja rokasgrāmatas materiālam ir jābūt pēc iespējas vienkāršākam un vienkārši saprotamam. Skaidrības un ērtības labad ir svarīgi pārdomāt un analizēt formātu un saturu.
Pārliecinieties, ka katrā procesa fāzē ir izklāstīts tikai viens uzdevums un tiek izmantota pēc iespējas skaidrāka un īsa valoda. Pārliecinieties, ka esat pareizi mainījis tekstu, līdz jums ir lietotāja rokasgrāmata, kurā ir tikai tā informācija, kas patiešām ir nepieciešama. - Pieejiet katram lietotājam kā iesācējam
Pieņemsim, ka lietotāja rokasgrāmatas lasītājam nav priekšzināšanu par jūsu produktu, to veidojot. Rakstiet tā, it kā jūs runātu ar nespeciālistu.
Jāizvairās no žargona vai tehniskās valodas lietošanas. Protams, būs reizes, kad no tā ir jāizvairās, taču tiem vajadzētu būt absolūtam izņēmumam. - Izmēģiniet produkta norādījumus ar iesācējiem lietotājiem
Lietotāja rokasgrāmatas izveides procesa testēšanas fāze ir ļoti svarīga. Eksperimenta priekšmetam ir būtiska ietekme uz rezultātu.
Ideālā gadījumā testēšana būtu jāveic cilvēkiem, kuri nekad nav izmantojuši jūsu produktu vai redzējuši dokumentāciju. Pārskatot lietotāja rokasgrāmatu, vērojiet, kā viņi pabeidz procesu, un pierakstiet, kur tie iestrēgst. Pēc tam informācija ir atbilstoši jāatjaunina.
Lai testētāji varētu strādāt ar izstrādājumu, ir nepieciešama tikai lietotāja rokasgrāmatas palīdzība. Viņiem nevajadzētu lūgt papildu palīdzību. PSRS ceļvedī jābūt visai tai nepieciešamajai informācijai. - Veidojiet saturu, izmantojot praktisku pieeju
Jāpieliek visas pūles, lai piedāvātu konkrētu exampun detalizēti apraksti par rezultātiem, kas lietotājiem varētu rasties pēc katras lietotāja rokasgrāmatas darbības. Lietotājam ir jāapzinās visas atsauksmes, ko viņš varētu saņemt no produkta, kā arī visi iespējamie skati vai skaņas, ar kurām viņi varētu saskarties ceļā. - Agri izskaidrojiet simbolus, ikonas un kodus
Rakstot lietotāja rokasgrāmatu, iespējams, būs jāizmanto ikonas, simboli vai kodi, lai palīdzētu nodrošināt nepieciešamos norādījumus. Lai novērstu lasītāju apjukumu vai neapmierinātību, ir svarīgi tos identificēt pēc iespējas agrāk savā lietotāja rokasgrāmatā.
Lietotāja rokasgrāmatas FAQ
Kas īsti ir lietotāja rokasgrāmatas?
Lietotāja dokumentācija ir informācija, kas tiek sniegta lietotāja rokasgrāmatu vai lietotāja rokasgrāmatu veidā, un tā ir paredzēta, lai palīdzētu galalietotājiem veiksmīgi mijiedarboties ar produktu.
- Kāda veida lietotāja dokumentācija pastāv?
Fiziskā dokumentācija, piemēram, bukleti vai rokasgrāmatas, tradicionāli tiek izmantota, lai piedāvātu lietotāja dokumentāciju. Mūsdienās lietotāja rokasgrāmatas tiek ražotas un izplatītas arvien biežāk digitālā veidā. - Kas ir ietverts lietotāja rokasgrāmatās?
Instrukciju rokasgrāmatā vai lietotāja rokasgrāmatā ir izmantots labs dizains, skaidra rakstīšana un koncentrēšanās uz problēmu risināšanu. Man ir jābūt satura rādītājam, jāievēro loģiska hierarhija un plūsma, kā arī jāpiedāvā pieejams saturs. Turklāt laba lietotāja rokasgrāmata būs meklējama un ņems vērā lietotāja reviews. - Kā tiek izveidots lietotāja dokuments?
Lai izstrādātu lietotāja rokasgrāmatas, var izmantot vienkāršas darbības. Vispirms ir jānosaka lietotāja rokasgrāmatas mērķi un jāizstrādā stratēģija, lai tos varētu sasniegt. Pirms publicēšanas lietotāja rokasgrāmata ir jāpārbauda un pēc vajadzības jāatjaunina. Visbeidzot, ir svarīgi regulāri atjaunināt lietotāja rokasgrāmatu, veicot izmaiņas, kad tiek pievienoti jauni atjauninājumi vai izdevumi.