Notendahandbók er yfirgripsmikil handbók sem hjálpar notendum að skilja og reka vöru eða þjónustu. Til að búa til skilvirka notendahandbók skaltu fylgja þessum skrefum:
- Skilgreindu markhópinn þinn: Tilgreindu aðalnotendur vöru þinnar eða þjónustu. Íhugaðu tæknilega þekkingu þeirra og aðlagaðu ritstíl þinn í samræmi við það.
- Komdu á framfæri tilgangi og umfangi handbókarinnar: Ákvarðaðu markmið og markmið handbókarinnar. Hvað viltu að notendur læri eða nái? Lýstu greinilega umfanginu til að tryggja að efnið sé einbeitt og viðeigandi.
- Safnaðu nauðsynlegum upplýsingum: Rannsakaðu og taktu saman allar viðeigandi upplýsingar um vöruna eða þjónustuna, þar á meðal tækniforskriftir, eiginleika, aðgerðir, bilanaleit og viðhald.
- Skipuleggðu innihaldið: Búðu til útlínur eða efnisyfirlit sem skipuleggur upplýsingarnar á rökréttan og auðveldan hátt. Íhugaðu ferðalag notandans og flokkaðu svipað efni saman.
- Skrifaðu skýrar og hnitmiðaðar leiðbeiningar: Notaðu einfalt tungumál, virka rödd og stuttar setningar til að gera innihaldið auðvelt að skilja. Forðastu hrognamál og tæknileg hugtök nema brýna nauðsyn beri til. Láttu fylgja með skref-fyrir-skref leiðbeiningar, myndir og skýringarmyndir þegar þörf krefur.
- Settu inn myndefni: Sjónræn hjálpartæki eins og myndir, skjámyndir og skýringarmyndir geta aukið skilning notandans til muna. Gakktu úr skugga um að þau séu skýr, nákvæm og merkt á viðeigandi hátt.
- Notaðu stöðugt snið og stíl: Komdu á samræmdu sniði og stíl fyrir fyrirsagnir, undirfyrirsagnir, lista og aðra þætti. Þetta hjálpar til við að bæta læsileikann og gerir handbókina fagmannlegri.
- Láttu orðalista og vísitölu fylgja með: Láttu orðalista fylgja með til að skilgreina tæknileg hugtök og vísitölu til að hjálpa notendum að finna tiltekið efni fljótt.
- Prófaðu og endurskoðaðu: Láttu hóp notenda eða samstarfsmanna endurskoðaview handbókina fyrir skýrleika, nákvæmni og notagildi. Safnaðu viðbrögðum þeirra og gerðu endurskoðun eftir þörfum.
- Prófarkalesa og breyta: Lestu handbókina vandlega fyrir málfræði-, stafsetningar- og greinarmerkjavillur. Gakktu úr skugga um að allt myndefni sé rétt staðsett og vísað til.
- Hönnun og útlit: Búðu til faglega hönnun og útlit sem er sjónrænt aðlaðandi, auðvelt að rata um og í samræmi við sjónræna auðkenni vörumerkisins þíns.
- Gefa út og dreifa: Þegar handbókinni er lokið skaltu birta hana á sniði sem er aðgengilegt notendum þínum, svo sem prentað, PDF eða hjálparkerfi á netinu. Gerðu það aðgengilegt notendum, annaðhvort sem fylgir vörunni, á þínu websíðuna, eða í gegnum þjónustuver.
Mundu að hafa notendahandbókina uppfærða eftir því sem vara þín eða þjónusta þróast. Reglulega umview og uppfærðu efnið til að tryggja að það sé áfram viðeigandi og gagnlegt.
Sniðmát
Ekki hika við að hlaða niður / afrita / nota eftirfarandi sniðmát fyrir notendahandbók:
Sniðmát fyrir Google Doc notendahandbók
Notendahandbók Sniðmát Word skjal
Sniðmát fyrir notendahandbók [OSX síður]
Aðgengi
Það er mikilvægt að búa til aðgengilega notendahandbók til að tryggja að allir notendur, þar með talið þeir sem eru með fötlun, geti notað vöruna þína eða þjónustu á áhrifaríkan hátt. Hér eru nokkur ráð um hvernig á að gera notendahandbók aðgengilegri:
Notaðu skýrt og einfalt tungumál: Forðastu hrognamál, skammstafanir og flókið hugtök. Notaðu látlaust tungumál sem auðvelt er að skilja. Stefnt er að læsileika sem hentar fjölbreyttum lestrarstigum.
Íhugaðu leturval: Notaðu leturgerðir sem auðvelt er að lesa. Sans-serif leturgerðir eins og Arial eða Verdana eru venjulega aðgengilegri. Leturstærðin ætti einnig að vera nógu stór til að lesa á þægilegan hátt, venjulega 12 punktar eða stærri.
Notaðu liti með mikla birtuskil: Texti og bakgrunnslitir ættu að hafa mikla birtuskil svo auðvelt sé að greina þá á milli. Svartur texti á hvítum bakgrunni er aðgengilegasti kosturinn.
Láttu annan texta fyrir myndir fylgja: Valtexti (alt texti) er stutt lýsing á mynd sem skjálesarar geta lesið fyrir þá sem eru með sjónskerðingu. Gakktu úr skugga um að allar myndir, skýringarmyndir eða grafík í handbókinni þinni hafi alt-texta.
Notaðu lýsandi fyrirsagnir og undirfyrirsagnir: Rétt sniðin og lýsandi fyrirsagnir og undirfyrirsagnir geta hjálpað lesendum að fletta í gegnum skjalið og skjálesarar geta notað þau til að útlista skjalaskipulagið.
Gefðu skjátexta eða afrit fyrir hljóð-/myndefni: Ef handbókin þín inniheldur hljóð- eða myndleiðbeiningar skaltu gefa skýringartexta eða afrit svo þeir sem eru með heyrnarskerðingu geti nálgast upplýsingarnar.
Gakktu úr skugga um að handbókin sé aðgengileg stafrænt: Ef handbókin er afhent stafrænt ætti hún að vera á sniði sem hægt er að lesa með hjálpartækjum. PDF skjöl, tdample, ætti að vera tagged rétt þannig að skjálesarar geti túlkað efnið nákvæmlega.
Rökrétt skipulag og stöðug leiðsögn: Uppsetning handbókarinnar ætti að vera rökrétt og samræmd, sem getur aðstoðað einstaklinga með vitræna fötlun. Þetta felur í sér að hafa efnisyfirlit, samræmd blaðsíðunúmer og auðveld leið til að fletta fram og til baka.
Gera ráð fyrir sérstillingu: Ef mögulegt er, hannaðu stafrænu handbókina þína þannig að notendur geti sérsniðið skjáinn að þörfum þeirra, svo sem að breyta textastærð eða bakgrunnslit.
Próf fyrir aðgengi: Að lokum skaltu prófa handbókina þína hjá ýmsum notendum, þar á meðal þeim sem nota hjálpartækni. Viðbrögð þeirra geta hjálpað þér að afhjúpa og laga öll aðgengisvandamál.
Að gera notendahandbókina þína aðgengilega tryggir ekki aðeins að farið sé að reglum eins og Americans with Disabilities Act (ADA), heldur bætir það einnig heildarupplifun notenda fyrir alla notendur.
Algengar spurningar
Notendahandbók leiðbeinir notendum um hvernig eigi að nota vöru eða þjónustu. Það veitir skref-fyrir-skref leiðbeiningar, ábendingar um bestu notkun, öryggisupplýsingar, viðhaldsleiðbeiningar og ráðleggingar um bilanaleit.
Aðalmarkhópur notendahandbókar er notandi vörunnar eða þjónustunnar. Hins vegar getur það einnig verið gagnlegt fyrir tæknimenn, þjónustufulltrúa og aðra sem þurfa að skilja vöruna eða þjónustuna.
Notendahandbók ætti að innihalda yfirview vörunnar eða þjónustunnar, skref-fyrir-skref leiðbeiningar um hvernig á að nota hana, öryggisráðstafanir, viðhaldsleiðbeiningar, ráðleggingar um bilanaleit, orðalista yfir skilmála og tengiliðaupplýsingar fyrir þjónustuver.
Notendahandbók ætti að vera skipulögð á rökréttan hátt sem samræmist ferðalagi notandans. Þetta þýðir oft að byrja á uppsetningar- eða uppsetningarleiðbeiningum, fara síðan yfir í grunnaðgerðir, háþróaða eiginleika, viðhald og bilanaleit.
Já, myndefni eins og skýringarmyndir, ljósmyndir og skjámyndir geta verulega aukið skilning notenda á leiðbeiningunum og gert handbókina meira aðlaðandi.
Til að gera notendahandbók auðskiljanlega skaltu nota skýrt, einfalt tungumál, sundurliða flóknum ferlum í skref-fyrir-skref leiðbeiningar, innihalda myndefni og nota snið (eins og punktalista, hausa og feitletraðan texta) til að auðkenna mikilvægar upplýsingar.
Notendahandbækur geta verið prentaðar, stafrænar (eins og PDF) eða jafnvel gagnvirkar (eins og hjálparmiðstöð á netinu). Besta sniðið fer eftir vörunni þinni, áhorfendum þínum og hvernig þeir eru líklegir til að nota handbókina.
Notendahandbók ætti að uppfæra þegar verulegar breytingar verða á vörunni, þjónustunni eða verklagsreglum. Það er líka góð hugmynd að endurskoða reglulegaview og uppfærðu handbókina til að tryggja að upplýsingarnar séu réttar og viðeigandi.
Próf eru nauðsynleg við gerð notendahandbóka til að tryggja að leiðbeiningarnar séu skýrar, nákvæmar og auðvelt að fylgja eftir. Þetta felur oft í sér að hafa raunverulega notendur eða samstarfsmenn umview handbókina og veita endurgjöf.
Til að gera notendahandbók grípandi skaltu nota vingjarnlegan samræðutón, láta myndefni fylgja með og gefa tdamples eða notkunartilvik. Íhugaðu líka að brjóta upp þéttan texta með sniði og hvítu bili til að gera hann læsilegri.
