Riippumatta siitä, kuinka kekseliäitä, ohjelmoivia tai järkeilijöitä kekseliäitä tahansa on, joskus hänen luomuksiaan ei yksinkertaisesti voida käyttää aiottuun tarkoitukseen. Syynä tähän on väärin laadittu käyttöohje tai sen täydellinen puuttuminen. Mutta myös nerokkaat keksijät kirjoittavat joskus sellaisia ohjeita, että kapeita asiantuntijoita lukuun ottamatta kukaan ei voi lukea näitä papereita. Joten miten laadit oikein tarvittavan asiakirjan?
Se on välttämätöntä
- - sataprosenttinen tieto laitteesta tai ohjelmistotuotteesta, jota varten opasta kirjoitetaan;
- - kielitieteen osaaminen
- - kirjoitustaidot.
Ohjeet
Vaihe 1
Käyttöohje tai toisin sanoen käyttöohje on asiakirja, joka on suunniteltu tarjoamaan apua tietyn järjestelmän käytössä sen käyttäjille. Käyttöoppaan laatimiseksi sinun on tunnettava kuvattu järjestelmä sataprosenttisesti, mutta katsottava sitä tietämättömän opiskelijan silmillä. Oletetaan, että käyttöopas on kirjoitettu ohjelmistolle, jolla ei ole vielä analogeja. Kuvittele, että käytät tätä ohjelmaa ensimmäistä kertaa. Mistä aloitat? Mikä on ensimmäinen asia tietää? Järjestä tämä tieto tärkeysluokkiin.
Vaihe 2
Jakamalla kaikki luomistasi koskevat tiedot ryhmiin, olet laatinut suunnitelman käyttöoppaan kirjoittamisesta. Aloita ohjelmasi työn kuvaaminen alusta alkaen, jättäen viimeisimmät vaikeimmat yksityiskohdat, kuten ohjelmointiominaisuudet uudelleen tai käsittelemällä kriittisiä virheitä. Tässä vaiheessa käyttäjän tulee olla valmis käyttöoppaan sisältö - yksi tämän asiakirjan vaadituista osista.
Vaihe 3
Jos luomasi käsikirja on tarkoitettu käytettäväksi suuressa yrityksessä, sinun on kiinnitettävä huomiota siellä sovellettuihin yritysstandardeihin. Esimerkiksi monissa venäläisissä yrityksissä käyttöoppaita ei hyväksytä ilman havainnollistavaa tukea, toisin sanoen kuvia, jotka selittävät kirjoitettua. Sisällön lisäksi käyttöoppaassa tulisi olla muita pakollisia osia: - huomautus, eli selitys käsikirjan ja kuvatun tuotteen yleistavoitteista; - johdanto, joka kuvaa käyttöohjeeseen liittyviä asiakirjoja ja miten käyttöoppaan käyttö - osiot, joissa selitetään tuotteen käyttöä sen eri vaiheissa, esimerkiksi ensimmäiset vaiheet, korjaus tai huolto - osio usein kysyttyjä kysymyksiä ja vastauksia niihin - sanasto tai aihehakemisto.
Vaihe 4
Yleensä käyttöoppaan luomiseen osallistuu tekninen kirjoittaja - henkilö, jolla on kaikki tarvittavat tiedot sekä kielellä että kuvatulla tuotteella. Teknisenä kirjoittajana ilman koulutusta on pidettävä mielessä muutama sääntö. Ensinnäkin, sinun ei pidä käyttää väärin erityisehtoja, joita tavallinen käyttäjä ei ymmärrä. Toiseksi jokaisen käytetyn termin on oltava yksityiskohtainen ja selitettävä. Kolmanneksi sinun on kirjoitettava mahdollisimman selkeästi ja ytimekkäästi. Lopuksi teknisen kirjoittajan on kyettävä tarkastelemaan omaa tekstiään tavallisen käyttäjän silmin nähdäkseen oman tekstinsä puutteet.
Vaihe 5
On hyvä testata käyttöohjeen lopputeksti käytännössä tarjoamalla se henkilölle, jolla ei ole mitään tekemistä kuvatun tuotteen kanssa. Yhteisin ponnisteluin on mahdollista poistaa kaikki asiakirjan puutteet ja sudenkuopat.
