Përmbajtje

• Të shkelësh
• Pjesa 1 nga 4: Planifikimi i manualit të pronarit tuaj
• Pjesa 2 nga 4: Përfshini informacione thelbësore
• Pjesa 3 nga 4: Përshkrimi i mirëmbajtjes së produktit
• Pjesa 4 nga 4: Shkruaj një manual të lexueshëm
• Këshilla

Softueri, kompjuterat, lojërat dhe pajisjet kërkojnë manuale të përdorimit; udhëzues që shpjegojnë se si të përdoret produkti (dhe si të mos përdoret). Një manual përdorimi është një dokument zyrtar me një strukturë specifike dhe duhet të shkruhet nga dikush që e njeh produktin brenda, siç është një shkrimtar teknik ose dizajner i produktit. Shkrimi i një manuali efektiv të përdorimit kërkon që ju të dini se kush do ta përdorë produktin dhe që ta shkruani manualin duke pasur parasysh këta përdorues. Mbani shkrimet tuaja të qarta, precize dhe të thjeshta për të siguruar një përvojë përdoruesi pa sherr.

Të shkelësh

Pjesa 1 nga 4: Planifikimi i manualit të pronarit tuaj

1. Bëni një analizë të përdoruesit. Manuali i përdorimit duhet të jetë i shkruar për përdoruesit - ata që do të blejnë produktin ose shërbimin tuaj dhe do të lexojnë manualin e përdorimit. Një analizë e përdoruesit do t'ju tregojë se cili do të jetë audienca juaj kryesore ose e synuar dhe do t'ju udhëzojë përmes shkrimit të tekstit.
   • Flisni me njerëzit që do të përdorin pajisjen tuaj. Ofroni përdoruesve të provës prototipat e pajisjes dhe hartoni manualin e përdorimit në kushte të kontrolluara. Kërkojuni këtyre përdoruesve të provës për reagime për gjërat që janë të paqarta ose konfuze në udhëzuesin e përdoruesit dhe bëni ndryshime në udhëzuesin tuaj të përdorimit bazuar në këtë reagim.
   • Ju kurrë nuk mund ta kënaqni të gjithë audiencën tuaj; shkruaj manualin të përshtatur për audiencën e synuar ose audiencën më të madhe.
   • Merrni parasysh moshën, shëndetin (a kanë ndonjë sëmundje, aftësi të kufizuara në të mësuar ose paaftësi?) Dhe nivelin e arsimimit të audiencës për të përcaktuar mënyrën më të mirë për të shkruar manualin e përdorimit.
2. Koordinoni modelin e manualit të përdorimit. Nëse keni qenë pjesë e ekipit që ndihmoi në dizenjimin dhe zhvillimin e pajisjes ose produktit, mund të jetë e vështirë të hidhni një vështrim objektiv në produkt për të shpjeguar se si funksionon. Prandaj duhet të kërkoni këshillat e një shkrimtari (mundësisht dikujt me përvojë me shkrim udhëzimesh) dhe një krijuesi grafik për t'ju ndihmuar të përgatisni manualin e përdorimit. Ju mund t'i zgjidhni këta njerëz përmes një këshillimi të jashtëm ose nga kompania ose organizata juaj.
3. Bëni një analizë të detyrës. Analiza e punës është procesi i identifikimit dhe organizimit të hapave të nevojshëm për të përdorur pajisjen. Një analizë e plotë e punës identifikon materialet dhe pajisjet (të tilla si bateritë, ilaçet ose produkte të tjerë të furnizuar nga përdoruesit) të kërkuara për çdo hap, si dhe veprimet, gabimet dhe këshillat për zgjidhjen e problemeve që mund të kërkojnë secili hap.
   • Nëse keni një produkt që mund të kryejë shumë detyra ose nën detyra, duhet të kryeni një analizë detyre për secilën detyrë. Për shembull: në një makinë mund të lundroni, të rripni veten dhe të ndizni ose fikni dritat. Bëni një analizë pune për secilën nga këto, nëse është e nevojshme.
4. Sigurohuni që produkti juaj plotëson kërkesat për etiketimin dhe autorizimin e marketingut. Këto kërkesa sigurojnë që produktet të prodhohen duke patur parasysh sigurinë e përdoruesit dhe që ekspozimi i përdoruesit ndaj kushteve të rrezikshme, të tilla si rrezatimi dhe goditja nga rryma, është i kufizuar. Reklamat duhet të tregojnë qartë qëllimin dhe udhëzimet themelore të funksionimit të një produkti, dhe ju duhet t'i përdorni këto burime kur shkruani manualin e pronarit tuaj.
   • Që manuali i përdorimit të një produkti të jetë efektiv, ai duhet të shkruhet në përputhje me etiketat e vendosura direkt në produkt.
   • Sigurohuni që pajisja juaj është licencuar zyrtarisht për shitje përpara se të shkruani manualin e përdorimit.
