Turinys

• Žengti
• 1 dalis iš 4: Savininko vadovo planavimas
• 2 dalis iš 4: Įterpkite esminę informaciją
• 3 dalis iš 4: Produkto priežiūros aprašymas
• 4 dalis iš 4: Parašykite skaitomą vadovą
• Patarimai

Programinei įrangai, kompiuteriams, žaidimams ir įrenginiams reikalingi vartotojo vadovai; vadovai, paaiškinantys, kaip naudoti produktą (ir kaip ne). Vartotojo vadovas yra oficialus dokumentas, turintis specifinę struktūrą. Jį turi parašyti kažkas, kas žino gaminį iš vidaus, pavyzdžiui, technikos rašytojas ar produkto dizaineris. Norint parašyti veiksmingą vartotojo vadovą, reikia žinoti, kas naudos gaminį, ir kad parašytumėte vadovą atsižvelgdami į šiuos vartotojus. Rašykite, kad rašymas būtų aiškus, tikslus ir paprastas, kad vartotojui būtų be rūpesčių.

Žengti

1 dalis iš 4: Savininko vadovo planavimas

1. Atlikite vartotojo analizę. Vartotojo vadovas turėtų būti parašytas vartotojams - tiems, kurie pirks jūsų gaminį ar paslaugą ir perskaitys vartotojo vadovą. Vartotojo analizė jums pasakys, kas bus jūsų pagrindinė ar tikslinė auditorija, ir padės jums rašyti tekstą.
   • Kalbėkitės su žmonėmis, kurie naudos jūsų įrenginį. Pasiūlykite bandomiesiems naudotojams įrenginio prototipus ir vartotojo vadovo projektą kontroliuojamomis sąlygomis. Paprašykite šių bandomųjų vartotojų pateikti atsiliepimų apie neaiškius ar painius dalykus vartotojo vadove ir, remdamiesi šiais atsiliepimais, atlikite pakeitimus savo vartotojo vadove.
   • Niekada negalite patenkinti visos savo auditorijos; parašykite vadovą, pritaikytą tikslinei auditorijai arba didžiausiai auditorijai.
   • Apsvarstykite amžių, sveikatą (ar jie turi kokių nors ligų, mokymosi sutrikimų ar negalią?) Ir auditorijos išsilavinimo lygį, kad nustatytumėte geriausią požiūrį į vartotojo vadovo rašymą.
2. Koordinuoti vartotojo vadovo dizainą. Jei buvote komandos, padėjusios kurti ir tobulinti įrenginį ar gaminį, dalis, gali būti sunku objektyviai pažvelgti į produktą, kad paaiškintumėte, kaip jis veikia. Todėl turėtumėte kreiptis į rašytoją (pageidautina asmenį, turintį patirties rašant instrukcijas) ir grafikos dizainerį, kuris padėtų jums parengti vartotojo vadovą. Šiuos žmones galite pasirinkti pasitelkę išorinę konsultaciją arba iš savo įmonės ar organizacijos.
3. Atlikite užduoties analizę. Darbo analizė yra procesas, kurio metu nustatomi ir organizuojami veiksmai, reikalingi norint naudoti įrenginį. Nuodugnios darbo analizės metu nustatomos kiekvienam žingsniui reikalingos medžiagos ir įranga (pvz., Baterijos, vaistai ar kiti vartotojo tiekiami produktai), taip pat veiksmai, klaidos ir patarimai dėl trikčių šalinimo, kurių gali prireikti kiekviename žingsnyje.
   • Jei turite produktą, galintį atlikti daug skirtingų užduočių ar tarpinių užduočių, turite atlikti kiekvienos užduoties užduoties analizę. Pvz .: automobilyje galite pasigirti, prisisegti ir įjungti arba išjungti priekinius žibintus. Jei reikia, atlikite kiekvieno iš jų darbo analizę.
4. Įsitikinkite, kad jūsų produktas atitinka ženklinimo ir leidimo prekiauti reikalavimus. Šie reikalavimai užtikrina, kad gaminiai būtų gaminami atsižvelgiant į vartotojo saugumą ir kad vartotojas yra ribotas pavojingų sąlygų, tokių kaip radiacija ir elektros smūgis, poveikis. Skelbimuose turėtų būti aiškiai nurodyta produkto paskirtis ir pagrindinės naudojimo gairės, o jūs turėtumėte naudoti šiuos išteklius rašydami savininko vadovą.
   • Kad produkto vartotojo vadovas būtų veiksmingas, jis turi būti parašytas pagal etiketes, pritvirtintas tiesiai prie gaminio.
   • Prieš rašydami vartotojo vadovą įsitikinkite, kad jūsų prietaisas yra oficialiai licencijuotas pardavimui.
