Sisältö

• Astua
• Osa 1/4: Omistajan käsikirjan suunnittelu
• Osa 2/4: Upota olennaiset tiedot
• Osa 3/4: Tuotteen ylläpidon kuvaus
• Osa 4/4: Kirjoita luettava käsikirja
• Vinkkejä

Ohjelmistot, tietokoneet, pelit ja laitteet edellyttävät käyttöoppaita; oppaat, joissa selitetään tuotteen käyttöä (ja miten ei). Käyttöopas on muodollinen asiakirja, jolla on erityinen rakenne, ja sen on kirjoittanut joku, joka tuntee tuotteen nurinpäin, kuten tekninen kirjoittaja tai tuotesuunnittelija. Tehokkaan käyttöoppaan kirjoittaminen edellyttää, että tiedät kuka käyttää tuotetta, ja että kirjoitat käsikirjan näitä käyttäjiä silmällä pitäen. Pidä kirjoituksesi selkeänä, täsmällisenä ja yksinkertaisena, jotta saat käyttöösi vaivatonta.

Astua

Osa 1/4: Omistajan käsikirjan suunnittelu

1. Tee käyttäjäanalyysi. Käyttöohje tulisi kirjoittaa käyttäjille - niille, jotka ostavat tuotteesi tai palvelusi ja lukevat käyttöoppaan. Käyttäjäanalyysi kertoo sinulle, kuka on pää- tai kohdeyleisösi, ja opastaa sinua kirjoittamaan tekstiä.
   • Keskustele ihmisten kanssa, jotka käyttävät laitettasi. Tarjoa testikäyttäjille laitteen prototyyppejä ja luonnos käyttöoppaaksi valvotuissa olosuhteissa. Pyydä näitä testikäyttäjiä antamaan palautetta asioista, jotka ovat epäselviä tai hämmentäviä käyttöoppaassa, ja tee muutoksia käyttöoppaaseen tämän palautteen perusteella.
   • Et voi koskaan tyydyttää koko yleisösi; kirjoita kohdeyleisölle tai suurimmalle yleisölle räätälöity käyttöopas.
   • Ota huomioon ikä, terveys (onko heillä sairauksia, oppimisvaikeuksia tai -vammaisia?) Ja yleisön koulutustaso, jotta voit määrittää parhaan lähestymistavan käyttöohjeen kirjoittamiseen.
2. Koordinoi käyttöoppaan suunnittelu. Jos olit osa tiimiä, joka auttoi suunnittelemaan ja kehittämään laitetta tai tuotetta, voi olla vaikeaa tarkastella tuotetta objektiivisesti sen toiminnan selvittämiseksi. Siksi sinun on kysyttävä kirjoittajan (mieluiten jonkun, jolla on kokemusta ohjeiden kirjoittamisesta) ja graafisen suunnittelijan neuvoja käyttäjän käsikirjan valmistelussa. Voit valita nämä ihmiset ulkopuolisen konsultoinnin kautta tai oman yrityksen tai organisaation kautta.
3. Tee tehtäväanalyysi. Työanalyysi on prosessi, jolla tunnistetaan ja järjestetään laitteen käyttöön tarvittavat vaiheet. Perusteellisessa työanalyysissä yksilöidään kullekin vaiheelle tarvittavat materiaalit ja laitteet (kuten paristot, lääkkeet tai muut käyttäjän toimittamat tuotteet), samoin kuin toimet, virheet ja vianetsintävinkit, joita jokainen vaihe saattaa edellyttää.
   • Jos sinulla on tuote, joka pystyy suorittamaan monia erilaisia ​​tehtäviä tai alitehtäviä, sinun on tehtävä tehtäväanalyysi jokaiselle tehtävälle. Esimerkiksi: autossa voit maistaa, kiinnittää itsesi ja kytkeä ajovalot päälle tai pois päältä. Tee työanalyysi kullekin näistä tarvittaessa.
