Sisu

• Astuda
• 1. osa 4-st: oma kasutusjuhendi kavandamine
• 2. osa 4-st: olulise teabe lisamine
• 3. osa 4-st: Toote hoolduse kirjeldamine
• 4. osa 4-st: kirjutage loetav kasutusjuhend
• Näpunäited

Tarkvara, arvutite, mängude ja seadmete jaoks on vaja kasutusjuhendeid; juhendid, mis selgitavad toote kasutamist (ja kuidas mitte). Kasutusjuhend on konkreetse struktuuriga ametlik dokument ja selle peab kirjutama keegi, kes tunneb toodet seestpoolt, näiteks tehniline kirjutaja või toote disainer. Efektiivse kasutusjuhendi kirjutamiseks on vaja teada, kes toodet kasutab, ja kirjutada kasutusjuhend neid kasutajaid silmas pidades. Hoidke kirjutamine selge, täpne ja lihtne, et tagada probleemideta kasutuskogemus.

Astuda

1. osa 4-st: oma kasutusjuhendi kavandamine

1. Tehke kasutajaanalüüs. Kasutusjuhend peaks olema kirjutatud kasutajatele - neile, kes ostavad teie toote või teenuse ja loevad kasutusjuhendit. Kasutajaanalüüs annab teile teada, kes on teie põhi- või sihtrühm ning juhatab teid teksti kirjutamisel.
   • Rääkige inimestega, kes teie seadet kasutavad. Pakkuge kontrolltingimustes kasutajatele seadme prototüüpe ja kasutusjuhendi mustandit. Küsige nendelt testkasutajatelt tagasisidet selle kohta, mis on kasutusjuhendis ebaselge või segane, ja muutke selle tagasiside põhjal oma kasutusjuhendit.
   • Sa ei saa kunagi kogu oma publikut rahuldada; kirjutage sihtrühmale või suuremale publikule kohandatud juhend.
   • Mõelge vanusele, tervisele (kas neil on mingeid haigusi, õpiraskusi või puudeid?) Ja publiku haridustase, et määrata parim lähenemisviis kasutusjuhendi kirjutamisele.
2. Koordineerige kasutusjuhendi kujundus. Kui kuulusite meeskonda, kes aitas seadet või toodet kujundada ja arendada, võib toote toimimist selgitades olla keeruline objektiivset pilku heita. Seetõttu peaksite kasutusjuhendi ettevalmistamisel abi küsima kirjanikult (eelistatavalt juhiste kirjutamise kogemusega inimeselt) ja graafiliselt disainerilt. Neid inimesi saate valida välise konsultatsiooni kaudu või oma ettevõttest või organisatsioonist.
3. Tehke ülesande analüüs. Tööanalüüs on seadme kasutamiseks vajalike sammude kindlakstegemine ja korraldamine. Põhjalikus tööanalüüsis tehakse kindlaks iga sammu jaoks vajalikud materjalid ja seadmed (näiteks patareid, ravimid või muud kasutaja poolt tarnitavad tooted), samuti toimingud, vead ja veaotsingu nõuanded, mida iga samm võib vajada.
   • Kui teil on toode, mis suudab täita palju erinevaid ülesandeid või alamülesandeid, peate iga ülesande jaoks tegema ülesande analüüsi. Näiteks: autos saate maadelda, end rihma kinnitada ja esituled sisse või välja lülitada. Vajadusel tehke nende kõigi jaoks tööanalüüs.
4. Veenduge, et teie toode vastab märgistamise ja müügiloa väljastamise nõuetele. Need nõuded tagavad, et tooteid valmistatakse kasutaja ohutust silmas pidades ning et kasutaja kokkupuude ohtlike tingimustega, nagu kiirgus ja elektrilöök, on piiratud. Reklaamid peaksid selgelt välja tooma toote eesmärgi ja põhijuhised ning neid ressursse peaksite kasutama omaniku käsiraamatu kirjutamisel.
   • Toote kasutusjuhendi tõhususe tagamiseks tuleb see kirjutada vastavalt otse tootele kinnitatud siltidele.
   • Enne kasutusjuhendi kirjutamist veenduge, et teie seadmel on ametlik müügilitsents.