5. Vendosni për paraqitjen e manualit tuaj. Ekzistojnë disa mënyra të rëndësishme me të cilat mund të përmirësoni manualin tuaj. Duhet të vendosni një titull të guximshëm në fillim të çdo pjese me secilën fjalë me shkronja të mëdha. Për shembull, "Konfiguroni pajisjen tuaj", "Operoni pajisjen tuaj" dhe "Zgjidhja e problemeve" të gjitha mund të jenë tituj të seksioneve të trasha.
   • Një mënyrë tjetër për të modernizuar udhëzuesin tuaj është të përdorni dy kolona, ​​njëra në të djathtë me tekst dhe tjetra vetëm në të majtë të tekstit, me plumba, numra ose ikona të vogla, të tilla si shenja paralajmëruese ose pikëçuditëse të kuqe.
   • Manuali mund të përbëhet kryesisht nga imazhe me disa tekst nën çdo imazh për të shpjeguar pajisjen, ose mund të jetë kryesisht teksti me vetëm disa imazhe shoqëruese. Ju gjithashtu mund të përdorni një diagram për të udhëhequr përdoruesin. Mendoni për produktin tuaj dhe si secila metodë mund t'ju ndihmojë të shkruani manualin tuaj. Sidoqoftë, shmangni përzierjen e paraqitjeve të ndryshme brenda një manuali. Zgjidh një dhe rri me të.

Pjesa 2 nga 4: Përfshini informacione thelbësore

1. Organizoni manualisht logjikisht. Manuali duhet të strukturohet në mënyrë të tillë që përdoruesi të përfitojë më shumë nga ai. Ndajeni manualin në kapituj ose pjesë që kanë kuptim për përdorimin e produktit dhe përfshini një tabelë të përmbajtjes në pjesën e përparme të manualit në mënyrë që secila seksion të gjendet shpejt.
   • Një tabelë e përmbajtjes është veçanërisht e nevojshme për manuale më të gjata.
   • Një fjalor ose indeks është i nevojshëm nëse ka shumë terma për të shpjeguar që audienca juaj mund të mos jetë e njohur. Sidoqoftë, një fjalor nuk rekomandohet; zgjidhja më e mirë është të shpjegoni terma konfuzë në vetë tekstin e manualit. Nëse vendosni të përfshini një fjalor, vendoseni atë në pjesën e përparme të manualit, menjëherë pas tabelës së përmbajtjes.
   • Një listë e tabelave ose figurave është e nevojshme vetëm nëse ka më shumë se disa tabela ose figura në manual.
   • Një shtojcë është e nevojshme për gjërat që duhet të shpjegohen, por nuk mund të shpjegohen diku tjetër në manual, pasi kjo mund të prishë rrjedhën dhe përqendrimin.
2. Përfshini paralajmërimet e nevojshme. Paralajmërimet e përgjithshme ose informacioni paraprak duhet të sigurojë informacion mbi rreziqet e mundshme të shkaktuara nga përdorimi jo i duhur i produktit, duke përfshirë vdekjen ose dëmtimin serioz. Këto paralajmërime duhet të vendosen në pjesën e përparme të manualit, pas faqes së parë, në mënyrë që përdoruesi t'i shohë ato së pari. Paralajmërime të veçanta duhet të përfshihen gjithashtu në tekstin e manualit menjëherë pas ose pak para se të sugjerohet një hap potencialisht i rrezikshëm.
   • Për shembull, një paralajmërim i përgjithshëm për një pajisje elektrike mund të jetë mos përdorimi i saj kur bie shi.
   • Një udhëzim specifik mund të jetë të siguroheni që të dy duart tuaja dhe pajisja janë të thata përpara se ta futni pajisjen në prizë.
   • Siguroni imazhe (të tilla si një kafkë dhe kocka kryqëzimi) ose tekst me një ngjyrë tjetër (siç është teksti i kuq) për të dalluar paralajmërimin nga udhëzimet e tjera në IFU dhe për të tërhequr vëmendjen e përdoruesve ndaj saj.
