Kuinka kirjoittaa selkeitä ja ytimekkäitä käyttöoppaita

Mikä on käyttöopas?

Käyttöohjeilla on useita nimiä. Tekniset asiakirjat, huolto- ja käyttöohjeet ovat kaikki nimiä, jotka viittaavat samaan kohteeseen. Käyttöopas on tehty auttamaan asiakkaita käyttämään tuotettasi tai palveluasi oikein tai ratkaisemaan käytön aikana ilmeneviä ongelmia. Ne voivat olla saatavilla painetussa, digitaalisessa tai molemmissa muodoissa.

Käyttöoppaat tarjoavat loppukäyttäjälle kattavat, vaiheittaiset ohjeet ja tukea ongelmiin. Sisällysluettelon tulee olla jokaisessa käyttöoppaassa, koska ne ovat vertailumateriaaleja eikä kirjoja, jotka tulisi lukea alusta loppuun. Lisää pika-aloitus tai aloitusopas käyttöoppaaseen, jotta käyttäjät voivat tuntea olonsa helpoksi aloittaessaan tuotteen käytön.

erilaisia ​​käyttöohjeita

Useita eri aiheita ja tavoitteita varten voidaan tuottaa käyttöoppaita. Tässä on joitain mahdollisuuksistasi, joten katsotaanpa niitä.

• Käyttöohje
  Käyttöopas on eräänlainen käyttöopas, joka tarjoaa selkeät ohjeet tuotteen käyttämiseen tarkoitetulla tavalla.
• Koulutusopas
  Tällainen käyttöopas tarjoaa luettelon ohjeista tietyn tehtävän, projektin tai työn viimeistelemiseksi.
• Huoltokirja
  Huoltokäsikirjat ovat käyttöoppaita, jotka kuvaavat koneen tai laitteen huoltamista ja huoltoa eri paikoissatages sen eliniästä.
• Käyttöopas
  Käyttöoppaat ovat teknisiä julkaisuja, joissa selitetään, kuinka tuotetta käytetään tai käytetään oikein.
• Käyttöopas
  Yrityksen tai organisaation roolit, tehtävät ja menettelytavat on kuvattu käyttöoppaissa.
• Organisaatiopolitiikan käsikirja
  Organisaatiopolitiikan käsikirja on dokumentaatio, joka määrittelee yrityksen politiikat, käytännöt ja parhaat käytännöt.
• Vakiokäyttömenettelyjen (SOP) käsikirja
  Käyttäjät hyötyvät vakiokäyttöohjeen yksityiskohtaisista ohjeista vakiintuneiden toimenpiteiden suorittamiseksi.

Miksi yrityksesi tarvitsee käyttöohjeita?

Ihmiset pystyvät paremmin käsittelemään ongelmia yksin käyttöoppaan tuella. Kunnollinen käyttöopas voi antaa asiakkaillesi työkalut, joita he tarvitsevat saavuttaakseen nopeasti ja tehokkaasti tuotteeltasi tai palvelultasi haluamansa arvon nykypäivän välittömässä tyydytyksen kulttuurissa.

Erinomaista asiakaspalvelua on täydennettävä käyttöohjeilla. Erinomaisten käyttöoppaiden kirjoittaminen antaa seuraavan hyödyntages yrityksellesi:

• Tehdäkseen perehdyttämisestä ja harjoittelusta yksinkertaisempaa
  Hyvin kirjoitetut käyttöohjeet voivat yksinkertaistaa perehdyttämistä ja koulutusta. Se on oikein, kehittämällä ja ottamalla käyttöön huippuluokan käyttöoppaita, sekä työntekijäsi että kuluttajasi voivat hyötyä.
  Yrityksesi voi käyttää käyttöoppaita auttaakseen uusia työntekijöitä käymään läpi joitakin prosesseja ja järjestelmiä, jotka kuuluvat heidän uusiin rooleihinsa sen sijaan, että järjestäisivät vain vaikeita henkilökohtaisia ​​koulutustilaisuuksia, jotka vaativat merkittäviä aika- ja taloudellisia kustannuksia. Koska työntekijät voivat oppia tehdessään tehtäviinsä käyttöohjeiden ansiosta, tuntihäviöitä voi olla vähemmän perehdyttämisen aikana.