4. Varmista, että tuotteesi täyttää merkintöjä ja myyntilupaa koskevat vaatimukset. Nämä vaatimukset varmistavat, että tuotteet valmistetaan käyttäjän turvallisuutta silmällä pitäen ja että käyttäjän altistuminen vaarallisille olosuhteille, kuten säteilylle ja sähköiskulle, on rajallinen. Mainoksissa on mainittava selvästi tuotteen tarkoitus ja peruskäyttöohjeet, ja sinun tulee käyttää näitä resursseja kirjoittaessasi omistajan käsikirjaa.
   • Jotta tuotteen käyttöopas olisi tehokas, se on kirjoitettava suoraan tuotteeseen kiinnitettyjen tarrojen mukaisesti.
   • Varmista, että laitteellasi on virallinen myyntilupa ennen käyttöoppaan kirjoittamista.
5. Päätä käsikirjan asettelusta. On useita tärkeitä tapoja virtaviivaistaa käyttöopasta. Kunkin osan alkuun on lisättävä lihavoitu otsikko, jokainen sana isoilla kirjaimilla. Esimerkiksi "Laitteen määrittäminen", "Laitteen käyttö" ja "Vianmääritys" voivat olla lihavoituja osion otsikoita.
   • Toinen tapa virtaviivaistaa opasta on käyttää kahta saraketta, yksi tekstin oikealla puolella ja toinen tekstin vasemmalla puolella, luetteloilla, numeroilla tai pienillä kuvakkeilla, kuten varoitusmerkeillä tai punaisilla huutomerkkeillä.
   • Opas voi koostua pääasiassa kuvista, joiden jokaisen kuvan alla on tekstiä laitteen selittämiseksi, tai se voi olla pääasiassa tekstiä, jossa on vain muutama mukana oleva kuva. Voit myös käyttää vuokaaviota käyttäjän ohjaamiseen. Ajattele tuotetta ja kuinka kukin menetelmä voi auttaa sinua kirjoittamaan käyttöoppaasi. Vältä kuitenkin eri asettelujen sekoittamista samaan käsikirjaan. Valitse yksi ja pidä siitä kiinni.

Osa 2/4: Upota olennaiset tiedot

1. Järjestä opas loogisesti. Käsikirjan tulisi olla rakenteeltaan sellainen, että käyttäjä saa siitä eniten hyötyä. Jaa käyttöohje lukuihin tai jaksoihin, jotka ovat järkeviä tuotteen käytön kannalta, ja sisällytä sisällysluettelo käyttöoppaan eteen, jotta jokainen osa löytyy nopeasti.
   • Sisällysluettelo on erityisen välttämätön pidemmille käsikirjoille.
   • Sanastoa tai hakemistoa tarvitaan, jos on olemassa useita termejä, jotka selittävät, että yleisösi ei ehkä tunne niitä. Sanastoa ei kuitenkaan suositella; paras valinta on selittää hämmentävät termit itse käsikirjan tekstissä. Jos haluat sisällyttää sanaston, aseta se käyttöoppaan etupuolelle heti sisällysluettelon jälkeen.
   • Taulukoiden tai kuvien luettelo on tarpeen vain, jos ohjekirjassa on enemmän kuin muutama taulukko tai kuva.
   • Liite tarvitaan asioihin, jotka on selitettävä, mutta joita ei voida selittää muualla käsikirjassa, koska se häiritsisi virtausta ja keskittymistä.
2. Sisällytä tarvittavat varoitukset. Yleisten varoitusten tai varotoimenpiteiden tulisi antaa tietoa tuotteen väärinkäytöstä mahdollisesti aiheutuvista vaaroista, mukaan lukien kuolema tai vakava loukkaantuminen. Nämä varoitukset tulee sijoittaa aivan käyttöoppaan etusivun jälkeen, jotta käyttäjä näkee ne ensin. Erityiset varoitukset tulisi myös sisällyttää käyttöohjeen tekstiin heti sen jälkeen, kun mahdollisesti vaarallista vaihetta ehdotetaan.
   • Esimerkiksi yleinen varoitus sähkölaitteelle voi olla olla käyttämättä sitä sateen aikana.
   • Erityinen ohje voi olla varmistaa, että sekä kädet että laite ovat kuivia, ennen kuin kytket laitteen pistorasiaan.
   • Tarjoa kuvia (kuten kallo ja sääriluut) tai eriväristä tekstiä (kuten punainen teksti), jotta varoitus erotetaan IFU: n muusta suunnasta ja kiinnitetään käyttäjien huomio siihen.
