Kuidas kirjutada selgeid ja ülevaatlikke kasutusjuhendeid

Mis on kasutusjuhend?

Kasutusjuhendil on erinevaid nimetusi. Tehnilised dokumendid, hooldusjuhendid ja kasutusjuhendid on kõik nimed, mis viitavad samale kaubale. Kasutusjuhend on koostatud selleks, et aidata klientidel teie toodet või teenust õigesti kasutada või lahendada kasutamise ajal tekkivaid probleeme. Need võivad olla saadaval trükituna, digitaalsena või mõlemas vormingus.

Kasutusjuhendid annavad lõppkasutajale põhjalikud, samm-sammult juhised ja teatud tuge probleemide lahendamiseks. Sisukord peaks olema igas kasutusjuhendis, sest need on pigem võrdlusmaterjalid kui raamatud, mida tuleks algusest lõpuni lugeda. Peaksite oma kasutusjuhendisse lisama kiirjuhendi või käivitusõpetuse, et kasutajad tunneksid end toote kasutamist alustades hõlpsalt.

tüüpi kasutusjuhendeid

Erinevate teemade ja eesmärkide jaoks saab koostada kasutusjuhendeid. Siin on mõned teie võimalused, nii et vaatame neid.

• Kasutusjuhend
  Kasutusjuhend on teatud tüüpi kasutusjuhend, mis pakub otseseid juhiseid toote kasutamiseks ettenähtud viisil.
• Koolituse käsiraamat
  Selline kasutusjuhend pakub juhiste loendit teatud ülesande, projekti või töö lõpetamiseks.
• Hooldusjuhend
  Hooldusjuhendid on kasutusjuhendid, mis kirjeldavad masinate või seadmete hooldamist ja hooldamist erinevatel seadmeteltages selle elueast.
• Kasutusjuhend
  Kasutusjuhendid on tehnilised väljaanded, mis selgitavad, kuidas toodet õigesti kasutada või kasutada.
• Kasutusjuhend
  Ettevõttele või organisatsioonile omaseid rolle, kohustusi ja protseduure kirjeldatakse kasutusjuhendites.
• Organisatsioonipoliitika käsiraamat
  Organisatsioonipoliitika käsiraamat on dokumentatsioon, mis määratleb ettevõtte poliitikad, tavad ja parimad tavad.
• Standardsete tööprotseduuride (SOP) juhend
  Kasutajad saavad kasu standardse tööprotseduuride juhendi üksikasjalikest juhistest kehtestatud protseduuride läbiviimiseks.

Miks teie ettevõte vajab kasutusjuhendit?

Inimesed on paremini varustatud probleemidega iseseisvalt toime tulema, kasutades kasutusjuhendit. Korralik kasutusjuhend võib anda teie klientidele tööriistad, mida nad vajavad kiireks ja tõhusaks teie tootelt või teenuselt soovitud väärtuse saavutamiseks tänapäevases vahetu rahulduse kultuuris.

Suurepärast klienditeenindust tuleb täiendada kasutusjuhenditega. Suurepäraste kasutusjuhendite kirjutamine annab järgmise edutages teie ettevõtte jaoks:

• Sisseastumise ja koolituse lihtsustamiseks
  Hästi kirjutatud kasutusjuhendid muudavad sisseelamise ja koolituse lihtsamaks. See on õige, tipptasemel kasutusjuhendite väljatöötamisest ja rakendamisest võidavad nii teie töötajad kui ka tarbijad.
  Teie ettevõte saab kasutada kasutusjuhendeid, et aidata uutel töötajatel läbida mõned protsessid ja süsteemid, mis on osa nende uutest rollidest, selle asemel, et korraldada ainult keerulisi isiklikke koolitusi, mis nõuavad märkimisväärseid aja- ja rahalisi kulutusi. Kuna tänu kasutusjuhenditele saavad töötajad oma ametikohaga seotud tööülesandeid täites õppida, võib pardalemineku ajal kuluda vähem tunde.
• Toetuskulude vähendamiseks
  Kasutusjuhendid on suurepärane täiendus teie klienditeeninduse jõupingutustele tarbija jaoks, kuid need teenivad ka ettevõtte omanikku ja on klienditoe süsteemi osa.
  Kui annate neile kiire juurdepääsu otsitavale kasutusjuhendile, leiavad kliendid tõenäolisemalt lahendused kohe ja neil on vähem tõenäoline, et nad peavad spetsialiseeritud toe saamiseks ühendust võtma tehniku ​​või esindajaga.
