Miten laadukkaan teknisen dokumentaation tuottaminen hyödyttää yritystä?

Sisältö

Technical-documentation-header-image

Tässä blogikirjoituksessa kerromme, miksi tekninen dokumentaatio on tärkeää ja kuinka yritys ja loppuasiakas hyötyvät laadukkaasta teknisestä dokumentaatiosta. Luomme myös katsauksen teknisen dokumentaation haasteisiin ja tulevaisuuteen.

Haastattelimme kahta kokenutta teknisen dokumentoinnin ammattilaista, Karl Bjelkesjötä ja Mats Hermanssonia. Karl on teknisen viestinnän ja WI-liiketoimintajärjestelmätyökalujen johtaja Xylem-yhtiössä ja Mats SAAB:n teknisen informaation strategiapäällikkö. Karl ja Mats kertoivat meille teknistä dokumentaatiota koskevista henkilökohtaisista näkemyksistään tätä artikkelia varten. He molemmat osallistuvat myös toimialan kehittämiseen ruotsalaisen teknisen informaatioalan järjestön BOTIn kautta. Siitä kerrotaan enemmän jäljempänä tässä artikkelissa.

 

Tässä artikkelissa käsitellään seuraavia aiheita:

 

Miksi laadukas tekninen dokumentaatio on niin tärkeää?

Asianmukaisesti esitetyt tekniset tiedot parantavat asiakastyytyväisyyttä ja auttavat käyttämään tuotetta optimaalisesti. Erityisesti näistä syistä laadukkaaseen tekniseen dokumentaatioon pyritään. Joillakin toimialoilla asiaa säädellään tuotevastuulla, eli silloin dokumentaatiota vaaditaan.

Kuinka laadukkaan teknisen dokumentaation tuottaminen hyödyttää yritystä?

Karl:

Tekninen dokumentaatio antaa yrityksille kilpailuedun, koska se parantaa käyttäjäkokemusta ja edistää myyntiä. Teknisten tietojen tulee olla joka vaiheessa helposti asiakkaan saatavilla. Laadukkaassa teknisessä dokumentaatiossa on siis kyse hyvän käyttäjäkokemuksen luomisesta, ja se myös toimii myyntivalttina tarjousprosessin aikana.

Mats:

Mielestäni tekninen dokumentaatio hyödyttää yritystä monin tavoin, joista yksi on mainearvo. Kun asiakas lukee hyvää dokumentaatiota, hän näkee myös, että kyseessä on brändi, tuote tai yritys, johon voi luottaa. Toinen tärkeä tekijä on, että ei välttämättä tarvita niin suurta tukiorganisaatiota, jos dokumentaatio on laadittu hyvin. Kaiken kaikkiaan hyvä dokumentaatio parantaa yrityksen kilpailukykyä.

Mielestäni yritykset siis hyötyvät dokumentaatiosta monilla eri tavoilla.

Miten loppukäyttäjä hyötyy?

Mats:

Ensimmäiseksi sanoisin, että hyötynä on helppokäyttöisyys. On tietenkin suuri etu, jos tuotetta voi käyttää helposti, tehokkaasti ja turvallisesti.

Karl:

Hyötyjä ovat tuotteen optimaalisen käytön varmistaminen sekä oikean tuotteen valitseminen kulloisiinkin tarpeisiin.

Kuinka hyvä tekninen dokumentaatio määritellään? Onko siihen olemassa selkeitä kriteerejä?

Karl:

Määrittelisin hyvän teknisen dokumentaation sellaiseksi, joka noudattaa tyyliopasta ja auttaa saavuttamaan dokumentaation kokonaistavoitteet. Ne taas saattavat hieman vaihdella muun muassa toimialan ja aiheen mukaan. Kuitenkin tavoitteiden saavuttamista tukevan tyylioppaan noudattaminen on mielestäni olennaista hyvässä teknisessä dokumentaatiossa.

