Tämän kirjoituksen tarkoitus ei ole antaa kaiken kattavaa vastausta siihen, mitä dokumentaatiota myytävän tuotteen oheen tulee tuottaa. Dokumentaatio on usein tapauskohtainen kokonaisuus, johon vaikuttavat määräysten lisäksi esimerkiksi tuotteen luonne (onko se itsenäinen tuote vai osa suurempaa kokonaisuutta) ja yrityksen muut tuotteet, brändi, yrityksen markkinointi, käyttäjäystävällisyys, budjetti, jne. Dokumentoinnissa toistuvat samat asiat, mutta myös tapauskohtainen tarkastelu ja pohdinta on yleensä paikallaan – selvitys vaatii vain aikaa.
Jos tuotetta myydään Euroopan maissa, sen tulee täyttää CE-merkinnän vaatimukset. CE-merkintä edellyttää laitteen turvallista, riskianalyysiin perustuvaa suunnittelua. CE-merkintä edellyttää myös tietynlaista dokumentaatiota. CE-merkintä ei kuitenkaan pääsääntöisesti vaadi viranomaisen suorittamaa tarkastusta ennen tuotteen markkinoille saattamista, minkä vuoksi puutteellisellakin tuotteella voidaan pärjätä siihen asti, kunnes tekevälle sattuu. Asiaa tutkiessaan viranomainen tarttuu ensimmäisenä kiinni dokumentaatioon, jonka tulisi markkinoilla olevien tuotteiden kohdalla olla huolella viimeistelty. Suomessa Tukes:n markkinavalvontakampanjoiden yhteydessä eräs yleisimmin todetuista puutteista on dokumentaation riittämättömyys, mikä voi johtaa tuotteen markkinoilta poistamiseen.
Konedirektiivin mukaan koneen mukana tulee toimittaa turvallista käyttöä koskevat ohjeet. Myös mahdollisen Quick Guiden tulee sisältää kaikki oleelliset tiedot käytön aloittamiseen ja turvalliseen käyttöön. Turvallisen käytön ohjeistuksella tarkoitetaan konedirektiivissä nimenomaan käyttäjän turvallisuuteen liittyviä ohjeita. Koneen mukana ei tarvitse toimittaa säätöihin tai huoltoon liittyviä asiakirjoja eikä koneeseen liittyviä piirustuksia, jos ne eivät ole oleellisia koneen turvallisen käsittelyn kannalta. Ohjeet tulee vielä nykyisin toimittaa koneen mukana tulostettuina, mutta säätöihin, lisävarusteisiin, variantteihin ym. liittyvät ohjeistukset voivat olla sähköisessä muodossa. Viranomaisten kanssa käytyjen keskustelujen mukaan ainoastaan internetistä löytyvää ohjetta ei voida katsoa koneen mukana toimitetuksi, sillä se vaatii käyttäjältä pääsyä internetiin. Sähköistä ohjeistusta on kuitenkin kätevämpi päivittää ja se on käytettävyydeltään helpompi, minkä vuoksi usein sekin tehdään tuotteelle kokonaisuudessaan.
Konedirektiivissä on määritelty paljon dokumentoinnin sisältöä ja se antaakin selkeän ohjeistuksen siitä, mitä koneesta tulee kertoa esimerkiksi käyttö- ja huolto-ohjeissa: Mitä tyyppikilvessä tulee olla, mitä riskeihin liittyviä varoituksia ohjeisiin tulee kirjata, mitä teknisen rakennetiedoston tulee sisältää ja niin edelleen.
Jos dokumentoitavaa kohdetta ei määritellä koneeksi, laite voi olla muiden CE-merkintää edellyttävien direktiivien, kuten pienjännitedirektiivin tai EMC-direktiivin, alainen. Näissä molemmissa on dokumentoinnista huomattavasti ylimalkaisempi ohjeistus kuin konedirektiivissä. Molemmista direktiiveistä löytyy asioita, joita tulee olla dokumentaatiossa, mutta kuluttajalle toimitettavaan sisältöön EMC- tai pienjännitedirektiivi eivät tarjoa kovin paljon ehdotuksia tai vaatimuksia; ilmoitus soveltuvuudesta riittää.
Dokumentoinnin kohteena oleva laite tai pelkkä software voi olla jonkin sellaisen standardin mukainen, joka asettaa vaatimuksia dokumentoinnille. Dokumentoinnin kannalta standardin vaatimusten täyttäminen vaatii tosin lähinnä hieman selvitystä ja aikaa: Luetaan standardia, peilataan sitä dokumentoitavaan tuotteeseen ja poimitaan ohjeisiin oleelliset asiat. Prosessi ei tämän monimutkaisempi ole, mutta se vaatii oman aikansa. Dokumentointivaiheessa voidaan turvallisuutta täydentää vielä tiedottamalla jäännösriskeistä, joskin riskien hallinta kuuluu varsinaisesti koneen suunnittelun piiriin.
Dokumentointistandardi SFS-EN 82079-1 on hyvä ohjekirja käyttö- ja huolto-ohjeiden tekemiselle. Jotta voidaan mainostaa dokumentaation olevan SFS-EN 82079-1 mukainen, pitää tehty dokumentaatio testata ja dokumentoida dokumentointi. Näin syvälliseen dokumentoinnin dokumentointiin ei budjetissa yleensä ole varaa, mutta SFS-EN 82079-1 antaa hyvän pohjan moneen tilanteeseen. Sen tarkistuslistat ovat omiaan tarkasteltaessa tehtyä luonnosta ja pohdittaessa, mitä olisi tarpeen lisätä. Dokumentointistandardi ottaa kantaa jopa tekstin minimi- tai maksimikokoon sekä neuvoo muun muassa, milloin dokumentissa tulee olla sisällysluettelo. Dokumentointistandardia ehkä pikemminkin sovelletaan kuin noudatetaan täysin.
Kuvituspuolella on piktogrammisarjoja, kuten ISO 7010 – ja ISO 3864 -sarjat, joissa on kaikille tuttuja kuvakkeita ja joiden käyttö on perusasia dokumentoinnin ammattilaiselle. Huomioitavaa on myös se, että globaalisti standardisymbolit voivat vaihdella, esimerkiksi Yhdysvalloissa ANSI-standardien mukaisesti.
RD Velholla on jo käytössä kattava kokoelma yleisimpiä suunnitteluun ja dokumentointiin liittyviä standardeja, joita sovelletaan projektitarpeiden mukaisesti. Standardikirjasto ei kuitenkaan ole täydellinen ja standardit uudistuvat jatkuvasti, minkä vuoksi projektikohtaisesti voidaan tehdä uusia hankintoja. Tosin nykyisellä kirjastolla selvitään useimmissa tapauksissa.
Lue lisää Teknisestä dokumentoinnista.
Teksti: Emmi Helanne, Petri Häll ja Taija Piippo
Kuvitus: Hanna Ruusulampi