3. Përshkruani pajisjen. Përshkrimi juaj duhet të përfshijë një shpjegim me shkrim të qëllimit të pajisjes dhe një paraqitje të vogël grafike të asaj se si duket pajisja. Shifra duhet të etiketojë dhe emërtojë të gjithë ndërprerësit, butonat dhe pjesët e lidhshme që përmban pajisja.
4. Jepni udhëzime instalimi. Seksioni i instalimit duhet të përmbajë informacionin bazë se si të përgatiteni për të përdorur produktin ose pajisjen. Nëse pajisja nuk mund të ndërtohet ose vendoset nga një përdorues shtëpiak, tregojeni qartë në një titull të trashë në pjesën e sipërme të seksionit të instalimit. Ju gjithashtu duhet të përfshini sa vijon:
   • Një listë e pjesëve
   • Udhëzimet e paketimit
   • Paralajmërimet e instalimit
   • Pasojat e instalimit të pasaktë
   • Kë duhet të telefononi në rast të vështirësive gjatë instalimit
5. Jepni informacion në lidhje me operacionin. Ky seksion është pjesa më e rëndësishme e manualit të përdorimit dhe duhet të sigurojë informacion konkret, të hollësishëm se si ta përdorni pajisjen. Filloni me përgatitjen themelore për përdorimin e njësisë, siç është lidhja e kordonit të rrymës ose larja e duarve. Vazhdoni me hapa logjikë, të numëruar, duke përshkruar mënyrën e përdorimit të pajisjes, si dhe çdo reagim (për shembull, "Do të dëgjoni një klikim ...") që përdoruesi mund të presë kur e përdor pajisjen siç duhet.
   • Në fund të këtij kapitulli, përdoruesit duhet t'i referohen kapitullit të zgjidhjes së problemeve për të zgjidhur çështje që nuk mund të shpjegohen shpejt.
   • Vendosni imazhe aty ku është e nevojshme. Disa hapa shpjegohen më mirë si me figura, ashtu edhe me fjalë. Konsideroni përdorimin e fotove ose ilustrimeve në manualin tuaj.
   • Në këtë seksion, si në çdo seksion, duhet të përfshini paralajmërimet përkatëse të sigurisë në lidhje me përdorimin ose funksionimin e pahijshëm. Për shembull, mund të paralajmëroni përdoruesit e sharrave me zinxhirë që të mos pinë alkool ose të përdorin sharrë elektrike me zinxhir ndërsa janë në ilaçe të caktuara.
   • Nëse mendoni se përdoruesit do të përfitojnë, merrni parasysh përfshirjen e lidhjeve me video në internet që demonstrojnë përdorimin dhe funksionimin e duhur të pajisjes. Këto video mund t'i regjistroni ose në fillim të këtij seksioni, ose (në rastin e videove që ilustrojnë vetëm një hap) në fund të secilit hap.
6. Përfshini një përmbledhje të produktit në fund. Përmbledhja duhet të paraqitet në fund të manualit, pak para indeksit, për të siguruar hapat themelorë të funksionimit. Ky duhet të jetë një version i thjeshtuar, i hequr poshtë i informacionit operativ dhe nuk duhet të jetë më shumë se një faqe. Përmbledhni mënyrën se si do të përdoret pajisja ose produkti. Përfshini njoftimet themelore, hapat e numëruar që shpjegojnë se si të përdorni produktin dhe numrat e telefonit ose adresat e postës elektronike që drejtojnë përdoruesit të ndihmojnë.
   • Nëse prisni që përdoruesi të heqë ose t'i referohet fletës përmbledhëse shpesh, mund ta shtypni atë në një kartë të laminuar ose karton të trashë që mund të hiqet për ta bërë më të lehtë për përdorimin e bartjes dhe referimit të tij.
   • Përndryshe, ju mund të aplikoni një përmbledhje direkt në produkt për referencë të shpejtë dhe të lehtë nga përdoruesi.

Pjesa 3 nga 4: Përshkrimi i mirëmbajtjes së produktit

1. Shpjegoni se si ta pastroni pajisjen. Nëse pajisja ose produkti juaj ka nevojë për pastrim, shpjegoni se si ta bëni këtë. Renditni agjentët e pastrimit të kërkuar. Tregoni lexuesit se sa shpesh duhet të pastrojë. Pastaj, si në çdo pjesë tjetër të manualit, përfshini udhëzime të numëruara hap pas hapi se si ta pastroni atë.
   • Nëse pastrimi kërkon që produkti të çmontohet, ose të hiqet një pjesë e veçantë ose pjesë, tregoni se si duhet të çmontohet produkti.
   • Jepni një paralajmërim për rezultatet e dështimit të pastrimit të pajisjes. Për shembull, mund të thuash: "Nëse pajisja nuk pastrohet, performanca do të jetë më pak se optimale".
