Saturs

• Lai soli
• 1. daļa no 4: Īpašnieka rokasgrāmatas plānošana
• 2. daļa no 4: Iegult būtisku informāciju
• 3. daļa no 4: Produkta apkopes apraksts
• 4. daļa no 4: Uzrakstiet lasāmu rokasgrāmatu
• Padomi

Programmatūrai, datoriem, spēlēm un ierīcēm nepieciešamas lietotāja rokasgrāmatas; rokasgrāmatas, kurās paskaidrots, kā lietot produktu (un kā to nelietot). Lietotāja rokasgrāmata ir oficiāls dokuments ar noteiktu struktūru, un tā jāraksta personai, kura zina produktu no iekšpuses, piemēram, tehniskajam rakstniekam vai produkta dizainerim. Lai rakstītu efektīvu lietotāja rokasgrāmatu, ir jāzina, kas izmantos izstrādājumu, un rakstāt rokasgrāmatu, domājot par šiem lietotājiem. Saglabājiet savu rakstīšanu skaidru, precīzu un vienkāršu, lai nodrošinātu bezrūpīgu lietotāja pieredzi.

Lai soli

1. daļa no 4: Īpašnieka rokasgrāmatas plānošana

1. Veiciet lietotāju analīzi. Lietotāja rokasgrāmata ir jāuzraksta lietotājiem - tiem, kas iegādāsies jūsu produktu vai pakalpojumu un izlasīs lietotāja rokasgrāmatu. Lietotāju analīze jums pateiks, kas būs jūsu galvenā vai mērķauditorija, un palīdzēs jums rakstīt tekstu.
   • Runājiet ar cilvēkiem, kuri izmantos jūsu ierīci. Piedāvājiet lietotājiem testa ierīces prototipus un lietotāja rokasgrāmatas projektu kontrolētos apstākļos. Jautājiet šiem testa lietotājiem atsauksmes par lietām, kas lietotāja rokasgrāmatā ir neskaidras vai neskaidras, un, pamatojoties uz šīm atsauksmēm, veiciet izmaiņas lietotāja rokasgrāmatā.
   • Jūs nekad nevarat apmierināt visu savu auditoriju; uzrakstiet rokasgrāmatu, kas pielāgota mērķauditorijai vai lielākajai auditorijai.
   • Apsveriet vecumu, veselību (vai viņiem ir kādas slimības, mācīšanās vai invaliditātes?) Un auditorijas izglītības līmeni, lai noteiktu labāko pieeju lietotāja rokasgrāmatas rakstīšanai.
2. Koordinēt lietotāja rokasgrāmatas dizainu. Ja jūs esat daļa no komandas, kas palīdzēja izstrādāt vai attīstīt ierīci vai produktu, var būt grūti objektīvi apskatīt produktu, lai izskaidrotu, kā tas darbojas. Tāpēc jums vajadzētu lūgt rakstnieka (vēlams, kāda ir pieredze ar instrukciju rakstīšanas pieredzi) un grafiskā dizainera padomu, lai palīdzētu jums sagatavot lietotāja rokasgrāmatu. Šos cilvēkus jūs varētu izvēlēties, izmantojot ārēju konsultāciju vai no sava uzņēmuma vai organizācijas.
3. Veiciet uzdevuma analīzi. Darba analīze ir process, kas nosaka un organizē ierīces izmantošanai nepieciešamās darbības. Veicot rūpīgu darba analīzi, tiek identificēti materiāli un aprīkojums (piemēram, baterijas, zāles vai citi lietotāja piegādāti produkti), kas nepieciešami katram solim, kā arī darbības, kļūdas un padomi par problēmu novēršanu, kas varētu būt nepieciešami katram solim.
   • Ja jums ir produkts, kas var izpildīt daudz un dažādus uzdevumus vai apakšuzdevumus, katram uzdevumam jāveic uzdevuma analīze. Piemēram: automašīnā jūs varat uzvilkt, piesprādzēties un ieslēgt vai izslēgt lukturus. Ja nepieciešams, veiciet darba analīzi katram no šiem.
