Tekninen dokumentaatio kasvaa tuotesarjojen laajentuessa, kieliversioiden lisääntyessä ja päivityssyklien nopeutuessa. Tavallinen toimisto-ohjelmisto tai yksinkertainen sisällönhallintajärjestelmä alkaa pettää juuri silloin, kun dokumentaation volyymi ja monimutkaisuus ylittävät tietyn kynnyksen. Tähän tarpeeseen on kehitetty erityinen järjestelmätyyppi: komponenttipohjainen sisällönhallintajärjestelmä eli CCMS.
Tässä artikkelissa käydään läpi, mitä CCMS tarkoittaa, miten se eroaa tutummista järjestelmistä, miten se toimii käytännössä ja kenelle se sopii. Artikkeli etenee peruskäsitteistä kohti käytännön soveltamista, joten se palvelee sekä aiheen ensi kertaa kohtaavaa että jo jonkin verran aiheeseen tutustunutta lukijaa.
Mitä CCMS tarkoittaa ja miten se eroaa tavallisesta CMS:stä?
CCMS, eli component content management system tai suomeksi komponenttipohjainen sisällönhallintajärjestelmä, on erikoistunut järjestelmä strukturoidun sisällön tuottamiseen, hallintaan ja julkaisemiseen. Se on suunniteltu erityisesti teknistä dokumentaatiota varten, ei verkkosivujen tai markkinointimateriaalin hallintaan.
Tavallinen CMS, kuten verkkosivualusta, käsittelee sisältöä sivuina tai artikkeleina. Jokainen sivu on oma kokonaisuutensa, jota muokataan erikseen. CCMS toimii täysin eri periaatteella: sisältö kirjoitetaan pieninä, itsenäisinä komponentteina, joita voidaan käyttää uudelleen eri dokumenteissa, kieliversioissa ja julkaisuformaateissa.
Konkreettinen esimerkki: jos tuotteesi turvaohje esiintyy asennusoppaassa, huolto-ohjeessa ja pikaoppaassa, tavallisessa CMS:ssä tai tekstinkäsittelyohjelmassa sama teksti kirjoitetaan tai kopioidaan kolmeen paikkaan erikseen. CCMS:ssä turvaohje on yksi komponentti, joka viittauksena lisätään kaikkiin kolmeen dokumenttiin. Kun ohje muuttuu, se päivitetään kerran ja muutos näkyy automaattisesti kaikkialla.
Miksi erottelu on tärkeä?
Erottelu ei ole tekninen yksityiskohta, vaan käytännön seuraukset ovat merkittävät. Tavallisella CMS:llä tai toimisto-ohjelmistolla hallittu dokumentaatio hajoaa helposti versioristiriidoiksi: eri tiedostoissa on eri versioita samasta tekstistä, eikä kukaan tiedä, mikä on ajantasainen. CCMS poistaa tämän ongelman rakenteellisesti, koska sisältö on yhdessä paikassa ja kaikki dokumentit viittaavat samaan lähteeseen.
Miten komponenttipohjainen sisältö toimii käytännössä?
Edellisessä osiossa käsiteltiin, mitä komponentit ovat käsitteellisesti. Tässä osiossa tarkastellaan, miten komponenttipohjainen sisältö rakentuu ja toimii konkreettisessa dokumentaatiotyössä.
CCMS:ssä dokumentti ei ole yksi pitkä tiedosto, vaan kokoelma erillisiä sisältömoduuleita. Tyypillisiä komponentteja ovat esimerkiksi:
- Varoitukset ja turvallisuusohjeet
- Tekniset spesifikaatiot
- Asennusvaiheet
- Huoltotoimenpiteiden kuvaukset
- Tuotteen ominaisuuksien selitykset
Kukin komponentti kirjoitetaan kerran ja tallennetaan järjestelmään. Kun dokumentaatioasiantuntija kokoaa uuden käyttöoppaan, hän ei kirjoita kaikkea alusta, vaan rakentaa oppaan viittaamalla olemassa oleviin komponentteihin ja kirjoittaa ainoastaan sen sisällön, joka on aidosti uutta.
Versiointi ja rinnakkaiset julkaisuformaatit
CCMS hallitsee automaattisesti sisällön versiohistorian. Jokainen muutos tallennetaan, ja aiemmat versiot ovat tarvittaessa palautettavissa. Tämä on erityisen tärkeää ympäristöissä, joissa dokumentaatiota päivitetään usein tai joissa eri tuoteversioilla on omat dokumentaatiovaatimuksensa.
Lisäksi CCMS mahdollistaa saman sisällön julkaisemisen useissa eri formaateissa yhdellä kertaa. Sama sisältö voidaan julkaista PDF-manuaalina, verkkosivuna, mobiilioptimoituna HTML-versiona tai muuna tarvittavana muotona ilman, että sisältöä kirjoitetaan uudelleen eri formaatteja varten.
Kenelle CCMS sopii ja millaisiin tarpeisiin?
CCMS ei ole tarkoitettu kaikenlaiseen sisällöntuotantoon. Se on erikoistunut työkalu, joka tuo selkeimmän hyödyn tietyntyyppisissä organisaatioissa ja tilanteissa.
CCMS sopii erityisesti organisaatioille, joissa esiintyy yksi tai useampi seuraavista piirteistä:
- Dokumentaatiota tuotetaan useille tuotteille tai tuotevarianteille, joissa on paljon yhteistä sisältöä
- Sama dokumentaatio julkaistaan useilla kielillä
- Dokumentit päivittyvät usein ja muutosten on heijastuttava kaikkiin relevantteihin julkaisuihin
- Useampi henkilö osallistuu dokumentaation tuottamiseen tai tarkistamiseen
- Dokumentaatiota julkaistaan useissa eri formaateissa
Tyypillisiä CCMS:n hyötyjiä ovat teollisuuskoneiden ja laitteiden valmistajat, joiden tuotteisiin liittyy laajat asennus-, käyttö- ja huolto-ohjeet useilla kielillä. Myös dokumentointipalveluja tarjoavat asiantuntijayritykset hyötyvät CCMS:stä, kun ne hallinnoivat useiden asiakkaiden dokumentaatioprojekteja rinnakkain.
CCMS ei sen sijaan ole oikea työkalu, jos dokumentaatio on yksinkertaista, harvoin muuttuvaa ja yksikielistä. Pienelle ja staattiselle dokumentaatiolle kevyempi ratkaisu voi olla riittävä.
CCMS:n keskeiset hyödyt teknisessä dokumentaatiossa
Nyt kun komponenttipohjaisen sisällön logiikka on selvä, on hyvä koota yhteen, mitä konkreettisia hyötyjä CCMS tuo teknisen dokumentaation arkeen. Hyödyt eivät ole teoreettisia, vaan ne ratkaisevat suoraan niitä ongelmia, joita toimisto-ohjelmistolla tai yksinkertaisella CMS:llä hallittu dokumentaatio tyypillisesti aiheuttaa.
- Sisällön uudelleenkäyttö vähentää kirjoitustyötä. Kerran kirjoitettu komponentti on käytettävissä kaikissa dokumenteissa, joissa se on relevantti. Sama spesifikaatio tai turvaohje ei vaadi uudelleenkirjoittamista.
- Yhtenäisyys säilyy automaattisesti. Kun komponentti päivitetään, muutos näkyy kaikkialla, missä komponenttia käytetään. Versioristiriidat poistuvat rakenteellisesti.
- Käännösprosessi tehostuu. Strukturoitu sisältö on helpompi kääntää, koska muuttuneet osat voidaan tunnistaa ja lähettää käännökseen erikseen. Koko dokumenttia ei tarvitse kääntää uudelleen yhden muutoksen takia.
- Yhteistyö sujuu ilman tiedostoviidakkoa. Selainpohjainen CCMS mahdollistaa useampien tekijöiden samanaikaisen työskentelyn ilman sähköpostiliitteitä tai päällekkäisiä tiedostoja.
- Julkaiseminen useisiin formaatteihin onnistuu yhdellä kertaa. PDF, HTML, WebHelp ja muut tarvittavat formaatit syntyvät samasta sisällöstä ilman erillistä muokkausta.
DITA ja Lw-DITA – standardit CCMS:n taustalla
Komponenttipohjainen sisältö tarvitsee rakenteen, joka määrittelee, miten komponentit muodostetaan, nimetään ja yhdistetään. Tähän tarpeeseen on kehitetty avoimia standardeja, joista tärkein teknisen dokumentaation alalla on DITA (Darwin Information Typing Architecture).
DITA on XML-pohjainen standardi, joka määrittelee, millaisia sisältötyyppejä dokumentaatiossa voidaan käyttää ja miten ne rakentuvat. Se on laajasti käytössä teollisuuden teknisessä dokumentaatiossa ympäri maailman. DITA:n vahvuus on sen avoimuus: standardi ei sido organisaatiota yhteen toimittajaan, vaan DITA-pohjainen sisältö on siirrettävissä järjestelmästä toiseen.
Mikä on Lw-DITA?
Täysi DITA-standardi on kattava mutta myös vaativa ottaa käyttöön. Tähän haasteeseen vastaa Lw-DITA eli Lightweight DITA, joka on DITA:n yksinkertaistettu versio. Lw-DITA säilyttää DITA:n keskeisen rakenteen ja hyödyt, mutta madaltaa merkittävästi käyttöönoton kynnystä.
Lw-DITA sopii erityisesti organisaatioille, jotka haluavat siirtyä strukturoituun sisällöntuotantoon ilman täyden DITA-implementaation vaatimaa teknistä erikoisosaamista. Se on käytännöllinen valinta silloin, kun tavoitteena on saada strukturoidun sisällön hyödyt käyttöön nopeasti ja kustannustehokkaasti. DoX CMS perustuu juuri Lw-DITA-standardiin, mikä tekee siitä helpommin lähestyttävän myös organisaatioille, joilla ei ole aiempaa DITA-kokemusta.
Miten CCMS:n käyttöönotto onnistuu?
CCMS:n käyttöönotto on muutos, joka vaatii suunnittelua. Tekninen järjestelmä on vain osa kokonaisuutta: yhtä tärkeää on miettiä, miten nykyinen dokumentaatio siirretään uuteen rakenteeseen ja miten tiimi oppii uuden työtavan.
Käyttöönotto etenee tyypillisesti seuraavien vaiheiden kautta:
- Nykytilan arviointi. Selvitetään, millaista dokumentaatiota organisaatiolla on, kuinka paljon sitä on, millä kielillä ja kuinka usein se päivittyy. Tämä luo pohjan sille, miten sisältö kannattaa strukturoida.
- Sisältörakenteen suunnittelu. Päätetään, millaisiin komponenttityyppeihin dokumentaatio jaetaan ja miten komponentit nimetään ja organisoidaan.
- Olemassa olevan sisällön siirto. Nykyinen dokumentaatio muunnetaan strukturoituun muotoon. Tämä on usein käyttöönoton työläin vaihe, mutta se tehdään vain kerran.
- Koulutus ja käytön aloitus. Tiimi perehdytetään uuteen järjestelmään ja työtapaan. Hyvä CCMS on suunniteltu niin, että uuden käyttäjän oppimiskäyrä on mahdollisimman loiva.
- Jatkuva kehittäminen. Strukturoitu sisältö kehittyy käytön myötä. Komponenttikirjasto kasvaa, prosessit hioutuvat ja julkaiseminen tehostuu ajan kanssa.
Yksi yleinen harhaluulo on, että CCMS:n käyttöönotto vaatii laajan IT-infrastruktuurin tai pitkän projektin ennen kuin järjestelmästä saadaan mitään hyötyä. Selainpohjaisessa CCMS:ssä ei tarvita paikallisia asennuksia, ja tiimi pääsee työskentelemään järjestelmässä mistä tahansa laitteelta heti käyttöönottokoulutuksen jälkeen.
Jos harkitset CCMS:ään siirtymistä tai haluat selvittää, sopiiko strukturoitu sisällönhallinta organisaatiosi tarpeisiin, ota yhteyttä DoX Systemsiin. Alkukartoitus ei sido mihinkään, ja suunnitteluapu on maksutonta.