Mitä tulee kriteereihin, luettavuus on varmastikin yksi niistä. Se varmistaa myös sisällön hyvän käytettävyyden ja käännettävyyden. Onko sisältö laadittu niin, että viestintä globaalien yleisöjen kanssa onnistuu? Siirrettävyys on myös tärkeää. Kuinka joustavasti sisältöä voidaan hyödyntää monikanavaisessa maailmassa? Voidaanko sisältö toimittaa asiakkaille eri kanavien kautta, joita asiakkaat käyttävät? Uudelleenkäytettävyys on myös yksi kriteeri. Organisaation kannalta parhaan vastineen investoinnille antaa se, jos aiemmin laadittua sisältöä voidaan käyttää uudelleen uusissa hankkeissa. Kriteereitä ovat siis luettavuus, käytettävyys, käännettävyys, siirrettävyys ja uudelleenkäytettävyys – asiakaskokemus ja toiminnan tehokkuus sekä kyky viestiä monien eri kanavien, tai kaikkien, kautta.

Mats:

Mielestäni dokumentaation tulee olla objektiivista ja faktoihin perustuvaa, eikä sen kuulu sisältää markkinointia. Sen tulee olla helppoa käyttää ja hyvin jäsenneltyä. Sen täytyy myös olla helposti ymmärrettävissä. Hyvä kieli on tietenkin tärkeää.

 


Onko sinulla tekniseen dokumentaatioon liittyvä käännösprojekti toteutettavana? Ota yhteyttä!

 

Millä toimialoilla tekniseen dokumentaatioon on tarpeen kiinnittää erityistä huomiota?

Mats:

Tuotteita dokumentoitaessa asia riippuu monimutkaisuudesta ja turvallisuuden tarpeesta. Yksi esimerkki on IKEAn malli, jossa tekniset tiedot ilmoitetaan kokonaan ilman sanoja, mikä tekee niistä mahdollisimman helpot ymmärtää.

En usko, että on mitään toimialaa, joka voisi jättää tekniset tiedot ja teknisen dokumentaation täysin huomiotta.

Karl:

On esimerkiksi ohjelmistoyhtiöitä, joiden myymään tuotteeseen kuuluu olennaisena osana API-ohjelmointirajapinta. Tällaisen rajapinnan avulla asiakkaat voivat kehittää omia sovelluksiaan. Näiden ohjelmistoyhtiöiden pitäisi kiinnittää erityistä huomiota API-kehittäjille tarkoitettuun dokumentaatioon, sillä dokumentaatio on itse asiassa tuote. Asiakkaita täytyy tukea, jotta kehittäjät voivat hyödyntää tuotetta onnistuneesti. Siksi API-dokumentaation kanssa on oltava erittäin tarkka.

Toisaalta on tiukasti säänneltyjä toimialoja, kuten koneteollisuus. Näillä toimialoilla on kiinnitettävä erityistä huomiota tekniseen dokumentaatioon ja kääntämiseen, erityisesti tuotevastuuseen liittyvän dokumentaation osalta. Säännellyillä toimialoilla mukana on aina oikeudellinen ulottuvuus.


Esimerkiksi konedirektiivi on yksi tärkeimmistä säädöksistä, joka ohjaa oleellisten terveys- ja turvallisuusvaatimusten harmonisointia EU-tasolla. Lisäksi voi tietysti olla paikallisia säädöksiä ja määräyksiä, joiden vuoksi tekniseen dokumentaatioon pitää kiinnittää vielä enemmän huomiota.


Technical-documentation-illustration-1

Kuinka muut yrityksen osastot voivat tukea teknisen dokumentaation tuotantoa?

Mats:

Oman kokemukseni perusteella on erittäin tärkeää, että muualla yrityksessä ymmärretään, mitä tekninen dokumentaatio on ja miksi se on niin tärkeää. Aina ei ole helppoa saada kaikkia ymmärtämään asiaa.