4. Pārliecinieties, ka jūsu produkts atbilst marķēšanas un tirdzniecības atļaujas prasībām. Šīs prasības nodrošina, ka izstrādājumi tiek ražoti, ņemot vērā lietotāja drošību un ka lietotāja iedarbība uz bīstamiem apstākļiem, piemēram, radiāciju un elektrotraumu, ir ierobežota. Reklāmās skaidri jānorāda produkta mērķis un darbības pamatnostādnes, un šie resursi jāizmanto, rakstot īpašnieka rokasgrāmatu.
   • Lai produkta lietotāja rokasgrāmata būtu efektīva, tā ir jāraksta saskaņā ar etiķetēm, kas piestiprinātas tieši pie produkta.
   • Pirms lietotāja rokasgrāmatas rakstīšanas pārliecinieties, vai ierīce ir oficiāli licencēta pārdošanai.
5. Izlemiet rokasgrāmatas izkārtojumu. Ir vairāki svarīgi veidi, kā pilnveidot rokasgrāmatu. Katras sadaļas sākumā ir jāievieto treknrakstā virsraksts ar katru vārdu lielajiem burtiem. Piemēram, “Ierīces iestatīšana”, “Darbiniet ierīci” un “Problēmu novēršana” var būt treknrakstā sadaļu virsraksti.
   • Vēl viens veids, kā vienkāršot ceļvedi, ir divu kolonnu izmantošana: viena pa labi ar tekstu un otra pa kreisi no teksta ar aizzīmēm, cipariem vai mazām ikonām, piemēram, brīdinājuma zīmēm vai sarkanām izsaukuma zīmēm.
   • Rokasgrāmata var sastāvēt galvenokārt no attēliem ar tekstu zem katra attēla, lai izskaidrotu ierīci, vai arī galvenokārt tekstā ar tikai dažiem pavadošiem attēliem. Lietotāja vadīšanai varat izmantot arī blokshēmu. Padomājiet par savu produktu un to, kā katra metode var palīdzēt rakstīt rokasgrāmatu. Tomēr izvairieties no dažādu izkārtojumu sajaukšanas vienā rokasgrāmatā. Izvēlieties vienu un pielīmējiet to.

2. daļa no 4: Iegult būtisku informāciju

1. Organizējiet rokasgrāmatu loģiski. Rokasgrāmatai jābūt strukturētai tā, lai lietotājs no tās gūtu vislielāko labumu. Sadaliet rokasgrāmatu nodaļās vai sadaļās, kurās ir jēga izmantot izstrādājumu, un rokasgrāmatas priekšpusē pievienojiet satura rādītāju, lai katru sadaļu varētu ātri atrast.
   • Satura rādītājs ir īpaši nepieciešams garākām rokasgrāmatām.
   • Vārdnīca vai rādītājs ir vajadzīgs, ja ir daudz vārdu, kas paskaidro, ka auditorija, iespējams, nav pazīstama. Tomēr glosārijs nav ieteicams; labākā izvēle ir izskaidrot neskaidros terminus pašā rokasgrāmatas tekstā. Ja izvēlaties iekļaut glosāriju, ievietojiet to rokasgrāmatas priekšpusē, tieši aiz satura rādītāja.
   • Tabulu vai attēlu saraksts ir nepieciešams tikai tad, ja rokasgrāmatā ir vairāk nekā dažas tabulas vai attēli.
   • Pielikums ir nepieciešams lietām, kuras jāskaidro, bet kuras nav izskaidrojamas citur rokasgrāmatā, jo tas traucētu plūsmu un fokusu.
2. Iekļaujiet nepieciešamos brīdinājumus. Vispārējiem brīdinājumiem vai piesardzības informācijai jāsniedz informācija par iespējamiem apdraudējumiem, ko rada nepareiza produkta lietošana, tostarp par nāvi vai nopietniem ievainojumiem. Šie brīdinājumi jānovieto pašā rokasgrāmatas priekšpusē, pēc pirmās lapas, lai lietotājs tos redzētu vispirms. Īpaši brīdinājumi jāiekļauj rokasgrāmatas tekstā tieši pēc vai tieši pirms potenciāli bīstama soļa ierosināšanas.
   • Piemēram, vispārējs brīdinājums par elektroierīci varētu būt tās nelietošana lietus laikā.
   • Īpaša instrukcija varētu būt pārliecināties, ka rokas un ierīce ir sausa, pirms ierīci pievienojat strāvas kontaktligzdai.
   • Nodrošiniet attēlus (piemēram, galvaskausu un krustu kaulus) vai citas krāsas tekstu (piemēram, sarkanu tekstu), lai atšķirtu brīdinājumu no pārējiem IFU virzieniem un pievērstu lietotāju uzmanību tam.