5. Otsustage oma käsiraamatu paigutus. Käsiraamatu sujuvamaks muutmiseks on mitu olulist viisi. Iga osa alguses peate panema rasvase pealkirja, kusjuures iga sõna on suurtähtedega. Näiteks „Seadme seadistamine“, „Seadme juhtimine“ ja „Veaotsing“ võivad kõik olla paksude jaotiste pealkirjad.
   • Teine võimalus oma juhendit sujuvamaks muuta on kasutada kahte veergu, üks tekstiga paremal ja teine ​​tekstist vasakul, täppide, numbrite või väikeste ikoonidega, näiteks hoiatusmärkide või punaste hüüumärkidega.
   • Kasutusjuhend võib koosneda peamiselt piltidest, mille seadme selgitamiseks on iga pildi all mõni tekst, või see võib olla peamiselt ainult mõne kaasneva pildiga tekst. Kasutaja juhendamiseks võite kasutada ka vooskeemi. Mõelge oma tootele ja sellele, kuidas iga meetod aitab teil käsiraamatu kirjutada. Kuid vältige erinevate paigutuste segamist ühes käsiraamatus. Valige üks ja jääge sellega.

2. osa 4-st: olulise teabe lisamine

1. Korrastage käsiraamat loogiliselt. Juhend peaks olema üles ehitatud nii, et kasutaja saaks sellest kõige rohkem kasu. Jagage kasutusjuhend peatükkideks või jaotisteks, mis on mõistlikud toote kasutamiseks, ja lisage kasutusjuhendi esiküljele sisukord, et iga jaotis oleks kiiresti leitav.
   • Sisukord on eriti vajalik pikemate käsiraamatute jaoks.
   • Sõnastikku või indeksit on vaja, kui on palju termineid, mis selgitavad, et teie vaatajaskond ei pruugi olla tuttav. Sõnastik pole siiski soovitatav; parim valik on selgitada segaseid termineid käsiraamatu enda tekstis. Kui otsustate lisada sõnastiku, asetage see kasutusjuhendi ette, kohe sisukorra järele.
   • Tabelite või jooniste loetelu on vajalik ainult siis, kui käsiraamatus on rohkem kui paar tabelit või joonist.
   • Lisa on vaja asjade jaoks, mis vajavad selgitamist, kuid mida ei saa mujal käsiraamatus selgitada, kuna see häiriks voolu ja keskendumist.
2. Lisage vajalikud hoiatused. Üldised hoiatused või ettevaatusabinõud peaksid andma teavet toote mittesihipärasest kasutamisest põhjustatud võimalike ohtude, sealhulgas surma või tõsiste vigastuste kohta. Need hoiatused tuleks paigutada kasutusjuhendi esiküljele, pärast esilehte, nii et kasutaja neid kõigepealt näeks. Spetsiifilised hoiatused tuleks lisada käsiraamatu teksti vahetult pärast potentsiaalselt ohtliku sammu soovitamist või vahetult enne seda.
   • Näiteks võib elektriseadme üldine hoiatus olla selle mitte kasutamine vihma ajal.
   • Konkreetne juhis võiks olla enne seadme pistikupessa ühendamist veenduda, et nii teie käed kui ka seade on kuivad.
   • Pakkuge pilte (näiteks kolju ja ristluud) või erinevat värvi teksti (näiteks punane tekst), et eristada hoiatust muudest IFU suundadest ja juhtida kasutajate tähelepanu sellele.