2. Numëroni përdoruesin se si të kryejë mirëmbajtjen themelore. Nëse produkti ose pajisja është në përdorim e përdoruesit për të korrigjuar problemet e performancës, siguroni udhëzime të numëruara se si ta bëni këtë për përdoruesin. Për shembull, nëse bateritë duhet të zëvendësohen pas çdo 300 orësh përdorimi, jepni udhëzime se si të kontrolloni nëse bateritë duhet të zëvendësohen, si të hiqni bateritë e humbura dhe si të instaloni bateritë e reja.
   • Nëse ka detyra të caktuara të mirëmbajtjes që mund të kryhen vetëm nga një teknik i çertifikuar, ndani pjesën e mirëmbajtjes së manualit në dy pjesë.
3. Diskutoni opsionet e hapësirës ruajtëse. Nëse është e nevojshme, manuali duhet të shpjegojë se si të ruani siç duhet produktin ose pajisjen. duhet të përfshini gjithashtu informacione rreth arsyes pse magazinimi është i nevojshëm dhe pasojat e magazinimit të pahijshëm. Për shembull: mund të shkruani:
   • Ruani produktin në një vend të freskët dhe të thatë. Magazinimi jo i duhur mund të shkurtojë jetën e produktit tuaj për shkak të grumbullimit të lagështisë. "
   • "Mos e ekspozoni produktin në nxehtësi ose mos e ruani në temperatura mbi 50 gradë Celsius.Nëse e bëni, mund të çojë në djegie ".
4. Jepni informacione për zgjidhjen e problemeve. Ju mund ta organizoni këtë pjesë si një listë e problemeve të zakonshme dhe zgjidhjeve të tyre. Gruponi probleme të ngjashme nën një titull logjik. Në këtë mënyrë, përdoruesit mund të gjejnë shpejt probleme specifike.
   • Për shembull, nëse ka disa probleme me kompjuterin që shfaq një ekran blu, grupojini ato nën një nëntitull, siç janë "Problemet e zakonshme të ekranit".
   • Ju gjithashtu duhet të përfshini një numër telefoni dhe / ose email për shërbimin ndaj klientit në këtë seksion.

Pjesa 4 nga 4: Shkruaj një manual të lexueshëm

1. Lexoni udhëzimet e tjera të përdoruesit. Para se të shkruani një manual për produktin tuaj, shikoni udhëzues të tjerë efektivë të përdoruesit. Kushtojini vëmendje strukturës, zgjedhjes së fjalës dhe strukturës së fjalisë. Markat kryesore si Apple, Google dhe Microsoft prodhojnë udhëzues të fortë dhe efektivë të përdorimit që mund t'ju ndihmojnë të prodhoni një udhëzues përdorimi të shkruar më me mend.
   • Mos lexo thjesht të gjitha manualet e përdorimit. Lexoni manualet për produkte të ngjashme që shesni. Për shembull, nëse shisni produkte për fëmijë, lexoni manualë për fëmijë, jo teknikë.
2. Zgjidhni standardet tuaja. Standardizimi i drejtshkrimit, zgjedhja e fjalëve dhe formulimi do ta bëjnë manualin e përdorimit më miqësor. Manuali i stilit në Chicago dhe Manuali i stilit i Microsoft mund të jenë gjithashtu udhëzues të dobishëm të stilit kur shkruani manualin e pronarit tuaj; kontrolloni të dy për të parë nëse dikush është i duhuri për manualin tuaj.
   • Për shembull, në vend që të përdorni të dy "ndërprerësin e energjisë" dhe "butonin e energjisë" në manualin tuaj, zgjidhni një nga dy termat dhe qëndroni në të.
3. Përdorni zërin aktiv. Zëri aktiv është një mënyrë e të shkruarit që shpjegon gjërat nga këndvështrimi i përdoruesit. Isshtë më lehtë të kuptohet sesa alternativa, zëri pasiv, në të cilin subjekti është i papërcaktuar.
   • Provoni Aplikacionin Hemingway (www.hemmingwayapp.com) për të identifikuar pasazhe pasive në shkrimet tuaja.
   • Studioni këto dy fjali shembull - e para është aktive dhe e dyta është pasive:
     • Duhet ta hapni paketën ngadalë dhe me kujdes.
     • Paketa duhet të hapet ngadalë dhe me kujdes.