3. Aprakstiet ierīci. Jūsu aprakstā jāietver gan rakstisks paskaidrojums par ierīces mērķi, gan neliels grafisks attēlojums par ierīces izskatu. Attēlam vajadzētu marķēt un nosaukt visus ierīcē esošos slēdžus, pogas un pievienojamās daļas.
4. Norādiet instalēšanas instrukcijas. Instalācijas sadaļā jābūt pamatinformācijai par to, kā sagatavoties produkta vai ierīces lietošanai. Ja ierīci nevar uzbūvēt vai uzstādīt mājas lietotājs, uzstādīšanas sadaļas augšpusē skaidri norādiet to treknrakstā. Jums jāiekļauj arī:
   • Detaļu saraksts
   • Izpakošanas instrukcijas
   • Uzstādīšanas brīdinājumi
   • Nepareizas uzstādīšanas sekas
   • Kam piezvanīt, ja uzstādīšanas laikā rodas grūtības
5. Sniedziet informāciju par darbību. Šī sadaļa ir vissvarīgākā lietotāja rokasgrāmatas daļa, un tajā jāsniedz konkrēta, detalizēta informācija par ierīces lietošanu. Sāciet ar pamata sagatavošanu ierīces lietošanai, piemēram, pievienojiet strāvas vadu vai mazgājiet rokas. Turpiniet ar loģiskām, numurētām darbībām, kas apraksta ierīces lietošanu, kā arī visas atsauksmes (piemēram, "Jūs dzirdēsiet klikšķi ..."), kuras lietotājs var sagaidīt, pareizi lietojot ierīci.
   • Šīs nodaļas beigās lietotāji jānorāda uz problēmu novēršanas nodaļu, lai atrisinātu problēmas, kuras nevar ātri izskaidrot.
   • Novietojiet attēlus, kur nepieciešams. Dažas darbības vislabāk izskaidro gan ar attēliem, gan vārdiem. Apsveriet fotoattēlu vai ilustrāciju izmantošanu savā rokasgrāmatā.
   • Šajā sadaļā, tāpat kā jebkurā sadaļā, jāiekļauj attiecīgie drošības brīdinājumi par nepareizu lietošanu vai darbību. Piemēram, jūs varētu brīdināt motorzāģa lietotājus nelietot alkoholu vai lietot motorzāģi, lietojot noteiktus medikamentus.
   • Ja jūs domājat, ka lietotāji gūs labumu, apsveriet iespēju pievienot saites uz tiešsaistes videoklipiem, kas parāda ierīces pareizu lietošanu un darbību. Šos videoklipus varat ierakstīt vai nu šīs sadaļas sākumā, vai (ja videoklipi ilustrē tikai vienu soli) katra soļa beigās.
6. Beigās pievienojiet produkta kopsavilkumu. Kopsavilkumam jāparādās rokasgrāmatas beigās tieši pirms rādītāja, lai sniegtu pamata darbības soļus. Tam vajadzētu būt vienkāršotai, noņemtai operatīvās informācijas versijai, un tai jābūt ne vairāk kā vienai lappusei. Apkopojiet ierīces vai produkta lietošanu. Iekļaujiet pamata brīdinājumus, numurētas darbības, kas izskaidro produkta lietošanu, un tālruņu numurus vai e-pasta adreses, kas liek lietotājiem palīdzēt.
   • Ja sagaidāt, ka lietotājs bieži noņem vai atsaucas uz kopsavilkuma lapu, varat to izdrukāt uz noņemamas laminētas kartes vai bieza kartona, lai lietotājam būtu vieglāk to nēsāt un atsaukties.
   • Varat arī lietot produktu tieši, lai lietotājs to ātri un ērti uzzinātu.

3. daļa no 4: Produkta apkopes apraksts

1. Paskaidrojiet, kā tīrīt ierīci. Ja jūsu ierīcei vai izstrādājumam nepieciešama tīrīšana, paskaidrojiet, kā to izdarīt. Uzskaitiet nepieciešamos tīrīšanas līdzekļus. Pastāstiet lasītājam, cik bieži jātīra. Pēc tam, tāpat kā jebkurā citā rokasgrāmatas daļā, iekļaujiet numurētas pakāpeniskas instrukcijas, kā to tīrīt.
   • Ja tīrīšanai nepieciešams izjaukt produktu vai noņemt noteiktu daļu vai daļas, norādiet, kā produkts jāizjauc.
   • Sniedziet brīdinājumu par ierīces tīrīšanas neveiksmes rezultātiem. Piemēram, jūs varētu teikt: "Ja ierīce netiek notīrīta, veiktspēja būs mazāka par optimālo."