• Aja säästmiseks
  Nii teie kliendid kui ka töötajad, alates algtaseme töötajatest kuni juhtkonnani, saavad kasutusjuhendeid kasutades aega kokku hoida. Kui kasutusjuhendid on teie klientidele kättesaadavad, ei pea nad raiskama aega toote kasutamise kohta teabe leidmiseks, sest neil on sellele teabele otsene juurdepääs.
  Kui teie töötajad on varustatud kasulike kasutusjuhenditega, ei pea nad raiskama aega iseseisvalt lahenduste otsimisele ega oma töökaaslaste ja juhtide tähelepanu päringutega monopoliseerima, sest neil on juurdepääs lahendustele otse oma kasutusjuhendis!
• Vastutuse minimeerimiseks
  Üks võimalus tõestada, et olete oma toodet põhjalikult testinud ja teate, kuidas seda turvaliselt kasutada, on kasutusjuhendite kirjutamine ja levitamine. See võib oluliselt vähendada üldsusele millegi tootmisega seotud kohustusi.
  Hoiatuste ja ettevaatusabinõude kirjutamine ja kasutajatele kättesaadavaks tegemine kasutusjuhendi kaudu on tõhus (kuigi mitte lollikindel) viis vigastuste või muude väärkasutusest põhjustatud kahjudega seotud juriidiliste probleemide vältimiseks, kui müüdav toode võib kasutajatele ohtlik olla (mõelge küttekehad, elektrilised tööriistad jne).

Millised komponendid moodustavad parimad kasutusjuhendid?

Lõppkasutaja dokumenteerimisel on mõningaid parimaid tavasid, millest olenemata tuleb kinni pidada, kuigi iga toode on ainulaadne ja vajab tõeliselt suurepärase kasutajadokumentatsiooni loomiseks eraldi komponente.

1. Lihtne keel
   Miski ei ärrita teie kliente rohkem – peale selle, et seda ei pakuta –, kui avastades, et nende kasutusjuhend on täis kõnepruuki ja raskesti mõistetavat keelt. Teie kasutusjuhiseid on nende keelevalikute tõttu raske kasutada, mis samuti ei edenda silmapaistvat klienditeenindust. Suurepäraste kasutusjuhendite loomisel on oluline tagada, et kirjutate kasutajale, mitte arendajale. Ärge eeldage, et teie lõppkasutaja teab või on millegagi tuttav. Akronüümid, žargoon ja kontoriterminoloogia panevad teie kliendid tundma end valesti informeerituna, pettunud ja ette valmistamata. Kasutusjuhendi koostamise parim punkt on tasakaalu leidmine selle vahel, et te ei kirjuta nii, nagu teie tarbijad oleksid lapsed (muidugi, kui nad seda ei ole!) ja annate neile lisaabi, mida nad vajavad toote kasutamise täielikuks mõistmiseks. keel.
2. Lihtsus
   Kasutusjuhendi kirjutamine nõuab, et asjad oleksid lihtsad. See kontseptsioon peaks kajastuma nii sisus kui ka kujunduses. Kui täidate oma dokumentatsiooni keeruliste piltide ja pikkade tekstilõikudega, tundub see liiga keerukas ja raskesti mõistetav. Selline kasutusjuhend hirmutab tõenäoliselt teie kasutajat ja sunnib teda pigem teie abiliinile helistama, selle asemel, et proovida oma probleemist üksi aru saada.
3. Visuaalid
   Maksimaalne “Näita, ära ütle” on kasutusjuhendi kirjutamise nurgakivi. Märkustega ekraanipildid, filmid ja muu visuaalne sisu on mõistete mõistmisel äärmiselt abiks. Sageli on palju kasulikum midagi tegevuses näha kui selle kohta lugeda. Visuaalid mitte ainult ei purusta pikki tekstilõike, vaid vähendavad ka hirmutavat teksti hulka kasutusjuhendites. On tõestatud, et inimesed säilitavad visuaalset teavet 7% kiiremini kui kirjalikku. Techsmithi uuring näitas ka, et 67% inimestest täitsid ülesandeid tõhusamalt, kui neile anti teabe edastamiseks juhiseid, mis sisaldasid kommenteeritud ekraanipilte, mitte ainult sõnu.
