ES dėka technologijų įmonės dabar turi pateikti savo gaminių remonto vadovus. Tačiau yra didžiulis atotrūkis tarp vadovo kūrimo ir a geras vadovas. Kai kurios įmonės (mes žiūrime į jus, Mackie) pakelia vadovą į džiaugsmingą meno formą, kuri yra tiek linksma, tiek naudinga. Kiti išmeta minimalią įmanomą dokumentaciją su tokiu pasipiktinimu, kad atrodo, kad jie nekenčia vartotojo.
Šiandien pažvelgsime į tai, kas yra geras vartotojo vadovas, ir pažvelgsime į kai kuriuos blogiausių mūsų matytų vadovų pavyzdžius. Ir kadangi šnipinėti blogus aktorius yra labai smagu, pradėkime nuo to.
„YouTube“ vaizdo įrašas nelaikomas tikru vadovu
Praėjusią savaitę norėjau sužinoti teisingą citrinmedžių trąšų dozę ir praskiedimą. Buteliukas apklijuotas visokiu tekstu, bet po solidžios minutės vartymo, bandant perskaityti mažytį šriftą, jokių nurodymų neradau. Buvo tik QR.
Jau susierzinęs nuskenavau, o nuoroda nuvedė į YouTube. Taip, turėjau žiūrėti vaizdo įrašą, kad sužinočiau, kiek vandens reikia įpilti į dangtelį skystų trąšų. Iki šiol aš pykstu. Vaizdo įrašas yra 40 sekundžių ilgio, jame nėra kalbos (tik skambanti muzika), o pirmoji pusė yra ne kas kita, kaip rinkodara. Aš esu, man sako (per ekrano tekstą) „gelbėti planetą“. Tikriausiai tai parašęs asmuo pamiršo, kad man reikia išmaniojo telefono, duomenų ryšio ir „YouTube“ serverių ūkio, kad galėčiau pamatyti vadovą, o ne tik perskaityti jį iš butelio.
Po 23 sekundžių pagaliau gavau reikalingą tekstą: 30 ml 5 litrams. Tekstas vaizdo įraše, susietas naudojant QR kodą, kuris etiketėje užima daugiau vietos nei paskutinės instrukcijos. Daugiau šio prekės ženklo nepirksiu.
Tai nereiškia, kad „YouTube“ nėra vietos remontui ir instrukcijoms. Toli nuo to. Dažnai fokusuotą vaizdo įrašą galima suprasti daug greičiau nei net geriausiai parašytą vadovą. „iFixit“ „YouTube“ kanale rodome viską, pradedant nuo multimetro naudojimo ir baigiant „iPhone 15 Pro“ baterijos keitimu. Nėra jokios priežasties, kodėl gamintojai neturėtų naudoti vaizdo įrašų norėdami parodyti, kaip taisyti savo gaminius: Baratza, kavos malūnėlių darbuotojai, sukuria puikių vaizdo įrašų, kuriuose aiškiai ir glaustai parodoma, kaip atlikti pagrindinį remontą ir techninę priežiūrą, be pūkelių pradžioje arba „patinka ir prenumeruoti“ maldavimo.
Tačiau vaizdo įrašai neturėtų pakeisti greito naudojimo etikečių, pvz., mano trąšų dozės, ir tinkamo vartotojo vadovo. PDF arba popierinius vadovus yra daug lengviau naršyti. Galite ieškoti, paryškinti, skaityti rodyklę ir turinį, kad rastumėte informacijos, net jei nežinote, ko tiksliai ieškote. Vaizdo įrašą beveik turite žiūrėti nuo pradžios iki pabaigos, kitaip galite ką nors praleisti. Jei vaizdo įrašo kūrėjas pridėjo tinkamus skyrių žymeklius, tai gali padėti, bet tekstas ir nuotraukos vis tiek yra geriausi norint greitai peršokti ir rasti tai, ko jums reikia.
Padaryti tinkamą spausdintą ar PDF vadovą nėra lengva. Reikia darbo ir įgūdžių bei tikro produkto, apie kurį rašote, ir to, kaip būsimasis savininkas gali tikėtis jį naudoti, supratimo.
Taigi, kaip tik daryti parašei gerą vadovą?
Rašymas rankiniu būdu 101
Visų pirma, jūs turite žinoti, apie ką kalbate. Tai tas pats, kas rašyti tokį straipsnį kaip šis. Jei jau daug žinau apie temą, galiu greitai ištarti 1000 žodžių, planuodamas tai eidamas. Jei to nepadarysiu, vienintelis būdas išvengti skausmo tiek man, tiek skaitytojui – pirmiausia viską ištirti. Tai dažnai reiškia, kad reikia apklausti ką nors, kas išmano šią temą. Skaityti yra gerai, bet iš tikrųjų kalbėtis su dizaineriais yra daug geriau, nes jie taip pat gali perteikti kontekstą, todėl rašytojas sutaupo daug laiko, praleisto paprasčiausiai suvokdamas temą. Taigi rankinio rašytojo darbas yra surinkti tas žinias ir paaiškinti jas taip, kad ją būtų lengva suprasti.
Aukščiau paminėjau Mackie, kompaniją, gaminančią maišytuvus, garsiakalbius ir kitą muzikos studijos ir gyvos muzikos įrangą. Mackie vadovuose yra anekdotų ir paaiškinamos ne tik neapdorotos funkcijos, bet ir pateikiami pavyzdžiai, kaip jie gali būti naudojami. Rašymo stilius taip pat lengvas ir draugiškas, neerzinantis. Gana aišku, kad jų vadovų autoriai išmano savo dalykus tiek bendrąja, tiek konkretaus produkto prasme.
Kaip priešingą pavyzdį pažvelkime į „Teenage Engineering“, Švedijos dizaino įmonę, sukūrusią keletą ikoniškų elektroninių muzikos instrumentų. OP-XY nešiojamojo sintezatoriaus / mėginių ėmimo įrenginio vadovas yra beveik kontrolinis sąrašas, ko nedaryti – jis paleistas kaip tik žiniatinklyje, o PDF versijoje nėra spustelėjamų nuorodų. Paleidimo metu kai kurios skiltys buvo visiškai neteisingos, ir net dabar, praėjus daug laiko po paleidimo, vadove trūksta daug pagrindinių funkcijų (visas MIDI diegimas) arba taip blogai paaiškinta, kad esate labiau sumišę nei prieš jį perskaitę. O ir tekstas mažas ir baltas ant juodo. Tai ypač erzina, nes „Teenage Engineering“ įdeda tiek daug dėmesio ir pastangų į savo tikrus produktus, pavyzdžiui, projektuoja gamybos liniją, kad iš prekių dalių būtų sukurtas mėginių ėmiklis.
Idealiu atveju vadovo autorius yra techninis rašytojas, kuris gerai paaiškina ir supranta produktą. Kitas geriausias dalykas yra tai, kad šis geras rašytojas glaudžiai bendradarbiauja su inžinieriais, kad viskas būtų gerai.
Trumpas ir mielas
Kita svarbi vadovo savybė – tai glaustai. Trumpas, bet ne per trumpas. Mackie vadovai čia vėl laimi. Galite perskaityti visą maišymo stalo vadovą vienu prisėdimu, galbūt išgėrę vieną puodelį kavos, bet kai baigsite, nesijaučiate, kad kažkas buvo praleista. Aš visada šiek tiek žaviuosi šiuo jų vadovų aspektu. Atrodo, kad jie ten užsiima kažkokiu TARDIS verslu.
Dalis glaustumo yra būti aišku. Aiškumas reiškia, kad nėra pūkų, jokių nukrypimų ir mažiausiai dešimties dolerių žodžių, kai tiks vieno dolerio žodžiai. Supainiotas, painus sakinys dažnai yra rašytojo nesuvokimo temos rezultatas. Norėdami paaiškinti ką nors aiškiai ir glaustai, turite tiksliai žinoti, kaip tai veikia. Jei pastebite įmantrią kalbą ir paleistinius sakinius, saugokitės: rašytojas bando užmaskuoti jų nežinojimą pūkais.
Taip pat turėtume paminėti žargoną. Geriausiu atveju žargonas yra labai veiksmingas santrumpa tarp bendraamžių. Tačiau dažnai tai tiesiog klaidina ir atstumia. Naudokite plačiai žinomą žargoną, o likusią dalį atsisakykite. Tačiau jei ketinate vartoti terminą dažnai, apibrėžkite jį iš anksto ir naudokite trumpąją versiją.
Geriausias būdas patikrinti, ar jūsų vadovas teisingai nustato šį balansą? Duokite jį perskaityti naujokui, taip pat duokite jį ekspertui. Jei naujokas tai supranta, o ekspertas neranda nieko blogo, einate teisingu keliu.
Pramoginė vertė
Vien todėl, kad jame gausu faktų ir instrukcijų, vadovas nebūtinai turi būti sausas. Tiesą sakant, aš tvirtinčiau, kad taip neturėtų būti. Geras rankinis rašytojas, kaip ir bet kuris geras rašytojas, naudoja anekdotus, realaus pasaulio pavyzdžius ir šiek tiek humoro, kad geriau perteiktų savo mintis. Mūsų iFixit tech rašymo vadove, skirtame rašyti taisymo vadovą (taip, mes turime viskam skirtus vadovus), turime visą skyrių apie rašymo stilių ir nenuostabu, kad jame gausu pavyzdžių iš Mackie vadovų.
Štai vienas iš mano mėgstamiausių. Tai paaiškina unikalią ir mėgstamą Mackie ALT 3+4 magistralę, kuri nukreipia bet kokį nutildytą maišytuvo kanalą į kur nors naudingesnę.
Dvigubos paskirties nutildymo / alt 3-4 jungiklis yra Mackie parašas. Kai Gregas kūrė mūsų pirmąjį gaminį, jis turėjo kiekvienam kanalui įtraukti nutildymo jungiklį. Nutildymo jungikliai veikia taip, kaip skamba. Jie išjungia signalą „nukreipdami“ į užmarštį. „Ei, koks švaistymas“, – samprotavo jis. „Kodėl nutildymo mygtukas nenukreiptų signalo į naudingą vietą, pavyzdžiui, į atskirą stereo magistralę?
Taigi nutildymas / alt 3-4 iš tikrųjų atlieka dvi funkcijas – nutildymą (dažnai naudojamas maišymo ar tiesioginių pasirodymų metu) ir signalo nukreipimą (keliant kelių takelių ir tiesioginį darbą), kur jis veikia kaip papildoma stereo magistralė.
Sakiau, kad tie vadovai buvo geri.
Kam jis skirtas?
Geras vadovų rašytojas pažįsta savo auditoriją. Kaip ir kalbant apie žargoną, aukščiau, jūs turite nuspręsti, kokį žinių lygį turės jūsų įprastas skaitytojas. Kas nors, perkantis akumuliatorių savo telefonui ar naujam televizoriui, gali neturėti jokių techninių žinių arba gali būti visiškas technikos specialistas. Turėsite paaiškinti dalykus, kad gautumėte žemiausią žinių lygį, o ekspertui vis tiek leiskite perskaityti, kad gautų norimą išsamią informaciją.
Žmonės, perkantys labai specializuotą įrangą, pavyzdžiui, studijos maišymo stalą, tikriausiai bent šiek tiek supras šią temą ir galėsite atitinkamai rašyti. Tai nereiškia, kad turėtumėte užpildyti tekstą akronimais. Tai taip pat nėra pasiteisinimas sudėtingiems sakiniams, kurie skaitosi kaip menas ant meno galerijos sienų. Būkite paprasta, bet žinokite, kam rašote.
Vaizdas Tobulas
Nuotraukos gali būti būtinos. Jie neturėtų pakeisti gerai parašytų instrukcijų, tačiau jie gali palengvinti paaiškinimus. Nuotraukos gali būti naudingos, ypač taisymo vadovams, tačiau yra situacijų, kai diagramos yra aiškesnės ir susitelkia ties ta vieta, kurią norite perteikti. Idealiu atveju iliustratorius ir rašytojas dirbtų kartu.
„Ikea“ surinkimo lankstinukai yra ekstremalus tik paveikslėlių vadovų pavyzdys, tikriausiai naudojamas, nes jiems nereikia jokio vertimo. Tačiau kai pripranti prie jų veikimo, IKEA vadovai bus puikūs. Jei nesutinkate, aš turiu vadovą iš lovos rėmo, kurį nusipirkau iš „Amazon“, kurį noriu jums parodyti.
Vaizdo įrašų vadovai gali puikiai papildyti rašytinį vadovą, tačiau jie niekada neturėtų būti vienintelis vadovas. Jie tinka, pavyzdžiui, norint tiksliai parodyti, kaip pasukti dalį, arba nustatyti ir diagnozuoti paslaptingus garsus.
Matydami, kiek pastangų kas nors įdeda į veržliaraktį atsukdamas dviračio pedalą, galite būti labiau įsitikinęs, kad per daug netraukiate. Be to, pavyzdžiui, gaminant majonezą, vaizdo įrašas gali būti daug geresnis nei žodžiai ar paveikslėliai, norint įvertinti pilimo greitį ir padažo tekstūrą.
Jei naudojate vaizdo įrašą, padarykite jį taip pat glaustą, kaip ir tekstą. Jokių išsamių prisistatymų, jokių kitų produktų reklamų, jokių ilgų pavadinimų sekų. Tik instrukcijos. Ir skyrių žymekliai bet kam.
Ko tikrai neturėtumėte daryti, tai įdėti QR kodą ant butelio šono ir priversti ką nors persėsti per visą „YouTube“ vaizdo įrašą, kad tik perskaitytų tekstą, kurį galėjote atspausdinti vietoje to QR kodo.
Lengva rasti
Galiausiai, jūsų vadovą turėtų būti lengva rasti. Jei jis yra jūsų svetainėje, jis turėtų būti ir palaikymo / atsisiuntimo skiltyje, ir nuoroda į produkto puslapį. Daugelis žmonių, prieš priimdami sprendimą dėl pirkimo, perskaitys vadovą.
Ir nors PDF, kuriame galima ieškoti, yra geras, internetinis vadovas turi privalumų. Pirma, galima ieškoti ir naudoti telefone (PDF failai gali būti nepatogūs mažuose ekranuose), o antra, jei sukursite atskirus tinklalapius skirtingoms vadovo skyriams, tie puslapiai bus rodomi paieškos sistemose, todėl žmonės, ieškantys atsakymų, bus nukreipti tiesiai į tinkamą vadovo puslapį.
Rolandas, kitas muzikos įrangos gamintojas, šiuo atžvilgiu gana gerai atlieka savo vadovus. Jie galimi ir kaip PDF, ir kaip HTML puslapiai su daugybe vidinių nuorodų. Taip pat galite persijungti iš vienos kalbos į kitą. Taip veikia ir mūsų pačių vadovai!
Pradedu pamėgti savo juokingą citrinmedžio trąšų buteliuką, nes tai tikrai puikus pavyzdys, kaip nedaryti visko. Jei norėjote produkto, kuris visiškai neatitinka jokių mūsų gairių, pavyzdžio, jis yra.
Nuoroda į informacijos šaltinį