Tekninen dokumentaatio kasvaa tuotteiden mukana. Kun tuoteperhe laajenee, kieliversioita lisätään ja päivityksiä tehdään jatkuvasti, syntyy helposti tilanne, jossa sama sisältö kirjoitetaan uudelleen yhä uudelleen eri dokumentteihin. Single-sourcing ja sisällön uudelleenkäyttö ovat rakenteisen dokumentaation peruskäsitteitä, jotka ratkaisevat juuri tämän ongelman. Tässä artikkelissa käymme läpi, mitä nämä käsitteet tarkoittavat, miten ne toimivat käytännössä ja milloin niiden käyttöönotto on perusteltua.
Artikkeli etenee perusteiden kautta käytännön sovelluksiin. Ensin selitämme käsitteet selkeästi, sitten kuvaamme konkreettisen toimintamallin ja lopuksi autamme arvioimaan, sopiiko lähestymistapa omaan tilanteeseen.
Mitä single-sourcing ja sisällön uudelleenkäyttö tarkoittavat?
Single-sourcing tarkoittaa periaatetta, jossa sama sisältö tuotetaan ja ylläpidetään yhdessä ainoassa paikassa, mutta julkaistaan useisiin eri kohteisiin. Sen sijaan, että sama varoitus, tekninen spesifikaatio tai asennusohje kirjoitettaisiin erikseen jokaiseen manuaaliin, se tallennetaan kerran ja käytetään tarvittaessa uudelleen eri dokumenteissa.
Sisällön uudelleenkäyttö on tämän periaatteen käytännön sovellus. Se tarkoittaa, että kerran kirjoitettu sisältömoduuli voidaan sisällyttää automaattisesti useisiin dokumentteihin ilman kopiointia tai uudelleenkirjoittamista. Kun moduulia päivitetään, muutos päivittyy kaikkialle, missä kyseistä moduulia käytetään.
Havainnollistava esimerkki: kuvittele, että turvaohje koskee kymmentä eri laitetta. Ilman single-sourcingia sama ohje kirjoitetaan tai kopioidaan kymmeneen eri manuaaliin erikseen. Kun ohje muuttuu, se täytyy etsiä ja päivittää kymmenestä eri dokumentista. Single-sourcing-mallissa ohje on olemassa yhtenä moduulina, joka on linkitetty kaikkiin kymmeneen manuaaliin. Yksi päivitys riittää.
Rakenteinen sisältö mahdollistaa uudelleenkäytön
Single-sourcing ei toimi ilman rakenteista sisältöä. Rakenteinen sisältö tarkoittaa, että dokumentaatio kirjoitetaan modulaarisina, itsenäisinä palasina sen sijaan, että se olisi pitkä, lineaarinen asiakirja. Jokainen moduuli on oma kokonaisuutensa, jolla on selkeä tarkoitus ja joka voidaan yhdistää muihin moduuleihin joustavasti.
Tämä ero on ratkaiseva. Perinteinen Word-dokumentti on yhtenäinen tiedosto, josta ei voi irrottaa yksittäisiä osia uudelleenkäyttöä varten. Rakenteinen sisältö sen sijaan koostuu palasista, joita voidaan yhdistellä eri tavoin eri julkaisuihin.
Miten single-sourcing toimii käytännössä?
Käytännössä single-sourcing rakentuu sisältömoduulien, metatietojen ja julkaisujärjestelmän varaan. Kirjoittaja tuottaa sisältöä erillisinä moduuleina, kuten toimintaohjeina, varoituksina tai teknisinä kuvauksina. Nämä moduulit tallennetaan komponenttisisällönhallintajärjestelmään eli CCMS:ään (component content management system).
Moduulien koostaminen dokumenteiksi
Yksittäisistä moduuleista rakennetaan dokumentteja ns. karttatiedostojen avulla. Kartta määrittelee, mitkä moduulit kuuluvat tiettyyn julkaisuun ja missä järjestyksessä. Sama moduuli voi esiintyä useissa eri kartoissa eli useissa eri dokumenteissa, mutta se sijaitsee aina yhdessä paikassa järjestelmässä.
Esimerkiksi huolto-ohje ja asennusopas voivat molemmat viitata samaan moottorin käynnistysohjeeseen. Kun ohjetta muutetaan, se päivittyy automaattisesti molempiin julkaisuihin seuraavalla julkaisukierroksella.
Julkaisu useisiin formaatteihin
Single-sourcing ulottuu myös julkaisuformaatteihin. Sama rakenteinen sisältö voidaan julkaista automaattisesti useisiin eri formaatteihin, kuten PDF:ksi, HTML-sivuksi tai WebHelp-muotoon, ilman että sisältöä tarvitsee muokata erikseen jokaista formaattia varten. Formaatti on eri asia kuin itse sisältö.
- Sisältö kirjoitetaan ja ylläpidetään kerran, formaattiriippumattomasti
- Julkaisujärjestelmä muuntaa saman sisällön tarvittavaan formaattiin automaattisesti
- Muutos sisältöön päivittyy kaikkiin formaatteihin seuraavalla julkaisukerralla
Sisällön uudelleenkäytön keskeinen arvo tekniselle dokumentaatiolle
Rakenteiseen sisältöön ja single-sourcingiin siirtyminen ei ole pelkästään tekninen valinta, vaan dokumentaation laadun ja ylläpidettävyyden kannalta merkittävä päätös. Arvo syntyy useasta eri suunnasta.
Päivitystyön väheneminen
Kun sisältömoduuli päivitetään kerran, muutos leviää automaattisesti kaikkialle, missä moduulia käytetään. Tämä vähentää merkittävästi sitä työmäärää, joka perinteisessä mallissa kuluu saman muutoksen tekemiseen kymmeniin eri tiedostoihin. Samalla riski siitä, että jokin dokumentti jää päivittämättä, pienenee huomattavasti.
Käännösprosessin tehostuminen
Monikielisessä dokumentaatiossa single-sourcing tuo erityisen selvän hyödyn. Kun sisältö on modulaarista, käännettäväksi lähetetään vain ne moduulit, joita on muutettu, eikä koko dokumenttia aina uudelleen. Tämä nopeuttaa käännösprosessia ja pienentää käännöskustannuksia.
Lisäksi rakenteinen sisältö soveltuu hyvin käännösmuistin hyödyntämiseen, koska moduulit ovat lyhyitä ja itsenäisiä. Käännöstyökalu tunnistaa jo aiemmin käännetyt lauseet ja ehdottaa niitä automaattisesti, mikä nopeuttaa työtä entisestään.
Sisällön johdonmukaisuus
Kun sama tieto on kirjoitettu kerran ja sitä käytetään uudelleen, se on sanamuodoltaan ja rakenteeltaan aina sama. Tämä parantaa dokumentaation johdonmukaisuutta ja luettavuutta. Lukija löytää tutun rakenteen dokumentista toiseen, mikä helpottaa tiedon löytämistä.
Milloin single-sourcing ratkaisee oikean ongelman?
Single-sourcing ei ole ratkaisu jokaiseen tilanteeseen. Se kannattaa ottaa käyttöön silloin, kun dokumentaatiotyössä esiintyy tiettyjä toistuvia haasteita. Seuraavat kysymykset auttavat arvioimaan, onko lähestymistapa perusteltu omassa organisaatiossa.
Merkkejä siitä, että single-sourcing on ajankohtainen
- Sama sisältö esiintyy useissa eri dokumenteissa, ja sen päivittäminen vaatii muutosten tekemistä moneen paikkaan erikseen
- Dokumentaatiota julkaistaan useissa kielissä, ja käännöskustannukset kasvavat jatkuvasti
- Sama tuotetieto täytyy julkaista useisiin eri formaatteihin, kuten PDF:ksi ja verkkosivulle
- Versioiden hallinta on hankalaa, ja kentällä on käytössä vanhentuneita dokumentteja
- Tuoteperhe on laaja ja dokumenttien määrä kasvaa jatkuvasti
Milloin perinteinen malli voi vielä riittää
Jos dokumentaatio koostuu muutamasta yksikielisestä dokumentista, joita päivitetään harvoin, rakenteisen sisällönhallinnan käyttöönotto voi olla ylimitoitettu investointi. Hyöty kasvaa sitä suuremmaksi, mitä enemmän dokumentteja on, mitä useammassa kielessä ne julkaistaan ja mitä tiheämmin niitä päivitetään.
Olennainen kysymys on siis: kuinka paljon aikaa kuluu tällä hetkellä saman tiedon päivittämiseen useisiin paikkoihin? Jos vastaus on ”paljon”, single-sourcing on todennäköisesti perusteltu askel eteenpäin.
DoX CMS on komponenttisisällönhallintajärjestelmä, joka on rakennettu juuri näitä tarpeita varten. Se perustuu LwDITA-standardiin ja mahdollistaa modulaarisen, uudelleenkäytettävän sisällön tuottamisen useisiin kieliin ja formaatteihin yhdestä lähteestä. Jos haluat arvioida, sopiiko rakenteinen dokumentaatio organisaatiosi tilanteeseen, ota yhteyttä DoX Systemsiin ja keskustellaan tarpeistanne ilman sitoumusta.