3. Kuvaile laitetta. Kuvauksen tulee sisältää sekä kirjallinen selvitys laitteen tarkoituksesta että pieni graafinen esitys laitteen ulkonäöstä. Kuvan tulisi merkitä ja nimetä kaikki laitteen sisältämät kytkimet, painikkeet ja kiinnitettävät osat.
4. Anna asennusohjeet. Asennusosassa on oltava perustiedot tuotteen tai laitteen käytön valmistelusta. Jos kotikäyttäjä ei pysty rakentamaan tai asentamaan laitetta, ilmoita se selvästi lihavoituna otsikkona asennusosan yläosassa. Sinun tulisi myös sisällyttää seuraavat:
   • Osaluettelo
   • Pakkauksen purkamisohjeet
   • Asennusvaroitukset
   • Väärän asennuksen seuraukset
   • Kenelle soittaa, jos asennuksen aikana ilmenee ongelmia
5. Anna tietoja toiminnasta. Tämä osa on tärkein osa käyttöohjetta, ja siinä tulisi olla konkreettisia, yksityiskohtaisia ​​tietoja laitteen käytöstä. Aloita laitteen käytön perusvalmisteluilla, kuten virtajohdon kytkeminen tai käsien peseminen. Jatka loogisilla, numeroiduilla vaiheilla, jotka kuvaavat laitteen käyttöä, sekä kaikki palautteet (esimerkiksi "Kuulet napsahduksen ..."), joita käyttäjä voi odottaa käyttäessään laitetta oikein.
   • Tämän luvun lopussa käyttäjät tulisi ohjata vianmääritysluvun kanssa sellaisten ongelmien ratkaisemiseksi, joita ei voida selittää nopeasti.
   • Sijoita kuvia tarvittaessa. Jotkut vaiheet selitetään parhaiten sekä kuvilla että sanoilla. Harkitse valokuvien tai kuvien käyttöä oppaassasi.
   • Tässä osiossa, kuten missä tahansa osassa, on oltava asiaankuuluvat turvallisuusvaroitukset väärinkäytöstä tai käytöstä. Voit esimerkiksi varoittaa moottorisahan käyttäjiä olemasta juomatta alkoholia tai käyttämättä moottorisahaa tiettyjen lääkkeiden kanssa.
   • Jos uskot käyttäjien hyötyvän, harkitse linkkien lisäämistä online-videoihin, jotka osoittavat laitteen asianmukaista käyttöä ja toimintaa. Voit tallentaa nämä videot joko tämän osan alkuun tai (jos video kuvaa vain yhtä vaihetta) kunkin vaiheen loppuun.
6. Liitä yhteenveto tuotteesta loppuun. Yhteenvedon tulisi näkyä käyttöohjeen lopussa, juuri ennen hakemistoa, perustoimintojen toimittamiseksi. Tämän tulisi olla yksinkertaistettu, poistettu versio operatiivisista tiedoista, ja sen tulisi olla enintään yksi sivu. Tee yhteenveto laitteen tai tuotteen käytöstä. Sisällytä perushälytykset, numeroidut vaiheet, jotka selittävät tuotteen käytön, sekä puhelinnumerot tai sähköpostiosoitteet, jotka ohjaavat käyttäjiä auttamaan.
   • Jos odotat käyttäjän poistavan yhteenvetolomakkeen tai viittaavan siihen usein, voit tulostaa sen irrotettavalle laminoidulle kortille tai paksulle pahville, jotta käyttäjän olisi helpompi kantaa sitä ja viitata siihen.
   • Vaihtoehtoisesti voit soveltaa yhteenvedon suoraan tuotteeseen käyttäjän nopeaa ja helppoa viittaamista varten.

Osa 3/4: Tuotteen ylläpidon kuvaus

1. Selitä laitteen puhdistaminen. Jos laite tai tuote tarvitsee puhdistusta, selitä miten se tehdään. Luettelo tarvittavista puhdistusaineista. Kerro lukijalle kuinka usein puhdistaa. Liitä sitten, kuten missä tahansa muussa käsikirjan osassa, numeroidut vaiheittaiset ohjeet sen puhdistamiseen.
   • Jos puhdistus edellyttää tuotteen purkamista tai tietyn osan tai osien poistamista, ilmoita, kuinka tuote on purettava.
   • Anna varoitus laitteen puhdistamisen epäonnistumisesta. Voit esimerkiksi sanoa: "Jos laitetta ei puhdisteta, suorituskyky on pienempi kuin optimaalinen."
