Tekniset oppaat

Tekniset oppaat voivat sisältää seuraavia kokonaisuuksia tai niiden osia:

 

Asennus, käyttö, muutokset, osaluettelot, huolto, vianetsintä ja korjaaminen, henkilöstön tuki- ja koulutusvaatimukset sekä erityiset ohjeet laitteiden tai järjestelmien turvallista ja tehokasta käyttöikää varten.

 

 

 

Käyttöohjeet

Käyttöohjeet auttavat käyttäjiä ymmärtämään, kuinka tuotetta tai palvelua käytetään parhaiten. Ne tarjoavat hyödyllistä tietoa henkilöstölle, joka tarvitsee perusohjeita jokapäiväiseen käyttöön.

 

Ohjeet voivat olla joko lehtisen, muistion tai kattavan ohjeistuksen muodossa, ja mielellään sisältäen tekstiä tukevia kuvia tai kaavioita.

 

 

 

Suunnittelumäärittely

Suunnittelumäärittely on yksityiskohtainen kuvaus siitä, miten jotain pitäisi valmistaa, suunnitella ja asentaa. Se voi koostua grafiikoista ja asiakirjoista, joissa luetellaan käyttäjän näkökulmasta vaatimukset laitteille, asennuksille tai järjestelmille, ja siinä otetaan yleensä huomioon käyttäjän vaatimukset MoSCoW-priorisointimenetelmän näkökulmasta, eli "täytyy olla" (Must have), "pitäisi olla" (Should have), "voisi olla" (Could have) ja "olisi mukavaa olla" (Would be nice to have).

Lohkokaaviot

Lohkokaaviot esittävät asennuksen tai järjestelmän pää- ja alakokoonpanot sekä niiden yhteenliittymät ja sijainnit piirustuksen muodossa; ne auttavat perehdyttämisessä ja voivat olla teknisen oppaan osa.

 

Kytkentäkaaviot menevät syvemmälle asennuksen tai järjestelmän yksityiskohtiin, sen kokoonpanoihin, alikokoonpanoihin, niiden tarvikkeisiin ja muihin niihin liittyviin yhteyksiin, jopa komponenttitasolle asti.

Lomakkeet ja tarkistuslistat

Lomakkeet mahdollistavat tietyn tapahtuman, toiminnon tai prosessin suorittamisen ja auditoinnin; sekä tekninen että ei-tekninen henkilöstö voivat käyttää niitä.

 

Tarkistuslistat mahdollistavat toimintojen suorittamisen samankaltaisesti kuin lomakkeiden kanssa, mutta lisäten valintaruutuja, jotka antavat positiivisen tai kielteisen vastauksen prosessin tiettyyn osaan; sekä tekninen että ei-tekninen henkilöstö voivat käyttää myös tarkistuslistoja.

Asennusmäärittely

Asennusmäärittely vie suunnitteluasiakirjat eteenpäin tärkeimmille sidosryhmille, kuten valmistajille, toimittajille, tekniselle henkilöstölle ja käyttäjille.

Näin varmistetaan, että alkuperäisen suunnitelman turvallisuutta, toimivuutta, kestävyyttä ja luotettavuutta koskevat standardit eivät vaarannu. Asennusmäärittelyssä luetellaan tarvittavat osat ja materiaalit, sekä kustannukset ja aikataulut.

 

Prosessikaaviot

Prosessikaavio (tai algoritmi) on prosessin graafinen esitys, joka koostuu useista käsittelyvaiheista, toimista tai toiminnoista ja näihin perustuvista ratkaisuista.

 

Prosessikaaviota käytetään keinona saada käsitys siitä, miten prosessi toimii, mistä vaiheista se koostuu, mitkä tapahtumat muuttavat lopputulosta, ja mahdollistaa asiaankuuluvien standardien ja laadun noudattamisen.

Oikolukeminen

Asiakirjan oikoluvulla ei tarkisteta vain oikeinkirjoitusta; sillä tarkistetaan asiakirjan kielioppi ja asettelu, sekä se, että kuvat tai kaaviot ovat oikeassa paikassa tekstiin nähden, ja että asiakirja vaikuttaa soveltuvan aiotulle yleisölle.

 

 

 

 

 

 

Esitykset

Tietojen esittäminen voi olla sekä käytännönläheistä että visuaalista; sen tulee olla selkeää, ilman ammattiterminologiaa, helposti ymmärrettävää, mieluiten vuorovaikutteista, ja sisältää asiaankuuluvat asiakirjat esityksen tueksi.