Tuotteen dokumentointi
Mitä dokumentaatiolla tarkoitetaan? Dokumentointi on kohteena olevan asian, tapahtuman tai tuotteen tarkkaa kirjallista kuvaamista eli kirjaamista. Kirjaamisen pitää olla yksiselitteistä. Kirjaamisen pitää olla ajantasaista. Kun tuote muuttuu, pitää dokumentoinninkin uudistua. Kirjaaminen on tärkeää monimutkaisten rakenteiden ja tuotteiden (laite, ohjelmisto tms.) ymmärtämiseksi. Dokumentteja ovat testaustulokset, tuotekuvaukset, käyttöohjeet. Yleensä käyttöohjeessa on myös tuotekuvaus tai laitekuvaus.
Hyvä dokumentointi ja yrityksen maine Hyvä dokumentaatio kertoo tuotteiden laadusta. Hyvä dokumentaatio antaa kuvan luotettavista tuotteista ja yrityksen hyvästä palvelutasosta. Hyvä dokumentaatio antaa asiakkaan lisäksi tietoa tuotteen myyjille ja huoltohenkilöstölle.
Hyvä dokumentaatio on rakenteeltaan selkeä (tärkeät tiedot löytyvät helposti) on kieleltään selkeä ja yksiselitteinen ei sisällä liian laajoja tekstiosuuksia on riittävän havainnollinen on visuaalinen (kuvia) on riittävän suurta tekstiä on helposti saatavilla
Dokumentin rakenne ja ulkoasu Yrityksessä käytetään ennalta sovittua dokumentointimallia. (Nämä mallit on yleensä määritelty yrityksen sisäisen ja ulkoisen viestinnän ohjeistuksissa.) Dokumenttien ulkoasun pitää olla aina sama. Dokumentissa on aina kansilehti. Yrityksen nimi Dokumentin nimi Tuotteen nimi Tekijät Version numero Dokumentissa on sisällysluettelo. Dokumentin sivut numeroidaan.
OSAON malleja
Käytäntöön Tutkitaan dokumentteja Tutkitaan dokumentoitavaa tuotetta Suunnitellaan dokumentointia