• Tukikulujen vähentämiseksi
  Käyttöoppaat ovat loistava lisä asiakaspalvelutyössäsi kuluttajalle, mutta ne palvelevat myös yrityksen omistajaa sekä osana asiakastukijärjestelmää.
  Asiakkaat löytävät ratkaisut todennäköisemmin heti, ja heidän on vähemmän todennäköisesti otettava yhteyttä teknikkoon tai edustajaan erikoistuen saamiseksi, kun annat heille nopean pääsyn haettavissa olevaan käyttöoppaaseen.
• Ajan säästämiseksi
  Sekä asiakkaasi että työntekijäsi, lähtötason henkilöstöstä johtoon, voivat säästää aikaa käyttämällä käyttöohjeita. Kun käyttöoppaat ovat asiakkaiden saatavilla, heidän ei tarvitse tuhlata aikaa etsiessään tietoa tuotteen käytöstä, koska heillä on suora pääsy tietoihin heti.
  Kun työntekijöilläsi on hyödyllisiä käyttöohjeita, heidän ei tarvitse tuhlata aikaa itsenäiseen ratkaisujen etsimiseen tai työtovereiden ja esimiesten huomion monopolioimiseen tiedusteluilla, koska heillä on pääsy ratkaisuihin suoraan käyttöoppaastaan!
• Vastuun minimoimiseksi
  Yksi tapa osoittaa, että olet testannut tuotteesi perusteellisesti ja osaat käyttää sitä turvallisesti, on kirjoittaa ja jakaa käyttöoppaita. Tämä voi merkittävästi alentaa yleisölle tuottamiseen liittyviä velvoitteita.
  Varoitusten ja turvatoimien kirjoittaminen ylös ja käyttäjien saataville käyttöoppaan kautta on tehokas (joskaan ei idioottivarma) tapa välttää oikeudellisia ongelmia, jotka liittyvät vammoihin tai muihin väärinkäytön aiheuttamiin vahinkoihin, jos myymäsi tuote saattaa olla vaarallinen käyttäjille (ajattele lämmittimet, sähkötyökalut jne.).

Mitkä komponentit muodostavat parhaat käyttöohjeet?

Loppukäyttäjän dokumentaatiossa on joitain parhaita käytäntöjä, joita on noudatettava riippumatta siitä, mitä tahansa, vaikka jokainen tuote on ainutlaatuinen ja tarvitsee erillisiä komponentteja todella erinomaisen käyttäjädokumentaation luomiseksi.

1. Selkeä kieli
   Mikään ei ärsytä asiakkaitasi enempää – paitsi se, että ei tarjoa sellaista – kuin huomaat, että heidän käyttöoppaansa on täynnä ammattikieltä ja vaikeasti ymmärrettävää kieltä. Käyttöohjeitasi on vaikea käyttää näiden kielivalintojen vuoksi, jotka eivät myöskään edistä erinomaista asiakaspalvelua. Sen varmistaminen, että kirjoitat käyttäjälle, ei kehittäjälle, on olennainen osa loistavien käyttöoppaiden luomista. Älä oleta, että loppukäyttäjäsi tietää tai tuntee mitään. Lyhenteet, ammattikieltä ja toimistoterminologia saavat asiakkaasi tuntemaan olonsa vääräksi, turhautuneiksi ja valmistautumattomiksi. Käyttöoppaan laatimisen paras vaihtoehto on löytää tasapaino sen välillä, ettet kirjoita ikään kuin kuluttajat olisivat lapsia (elleivät he tietenkään ole!) ja anna heille lisäapu, jonka he tarvitsevat ymmärtääkseen täysin, kuinka tuotetta käytetään. kieli.
