Si të shkruani manuale të qarta dhe koncize të përdoruesit
Çfarë është një manual përdorimi?
Ka emra të ndryshëm për një manual përdorimi. Dokumentet teknike, manualet e mirëmbajtjes dhe manualet e udhëzimeve janë të gjithë emra që i referohen të njëjtit artikull. Një manual përdorimi është krijuar për të ndihmuar klientët të përdorin produktin ose shërbimin tuaj në mënyrë korrekte ose të zgjidhin problemet që ndodhin gjatë përdorimit. Ato mund të jenë të disponueshme në formate të shtypura, dixhitale ose të dyja.
Manualet e përdorimit i ofrojnë përdoruesit fundor udhëzime gjithëpërfshirëse hap pas hapi dhe mbështetje për problemet. Një tabelë e përmbajtjes duhet të jetë e pranishme në çdo manual përdorimi, sepse ato janë materiale referimi dhe jo libra që duhen lexuar nga fillimi në fund. Ju duhet të shtoni një tutorial për fillimin e shpejtë ose fillimin në manualin tuaj të përdoruesit, në mënyrë që përdoruesit të mund të ndihen lehtësisht të qetë duke filluar të përdorin produktin.
llojet e manualeve të përdorimit
Për një sërë temash dhe objektivash, mund të prodhohen manuale përdoruesi. Këtu janë disa nga mundësitë tuaja, kështu që le t'i shohim ato.
- Manuali i Udhëzimeve
Një manual udhëzimi është një lloj udhëzuesi përdoruesi që ofron udhëzime të drejtpërdrejta për përdorimin e një produkti në mënyrën se si synohej të përdorej. - Manuali i Trajnimit
Ky lloj udhëzuesi përdoruesi ofron një listë udhëzimesh për përfundimin e një detyre, projekti ose pune të caktuar. - Manuali i Shërbimit
Manualet e shërbimit janë udhëzues përdoruesi që përshkruajnë se si të kujdeseni dhe mirëmbani një makineri ose pajisje në vende të ndryshmetages të jetëgjatësisë së saj. - Manuali i Përdoruesit
Manualet e përdorimit janë botime teknike që shpjegojnë se si të përdorni ose përdorni një produkt siç duhet. - Manuali i operimit
Rolet, detyrat dhe procedurat specifike për një biznes ose organizatë përshkruhen në manualet e funksionimit. - Manuali i Politikave Organizative
Një manual i politikave organizative është dokumentacioni që përcakton politikat, praktikat dhe praktikat më të mira të një kompanie. - Manuali i Procedurave Standarde të Operacionit (SOPs).
Përdoruesit përfitojnë nga udhëzimet e hollësishme të manualit të procedurave standarde të funksionimit për kryerjen e procedurave të përcaktuara.
Pse biznesi juaj ka nevojë për manuale përdoruesi?
Njerëzit janë të pajisur më mirë për të trajtuar problemet vetë me mbështetjen e një manuali përdoruesi. Një manual përdorimi i mirëfilltë mund t'u japë klientëve tuaj mjetet që u nevojiten për të arritur me shpejtësi dhe në mënyrë efektive vlerën që dëshirojnë nga produkti ose shërbimi juaj në kulturën e sotme të kënaqësisë së menjëhershme.
Shërbimi i shkëlqyer ndaj klientit duhet të plotësohet me manuale përdoruesi. Shkrimi i manualeve të shkëlqyera të përdoruesit do të sigurojë avancimin e mëposhtëmtages për kompaninë tuaj:
- Për ta bërë më të thjeshtë hyrjen dhe trajnimin
Udhëzuesit e përdoruesit të shkruar mirë mund t'i bëjnë më të thjeshta procedurat e hyrjes dhe trajnimit. Kjo është e saktë, duke zhvilluar dhe zbatuar manuale përdoruesi të nivelit më të lartë, si punonjësit, ashtu edhe konsumatorët tuaj do të përfitojnë.
Kompania juaj mund të përdorë udhëzues përdoruesi për të ndihmuar të punësuarit e rinj të kalojnë nëpër disa nga proceset dhe sistemet që janë pjesë e roleve të tyre të reja në vend që të krijojnë vetëm seanca të vështira trajnimi personalisht, të cilat kanë shpenzime të konsiderueshme kohore dhe financiare. Për shkak se punonjësit mund të mësojnë gjatë kryerjes së detyrave që lidhen me pozicionet e tyre falë udhëzuesve të përdoruesit, mund të ketë më pak orë të humbura gjatë hipjes. - Për të reduktuar shpenzimet e mbështetjes
Udhëzuesit e përdorimit janë një shtesë e shkëlqyer në përpjekjet tuaja për shërbimin ndaj klientit për konsumatorin, por ato gjithashtu i shërbejnë mirë pronarit të biznesit si një komponent i sistemit të mbështetjes së klientit.
Klientët kanë më shumë gjasa të gjejnë zgjidhje menjëherë dhe kanë më pak gjasa të kenë nevojë të kontaktojnë një teknik ose përfaqësues për mbështetje të specializuar kur u jepni atyre akses të shpejtë në një udhëzues përdoruesi të kërkueshëm. - Për të kursyer kohë
Si klientët, ashtu edhe punonjësit tuaj, nga stafi i nivelit fillestar deri te menaxhmenti, mund të kursejnë kohë duke përdorur manualet e përdoruesit. Kur manualet e përdorimit janë të disponueshme për klientët tuaj, ata nuk do të duhet të humbasin kohë duke u përpjekur të gjejnë informacione se si të përdorin një produkt, sepse ata do të kenë akses të drejtpërdrejtë në atë informacion menjëherë.
Kur punonjësit tuaj janë të pajisur me manuale të dobishme përdoruesi, ata nuk duhet të humbasin kohë në kërkim të zgjidhjeve në mënyrë të pavarur ose duke monopolizuar vëmendjen e kolegëve dhe menaxherëve të tyre me pyetje, sepse ata kanë akses në zgjidhjet pikërisht në manualin e tyre të përdorimit! - Për të minimizuar përgjegjësinë
Një mënyrë për të demonstruar se e keni testuar plotësisht produktin tuaj dhe dini se si ta përdorni në mënyrë të sigurt është të shkruani dhe shpërndani manualet e përdoruesit. Kjo mund të ulë ndjeshëm çdo detyrim që lidhet me prodhimin e diçkaje për publikun e gjerë.
Të kesh paralajmërime dhe masa paraprake sigurie të shkruara dhe të aksesueshme për përdoruesit nëpërmjet një udhëzuesi përdorimi është një mënyrë efektive (megjithëse jo e pagabueshme) për të shmangur problemet ligjore që lidhen me lëndimet ose dëmtimet e tjera të shkaktuara nga keqpërdorimi nëse produkti që shisni mund të jetë i rrezikshëm për përdoruesit (mendoni ngrohës të hapësirës, vegla elektrike, etj.).
Cilat komponentë përbëjnë manualet më të mira të përdorimit?
Ekzistojnë disa praktika më të mira të dokumentacionit të përdoruesit përfundimtar që duhet t'i përmbahen pavarësisht se çfarë, edhe pse çdo produkt është unik dhe do të ketë nevojë për komponentë të veçantë për të gjeneruar dokumentacion vërtet të shkëlqyer të përdoruesit.
- Gjuhë e thjeshtë
Asgjë nuk do t'i acarojë më shumë klientët tuaj – përveçse të mos ofroni një të tillë – sesa të zbuloni se manuali i tyre i përdorimit është i mbushur me zhargon dhe gjuhë të vështirë për t'u kuptuar. Udhëzimet tuaja të përdoruesit janë të vështira për t'u përdorur për shkak të këtyre zgjedhjeve gjuhësore, të cilat gjithashtu nuk promovojnë shërbimin e jashtëzakonshëm të klientit. Sigurimi që po shkruani për përdoruesin, jo për zhvilluesin, është një komponent thelbësor i krijimit të udhëzuesve të shkëlqyer të përdoruesit. Mos supozoni se përdoruesi juaj fundor di ose është i njohur me ndonjë gjë. Akronimet, zhargoni dhe terminologjia e zyrës do t'i bëjnë klientët tuaj të ndihen të keqinformuar, të frustruar dhe të papërgatitur. Pika e ëmbël për prodhimin e një manuali përdorimi është arritja e një ekuilibri midis mosshkrimit sikur konsumatorët tuaj janë fëmijë (përveç nëse, sigurisht, janë!) dhe dhënies së ndihmës shtesë që u nevojitet për të kuptuar plotësisht se si ta përdorin produktin, në mënyrë të thjeshtë gjuha. - Thjeshtësia
Shkrimi i një manuali përdoruesi kërkon t'i mbani gjërat të thjeshta. Ky koncept duhet të pasqyrohet si në përmbajtje ashtu edhe në dizajn. Nëse e mbingarkoni dokumentacionin tuaj me fotografi të ndërlikuara dhe pasazhe të gjata teksti, ai do të duket shumë i sofistikuar dhe i vështirë për t'u kuptuar. Ky lloj manuali i përdoruesit ka të ngjarë të frikësojë përdoruesin tuaj dhe t'i bëjë ata të telefonojnë linjën tuaj të ndihmës në vend që të përpiqen ta kuptojnë vetë problemin e tyre. - Pamje
Maksima "Trego, mos trego" është një gur themeli i shkrimit të manualit të përdoruesit. Pamjet me shënime të ekranit, filmat dhe përmbajtje të tjera vizuale janë jashtëzakonisht të dobishme për të kuptuar konceptet. Shpesh është shumë më e dobishme të shohësh diçka në veprim sesa të lexosh për të. Vizualet jo vetëm që thyejnë pjesë të gjata të tekstit, por ato gjithashtu zvogëlojnë sasinë e tekstit në manualet e përdoruesit që mund të jenë të frikshme. Është demonstruar se njerëzit e ruajnë informacionin vizual 7% më shpejt sesa informacionin e shkruar. Në një studim të Techsmith, u tregua gjithashtu se 67% e njerëzve kryenin detyrat në mënyrë më efektive kur u jepeshin udhëzime që përfshinin pamje të shënimeve të ekranit dhe jo vetëm fjalë për të përcjellë informacionin. - Përqendrohuni në problemin që duhet zgjidhur
Ka shumë të ngjarë që dikush të blejë produktin tuaj për të adresuar një problem. Është thelbësore të qëndroni të fokusuar në këtë çështje kur hartoni manualin e përdorimit që do të përfshihet me produktin. Në vend që të numëroni dhe diskutoni të gjitha veçoritë që ofron produkti juaj ose elementët intrigues të dizajnit që keni përfshirë, informoni përdoruesit tuaj për to në një mënyrë që lehtëson përdorimin e produktit. Vendoseni problemin që zgjidhet në kontekstin e veçorive dhe përfitimeve të produktit tuaj kur i përshkruani ato. - Rrjedha logjike dhe hierarkia
Për ta bërë të qartë për përdoruesin se çfarë do të mësojë nga secili seksion i manualit tuaj të përdoruesit, përdorni titujt dhe nëntitujt që ndjekin një strukturë të qartë hierarkike. Për t'i udhëhequr pa mundim klientët tuaj përmes gjithçkaje që duhet të dinë nga fillimi deri në përfundim, hierarkia që zgjidhni duhet të ndjekë një rrjedhë logjike. Sigurohuni që të filloni me bazat dhe të përfshini një përparim logjik drejt veçorive më të sofistikuara të produktit tuaj. - Lista e përmbajtjeve
Udhëzuesi juaj i përdoruesit do të jetë më i dobishëm për lexuesit nëse fillon me një tabelë të përmbajtjes. Pa pasur nevojë të gërmojë nëpër shumë faqe informacioni që nuk kanë lidhje me problemin aktual me të cilin po përballen, është një qasje e njohur për dikë që të eksplorojë shpejt dhe me lehtësi një dokument. - Bëjeni të kërkueshëm
Edhe nëse mund të printoni manualet tuaja të përdoruesit, ka të ngjarë që dokumentacioni dixhital të jetë prioriteti juaj kryesor. Ka shumë të ngjarë që manualet tuaja të përdoruesit të përdoren më shpesh në një format dixhital në një botë ku shumica e njerëzve kanë gjithmonë një smartphone me vete. Shtimi i një veçorie të kërkueshme në manualet tuaja dixhitale të përdoruesit do të promovojë një lehtësi të këndshme përdorimi për përdoruesit që kërkojnë të zgjidhin një problem duke e aksesuar atë, ngjashëm me mënyrën se si një tabelë e përmbajtjes shërben për t'i drejtuar përdoruesit në vendin e duhur në një dokument të printuar. - Aksesueshmëria
Është e mundur që disa nga njerëzit që kërkojnë manualin tuaj të përdoruesit mund të përfitojnë nga një ndihmë shtesë për të siguruar që ai të funksionojë siç duhet. Pavarësisht nëse ato kërkohen me ligj, kërkesat e aksesueshmërisë janë përgjithësisht praktikë e mirë. Ruajtja e kërkesave të aksesueshmërisë në manualet tuaja të përdoruesit është thjesht një praktikë e shkëlqyer biznesi. Krijimi i udhëzuesve të përdoruesit me përmbajtje që është e aksesueshme për përdoruesit që mund të kenë sfida vizuale, dëgjimore ose njohëse është thelbësore. - E projektuar mirë
Merrni parasysh audiencën tuaj kur krijoni udhëzuesit tuaj të përdoruesit. Ata do të jenë shumë më të prirur për ta përdorur atë në mënyrë efektive nëse bëni diçka që u pëlqen ta shikojnë! Shmangni përdorimin e blloqeve të gjata të tekstit dhe siguroni shumë hapësirë të bardhë. Kombinimi i këtyre dy karakteristikave mund t'i ndihmojë konsumatorët të duken më pak të frikshëm dhe të bëjnë të mësuarit e çdo gjëje të re të duket emocionuese dhe jo kërcënuese. Qasja "trego, mos trego" që përshkruam më herët vlen edhe këtu. Si për manualet e përdorimit të printuar ashtu edhe për ato dixhitale, shtimi i pamjeve dhe fotografive në tekst është një alternativë e shkëlqyer. Për manualet dixhitale të përdoruesit, videot dhe GIF-të ofrojnë interes dhe një element të dobishëm. Nëse kompania juaj ka një udhëzues stili, dizajni juaj duhet ta ndjekë atë; përndryshe, nëse jeni duke operuar pa një të tillë, është thelbësore ta mbani udhëzuesin tuaj të përdoruesit të qëndrueshëm. Skemat e shkronjave dhe ngjyrave të përdorura gjatë gjithë letrës, dhe në mënyrë ideale në të gjithë udhëzuesit tuaj të përdoruesit, duhet të jenë të qëndrueshme. - Komente nga klientët aktualë ose testues beta
Ju nuk do të jeni në gjendje të përcaktoni nëse udhëzuesit e përdoruesit që keni përgatitur janë ose jo aq të suksesshëm sa të jetë e mundur derisa të keni kërkuar dhe dëgjuar komentet nga njerëzit që do të përdorin në të vërtetë produktin tuaj. Udhëzuesit e përdoruesit që zhvilloni për produktin tuaj duhet të marrin parasysh problemet që njerëzit kanë me të. Ju mund të mësoni diçka që duket jashtëzakonisht e dukshme, por ka shumë mundësi më të mira që të mësoni diçka që do t'ju ndihmojë të kuptoni nevojat e klientëve që po përpiqeni të arrini.
Si mund të shkruaj një manual përdorimi?
Krijimi i një manuali përdoruesi është një detyrë thelbësore që mund të ketë një ndikim të madh si në kompaninë tuaj ashtu edhe në konsumatorët që dëshironi t'u shërbeni. Ne kemi thjeshtuar procesin e zhvillimit të një manuali përdoruesi, në mënyrë që të mund ta ndiqni lehtësisht, sepse mund të jetë dërrmues.
- Identifikoni përdoruesit
Gjetja e marrësit të komunikimit tuaj është një hap fillestar thelbësor, ashtu si me çdo komunikim tjetër që gjeneroni. Audienca e synuar e manualit tuaj të përdoruesit do t'ju ndihmojë të vendosni për çështje të tilla si toni, niveli i detajeve që duhet të jepni dhe si të jepni përmbajtjen. Shkrimi i një udhëzuesi përdorimi për përdoruesin përfundimtar të produktit tuaj është dukshëm i ndryshëm nga shkrimi i një udhëzuesi për një inxhinier teknologjie. Hapi i parë është të përcaktoni audiencën tuaj. - Përqendrohuni te problemi
Manualet e përdorimit janë bërë për të ndihmuar në zgjidhjen e problemeve ose për të udhëzuar dikë se si të bëjë diçka të re. Ju duhet të përcaktoni saktësisht se çfarë synohet të bëjë manuali juaj i përdoruesit dhe të siguroheni që ta ruani atë fokus.
Mund të jetë joshëse të zgjeroni temën dhe të diskutoni veçori ose aplikacione të shumta për produktin tuaj. Kjo mund të zhgënjejë përdoruesit dhe të çojë në telefonata në linjën tuaj të mbështetjes së klientit duke turbulluar përgjigjen e vërtetë që ata kërkojnë.
Nëse klienti juaj është një konsumator që mëson të përdorë produktin ose një teknik që duhet ta rregullojë atë, përqendrohuni në zgjidhjen e saktë që do të kërkojnë. - Përdorni një qasje sekuenciale
Udhëzimet e manualit tuaj të përdorimit duhet të vendosen në rendin vijues të nevojshëm për të përfunduar punën në fjalë. Rendisni çdo hap për të filluar. Më pas, bëni një përpjekje për të kryer detyrën duke iu përmbajtur hapave të saktë që keni përshkruar në rendin e dhënë. Ndërsa kaloni nëpër listën tuaj origjinale, është e mundur, ndoshta edhe e mundshme, që të gjeni ndonjë stage që mungojnë. Për më tepër, mund të zbuloni se diçka që dikur besonit se ishte një detyrë e vetme, në fakt duhet të ndahet në disa aktivitete për hir të qartësisë.
Sigurohuni që të keni specifikuar një rezultat të qartë për çdo hap vijues që keni caktuar përpara se të kaloni në fazën tjetër të shkrimit të një udhëzuesi përdoruesi. Përpara se të kalojnë në nivelin tjetër, lexuesit duhet të jenë plotësisht të qartë se çfarë duan të realizohet dhe si duhet të duket. - Udhëtimi i përdoruesit të hartës
Të kuptuarit se si konsumatorët tuaj planifikojnë të përdorin produktin tuaj dhe t'ua lehtësoni ta bëjnë këtë janë qëllimet e prodhimit të një udhëzuesi përdoruesi. Ju duhet të bëni përpjekje për të kuptuar çështjen që konsumatori po përpiqet të zgjidhë ose objektivin që ata po përpiqen të arrijnë duke përdorur zgjidhjen tuaj, si dhe mënyrën se si ata angazhohen me biznesin tuaj. Ju mund të planifikoni hapat e nevojshëm për të udhëhequr klientin gjatë procesit duke përdorur këto detaje për të vizualizuar udhëtimin e tyre nga problemi në zgjidhje. - Zgjidhni një shabllon
Detyra e shkrimit dhe zhvillimit të manualeve të përdoruesit mund të bëhet shumë më e thjeshtë nga sa mund të prisni duke krijuar një sërë shabllonesh. Procedura juaj mund të jetë e thjeshtë dhe konsistenca do të bëhej një objektiv shumë më realist.
Në shabllonin tuaj të manualit të përdoruesit, përveç përcaktimit të detajeve si fontet (lloji dhe madhësia), kërkesat e kontrastit dhe skemat e ngjyrave, duhet të përfshini edhe sa vijon:- Zona e caktuar për një hyrje
- Nënseksione dhe seksione të veçanta
- Formati juaj i zgjedhur për përcjelljen e një sërë veprimesh
- Shënime dhe paralajmërime paralajmëruese
- Zona e caktuar për një përfundim
- Shkruani përmbajtje të thjeshtë dhe të lehtë për t'u ndjekur
Materiali i manualit tuaj të përdorimit duhet të jetë sa më i drejtpërdrejtë dhe i thjeshtë për t'u kuptuar sa të jetë e mundur. Është e rëndësishme të mendoni dhe analizoni formatin dhe përmbajtjen për qartësi dhe lehtësi.
Sigurohuni që çdo fazë e procesit përshkruan vetëm një detyrë dhe përdor një gjuhë sa më të qartë dhe të shkurtër që të jetë e mundur. Sigurohuni që të modifikoni siç duhet tekstin tuaj derisa të keni një manual përdorimi që përmban vetëm informacionin që është vërtet i nevojshëm. - Qasuni çdo përdoruesi si një fillestar
Supozoni se lexuesi i manualit tuaj të përdorimit nuk ka njohuri paraprake për produktin tuaj kur e krijoni atë. Shkruani sikur po flisni me një laik.
Çdo përdorim i zhargonit ose gjuhës teknike duhet të shmanget. Natyrisht, do të ketë raste kur duhet shmangur, por këto duhet të jenë përjashtimi absolut. - Testoni udhëzimet e produktit me përdoruesit fillestarë
Faza e testimit të procesit të krijimit të manualit të përdoruesit është vendimtare. Tema e eksperimentit ka një ndikim të rëndësishëm në rezultatin.
Në mënyrë ideale, testimi duhet të bëhet te njerëzit që nuk e kanë përdorur kurrë produktin tuaj ose nuk e kanë parë dokumentacionin. Ndërsa kaloni nëpër manualin e përdorimit, shikoni ata teksa përfundojnë procesin dhe regjistroni se ku ngecin. Më pas, informacioni duhet të përditësohet siç duhet.
Vetëm ndihma e manualit të përdorimit duhet të jetë e nevojshme që testuesit tuaj të përdorin produktin. Ata nuk duhet të kërkojnë më shumë ndihmë. Udhëzuesi i BRSS duhet të ketë të gjithë informacionin që ata kërkojnë. - Ndërtoni përmbajtje duke përdorur një qasje praktike
Duhet bërë çdo përpjekje për të ofruar ish konkreteampmë shumë dhe përshkrime të detajuara të çdo rezultati që mund të përjetojnë përdoruesit pas çdo hapi në manualin e përdoruesit. Përdoruesi duhet të jetë i vetëdijshëm për çdo reagim që mund të marrë nga produkti, si dhe për çdo pamje ose tingull të mundshëm që mund të hasë gjatë rrugës. - Shpjegoni simbolet, ikonat dhe kodet herët
Mund t'ju duhet të përdorni ikona, simbole ose kode ndërsa shkruani një manual përdorimi për të ndihmuar në dhënien e udhëzimeve të nevojshme. Për të parandaluar konfuzionin ose zhgënjimin e lexuesit, është thelbësore t'i identifikoni këto sa më shpejt që të jetë e mundur në manualin tuaj të përdoruesit.
Pyetjet e shpeshta të manualit të përdorimit
Çfarë janë saktësisht manualet e përdoruesit?
Dokumentacioni i përdoruesit është informacion i dhënë në formën e manualeve të përdoruesit ose udhëzuesve të përdorimit dhe ka për qëllim të ndihmojë përdoruesit fundorë në ndërveprim të suksesshëm me një produkt.
- Çfarë lloje të dokumentacionit të përdoruesit ekzistojnë?
Dokumentacioni fizik, si broshurat ose manualet, është përdorur tradicionalisht për të ofruar dokumentacionin e përdoruesit. Këto ditë, manualet e përdorimit prodhohen dhe shpërndahen më shpesh në mënyrë dixhitale. - Çfarë përmban manualet e përdorimit?
Një manual udhëzimi ose udhëzues përdorimi përdor dizajn të mirë, shkrim të qartë dhe fokus në zgjidhjen e problemeve. Unë duhet të kem një tabelë të përmbajtjes, t'i përmbahem një hierarkie dhe rrjedhe logjike dhe të ofroj përmbajtje që është e arritshme. Për më tepër, një manual i mirë përdoruesi do të jetë i kërkueshëm dhe do të marrë parasysh ri-përdoruesinviews. - Si bëhet një dokument përdoruesi?
Hapat e thjeshtë mund të përdoren për të zhvilluar manualet e përdoruesit. Fillimisht duhet të përcaktohen objektivat e udhëzuesit të përdorimit dhe duhet të zhvillohet një strategji për të mundësuar përmbushjen e tyre. Manuali i përdorimit duhet të testohet dhe përditësohet sipas nevojës përpara se të publikohet. Së fundi, është e rëndësishme të mbani të përditësuar udhëzuesin e përdoruesit, duke bërë ndryshime ndërsa shtohen përditësime ose botime të reja.