3. Kirjeldage seadet. Teie kirjeldus peaks sisaldama nii seadme eesmärgi kirjalikku selgitust kui ka väikest graafilist kujutist seadme väljanägemise kohta. Joonisel tuleks sildistada ja nimetada kõik seadmes olevad lülitid, nupud ja kinnitatavad osad.
4. Esitage paigaldusjuhised. Installimisjagu peaks sisaldama põhiteavet toote või seadme kasutamiseks ettevalmistamise kohta. Kui kodukasutaja ei saa seadet ehitada ega seadistada, märkige see installimisjaotise ülaosas rasvases kirjas selgelt. Peaksite lisama ka järgmise:
   • Osade loend
   • Lahtipakkimisjuhised
   • Paigaldamise hoiatused
   • Ebaõige paigaldamise tagajärjed
   • Kellele helistada installimisel tekkivate raskuste korral
5. Andke teavet toimingu kohta. See jaotis on kasutusjuhendi kõige olulisem osa ja peaks andma konkreetset, üksikasjalikku teavet seadme kasutamise kohta. Alustage seadme kasutamiseks põhiliste ettevalmistustega, näiteks toitejuhtme ühendamine pistikupesaga või käte pesemine. Jätkake loogiliste, nummerdatud toimingutega, milles kirjeldatakse seadme kasutamist, samuti igasugust tagasisidet (näiteks „Kuulete klikki ...”), mida kasutaja võib seadme õigel kasutamisel oodata.
   • Selle peatüki lõpus tuleks kasutajad suunata tõrkeotsingu peatükki, et lahendada probleeme, mida ei saa kiiresti seletada.
   • Pange pildid sinna, kus see on vajalik. Mõningaid samme saab kõige paremini selgitada nii piltide kui ka sõnadega. Kaaluge fotode või illustratsioonide kasutamist oma kasutusjuhendis.
   • Selles jaotises, nagu ka igas jaotises, peaksite sisaldama asjakohaseid ohutushoiatusi ebaõige kasutamise või kasutamise kohta. Näiteks võite hoiatada mootorsae kasutajaid, et nad ei tarvitaks alkoholi ega kasutaks mootorsaagi teatud ravimite kasutamise ajal.
   • Kui arvate, et kasutajad saavad sellest kasu, kaaluge linkide lisamist veebivideotele, mis demonstreerivad seadme õiget kasutamist ja toimimist. Saate need videod salvestada kas selle jaotise alguses või (ainult ühte sammu illustreerivate videote puhul) iga sammu lõpus.
6. Lisage lõppu toote kokkuvõte. Kokkuvõte peaks ilmuma käsiraamatu lõpus, vahetult enne indeksit, et anda põhitegevusetapid. See peaks olema operatiivteabe lihtsustatud ja eemaldatud versioon ning see ei tohiks olla rohkem kui üks leht. Tehke kokkuvõte seadme või toote kasutamisest. Lisage põhiteatised, nummerdatud toimingud, mis selgitavad toote kasutamist, ja telefoninumbrid või e-posti aadressid, mis suunavad kasutajaid abistama.
   • Kui eeldate, et kasutaja eemaldab kokkuvõtte lehe või viitab sellele sageli, saate selle printida eemaldatavale lamineeritud kaardile või paksule papile, et kasutajal oleks seda hõlpsam kanda ja viidata.
   • Teise võimalusena võite kasutajale kiireks ja hõlpsaks viitamiseks rakendada kokkuvõtte otse tootele.

3. osa 4-st: Toote hoolduse kirjeldamine

1. Selgitage, kuidas seadet puhastada. Kui teie seade või toode vajab puhastamist, selgitage, kuidas seda teha. Loetlege vajalikud puhastusvahendid. Öelge lugejale, kui tihti puhastada. Seejärel, nagu ka kasutusjuhendi mis tahes muus osas, lisage järk-järgult nummerdatud juhised selle puhastamiseks.
   • Kui puhastamine nõuab toote lahtivõtmist või konkreetse osa või osade eemaldamist, näidake, kuidas toodet tuleks lahti võtta.
   • Esitage hoiatus seadme puhastamata jätmise tulemuste kohta. Näiteks võite öelda: "Kui seadet ei puhastata, on jõudlus optimaalsest väiksem."