2. Yksinkertaisuus
   Käyttöoppaan kirjoittaminen vaatii asioiden yksinkertaistamista. Tämän konseptin tulee näkyä sekä sisällössä että suunnittelussa. Jos täytät dokumentaatiosi liikaa monimutkaisilla kuvilla ja pitkillä tekstiosilla, se näyttää liian hienostuneelta ja vaikeaselkoiselta. Tällainen käyttöopas todennäköisesti pelottelee käyttäjääsi ja saa hänet soittamaan auttavaan numeroon sen sijaan, että he yrittäisivät selvittää ongelmansa itse.
3. Visuaalisia
   Maksimi "Näytä, älä kerro" on käyttöoppaan kirjoittamisen kulmakivi. Kuvakaappaukset, elokuvat ja muu visuaalinen sisältö ovat erittäin hyödyllisiä käsitteiden ymmärtämisessä. Usein on paljon hyödyllisempää nähdä jotain toiminnassa kuin lukea siitä. Visuaaliset materiaalit eivät ainoastaan ​​hajoa pitkiä tekstin kohtia, vaan ne myös vähentävät käyttöoppaissa olevan tekstin määrää, joka voi olla pelottavaa. On osoitettu, että ihmiset säilyttävät visuaalisen tiedon 7 % nopeammin kuin kirjallisen tiedon. Techsmith-tutkimuksessa osoitettiin myös, että 67 % ihmisistä suoriutui tehtäviä tehokkaammin, kun heille annettiin ohjeita, jotka sisälsivät huomautuksia sisältäviä kuvakaappauksia pelkkien sanojen sijaan tiedon välittämiseen.
4. Keskity ratkaistavaan ongelmaan
   On melko todennäköistä, että joku osti tuotteesi ratkaistakseen ongelman. On tärkeää keskittyä tähän asiaan, kun laaditaan tuotteen mukana toimitettavaa käyttöohjetta. Sen sijaan, että luettelet ja keskustelet kaikista tuotteesi tarjoamista ominaisuuksista tai sisällyttämistäsi kiehtovista suunnitteluelementeistä, kerro niistä käyttäjillesi tavalla, joka helpottaa tuotteen käyttöä. Laita ratkaistava ongelma tuotteesi ominaisuuksien ja etujen kontekstiin, kun kuvailet niitä.
5. Looginen kulku ja hierarkia
   Käytä selkeää hierarkkista rakennetta noudattavia otsikoita ja alaotsikoita, jotta käyttäjä huomaa, mitä hän oppii käyttöoppaasi kustakin osiosta. Jotta voit vaivattomasti ohjata asiakkaasi läpi kaiken heidän tarvitsemansa alusta loppuun, valitsemasi hierarkian tulee noudattaa loogista kulkua. Varmista, että aloitat perusteista ja sisällytä looginen eteneminen kohti tuotteesi kehittyneempiä ominaisuuksia.
6. Sisältöluettelo
   Käyttöoppaastasi on eniten hyötyä lukijoille, jos se alkaa sisällysluettelolla. Jollekulle on tuttu tapa tutkia dokumenttia nopeasti ja helposti ilman, että tarvitsee kaivella läpi monia sivuja tietoja, jotka eivät liity nykyiseen ongelmaan.
7. Tee siitä haettavissa
   Vaikka saatat tulostaa käyttöoppaasi, on todennäköistä, että digitaalinen dokumentaatio on tärkein prioriteettisi. On melko todennäköistä, että käyttöoppaitasi hyödynnetään useimmiten digitaalisessa muodossa maailmassa, jossa suurimmalla osalla ihmisistä on älypuhelin aina mukana. Haettavan ominaisuuden lisääminen digitaalisiin käyttöoppaisiin helpottaa käyttöä käyttäjille, jotka haluavat ratkaista ongelman käyttämällä sitä, samalla tavalla kuin sisällysluettelo ohjaa käyttäjät oikeaan paikkaan painetussa asiakirjassa.