2. Saskaitiet lietotāju, kā veikt pamata apkopi. Ja produkts vai ierīce ir lietotāja rīcībā, lai novērstu veiktspējas problēmas, sniedziet numurētas instrukcijas, kā to izdarīt lietotāja labā. Piemēram, ja baterijas jāmaina pēc katrām 300 lietošanas stundām, sniedziet norādījumus, kā pārbaudīt, vai baterijas ir jāmaina, kā jāizņem nolietotās baterijas un kā jāuzstāda jaunās.
   • Ja ir noteikti apkopes uzdevumi, kurus var veikt tikai sertificēts tehniķis, sadaliet rokasgrāmatas apkopes daļu divās daļās.
3. Apspriediet uzglabāšanas iespējas. Vajadzības gadījumā rokasgrāmatā jāpaskaidro, kā pareizi uzglabāt produktu vai ierīci. jāiekļauj arī informācija par to, kāpēc uzglabāšana ir nepieciešama, un nepareizas uzglabāšanas sekas. Piemēram: jūs varētu rakstīt:
   • Uzglabājiet produktu vēsā, sausā vietā. Nepareiza uzglabāšana var saīsināt produkta kalpošanas laiku mitruma uzkrāšanās dēļ. "
   • "Nepakļaujiet produktu karstumam un neglabājiet to temperatūrā, kas pārsniedz 50 grādus pēc Celsija.Ja jūs to izdarīsit, tas var izraisīt sadedzināšanu. "
4. Norādiet problēmu novēršanas informāciju. Jūs varētu organizēt šo sadaļu kā biežāko problēmu sarakstu un to risinājumus. Grupējiet līdzīgas problēmas loģiskā virsrakstā. Tādā veidā lietotāji var ātri atrast specifiskas problēmas.
   • Piemēram, ja ir vairākas problēmas ar datoru, kurā tiek parādīts zils ekrāns, grupējiet tos apakšpozīcijā, piemēram, “Bieži sastopamās ekrāna problēmas”.
   • Šajā sadaļā ir jāiekļauj arī tālruņa numurs un / vai e-pasta adrese klientu apkalpošanai.

4. daļa no 4: Uzrakstiet lasāmu rokasgrāmatu

1. Izlasiet citas lietotāja rokasgrāmatas. Pirms rakstāt sava produkta rokasgrāmatu, apskatiet citas efektīvas lietotāja rokasgrāmatas. Pievērsiet uzmanību struktūrai, vārdu izvēlei un teikuma struktūrai. Lielākie zīmoli, piemēram, Apple, Google un Microsoft, ražo spēcīgas, efektīvas lietotāja rokasgrāmatas, kas var palīdzēt izveidot pārdomātāk uzrakstītu lietotāja rokasgrāmatu.
   • Ne tikai lasiet visi lietotāja rokasgrāmatas. Izlasiet līdzīgu jūsu pārdoto produktu rokasgrāmatas. Piemēram, ja jūs pārdodat zīdaiņu produktus, izlasiet zīdaiņu rokasgrāmatas, nevis tehniskās.
2. Atlasiet savus standartus. Pareizrakstības, vārdu izvēles un formulējumu standartizēšana padarīs lietotāja rokasgrāmatu lietotājam draudzīgāku. Čikāgas stila rokasgrāmata un Microsoft stila rokasgrāmata var būt arī noderīgas stila rokasgrāmatas, rakstot īpašnieka rokasgrāmatu; pārbaudiet abus, lai redzētu, vai viens ir piemērots jūsu rokasgrāmatai.
   • Piemēram, tā vietā, lai rokasgrāmatā izmantotu gan “strāvas slēdzi”, gan “barošanas pogu”, izvēlieties vienu no diviem terminiem un turieties pie tā.
3. Izmantojiet aktīvo balsi. Aktīvā balss ir rakstīšanas veids, kas izskaidro lietas no lietotāja viedokļa. To ir vieglāk saprast nekā alternatīvu, pasīvo balsi, kurā subjekts nav definēts.
   • Izmēģiniet Hemingveja lietotni (www.hemmingwayapp.com), lai rakstā identificētu pasīvās ejas.
   • Izpētiet šos divus teikuma paraugus - pirmais ir aktīvs un otrais pasīvs:
     • Iepakojums jāatver lēni un uzmanīgi.
     • Iepakojums jāatver lēnām un uzmanīgi.