5. Nuspręskite savo vadovo išdėstymą. Yra keli svarbūs būdai, kaip supaprastinti vadovą. Kiekvienos dalies pradžioje turite įdėti paryškintą antraštę su kiekvienu žodžiu didžiosiomis raidėmis. Pavyzdžiui, „Nustatyti įrenginį“, „Valdyti įrenginį“ ir „Trikčių šalinimas“ gali būti paryškintos skilčių antraštės.
   • Kitas būdas supaprastinti vadovą yra naudoti du stulpelius - vieną dešinėje su tekstu, kitą - kairėje nuo teksto, su ženkleliais, skaičiais ar mažomis piktogramomis, tokiomis kaip įspėjamieji ženklai ar raudoni šauktukai.
   • Vadovą gali sudaryti daugiausia vaizdai su tekstu po kiekvienu atvaizdu, kad paaiškintumėte įrenginį, arba daugiausia tekstas su tik keliais pridedamais vaizdais. Taip pat galite naudoti srauto schemą, kad padėtumėte vartotojui. Pagalvokite apie savo produktą ir tai, kaip kiekvienas metodas gali padėti parašyti vadovą. Tačiau venkite skirtingų maketų maišymo viename vadove. Pasirinkite vieną ir laikykitės jo.

2 dalis iš 4: Įterpkite esminę informaciją

1. Logiškai sutvarkykite vadovą. Vadovas turėtų būti sukonstruotas taip, kad vartotojas gautų kuo daugiau naudos. Padalinkite vadovą į skyrius ar skyrius, kurie yra prasmingi naudojant gaminį, ir pridėkite turinio lentelę vadovo priekyje, kad kiekvieną skyrių būtų galima greitai rasti.
   • Turinio lentelė ypač reikalinga ilgesniems vadovams.
   • Žodynėlis ar rodyklė yra būtini, jei yra daugybė terminų, kurie paaiškina, kad jūsų auditorija gali būti nežinoma. Tačiau žodynėlis nerekomenduojamas; geriausias pasirinkimas yra painio vadovo tekste paaiškinti painius terminus. Jei nuspręsite įtraukti žodyną, padėkite jį vadovo priekyje, iškart po turinio.
   • Lentelių ar paveikslų sąrašas yra būtinas tik tuo atveju, jei vadove yra daugiau nei kelios lentelės ar paveikslai.
   • Priedas reikalingas dalykams, kuriuos reikia paaiškinti, bet kurių negalima paaiškinti kitur instrukcijoje, nes tai sutrikdytų srautą ir dėmesį.
2. Įtraukite būtinus įspėjimus. Bendruose įspėjimuose ar atsargumo priemonėse turėtų būti pateikta informacija apie galimus pavojus, kuriuos sukelia netinkamas produkto naudojimas, įskaitant mirtį ar sunkius sužalojimus. Šie įspėjimai turėtų būti dedami pačiame vadovo priekyje, po pirmojo puslapio, kad vartotojas juos pamatytų pirmiausia. Konkretūs įspėjimai taip pat turėtų būti įtraukti į vadovo tekstą iškart po to, kai siūloma atlikti potencialiai pavojingą veiksmą arba prieš pat jį siūlant.
   • Pavyzdžiui, bendras įspėjimas apie elektros prietaisą gali būti nenaudoti, kai lyja.
   • Konkretus nurodymas galėtų būti įsitikinti, kad rankos ir prietaisas yra sausi, prieš prijungdami prietaisą prie maitinimo lizdo.
   • Pateikite vaizdus (pvz., Kaukolę ir kryžkaulius) arba kitokios spalvos tekstą (pvz., Raudoną tekstą), kad įspėjimas būtų atskirtas nuo kitų IFU nurodytų krypčių ir atkreiptumėte į tai vartotojų dėmesį.