4. Keskenduge lahendatavale probleemile
   On üsna tõenäoline, et keegi ostis teie toote probleemi lahendamiseks. Tootega kaasasoleva kasutusjuhendi koostamisel on oluline sellele probleemile keskenduda. Selle asemel, et loetleda ja arutada kõiki teie toote pakutavaid funktsioone või kaasatud intrigeerivaid disainielemente, teavitage oma kasutajaid neist viisil, mis hõlbustab toote kasutamist. Pange lahendatav probleem oma toote omaduste ja eeliste konteksti nende kirjeldamisel.
5. Loogiline voog ja hierarhia
   Selleks, et kasutajale selgeks teha, mida ta teie kasutusjuhendi igast jaotisest õpib, kasutage selget hierarhilist struktuuri järgivaid päiseid ja alampealkirju. Selleks, et juhtida oma kliente hõlpsalt läbi kõige vajaliku algusest lõpuni, peaks teie valitud hierarhia järgima loogilist voolu. Alustage kindlasti põhitõdedest ja lisage loogiline areng oma toote keerukamate funktsioonide poole.
6. Sisuloend
   Teie kasutusjuhend on lugejatele kõige kasulikum, kui see algab sisukorraga. Ilma, et nad peaksid kaevama läbi palju lehekülgi teavet, mis ei ole seotud praeguse probleemiga, on see tuttav lähenemisviis, mis võimaldab dokumenti kiiresti ja lihtsalt uurida.
7. Tee see otsitavaks
   Isegi kui võite oma kasutusjuhendid välja printida, on tõenäoline, et digitaalne dokumentatsioon on teie peamine prioriteet. On üsna tõenäoline, et teie kasutusjuhendeid kasutatakse kõige sagedamini digitaalsel kujul maailmas, kus enamikul inimestel on nutitelefon alati kaasas. Otsitava funktsiooni lisamine oma digitaalsetele kasutusjuhenditele muudab kasutajad, kes soovivad sellele juurdepääsu kaudu probleemi lahendada, meeldivat kasutusmugavust, sarnaselt sellele, kuidas sisukord suunab kasutajad trükitud dokumendis õigesse kohta.
8. Juurdepääsetavus
   Võimalik, et mõned inimesed, kes vajavad teie kasutusjuhendit, saavad selle nõuetekohase toimimise tagamiseks kasu täiendavast abist. Olenemata sellest, kas need on seadusega ette nähtud, on juurdepääsetavuse nõuded üldiselt head tavad. Juurdepääsetavusnõuete järgimine oma kasutusjuhendites on lihtsalt suurepärane äripraktika. Kasutusjuhendite koostamine sisuga, mis on juurdepääsetav kasutajatele, kellel võib esineda visuaalseid, kuuldavaid või kognitiivseid probleeme, on ülioluline.
9. Hästi kujundatud
   Kasutusjuhendeid koostades arvestage oma vaatajaskonnaga. Nad kasutavad seda palju rohkem tõhusalt, kui teete midagi, mida neile meeldib vaadata! Vältige pikkade tekstiplokkide kasutamist ja jätke palju tühja ruumi. Nende kahe omaduse kombineerimine võib aidata tarbijatel tunduda vähem hirmutav ja muuta uue õppimise põnevaks, mitte ähvardavaks. Varem kirjeldatud lähenemine „näita, ära ütle” kehtib ka siin. Nii trükitud kui ka digitaalsete kasutusjuhendite puhul on visuaalide ja fotode lisamine tekstile suurepärane alternatiiv. Digitaalsete kasutusjuhendite jaoks pakuvad huvi ja kasulikku elementi videod ja GIF-id. Kui teie ettevõttel on stiilijuhend, peaks teie kujundus seda järgima; muidu, kui töötate ilma selleta, on ülioluline, et teie kasutusjuhend oleks järjepidev. Kogu paberil ja ideaaljuhul kõigis teie kasutusjuhendites kasutatavad fondid ja värviskeemid peaksid olema järjepidevad.