2. Loendage kasutajale, kuidas põhihooldustöid teha. Kui toode või seade on jõudlusprobleemide kõrvaldamiseks kasutaja poolt hooldatav, andke nummerdatud juhised, kuidas seda kasutaja jaoks teha. Näiteks kui patareid tuleb vahetada iga 300 töötunni järel, andke juhised selle kohta, kuidas kontrollida, kas patareisid tuleb vahetada, kuidas tühjad patareid eemaldada ja kuidas uued paigaldada.
   • Kui on teatud hooldustöid, mida saab läbi viia ainult sertifitseeritud tehnik, jagage käsiraamatu hoolduse osa kaheks osaks.
3. Arutage salvestusvõimalusi. Vajadusel peaks kasutusjuhendis selgitama, kuidas toodet või seadet õigesti säilitada. peaksite lisama ka teavet selle kohta, miks ladustamine on vajalik, ja vale salvestamise tagajärgedest. Näiteks: võite kirjutada:
   • Hoidke toodet jahedas ja kuivas kohas. Vale ladustamine võib niiskuse kogunemise tõttu lühendada toote eluiga. "
   • "Ärge jätke toodet kuumusele ega hoidke seda temperatuuril üle 50 kraadi.Kui teete seda, võib see põhjustada põlemist. "
4. Esitage veaotsingu teave. Selle jaotise võiksite korraldada levinumate probleemide ja nende lahenduste loendina. Grupeerige sarnased probleemid loogilise pealkirja alla. Nii saavad kasutajad kiiresti leida konkreetseid probleeme.
   • Näiteks kui sinise ekraani kuvamise arvutiga on mitu probleemi, grupeerige need alamrubriiki, näiteks „Tavalised ekraaniprobleemid”.
   • Selles jaotises peate lisama ka klienditeeninduse telefoninumbri ja / või e-posti aadressi.

4. osa 4-st: kirjutage loetav kasutusjuhend

1. Lugege teisi kasutusjuhendeid. Enne oma toote käsiraamatu kirjutamist vaadake teisi tõhusaid kasutusjuhendeid. Pöörake tähelepanu ülesehitusele, sõnavalikule ja lauseehitusele. Suured kaubamärgid, nagu Apple, Google ja Microsoft, toodavad tugevaid ja tõhusaid kasutusjuhendeid, mis aitavad teil koostada läbimõeldumalt kirjutatud kasutusjuhendi.
   • Ärge lihtsalt lugege kõik kasutusjuhendid. Lugege müüdavate sarnaste toodete kasutusjuhendeid. Näiteks kui müüte imikutooteid, lugege imikute käsiraamatuid, mitte tehnilisi.
2. Valige oma standardid. Õigekirja, sõnavaliku ja sõnastuse ühtlustamine muudab kasutusjuhendi kasutajasõbralikumaks. Chicago stiilijuhend ja Microsofti stiilijuhend võivad olla kasulikud stiilijuhised ka omanikujuhendi kirjutamisel; kontrollige mõlemat, kas üks sobib teie kasutusjuhendi jaoks.
   • Näiteks selle asemel, et käsiraamatus kasutada nii "toitelülitit" kui ka "toitenuppu", valige üks kahest terminist ja jääge sellest kinni.
3. Kasutage aktiivset häält. Aktiivne hääl on kirjutamisviis, mis selgitab asju kasutaja vaatenurgast. Seda on lihtsam mõista kui alternatiivi, passiivset häält, milles subjekt on määratlemata.
   • Proovige Hemingway rakendust (www.hemmingwayapp.com), et oma kirjas passiivsed lõigud tuvastada.
   • Uurige neid kahte näidislauset - esimene on aktiivne ja teine ​​passiivne:
     • Pakend tuleb avada aeglaselt ja ettevaatlikult.
     • Pakend tuleb avada aeglaselt ja ettevaatlikult.
