Käyttöohjeet - User guide

Ei pidä sekoittaa käyttöoppaaseen .

Käyttöohjeet , myös yleisesti tunnettu käyttöohjeet , on tarkoitus auttaa käyttäjiä käyttää tiettyä tuotetta, palvelun tai sovelluksen. Sen on yleensä kirjoittanut teknikko, tuotekehittäjä tai yrityksen asiakaspalvelu.

Käyttöohjeet sisältyvät usein kodinkoneiden hankintaan. Mutta nyt se on yleistä molemmissa palveluissa, ohjelmistoissa, sovelluksissa ... Se julkaistaan ​​paperiversiona tai pehmeänä (asiakirja tai sovellus).

Useimmat käyttöoppaat sisältävät sekä kirjallisen oppaan että siihen liittyviä kuvia. Tietokonesovellusten tapauksessa on tavallista sisällyttää kuvakaappauksia ihmisen ja koneen rajapinnasta, ja laitteisto-oppaat sisältävät usein selkeitä, yksinkertaistettuja kaavioita . Käytetty kieli sovitetaan tarkoitettuun yleisöön , ja ammattikieltä pidetään minimissä tai se selitetään perusteellisesti.

Käyttöoppaan sisältö

Käyttöoppaan osiin kuuluu usein:

  • Kansilehti
  • Otsikko- ja tekijänoikeussivu
  • Esipuhe, joka sisältää tietoja liittyvistä asiakirjoista ja tietoja käyttöoppaan navigoinnista
  • Sisältösivu
  • A Tarkoitus -osio. Tämän pitäisi olla pikemminkin yleiskatsaus kuin asiakirjan tavoite
  • Yleisö -osio, jossa ilmoitetaan nimenomaisesti, kuka on kohdeyleisö, joka on luettava, mukaan lukien valinnaiset
  • Soveltamisala-osa on ratkaiseva, koska se toimii myös vastuuvapauslausekkeena, jossa ilmoitetaan, mikä on soveltamisalan ulkopuolella ja mitä se kattaa
  • Opas ainakin järjestelmän päätoiminnon käyttämiseen
  • Vianmääritys osio yksityiskohtaisesti mahdollisista virheistä tai ongelmia, joita saattaa ilmetä, sekä niiden korjaamista
  • FAQ (usein kysytyt kysymykset)
  • Mistä saa lisää apua ja yhteystiedot
  • Sanasto ja suurempien -asiakirjojen indeksi

Historia

Image
Käyttöopas on kaiverrettu Antikythera -mekanismin malliin.

Käyttöoppaita on löydetty muinaisista laitteista. Yksi esimerkki on Antikythera -mekanismi , 2000 vuotta vanha kreikkalainen analoginen tietokone, joka löydettiin Kreikan Antikytheran saaren rannikolta vuonna 1900. Tämän laitteen kannessa on tekstikohtia, jotka kuvaavat mekanismin ominaisuuksia ja toimintaa.

Ohjelmistoteollisuuden kehittyessä kysymys siitä, miten parhaiten dokumentoida ohjelmistoja, oli päättämätön. Tämä oli ainutlaatuinen ongelma ohjelmistokehittäjille, koska käyttäjät turhautuivat usein nykyisiin ohjeasiakirjoihin. Joitakin tällä hetkellä kehitettyjä käyttöoppaan kirjoittamisen näkökohtia ovat:

  • käyttö selkokielinen
  • pituus ja lukemisvaikeudet
  • digitaalisten ohjelmien painettujen käyttöoppaiden rooli
  • käyttäjäkeskeinen muotoilu

Tietokoneohjelmistojen käyttöoppaat ja oppaat

Useimpien ei-triviaalien sovellusten käyttöoppaat ja käyttöoppaat ovat kirjan kaltaisia ​​asiakirjoja, joiden sisältö on samanlainen kuin yllä oleva luettelo. Ne voidaan jakaa joko painettuna tai sähköisesti. Joillakin asiakirjoilla on joustavampi rakenne, jossa on monia sisäisiä linkkejä. Google Earthin käyttöopas on esimerkki tässä muodossa. Termiä opas käytetään usein asiakirjassa, joka koskee tiettyä ohjelmistotuotteen osaa. Jotkut käyttötavat ovat Installation Guide , aloitusopas , ja erilaiset Miten oppaita. Esimerkki on Picasan aloitusopas .

Joissakin yritysohjelmistosovelluksissa , joissa käyttäjäryhmillä on pääsy vain osaan sovelluksen kaikista toiminnoista, jokaiselle ryhmälle voidaan laatia käyttöopas. Esimerkkinä tästä lähestymistavasta on Autodesk Topobase 2010 Help asiakirja, joka sisältää erilliset Administrator oppaat , User Guides , ja kehittäjän oppaan .

Katso myös

Viitteet