10. Tegelike klientide või beetatestijate kommentaarid
    Te ei saa kindlaks teha, kas teie koostatud kasutusjuhendid on võimalikult edukad või mitte, enne kui olete otsinud ja kuulanud tagasisidet inimestelt, kes teie toodet tegelikult kasutavad. Kasutusjuhendid, mille oma toote jaoks välja töötate, peaksid arvestama inimeste probleemidega. Võite õppida midagi, mis tundub äärmiselt ilmne, kuid on palju suurem võimalus, et õpite midagi, mis aitab teil mõista nende klientide vajadusi, kelle poole püüate jõuda.

Kuidas kirjutada kasutusjuhendit?

Kasutusjuhendi koostamine on ülioluline ülesanne, millel võib olla suur mõju nii teie ettevõttele kui ka tarbijatele, keda soovite teenindada. Oleme kasutusjuhendi väljatöötamise protsessi lihtsustanud, et saaksite seda hõlpsalt jälgida, sest see võib olla üle jõu käiv.

• Tuvastage kasutajad
  Teie suhtluse adressaadi leidmine on esmatähtis samm, nagu iga muu suhtluse puhul. Teie kasutusjuhendi sihtrühm aitab teil otsustada selliste küsimuste üle nagu toon, esitatava üksikasjalikkuse tase ja sisu edastamine. Kasutusjuhendi kirjutamine oma toote lõppkasutajale erineb oluliselt tehnikainsenerile mõeldud juhendi kirjutamisest. Esimene samm on sihtrühma kindlaksmääramine.
• Keskenduge probleemile
  Kasutusjuhendid on loodud selleks, et aidata probleeme lahendada või juhendada kedagi, kuidas midagi uut teha. Peate täpselt kindlaks määrama, milleks teie kasutusjuhend on mõeldud, ja veenduge, et see fookus säiliks.
  Võib olla ahvatlev teemat laiendada ja arutada oma toote arvukate funktsioonide või rakenduste üle. See võib tekitada kasutajatele meelehärmi ja viia teie klienditoe liinile helistamiseni, varjutades nende nõutud ehtsa vastuse.
  Kui teie klient on tarbija, kes õpib toodet kasutama, või tehnik, kes peab seda parandama, keskenduge konkreetsele lahendusele, mida ta vajab.
• Kasutage järjestikust lähenemist
  Kasutusjuhendi juhised peaksid olema esitatud töö lõpetamiseks vajalikus järjestuses. Alustamiseks loetlege kõik sammud. Seejärel proovige ülesannet täita, järgides samal ajal täpselt etteantud järjekorras välja toodud samme. Algset loendit läbi vaadates on võimalik, võib-olla isegi tõenäoline, et leiate mõne stagneed, mis puuduvad. Lisaks võite avastada, et midagi, mida te kunagi pidasite üheks ülesandeks, tuleb selguse huvides jagada mitmeks tegevuseks.
  Veenduge, et oleksite määranud iga määratud järjestikuse etapi jaoks selge tulemuse, enne kui asute järgmisesse kasutusjuhendi kirjutamise etappi. Enne järgmisele tasemele liikumist peaksid lugejad olema täiesti selged, mida nad tahavad saavutada ja kuidas see peaks välja nägema.
• Kaardi kasutaja teekond
  Kasutusjuhendi koostamise eesmärk on mõista, kuidas teie tarbijad kavatsevad teie toodet kasutada, ja muuta see neile lihtsaks. Peate tegema jõupingutusi, et mõista probleemi, mida tarbija püüab lahendada, või eesmärki, mida ta püüab teie lahendust kasutades saavutada, ja seda, kuidas nad teie ettevõttega suhtlevad. Saate kavandada sammud, mis on vajalikud kliendi suunamiseks protsessi läbi, kasutades neid üksikasju, et visualiseerida tema teekond probleemist lahenduseni.
• Valige mall
  Kasutusjuhendite kirjutamise ja arendamise saab muuta palju lihtsamaks, kui võite oodata, luues mallide seeria. Teie protseduur võib olla sujuvam ja järjepidevus muutub palju realistlikumaks eesmärgiks.
  Lisaks selliste üksikasjade määratlemisele nagu fondid (tüüp ja suurus), kontrastinõuded ja värviskeemid, peaksite oma kasutusjuhendi malli sisaldama ka järgmist.
  • Sissejuhatuseks eraldatud ala
  • Eristavad alajaotised ja sektsioonid
  • Teie valitud vorming toimingute jada edastamiseks
  • Hoiatavad märkused ja hoiatused
  • Järelduste tegemiseks eraldatud ala