3. Apibūdinkite įrenginį. Aprašyme turėtų būti rašytinis prietaiso paskirties paaiškinimas ir nedidelis grafinis prietaiso išvaizdos vaizdas. Paveiksle turėtų būti pažymėti visi įrenginyje esantys jungikliai, mygtukai ir pritvirtinamos dalys.
4. Pateikite diegimo instrukcijas. Diegimo skyriuje turėtų būti pagrindinė informacija, kaip pasiruošti naudoti gaminį ar įrenginį. Jei prietaiso negali pastatyti ar pastatyti namų vartotojas, tai aiškiai nurodykite paryškinta antrašte diegimo skyriaus viršuje. Taip pat turėtumėte įtraukti:
   • Dalių sąrašas
   • Išpakavimo instrukcijos
   • Įspėjimai apie montavimą
   • Neteisingo įrengimo pasekmės
   • Kam skambinti iškilus sunkumams diegiant
5. Pateikite informaciją apie operaciją. Šis skyrius yra svarbiausia vartotojo vadovo dalis ir jame turėtų būti pateikta konkreti, išsami informacija apie tai, kaip naudotis prietaisu. Pradėkite nuo pagrindinio pasirengimo naudoti įrenginį, pavyzdžiui, prijunkite maitinimo laidą ar nusiplaukite rankas. Tęskite loginius, sunumeruotus veiksmus, apibūdinančius, kaip naudotis įrenginiu, taip pat visus atsiliepimus (pavyzdžiui, „Išgirsite paspaudimą ...“), kurių vartotojas gali tikėtis tinkamai naudodamasis įrenginiu.
   • Šio skyriaus pabaigoje vartotojai turėtų būti nukreipti į trikčių šalinimo skyrių, kad išspręstų problemas, kurių negalima greitai paaiškinti.
   • Dėkite vaizdus ten, kur reikia. Kai kuriuos veiksmus geriau paaiškinti ir paveikslėliais, ir žodžiais. Apsvarstykite nuotraukų ar iliustracijų naudojimą savo vadove.
   • Šiame skyriuje, kaip ir bet kuriame skyriuje, turėtumėte įtraukti atitinkamus saugos įspėjimus apie netinkamą naudojimą ar naudojimą. Pavyzdžiui, galite įspėti grandininių pjūklų vartotojus nevartoti alkoholio ir nenaudoti grandininių pjūklų vartodami tam tikrus vaistus.
   • Jei manote, kad vartotojams bus naudinga, apsvarstykite galimybę įtraukti nuorodas į internetinius vaizdo įrašus, parodančius tinkamą prietaiso naudojimą ir veikimą. Šiuos vaizdo įrašus galite įrašyti arba šio skyriaus pradžioje, arba (jei vaizdo įrašai iliustruoja tik vieną veiksmą) kiekvieno žingsnio pabaigoje.
6. Pabaigoje įtraukite produkto santrauką. Santrauka turėtų būti rodoma vadovo pabaigoje, prieš pat rodyklę, kad būtų pateikti pagrindiniai naudojimo veiksmai. Tai turėtų būti supaprastinta, nuimta operatyvinės informacijos versija ir būti ne daugiau kaip vienas puslapis. Apibendrinkite, kaip prietaisas ar produktas turi būti naudojamas. Įtraukite pagrindinius įspėjimus, sunumeruotus veiksmus, paaiškinančius, kaip naudoti produktą, ir telefono numerius ar el. Pašto adresus, kurie nukreipia vartotojus į pagalbą.
   • Jei tikitės, kad vartotojas dažnai pašalins suvestinės lapą arba nurodys jį, galite jį atsispausdinti ant nuimamos laminuotos kortelės arba storo kartono, kad vartotojui būtų lengviau nešiotis ir kreiptis.
   • Arba galite pritaikyti santrauką tiesiai į gaminį, kad vartotojas galėtų greitai ir lengvai jį rasti.

3 dalis iš 4: Produkto priežiūros aprašymas

1. Paaiškinkite, kaip valyti įrenginį. Jei jūsų prietaisą ar gaminį reikia valyti, paaiškinkite, kaip tai padaryti. Išvardykite reikalingas valymo priemones. Papasakokite skaitytojui, kaip dažnai valyti. Tada, kaip ir bet kurioje kitoje vadovo dalyje, įtraukite sunumeruotas žingsnis po žingsnio instrukcijas, kaip jį išvalyti.
   • Jei valant reikia išardyti gaminį arba pašalinti tam tikrą dalį ar dalis, nurodykite, kaip gaminį reikia išardyti.
   • Pateikite įspėjimą apie prietaiso neišvalymo rezultatus. Pavyzdžiui, galite pasakyti: "Jei įrenginys nebus išvalytas, našumas bus mažesnis nei optimalus".