4. Shkruaj udhëzime të numëruara. Udhëzimet e renditura në mënyrë numerike e ndihmojnë lexuesin të përqendrohet më mirë në procesin e përdorimit, lidhjes ose ndërtimit të produktit në fjalë. Në vend që të shkruani një paragraf të gjatë, me shumë fjalë ose një seri paragrafësh të panumërt, shkruani udhëzuesin tuaj të përdorimit me hapa të thjeshtë, të qartë, secili i numëruar qartë.
5. Filloni çdo hap me një domosdoshmëri. Një urdhër është një folje e orientuar drejt veprimit. Duke filluar çdo hap me një folje, ju i jepni lexuesit një aluzion për veprimin e kërkuar për të përfunduar hapin. Për shembull, në varësi të produktit për të cilin po shkruani, mund të filloni hapat tuaj me një komandë si "Lidhu", "Konfirmo" ose "Rrëshqitje". Sidoqoftë, mos filloni hapat tuaj me një përgjigje nga sistemi.
   • Për shembull, nëse ekrani kthehet në blu dhe fillon të pulsojë, mos e filloni hapin me: "Ekrani do të pulsojë dhe do të bëhet blu." Provoni: "Shtypni dhe mbani të shtypur butonin e shtëpisë. Ekrani do të pulsojë dhe do të bëhet blu. "
6. Përcaktoni cilin fjalor do të përdorni. Nëse jeni duke shkruar një manual yo-yo, audienca juaj do të jetë kryesisht fëmijë të vegjël. Përdorni fjalë dhe fjalor të thjeshtë për të shpjeguar se si funksionon yo-yo. Kur jeni duke shkruar një manual të mikroskopit elektronik të skanimit, audienca juaj përbëhet nga shkencëtarë shumë të aftë që mund të kuptojnë informacione shumë të hollësishme, prandaj mos u shmangni duke përdorur fjalor të specializuar ose shpjegime të nuancuara.
   • Në përgjithësi, ju përpiqeni të shmangni zhargonin dhe gjuhën teknike.
   • Për të qenë efektiv për një bazë sa më të gjerë të përdoruesve, përpiquni të shkruani në një nivel nga klasa e gjashtë në të shtatë të shkollës fillore.
7. Kur dërgoni një produkt jashtë shtetit, sigurohuni që përkthimet tuaja të jenë të sakta. Punësoni një përkthyes për të përkthyer manualin tuaj të përdorimit në gjuhën amtare të vendit në të cilin po dërgoni produktin tuaj. Ju gjithashtu mund të përdorni një program përkthimi në internet, por kërkoni nga një folës amtare të lexojë përkthimin dhe të kontrollojë gabimet.
   • Nëse grupe të shumta gjuhësh përfaqësohen në audiencën tuaj, ju lutemi përfshini përkthime të manualit të përdorimit në secilën gjuhë përkatëse.
   • Përkthyesi duhet të jetë i njohur me produktin pasi mund të ketë fjalë të ndryshme në gjuhën e synuar për terma specifikë që nuk janë përkthime fjalë për fjalë.
8. Shkruaj me fjali të shkurtra. Në vend të disa paragrafëve të gjatë, ju përdorni shumë paragrafë të shkurtër. Kërkoni ndërprerje logjike në secilën pjesë dhe tretni informacionin e dobishëm në copa me një ose dy fjali. E njëjta gjë është e vërtetë në nivelin e fjalisë. Mbani fjalitë tuaja të shkurtra dhe të thjeshta, në vend se të gjata dhe me fjalë.
   • Nëse një hap po vonon shumë, ndani atë në hapa më të vegjël. Kjo nuk do të zvogëlojë numrin e fjalëve, por ndërprerjet e rreshtave do ta bëjnë më të lehtë leximin.
9. Kontrolloni manualin për gabime. Një manual mund të humbasë besueshmërinë për shkak të gabimeve të gramatikës dhe drejtshkrimit. Bëni gjithashtu një koleg ose shkrimtar teknik të redaktojë dhe korrigjojë manualin gjithashtu. Përveç drejtshkrimit dhe gramatikës, një korrektor duhet t'i kushtojë vëmendje sa më poshtë:
   • Zë pasiv
   • Gjuhë e paqartë ose konfuze
   • Struktura e fjalisë së mbështjellur
   • Paragrafë tepër të gjatë

Këshilla

• Njerëzit mësojnë në mënyra të ndryshme; Nëse është e mundur dhe e përshtatshme, përfshini mjete ndihmëse vizuale ose lidhje me video në internet në manual për të akomoduar lexues të orientuar drejt shikimit.