8. Esteettömyys
   On mahdollista, että jotkut käyttäjät, jotka tarvitsevat käyttöoppaasi, voivat hyötyä lisätuesta varmistaakseen, että se toimii oikein. Riippumatta siitä, ovatko ne lain edellyttämät, saavutettavuusvaatimukset ovat yleensä hyviä käytäntöjä. Helppokäyttöisyysvaatimusten säilyttäminen käyttöoppaissasi on vain erinomaista liiketapaa. On erittäin tärkeää suunnitella käyttöoppaita, joiden sisältö on niiden käyttäjien saatavilla, joilla voi olla visuaalisia, kuultavia tai kognitiivisia haasteita.
9. Hyvin suunniteltu
   Ota yleisösi huomioon, kun luot käyttöoppaita. He ovat paljon taipuvaisempia käyttämään sitä tehokkaammin, jos teet jotain, jota he nauttivat katselemisesta! Vältä pitkien tekstilohkojen käyttöä ja jätä runsaasti tyhjää tilaa. Näiden kahden ominaisuuden yhdistäminen voi auttaa kuluttajia näyttämään vähemmän pelottavalta ja saada kaiken uuden oppiminen näyttämään jännittävältä eikä uhkaavalta. Aiemmin kuvaamamme "näytä, älä kerro" -lähestymistapa pätee myös tässä. Sekä painetuissa että digitaalisissa käyttöoppaissa visuaalien ja valokuvien lisääminen tekstiin on loistava vaihtoehto. Digitaalisille käyttöohjeille videot ja GIF-kuvat tarjoavat mielenkiintoa ja hyödyllistä elementtiä. Jos yritykselläsi on tyyliopas, suunnittelusi tulee noudattaa sitä; muuten, jos käytät ilman sitä, on erittäin tärkeää pitää käyttöoppaasi johdonmukaisena. Paperilla ja mieluiten kaikissa käyttöoppaissa käytettyjen fonttien ja värimallien tulee olla yhdenmukaisia.
10. Varsinaisten asiakkaiden tai beta-testaajien kommentit
    Et voi määrittää, ovatko laatimasi käyttöohjeet mahdollisimman onnistuneita, ennen kuin olet etsinyt ja kuunnellut palautetta ihmisiltä, ​​jotka todella käyttävät tuotettasi. Tuotteellesi kehittämissäsi käyttöoppaissa tulee ottaa huomioon ihmisten ongelmat sen kanssa. Saatat oppia jotain, joka näyttää erittäin ilmeiseltä, mutta on paljon paremmat mahdollisuudet, että opit jotain, joka auttaa sinua ymmärtämään asiakkaiden tarpeita, joita yrität tavoittaa.

Kuinka kirjoitan käyttöoppaan?

Käyttöoppaan tekeminen on ratkaiseva tehtävä, jolla voi olla suuri vaikutus sekä yritykseesi että kuluttajiin, joita haluat palvella. Olemme yksinkertaistaneet käyttöoppaan kehittämisprosessia, jotta voit helposti seurata sitä, koska se voi olla ylivoimaista.

• Tunnista käyttäjät
  Viestisi vastaanottajan löytäminen on olennainen alkuvaihe, aivan kuten minkä tahansa muun luomasi viestintäsi yhteydessä. Käyttöoppaasi kohdeyleisö auttaa sinua päättämään sellaisista asioista kuin sävy, tarjottavan yksityiskohtaisuus ja sisällön toimitustapa. Käyttöoppaan kirjoittaminen tuotteesi loppukäyttäjälle eroaa merkittävästi tekniikan insinöörin kirjoittamisesta. Ensimmäinen askel on määrittää yleisösi.