2. Suskaičiuokite vartotoją, kaip atlikti pagrindinę priežiūrą. Jei gaminys ar įrenginys yra tinkami vartotojui, kad išspręstų našumo problemas, pateikite sunumeruotas instrukcijas, kaip tai padaryti vartotojui. Pavyzdžiui, jei reikia keisti baterijas kas 300 naudojimo valandų, pateikite instrukcijas, kaip patikrinti, ar reikia pakeisti baterijas, kaip pašalinti išsekusias baterijas ir kaip įdėti naujas.
   • Jei yra tam tikrų priežiūros užduočių, kurias gali atlikti tik sertifikuotas technikas, padalykite vadovo techninės priežiūros dalį į dvi dalis.
3. Aptarkite saugojimo galimybes. Jei reikia, vadove turėtų būti paaiškinta, kaip tinkamai laikyti gaminį ar prietaisą. taip pat turėtumėte įtraukti informaciją apie tai, kodėl saugojimas yra būtinas, ir netinkamo saugojimo pasekmes. Pavyzdžiui: galėtumėte parašyti:
   • Laikykite produktą vėsioje, sausoje vietoje. Netinkamas laikymas gali sutrumpinti jūsų produkto tarnavimo laiką dėl drėgmės kaupimosi “.
   • „Nelaikykite gaminio karštyje ir nelaikykite aukštesnėje nei 50 laipsnių Celsijaus temperatūroje.Jei taip padarysite, tai gali sukelti degimą “.
4. Pateikite trikčių šalinimo informaciją. Šį skyrių galite sutvarkyti kaip dažniausiai pasitaikančių problemų ir jų sprendimo būdų sąrašą. Grupuokite panašias problemas pagal loginę antraštę. Tokiu būdu vartotojai gali greitai rasti konkrečių problemų.
   • Pvz., Jei kyla kelios problemos, kai kompiuteris rodo mėlyną ekraną, sugrupuokite juos į paantraštę, pvz., „Dažnos ekrano problemos“.
   • Šiame skyriuje taip pat turite nurodyti klientų aptarnavimo telefono numerį ir (arba) el. Pašto adresą.

4 dalis iš 4: Parašykite skaitomą vadovą

1. Perskaitykite kitus vartotojo vadovus. Prieš rašydami savo gaminio vadovą, peržiūrėkite kitus efektyvius vartotojo vadovus. Atkreipkite dėmesį į sandarą, žodžio pasirinkimą ir sakinio struktūrą. Pagrindiniai prekės ženklai, tokie kaip „Apple“, „Google“ ir „Microsoft“, sukuria tvirtus, efektyvius vartotojo vadovus, kurie gali padėti sukurti apgalvotiau parašytą vartotojo vadovą.
   • Ne tik skaitykite visi vartotojo vadovai. Perskaitykite panašių produktų, kuriuos parduodate, vadovus. Pavyzdžiui, jei prekiaujate kūdikių produktais, skaitykite ne techninius, o kūdikių vadovus.
2. Pasirinkite savo standartus. Rašybos, žodžių pasirinkimo ir žodžių standartizavimas padarys vartotojo vadovą patogesnį. Čikagos stiliaus vadovas ir „Microsoft“ stiliaus vadovas taip pat gali būti naudingi stiliaus vadovai, rašydami savo savininko vadovą; patikrinkite abu, ar jie tinka jūsų vadovui.
   • Pavyzdžiui, užuot naudoję „maitinimo jungiklį“ ir „maitinimo mygtuką“ savo vadove, pasirinkite vieną iš dviejų terminų ir jo laikykitės.
3. Naudokitės aktyviu balsu. Aktyvus balsas yra rašymo būdas, paaiškinantis dalykus iš vartotojo perspektyvos. Tai lengviau suprasti nei alternatyva, pasyvus balsas, kuriame subjektas nėra apibrėžtas.
   • Išbandykite „Hemingway“ programą (www.hemmingwayapp.com), kad atpažintumėte pasyvius jūsų rašto fragmentus.
   • Išnagrinėkite šiuos du sakinių pavyzdžius - pirmasis yra aktyvus, o antrasis - pasyvus:
     • Pakuotę turite atidaryti lėtai ir atsargiai.
     • Pakuotę reikia atidaryti lėtai ir atsargiai.
