Laadukas ja oikeasisältöinen
Tekninen dokumentointi
Valmistan yrityksen tuotteelle tai palvelulle teknistä dokumentaatiota tilauksesta. Käyttöohje, asennusohje tai varaosaluettelo. Dokumentaatio on osa palvelua / tuotetta ja se ei saa olla tuotteen heikoin lenkki.
Tekninen dokumentaatio – osa tuotetta
Teknisen dokumentin käyttötarkoitus
Tekniset dokumentit valmistetaan eri medioihin julkaistavaksi: perinteiseksi paperioppaaksi, sähköiseksi jaettavaksi dokumentiksi tai vaikkapa itse tuotteeseen online -helpiksi.
Lähdemateriaali
Lähdemateriaali voi olla peräisin esimerkiksi asiakkaan tuotetietojen hallintajärjestelmästä tai asiakkaan alihankkijoiden suunnittelujärjestelmistä. Ilman lähdemateriaaliakin käyttöohje syntyy, haastattelu – tuotteeseen tutustuminen – tuotteen käyttäminen -prosessin kautta. Tuotteen suunnittelu- ja testiraportit toki auttavat dokumentaation suunnittelussa merkittävästi.
Dokumentoinnin suunnittelu vaiheittain
Pääsääntöisesti teknisen dokumentin valmistamiseen kuuluu kuvien valmistus, tekstin tuottaminen & muokkaus sekä tarvittaessa käännöspalvelut, joko itse tehtynä tai alihankintana. Valitsemme tarvittaessa asiakkaan kanssa yhteistyössä sopivimmat dokumentoinnin työkalut sekä valmistuvien dokumenttien julkaisuformaatit. Hoidan mielelläni myös toteutettujen dokumenttien ylläpidon, jotta tiedot pysyvät ajan tasalla.
Dokumentointiprosessi voidaan jakaa karkeasti kuuteen osa-alueeseen:
- Työkalut asiakasprojektissa
- Kuvitus (lähdemateriaali / uusien kuvien teko)
- Tekstisisältö (lähdemateriaali, haastattelut, tuotteeseen tutustuminen)
- Julkaisumedia – sekä julkaisukanavat (painatus – sähköinen julkaisu)
- Kieliversiot
- Dokumenttien ylläpito
Teknisen dokumentoinnin aloitus
Dokumentointiprojekti voidaan aloittaa yritykselle seuraavasti:
- käymme yhdessä läpi dokumentointitarpeenne (mm. dokumentoinnin tyypit, versiot, kieliversiot)
- miten dokumentointi toteutetaan tehokkaasti (työkalut)
- esitän jatkotoimenpiteet em. asioiden pohjalta.
Dokumentoinnin kustannukset
Jokainen projekti on omanlainen. Edellä esitetyn aloituslistan läpikäyminen auttaa hahmottamaan dokumentointiprojektin vaatimaa työmäärää, jolloin asiakas voi arvioida myös projektin kustannuksia. Suurin osa dokumentointiprojekteista alkaa asiakkaan tarpeesta saada jokin dokumentointityö valmiiksi. Monesti toteutan halutun dokumentoinnin tuntityönä asiakkaan antamissa raameissa. Tuntihinta pidemmissä projekteissa alkaa 40 €:sta. Joskus asiakas haluaa teettää työn urakkana, jolloin lasken työstä kokonaistarjouksen.
SV-palvelu tuottaa
tuotteellesi tai palvelullesi laadukasta dokumentaatiota. Toteutan sopimuksen mukaan:
#teknisenesitteen #käyttöohjeen #asennusohjeen #varaosaluettelon #tuotekatalogin #korjausoppaan #teknisenpiirrustuksen #tuotevalokuvat #koulutusmateriaalin
Ota yhteyttä, jos yritykselläsi on dokumentointitarpeita. Sovitaan tapaaminen.