• Keskity ongelmaan
  Käyttöoppaat on tehty auttamaan ongelmanratkaisussa tai opastamaan jotakuta uuden tekemisessä. Sinun on määritettävä tarkasti, mitä käyttöoppaasi on tarkoitus tehdä, ja varmista, että pysyt keskittymässä.
  Voi olla houkuttelevaa laajentaa aihetta ja keskustella tuotteesi lukuisista ominaisuuksista tai sovelluksista. Tämä voi turhauttaa käyttäjiä ja johtaa puheluihin asiakastukilinjaasi hämärtämällä heidän tarvitsemansa aidon vastauksen.
  Jos asiakkaasi on kuluttaja, joka oppii käyttämään tuotetta, tai teknikko, jonka täytyy korjata se, keskity tarkalleen tarvitsemaansa ratkaisuun.
• Käytä peräkkäistä lähestymistapaa
  Käyttöoppaasi ohjeet tulee laatia siinä järjestyksessä, joka on tarpeen käsillä olevan työn suorittamiseksi. Luettele jokainen vaihe aloittaaksesi. Yritä sitten suorittaa tehtävä noudattaen tarkkoja vaiheita, jotka olet hahmotellut annetussa järjestyksessä. Kun käyt läpi alkuperäistä luetteloasi, on mahdollista, ehkä jopa todennäköistä, että löydät stagjotka puuttuvat. Lisäksi saatat huomata, että jokin asia, jonka olet aiemmin uskonut olevan yksi tehtävä, on itse asiassa jaettava useisiin toimintoihin selvyyden vuoksi.
  Varmista, että olet määrittänyt selkeän tuloksen jokaiselle määrittämäsi peräkkäiselle vaiheelle ennen kuin siirryt seuraavaan käyttöoppaan kirjoittamisen vaiheeseen. Ennen seuraavalle tasolle siirtymistä lukijoiden tulee olla täysin selvillä siitä, mitä he haluavat saavuttaa ja miltä sen pitäisi näyttää.
• Kartan käyttäjän matka
  Käyttöoppaan laatimisen tavoitteena on ymmärtää, kuinka kuluttajat aikovat käyttää tuotettasi, ja tehdä siitä helppoa. Sinun on ponnisteltava ymmärtääksesi ongelman, jota kuluttaja yrittää ratkaista, tai tavoitteen, jonka hän yrittää saavuttaa käyttämällä ratkaisuasi, sekä sen, kuinka he sitoutuvat yritykseesi. Voit suunnitella tarvittavat vaiheet ohjataksesi asiakasta prosessin läpi käyttämällä näitä tietoja visualisoidaksesi hänen matkaansa ongelmasta ratkaisuun.
• Valitse malli
  Käyttöoppaiden kirjoittaminen ja kehittäminen voidaan tehdä paljon yksinkertaisemmiksi luomalla useita malleja. Menettelysi voi olla virtaviivaistettu, ja johdonmukaisuudesta tulee paljon realistisempi tavoite.
  Sen lisäksi, että määrität tietoja, kuten fontit (tyyppi ja koko), kontrastivaatimukset ja värimallit, sinun tulee sisällyttää käyttöoppaasi malliin myös seuraavat tiedot:
  • Esittelyyn varattu alue
  • Erilliset alaosastot ja osat
  • Valitsemasi muoto toimintosarjan välittämiseksi
  • Varoitukset ja varoitukset
  • Johtopäätöstä varten varattu alue
• Kirjoita yksinkertaista ja helposti seurattavaa sisältöä
  Käyttöoppaasi materiaalin tulee olla mahdollisimman suoraviivaista ja yksinkertaista ymmärtää. On tärkeää miettiä ja analysoida muotoa ja sisältöä selkeyden ja mukavuuden vuoksi.
  Varmista, että prosessin jokaisessa vaiheessa hahmotellaan vain yksi tehtävä ja että siinä käytetään mahdollisimman selkeää ja lyhyttä kieltä. Muista muokata tekstiäsi oikein, kunnes sinulla on käyttöopas, joka sisältää vain todella tarpeelliset tiedot.