• Kirjutage lihtsat ja hõlpsasti jälgitavat sisu
  Teie kasutusjuhendi materjal peaks olema võimalikult lihtne ja arusaadav. Selguse ja mugavuse huvides on oluline vormi ja sisu läbi mõelda ja analüüsida.
  Veenduge, et protsessi iga etapp kirjeldaks ainult ühte ülesannet ja kasutaks võimalikult selget ja lühikest keelt. Muutke kindlasti oma teksti korralikult, kuni teil on kasutusjuhend, mis sisaldab ainult seda teavet, mis on tõesti vajalik.
• Lähenege igale kasutajale nagu algajale
  Oletagem, et teie kasutusjuhendi lugejal pole teie toote loomisel eelteadmisi. Kirjutage nii, nagu räägiksite võhikuga.
  Vältida tuleks žargooni või tehnilise keele kasutamist. Loomulikult tuleb aegu, mil seda tuleb vältida, kuid need peaksid olema absoluutne erand.
• Testige toote juhiseid algajate kasutajatega
  Kasutusjuhendi loomise protsessi testimise etapp on ülioluline. Eksperimendi teemal on tulemust oluline mõju.
  Ideaalis tuleks testida inimestega, kes pole kunagi teie toodet kasutanud ega dokumentatsiooni näinud. Kasutusjuhendis liikudes jälgige, kuidas nad protsessi lõpetavad, ja salvestage, kus nad kinni jäävad. Seejärel tuleks teavet asjakohaselt ajakohastada.
  Testijatel peaks toote kasutamiseks vaja minema ainult kasutusjuhendi abi. Nad ei peaks rohkem abi küsima. NSVL juhendis peaks olema kogu vajalik teave.
• Looge sisu praktilise lähenemisviisi abil
  Tuleks teha kõik, et pakkuda konkreetset eksampja üksikasjalikud kirjeldused tulemuste kohta, mida kasutajad võivad kogeda pärast kasutusjuhendi iga sammu järgimist. Kasutaja peaks olema teadlik tootelt saadavast tagasisidest, samuti võimalikest vaatamisväärsustest või helidest, mida ta teel võib kohata.
• Selgitage sümboleid, ikoone ja koode varakult
  Vajalike juhiste andmiseks peate võib-olla kasutama kasutusjuhendi kirjutamisel ikoone, sümboleid või koode. Lugejate segaduse või pettumuse vältimiseks on ülioluline need oma kasutusjuhendist võimalikult varakult välja selgitada.

Kasutusjuhendi KKK

Mis täpsemalt on kasutusjuhendid?

Kasutusdokumentatsioon on teave, mis on esitatud kasutusjuhendite või juhenditena ja mille eesmärk on aidata lõppkasutajaid tootega edukalt suhelda.

• Milliseid kasutajadokumente on olemas?
  Kasutajadokumentatsiooni pakkumiseks on traditsiooniliselt kasutatud füüsilist dokumentatsiooni, nagu brošüürid või juhendid. Tänapäeval toodetakse ja levitatakse kasutusjuhendeid sagedamini digitaalselt.
• Mida kasutusjuhendid sisaldavad?
  Kasutusjuhendis või kasutusjuhendis kasutatakse head disaini, selget kirjalikkust ja keskendumist probleemide lahendamisele. Pean omama sisukorda, järgima loogilist hierarhiat ja voogu ning pakkuma juurdepääsetavat sisu. Lisaks on hea kasutusjuhend otsitav ja võtab arvesse kasutaja reviews.
• Kuidas tehakse kasutajadokumenti?
  Kasutusjuhendite koostamiseks saab kasutada lihtsaid samme. Kasutusjuhendi eesmärgid tuleb kõigepealt kindlaks määrata ja nende elluviimiseks tuleb välja töötada strateegia. Kasutusjuhendit tuleb enne avaldamist testida ja vajadusel uuendada. Lõpuks on oluline hoida kasutusjuhendit ajakohasena, tehes muudatusi uute värskenduste või väljaannete lisamisel.