2. Laske käyttäjälle, kuinka hän suorittaa perushuollon. Jos tuote tai laite on käyttäjän huollettavissa suorituskykyongelmien korjaamiseksi, anna numeroidut ohjeet siitä, miten se tehdään käyttäjälle. Jos esimerkiksi paristot on vaihdettava 300 käyttötunnin välein, anna ohjeet siitä, miten tarkistetaan, onko paristot vaihdettava, kuinka tyhjät paristot poistetaan ja miten uudet asennetaan.
   • Jos on olemassa tiettyjä huoltotöitä, jotka voi suorittaa vain valtuutettu teknikko, jaa käyttöoppaan huolto-osa kahteen osaan.
3. Keskustele tallennusvaihtoehdoista. Tarvittaessa käyttöoppaassa on selitettävä, kuinka tuote tai laite säilytetään oikein. sinun tulisi myös sisällyttää tietoja siitä, miksi tallennus on välttämätöntä ja väärän tallennuksen seuraukset. Esimerkiksi: voit kirjoittaa:
   • Säilytä tuotetta viileässä, kuivassa paikassa. Virheellinen varastointi voi lyhentää tuotteen käyttöikää kosteuden kertymisen vuoksi. "
   • "Älä altista tuotetta lämmölle tai säilytä sitä yli 50 celsiusasteen lämpötilassa.Jos teet niin, se voi johtaa palamiseen. "
4. Anna vianmääritystiedot. Voit järjestää tämän osan luettelona yleisimmistä ongelmista ja niiden ratkaisuista. Ryhmittele samanlaiset ongelmat loogiseen otsikkoon. Tällä tavalla käyttäjät voivat nopeasti löytää erityisiä ongelmia.
   • Jos esimerkiksi tietokoneessa on useita näyttöjä, joissa on sininen näyttö, ryhmitä ne alaotsikkoon, kuten "Yleiset näyttöongelmat".
   • Tässä osiossa on oltava myös puhelinnumero ja / tai sähköposti asiakaspalvelua varten.

Osa 4/4: Kirjoita luettava käsikirja

1. Lue muut käyttöoppaat. Ennen kuin kirjoitat käyttöoppaan omalle tuotteellesi, tutustu muihin tehokkaisiin käyttöoppaisiin. Kiinnitä huomiota rakenteeseen, sanavalintaan ja lauseen rakenteeseen. Suuret tuotemerkit, kuten Apple, Google ja Microsoft, tuottavat vahvoja ja tehokkaita käyttöoppaita, joiden avulla voit luoda tarkemmin kirjoitetun käyttöoppaan.
   • Älä vain lue kaikki käyttöoppaat. Lue vastaavien myymiesi tuotteiden käyttöoppaat. Jos esimerkiksi myyt vauvan tuotteita, lue vauvan käyttöohjeet, älä teknisiä.
2. Valitse standardisi. Oikeinkirjoituksen, sanavalinnan ja sanamuodon yhdenmukaistaminen tekee käyttöoppaasta käyttäjäystävällisemmän. Chicagon käsikirja tyylistä ja Microsoftin käsikirja tyylistä voivat myös olla hyödyllisiä tyylin oppaita kirjoitettaessa omistajan käsikirjaa. tarkista molemmat, onko jokin oikea käyttöoppaasi.
   • Esimerkiksi sen sijaan, että käytät käsikirjassa sekä virtakytkintä että virtapainiketta, valitse toinen kahdesta termistä ja pidä siitä kiinni.
3. Käytä aktiivista ääntä. Aktiivinen ääni on tapa kirjoittaa, joka selittää asioita käyttäjän näkökulmasta. Se on helpommin ymmärrettävissä kuin vaihtoehto, passiivinen ääni, jossa kohdetta ei ole määritelty.
   • Kokeile Hemingway-sovellusta (www.hemmingwayapp.com) tunnistaaksesi passiiviset kohdat kirjoituksessasi.
   • Tutki näitä kahta esimerkkilausetta - ensimmäinen on aktiivinen ja toinen passiivinen:
     • Pakkaus on avattava hitaasti ja varovasti.
     • Pakkaus on avattava hitaasti ja varovasti.