4. Parašykite sunumeruotas instrukcijas. Skaitinės eilės nurodymai padeda skaitytojui geriau sutelkti dėmesį į nagrinėjamo gaminio naudojimą, prijungimą ar sukūrimą. Užuot parašę ilgą, išsamią pastraipą ar nenumeruotų pastraipų seriją, parašykite savo vartotojo vadovą atlikdami paprastus, aiškius veiksmus, kurių kiekvienas aiškiai sunumeruotas.
5. Kiekvieną žingsnį pradėkite imperatyvu. Imperatyvas yra veiksmo veiksmažodis. Pradėdami kiekvieną veiksmą veiksmažodžiu, jūs suteikiate skaitytojui užuominą apie veiksmą, būtiną žingsniui atlikti. Pavyzdžiui, atsižvelgiant į produktą, apie kurį rašote, galite pradėti veiksmus naudodami komandą, pvz., „Prisijungti“, „Patvirtinti“ arba „Pristatymas“. Tačiau nepradėkite savo veiksmų atsakydami iš sistemos.
   • Pavyzdžiui, jei ekranas tampa mėlynas ir pradeda mirksėti, nepradėkite šio veiksmo: „Ekranas mirksi ir taps mėlynas.“ Pabandykite: „Paspauskite ir palaikykite pagrindinį mygtuką. Ekranas mirksi ir taps mėlynas “.
6. Nustatykite, kurį žodyną naudosite. Jei rašote yo-yo vadovą, jūsų auditorija bus daugiausia maži vaikai. Norėdami paaiškinti, kaip veikia jojo, naudokite paprastus žodžius ir žodyną. Kai rašote nuskaitymo elektroninio mikroskopo vadovą, jūsų auditoriją sudaro aukštos kvalifikacijos mokslininkai, kurie gali suprasti labai išsamią informaciją, todėl nevenkite naudoti specializuoto žodyno ar niuansuotų paaiškinimų.
   • Apskritai stengiatės vengti žargono ir techninės kalbos.
   • Norėdami būti veiksmingi kuo platesnei vartotojų bazei, pabandykite rašyti nuo šeštosios iki septintosios pradinės mokyklos klasės.
7. Siunčiant produktą į užsienį, įsitikinkite, kad jūsų vertimai yra tikslūs. Pasamdykite vertėją, kad jis išverstų jūsų vartotojo vadovą į gimtąją šalies, į kurią siunčiate gaminį, kalbą. Taip pat galite naudoti internetinę vertimo programą, tačiau paprašykite gimtojo kalbėtojo perskaityti vertimą ir patikrinti, ar nėra klaidų.
   • Jei jūsų auditorijoje yra kelios kalbų grupės, įtraukite vartotojo vadovo vertimus į kiekvieną atitinkamą kalbą.
   • Vertėjas turi būti susipažinęs su produktu, nes tam tikriems terminams, kurie nėra žodiniai žodžiai, tikslinėje kalboje gali būti įvairių žodžių.
8. Rašykite trumpais sakiniais. Vietoj kelių ilgų pastraipų naudojate daug trumpų pastraipų. Kiekvienoje skiltyje ieškokite logiškų pertraukų ir naudingą informaciją suformuokite vieno ar dviejų sakinių dalimis. Tas pats pasakytina ir sakinių lygiu. Sakiniai turi būti trumpi ir paprasti, o ne ilgi ir žodingi.
   • Jei žingsnis tampa per ilgas, suskirstykite jį į mažesnius žingsnius. Tai nemažins žodžių skaičiaus, tačiau eilučių pertraukėlės palengvins skaitymą.
9. Patikrinkite, ar nėra instrukcijų, ar nėra klaidų. Vadovas gali prarasti patikimumą dėl gramatikos ir rašybos klaidų. Taip pat paprašykite kolegos ar technikos rašytojo redaguoti ir koreguoti vadovą. Be rašybos ir gramatikos, korektorius turėtų atkreipti dėmesį į šiuos dalykus:
   • Pasyvus balsas
   • Neaiški ar paini kalba
   • Apvyniota sakinio struktūra
   • Per ilgos pastraipos

Patarimai

• Žmonės mokosi įvairiai; Jei įmanoma ir tinkama, į vadovą įtraukite vaizdines priemones arba nuorodas į internetinius vaizdo įrašus, kad tilptų į vizualiai orientuotus skaitytojus.