4. Uzrakstiet numurētas instrukcijas. Skaitliski sakārtotas instrukcijas palīdz lasītājam labāk koncentrēties uz attiecīgā produkta izmantošanas, pievienošanas vai uzbūves procesu. Tā vietā, lai rakstītu garu, daudzbalsīgu rindkopu vai nenumurētu rindkopu sēriju, uzrakstiet lietotāja rokasgrāmatu, veicot vienkāršas, skaidras darbības un katru skaidri numurējot.
5. Sāciet katru soli ar imperatīvu. Obligāts ir darbības orientēts darbības vārds. Sākot katru soli ar darbības vārdu, jūs lasītājam dodat mājienu par darbību, kas nepieciešama soļa pabeigšanai. Piemēram, atkarībā no produkta, par kuru rakstāt, varat sākt soļus ar komandu, piemēram, "Savienot", "Apstiprināt" vai "Slaids". Tomēr nesāciet savas darbības ar sistēmas atbildi.
   • Piemēram, ja ekrāns kļūst zils un sāk mirgot, nesāciet darbību ar: "Ekrāns mirgos un kļūs zils." Mēģiniet: "Nospiediet un turiet sākuma taustiņu. Ekrāns mirgos un kļūs zils. "
6. Nosakiet, kuru vārdu krājumu izmantosiet. Ja jūs rakstāt yo-yo rokasgrāmatu, jūsu auditorija galvenokārt būs mazi bērni. Izmantojiet vienkāršus vārdus un vārdu krājumu, lai izskaidrotu, kā darbojas jojo. Rakstot skenējošā elektronu mikroskopa rokasgrāmatu, jūsu auditoriju veido augsti kvalificēti zinātnieki, kuri var saprast ļoti detalizētu informāciju, tāpēc nevilcinieties izmantot specializētu vārdu krājumu vai niansētus paskaidrojumus.
   • Kopumā jūs mēģināt izvairīties no žargona un tehniskās valodas.
   • Lai būtu efektīvs pēc iespējas plašākai lietotāju bāzei, mēģiniet rakstīt līmenī no pamatskolas sestās līdz septītajai klasei.
7. Nosūtot produktu uz ārzemēm, pārliecinieties, vai tulkojumi ir precīzi. Nomājiet tulku, lai tulkotu jūsu lietotāja rokasgrāmatu tās valsts dzimtajā valodā, uz kuru jūs sūtāt savu produktu. Varat arī izmantot tiešsaistes tulkošanas programmu, bet lūdziet dzimtā valoda lasīt tulkojumu un pārbaudīt kļūdas.
   • Ja jūsu auditorijā ir pārstāvētas vairākas valodu grupas, lūdzu, iekļaujiet lietotāja rokasgrāmatas tulkojumus katrā attiecīgajā valodā.
   • Tulkotājam ir jāpārzina produkts, jo mērķvalodā var būt dažādi vārdi konkrētiem terminiem, kas nav tulkojumi pa vārdam.
8. Rakstiet īsos teikumos. Dažu garu rindkopu vietā jūs izmantojat daudz īsu rindkopu. Katrā sadaļā meklējiet loģiskus pārtraukumus un sagremojiet noderīgu informāciju viena vai divu teikumu daļās. Tas pats sakāms teikumu līmenī. Saglabājiet teikumus īsus un vienkāršus, nevis garus un izteiksmīgus.
   • Ja solis kļūst pārāk garš, sadaliet to mazākos soļos. Tas nesamazinās vārdu skaitu, bet rindiņu pārtraukumi atvieglos lasīšanu.
9. Pārbaudiet, vai rokasgrāmatā nav kļūdu. Rokasgrāmata var zaudēt uzticamību gramatikas un pareizrakstības kļūdu dēļ. Palūdziet arī kolēģim vai tehniskajam rakstniekam rediģēt un korektūru izlasīt. Papildus pareizrakstībai un gramatikai korektoram jāpievērš uzmanība šādiem jautājumiem:
   • Pasīvā balss
   • Neskaidra vai mulsinoša valoda
   • Iesaiņota teikuma struktūra
   • Pārāk garas rindkopas

Padomi

• Cilvēki mācās dažādos veidos; Ja iespējams un lietderīgi, rokasgrāmatā iekļaujiet vizuālos palīglīdzekļus vai saites uz tiešsaistes videoklipiem, lai pielāgotos vizuāli orientētiem lasītājiem.