• Lähesty jokaista käyttäjää kuin aloittelijaa
  Oletetaan, että käyttöoppaasi lukijalla ei ole aiempaa tietoa tuotteestasi sitä luodessaan. Kirjoita ikään kuin puhuisit maallikolle.
  Kaikenlaista ammattikieltä tai teknistä kieltä tulee välttää. Tietysti tulee aikoja, jolloin sitä on vältettävä, mutta näiden pitäisi olla ehdoton poikkeus.
• Testaa tuotteen ohjeita aloittelevien käyttäjien kanssa
  Käyttöoppaan luontiprosessin testausvaihe on ratkaiseva. Kokeen aiheella on merkittävä vaikutus lopputulokseen.
  Testaus tulisi mieluiten tehdä ihmisille, jotka eivät ole koskaan käyttäneet tuotettasi tai nähneet dokumentaatiota. Kun siirryt käyttöoppaan läpi, katso, kuinka he suorittavat prosessin ja tallenna, missä ne ovat juuttuneet. Sen jälkeen tiedot on päivitettävä asianmukaisesti.
  Ainoastaan ​​käyttöoppaan apua tarvitaan, jotta testaajat voivat käyttää tuotetta. Heidän ei pitäisi pyytää enempää apua. Neuvostoliiton oppaassa pitäisi olla kaikki tarvitsemansa tiedot.
• Rakenna sisältöä käytännönläheisesti
  Konkreettisia exampja yksityiskohtaiset kuvaukset tuloksista, joita käyttäjät voivat kokea jokaisen käyttöoppaan vaiheen jälkeen. Käyttäjän tulee olla tietoinen kaikesta palautteesta, jota hän saattaa saada tuotteesta, sekä mahdollisista nähtävyyksistä tai äänistä, joita hän saattaa kohdata matkan varrella.
• Selitä symbolit, kuvakkeet ja koodit ajoissa
  Saatat joutua käyttämään kuvakkeita, symboleja tai koodeja, kun kirjoitat käyttöopasta, jotta saat tarvittavat ohjeet. Lukijoiden hämmennyksen tai turhautumisen estämiseksi on erittäin tärkeää tunnistaa ne mahdollisimman varhaisessa käyttöoppaassa.

Käyttöohjeen usein kysytyt kysymykset

Mitä käyttöohjeet tarkalleen ottaen ovat?

Käyttäjädokumentaatio on tietoa, joka tarjotaan käyttöoppaiden tai käyttöoppaiden muodossa, ja sen tarkoituksena on auttaa loppukäyttäjiä vuorovaikutuksessa tuotteen kanssa.

• Millaista käyttäjädokumentaatiota on olemassa?
  Fyysistä dokumentaatiota, kuten esitteitä tai käsikirjoja, on perinteisesti käytetty tarjoamaan käyttäjädokumentaatiota. Nykyään käyttöoppaita tuotetaan ja jaetaan useammin digitaalisesti.
• Mitä käyttöohjeet sisältävät?
  Ohjekirjassa tai käyttöoppaassa käytetään hyvää suunnittelua, selkeää kirjoitusta ja keskittymistä ongelmanratkaisuun. Minulla on oltava sisällysluettelo, noudatettava loogista hierarkiaa ja kulkua ja tarjottava sisältöä, joka on saatavilla. Lisäksi hyvä käyttöopas on haettavissa ja ottaa huomioon käyttäjän reviews.
• Miten käyttäjädokumentti tehdään?
  Käyttöoppaita voidaan kehittää yksinkertaisten vaiheiden avulla. Käyttöoppaan tavoitteet on ensin määriteltävä ja niiden saavuttamisen mahdollistamiseksi on kehitettävä strategia. Käyttöopas on testattava ja tarvittaessa päivitettävä ennen julkaisemista. Lopuksi on tärkeää pitää käyttöopas ajan tasalla ja tehdä muutoksia sitä mukaa, kun uusia päivityksiä tai versioita lisätään.