Työskentelin aiemmin ohjelmistoyhtiössä, jossa ohjelmistokehittäjät ajattelivat saavuttaneensa tavoitteen, kun he olivat toimittaneet valmiin ohjelman muiden käytettäväksi. Kesti kauan saada nämä ohjelmistokehittäjät ymmärtämään teknisten tietojen merkitys ja se, että heidän täytyy antaa tukea dokumentaatiolla.

Mitä tulee teknisiin kirjoittajiin, heillä saattaa olla vaikeita kysymyksiä tai suuri määrä kysymyksiä, ja joskus nämä kysymykset voivat olla hyvinkin amatööritason kysymyksiä. Tällöin on erittäin tärkeää, että asiantuntijat antavat vastaukset kysymyksiin, jotta tekniset kirjoittajat voivat vastausten perusteella laatia erinomaisen teknisen dokumentaation.

Toinen tärkeä asia on terminologia. Tekniset kirjoittajat toimivat usein työnkulun jälkipäässä, erillään yrityksen toimialasta. Kyseessä voi olla esimerkiksi toimiala, jossa toimii suunnittelijoita, mutta ostajat voivat päättää tuotteen tai tuotteen osan tietystä termistä. Suunnittelijat ja ostajat saattavatkin kutsua samaa osaa eri nimillä.

Niinpä kyseisestä asiasta käytetään eri nimiä eri järjestelmissä. Teknisen kirjoittajan täytyy puolestaan pyrkiä yhdenmukaiseen terminologiaan, mikä voi tällaisessa tapauksessa olla todella haastavaa.

Ihannetapauksessa teknisen kirjoittajan pitäisi mielestäni osallistua myös osto- ja suunnitteluprosesseihin ja päästä mukaan päättämään termeistä. Loppukäyttäjien kannalta olisi paljon parempi, jos samalle asialle ei olisi kahta, kolmea tai viittä termiä.

Karl:

Mitä tulee teknisen dokumentaation tuotannon tukemiseen, on tärkeää osallistua prosessiin. Suositeltavien menetelmien kehittäminen on yhteistyötä. Voit auttaa selvittämään, millainen on erinomainen tuotteen pakkauksen avaamiskokemus, tai osallistua menetelmäkehitykseen. On varmasti kenen tahansa teknisen kirjoittajan toive, että hänen kanssaan työskennellään yhdessä sen varmistamiseksi, että dokumentaatio on mahdollisimman hyvää, ja palautetta annetaan tarkistuksen perusteella oikeaan aikaan.

Tekninen dokumentaatio on oleellinen osa tuotetta – ei ole erikseen tuotetta tai palvelua, jonka lisäksi tulee dokumentaatio. Dokumentaatio on osa tuotetta tai palvelua. Asiakkaan näkökulmasta ne kuuluvat yhtä lailla samaan asiakaskokemukseen.

Mitä kansainvälisesti toimivien yritysten tulisi ottaa huomioon teknisestä dokumentaatiosta?

Mats:

On montakin asiaa. Yksi niistä on kieli. Jos dokumentaatiota ei käännetä, on varmistettava, että kieli on todella yksinkertaista. Esimerkiksi lentokoneteollisuudessa, missä itse toimin, käytämme tavallisesti yksinkertaistettua teknistä englantia. Se tarkoittaa yksinkertaista tapaa kirjoittaa englannin kielellä. Sen ansiosta myös ne, jotka eivät ole opiskelleet englannin kieltä pitkälle, pystyvät ymmärtämään ohjeet. Kaikessa dokumentaatiossa kannattaa käyttää samaa ilmaisutapaa, koska se tekee dokumentaatiosta helpommin ymmärrettävää.

On myös ajateltava Internet-yhteyden käyttöä. Ajattelemme usein, että Internetiä voi käyttää kaikkialla maailmassa, mutta on paikkoja, joissa Internet-yhteyttä ei ole. Siksi teknisten tietojen toimittamiseen täytyy olla ratkaisuja, joita voidaan käyttää ilman verkkoyhteyttä.

Olemassa on useita erilaisia kirjoitusoppaita, yksinkertaistettuja kielimuotoja ja rakenteita eri toimialoille. Uskon, että jokaiselle löytyy juuri omalle toimialalle sopiva vaihtoehto.