4. Kirjutage nummerdatud juhised. Numbriliselt järjestatud juhised aitavad lugejal paremini keskenduda kõnealuse toote kasutamise, ühendamise või ehitamise protsessile. Pika, mitmekülgse lõigu või nummerdamata lõigude sarja kirjutamise asemel kirjutage oma kasutusjuhend lihtsate, selgesõnaliste ja selgelt nummerdatud toimingutega.
5. Alustage iga sammu imperatiiviga. Imperatiiv on tegevusele suunatud verb. Alustades igat sammu verbiga, annate lugejale vihje toimingu sooritamiseks, mis on vajalik sammu lõpetamiseks. Näiteks olenevalt tootest, millest kirjutate, võite oma samme alustada käsuga nagu "Ühenda", "Kinnita" või "Slaid". Kuid ärge alustage oma samme süsteemi vastusega.
   • Näiteks kui ekraan muutub siniseks ja hakkab vilkuma, ärge alustage sammu järgmisega: "Ekraan vilgub ja muutub siniseks." Proovige: "Vajutage ja hoidke all koduklahvi. Ekraan vilgub ja muutub siniseks. "
6. Otsustage, millist sõnavara kasutate. Kui kirjutate jo-jo käsiraamatut, on teie publik enamasti väikesed lapsed. Jo-jo toimimise selgitamiseks kasutage lihtsaid sõnu ja sõnavara. Skaneeriva elektronmikroskoobi käsiraamatu kirjutamisel koosneb teie publik kõrgelt kvalifitseeritud teadlastest, kes saavad aru väga üksikasjalikust teabest, nii et ärge hoiduge spetsiaalse sõnavara või nüansseeritud selgituste kasutamisest.
   • Üldiselt proovite vältida žargooni ja tehnilist keelt.
   • Et olla efektiivne võimalikult laia kasutajaskonna jaoks, proovige kirjutada tasemel põhikooli kuuendast seitsmendani.
7. Toote välismaale saatmisel veenduge, et tõlked oleksid õiged. Palgake tõlk, kes tõlgib teie kasutusjuhendi selle riigi emakeelde, kuhu oma toode tarnite. Võite kasutada ka veebipõhist tõlkeprogrammi, kuid paluge emakeelena kõnelejal tõlge lugeda ja vigade kontrollimiseks.
   • Kui teie vaatajaskonnas on esindatud mitu keelerühma, lisage palun kasutusjuhendi tõlked igasse asjakohasesse keelde.
   • Tõlkija peab toodet tundma, kuna sihtkeeles võib olla erinevaid sõnu konkreetsete terminite jaoks, mis pole sõna-sõnalised tõlked.
8. Kirjutage lühikeste lausetega. Mõne pika lõigu asemel kasutate palju lühikesi lõike. Otsige igas jaotises loogilisi katkestusi ja kasutage kasulikku teavet ühe- või kahelauselistena. Sama kehtib ka lause tasandil. Hoidke oma lauseid pigem lühikesi ja lihtsaid, mitte pikki ja paljusõnalisi.
   • Kui samm läheb liiga pikaks, jagage see väiksemateks sammudeks. See ei vähenda sõnade arvu, kuid reavahetused muudavad selle lugemise lihtsamaks.
9. Kontrollige, kas juhendis pole vigu. Käsiraamat võib kaotada usaldusväärsuse grammatika ja õigekirjavigade tõttu. Paluge kolleegil või tehnilisel kirjutajal ka käsiraamatut redigeerida ja korrektuurida. Lisaks õigekirjale ja grammatikale peaks korrektor pöörama tähelepanu ka järgmistele:
   • Passiivne hääl
   • Ebaselge või segane keel
   • Pakitud lauseehitus
   • Liiga pikad lõigud

Näpunäited

• Inimesed õpivad erineval viisil; Kui võimalik ja asjakohane, lisage visuaalselt orienteeritud lugejate käsiraamatusse visuaalsed abivahendid või lingid veebivideotele.