4. Kirjoita numeroidut ohjeet. Numeerisesti järjestetyt ohjeet auttavat lukijaa keskittymään paremmin tuotteen käyttämiseen, kytkemiseen tai rakentamiseen. Kirjoita käyttöoppaasi sen sijaan, että kirjoittaisit pitkän, yksityiskohtaisen kappaleen tai sarjan numeroimattomia kappaleita, yksinkertaisilla ja yksiselitteisillä vaiheilla, joista jokainen on selvästi numeroitu.
5. Aloita jokainen vaihe välttämättömällä tavalla. Imperatiivi on toimintakeskeinen verbi. Aloittamalla jokaisen vaiheen verbillä annat lukijalle vihjeen vaiheen suorittamiseen tarvittavasta toiminnasta. Esimerkiksi kirjoittamasi tuotteen mukaan voit aloittaa vaiheesi komennolla, kuten "Yhdistä", "Vahvista" tai "Liuku". Älä kuitenkaan aloita vaiheitasi järjestelmän vastauksella.
   • Esimerkiksi, jos näyttö muuttuu siniseksi ja alkaa vilkkua, älä aloita vaihetta seuraavasti: "Näyttö vilkkuu ja muuttuu siniseksi." Yritä: "Pidä aloitusnäppäintä painettuna. Näyttö vilkkuu ja muuttuu siniseksi. "
6. Määritä käytettävä sanasto. Jos kirjoitat jo-jo-opasta, yleisösi on enimmäkseen pieniä lapsia. Käytä yksinkertaisia ​​sanoja ja sanastoa selittääkseen, miten jo-jo toimii. Kun kirjoitat skannaavaa elektronimikroskooppikäsikirjaa, yleisösi koostuu ammattitaitoisista tiedemiehistä, jotka ymmärtävät hyvin yksityiskohtaisia ​​tietoja, joten älä epäröi käyttää erikoissanastoa tai vivahteikkaita selityksiä.
   • Yleensä yrität välttää ammattikieltä ja teknistä kieltä.
   • Yritä kirjoittaa ala-asteen kuudennesta seitsemänteen luokkaan, jotta voisit olla tehokas mahdollisimman laajalle käyttäjäkunnalle.
7. Kun lähetät tuotetta ulkomaille, varmista, että käännöksesi ovat tarkkoja. Palkkaa kääntäjä kääntämään käyttöoppaasi sen maan äidinkielelle, johon lähetät tuotteesi. Voit käyttää myös online-käännösohjelmaa, mutta pyydä äidinkielenään puhuvaa lukemaan käännös ja tarkistamaan virheet.
   • Jos yleisösi edustaa useita kieliryhmiä, sisällytä käyttöohjeen käännökset jokaiselle asiaankuuluvalle kielelle.
   • Kääntäjän on tunnettava tuote, koska kohdekielessä voi olla erilaisia ​​sanoja tietyille termeille, jotka eivät ole sanakohtaisia ​​käännöksiä.
8. Kirjoita lyhyillä lauseilla. Muutaman pitkän kappaleen sijaan käytät paljon lyhyitä kappaleita. Etsi kussakin osassa loogisia taukoja ja sulje hyödyllistä tietoa yhden tai kahden lauseen paloina. Sama pätee lauseiden tasolla. Pidä lauseesi lyhyinä ja yksinkertaisina, pikemminkin kuin pitkinä ja tarkkoina.
   • Jos askel on liian pitkä, jaa se pienempiin vaiheisiin. Tämä ei vähennä sanamäärää, mutta rivinvaihdot helpottavat lukemista.
9. Tarkista käyttöoppaasta virheiden varalta. Käsikirja voi menettää uskottavuutensa kieliopin ja kirjoitusvirheiden vuoksi. Pyydä kollegaa tai teknistä kirjoittajaa muokkaamaan ja oikolukemaan myös ohjekirjaa. Oikeinkirjoituksen ja kieliopin lisäksi oikolukijan tulisi kiinnittää huomiota seuraaviin:
   • Passiivinen ääni
   • Epäselvä tai sekava kieli
   • Kääritty lauseen rakenne
   • Liian pitkät kappaleet

Vinkkejä

• Ihmiset oppivat eri tavoin; Jos mahdollista ja aiheellista, sisällytä oppaaseen visuaalisia apuvälineitä tai linkkejä online-videoihin visuaalisesti suuntautuneiden lukijoiden sijoittamiseksi.