Mikä on merkittävin haaste dokumentaatioalalla?

Mats:

Haasteita on useita, ja tulevina vuosina jotkin niistä ovat myöskin vastausta odottavia kysymyksiä.

Perustan haasteille asettaa kuitenkin tekninen kehitys. Teknisten tietojen toimittamiseen tarvitaan uusia alustoja, ja erityisesti nuoret ihmiset odottavat saavansa tekniset tiedot ja teknisen dokumentaation eri tavoin kuin aiemmin. Kun olin itse nuori, ainoa tapa saada selville, kuinka jotakin käytetään tai kuinka se korjataan, oli lukea tuotteen mukana tullut käyttöopas. Nyt tämä selviää Google-haulla. Dokumentaation saa näkyviin heti, kun ongelma ilmenee, ja dokumentaation avulla ongelman voi usein ratkaista saman tien.

Karl:

Näyttää siltä, että toimitusaikoja koskevat vaatimukset ovat muuttumassa. Monet yritykset ovat siirtymässä ketterään tuotekehitykseen ja ketteriin prosesseihin perinteisen vesiputousmallin sijaan. Siinä työskennellään tiiviisti kuukaudesta toiseen, jopa vuosia, ja sen jälkeen tuote tuodaan markkinoille. Tuotekehitys on siirtymässä markkinoille tuotavaan pienimpään toteuttamiskelpoiseen tuotteeseen, palautteen keräämiseen ja tuotteen parantamiseen yhdessä asiakkaiden kanssa. Vaikutus sisällön laatimiseen on, että toimitusaikavaatimukset tiukkenevat. Sisällöntuotantotiimin täytyy siis nyt julkaista sisältöä useammin ja pienemmissä erissä. Kun aiemmin työhön käytettiin kuukausia kerrallaan, nyt kyse on viikoista.

Tässä on yksi haaste. Julkaiseminen voi olla kallista, ja tiimien on mietittävä tätä asiaa: kuinka kustannuksia voidaan vähentää ja samalla lisätä jatkuvasti sisältöä uusien ominaisuuksien integroimiseksi tuotteen kehittyessä.

Siirtyminen ketterään toimintaan koskee muidenkin kuin teknologiatuotteiden kehittämistä. Millään teollisuudenalalla ei ole tiimiä, jossa ei keskusteltaisi ketterästä toimintamallista ja muista vastaavista asioista. Esimerkiksi koulutussisällöt, tekninen dokumentaatio, markkinointimateriaalit, verkkosivustot, verkkokauppa ja niin edelleen – muutos vaikuttaa näihin kaikkiin.

Technical-documentation-illustration-2

 

Entä toimialan tulevaisuus? Mitä muutoksia on odotettavissa?

Karl:

Julkaisemisesta tekee kallista taitto: asettelun tekeminen aina uudelleen julkaisuja varten. Yksi trendi koskeekin siksi siirtymistä verkkokaupassa kohti mallia, jossa sisältö tarjotaan palveluna. Tätä kutsutaan headless-tyyppiseksi sisällönhallinnaksi. Siinä sisällön asettelu toteutetaan käyttäjälle näkyvässä front end -järjestelmässä, olipa sitten kyseessä ohjekeskus, koulutusjärjestelmä tai verkkokauppa-alusta, ja sisällöntuottajat keskittyvät pelkästään varsinaiseen erillisessä taustajärjestelmässä säilytettävään sisältöön.

Palveluna tarjottava sisältö ja headless-sisällönhallintajärjestelmät ovat varmasti yksi trendi. Sen sijaan, että kukin dokumentaation laatija huolehtii asettelusta omassa työympäristössään, taittotyö on siirtynyt prosessin myöhempiin vaiheisiin.

Toinen trendi on sisällön toimittaminen yhdestä lähteestä: sisällön uudelleenkäyttö erilaisissa tuote- tai palvelukehityshankkeissa. Yritykset pyrkivät hyödyntämään sisältöön tekemiään investointeja parhaalla mahdollisella tavalla. Kertaalleen laadittuja digitaalisia materiaaleja käytetään yhä uudelleen, oli kyseessä sitten sisällönhallintajärjestelmä, käännöksenhallintajärjestelmä tai yleinen tietokanta. En sanoisi tätä tämän vuoden trendiksi; tämä kehitys on ollut käynnissä yli vuosikymmenen.

Kolmas trendi on teollisen Internetin tukeminen tietojen käytön osalta tuotteiden ja palvelujen siirtyessä pilveen. Siirtyminen paperista digitaalisiin ratkaisuihin on varmasti osa toimialan tulevaisuutta.

Neljäs trendi on sitten kansainvälistyminen: tuotteista tulee verkottuneita ja markkinoista globaaleja. On mahdollista tavoittaa asiakkaat kaikkialla maailmassa.

Mats:

Tämä on yksi tulevien vuosien tavoitteista: katsoa tulevaisuuteen ja ennakoida, mitä muutoksia tai haasteita on odotettavissa. Monista uusista käsitteistä keskustellaan paljon. Näitä ovat tekoäly, lisätty todellisuus, virtuaalitodellisuus ja digitaalinen kaksonen.

Ei ole kovinkaan helppoa ennakoida, kuinka nämä asiat vaikuttavat teknisten tietojen tarpeeseen ja tapoihin, joilla teknistä dokumentaatiota ja tietoa tuotetaan ja käytetään. Tässä ei siis mielestäni ole kyse vain yhdestä asiasta. Kyseessä on joukko erilaisia uusia teknologioita ja kiihtyvä kehitys, jonka kyydissä meidän on pysyttävä.

Mikä on BOTI?

Lyhyesti sanottuna BOTI on yritysten tapaamispaikka, jossa teemme yhteistyötä paremman teknisen tiedon kehittämiseksi ruotsalaisissa yrityksissä. BOTI tukee laadukkaiden teknisten tietojen ylläpitoa ruotsalaisissa yrityksissä eri kielillä, siis tietenkin myös käännöksissä.

Yksi meille tärkeä asia on, että tekniset kirjoittajat ja teknisten tietojen ala ovat usein vain pieni osa yritystä. Sadan hengen yrityksessä saattaa olla vain yksi tekninen kirjoittaja. Ei ole helppoa korostaa tekniseen kirjoittamiseen tarvittavaa asiantuntemusta ja parantaa sitä, jos työskentelee yksin eikä ketään ole opastamassa. Siksi on mielestämme tärkeää, että on organisaatio, jonka kautta voimme auttaa toisiamme ja yrityksiä, sekä tietenkin viedä teknistä informaatioalaa eteenpäin.

Meillä on paljon toimintaa: järjestämme konferenssin kerran vuodessa sekä paljon webinaareja, joihin kaikilla on vapaa pääsy. Meillä on myös paljon työryhmiä, joissa on mahdollista keskustella eri yrityksissä työskentelevien ihmisten kanssa ja verkostoitua tehokkaasti.

Järjestön tavoitteena on levittää tietoa siitä, kuinka laadukas dokumentaatio tuottaa lisäarvoa ja parantaa liiketoiminnan kilpailukykyä.

Järjestön pääkieli on ruotsi, mutta kaikki ovat tervetulleita. Esimerkiksi vuosittain järjestettävä konferenssi ja verkkosivusto ovat ruotsinkielisiä. Parhaan hyödyn toiminnasta siis saa, jos osaa ainakin jonkin verran ruotsia.

Lisätietoa BOTI-järjestöstä löytyy täältä.

Kuinka jäseneksi voi liittyä?

Se on helppoa. Täytä yrityksen tiedot täältä löytyvään lomakkeeseen. Kun yrityksestä tulee jäsen, myös kaikki yrityksen työntekijät katsotaan jäseniksi.

 

Onko sinulla teknistä dokumentaatiota, joka täytyy kääntää?  Ota yhteyttä!