CMS teknisessä dokumentoinnissa

06.02.2018

Wikipedia kertoo: Sisällönhallintajärjestelmä (engl. "content management system" tai "CMS") on yleisnimitys tietojärjestelmälle, joka palvelee koko organisaation sisällönhallintaa sen sijaan, että olisi keskittynyt pelkästään johonkin yksittäiseen osa-alueeseen, kuten verkkopalveluiden hallintaan[1]. Sisällönhallintajärjestelmälle ei täten ole olemassa mitään kovin selkeätä määritelmää vaan toimialasta riippuen sillä saatetaan viitata eri tavoin painottuneeseen tietojärjestelmään[1][2].

Teknisessä dokumentoinnissa on perustarve tiedon järjestelemiseen ja hallitsemiseen. Osan hommasta hoitaa XML-editori (Meidän tapauksessa useimmiten oXygen XML). Toisen puolen, voisi karkeasti sanoa projektinhallinnan, hoitaa tietojärjestelmä.

Dokumentoinnin CMS:ksi on vaihtoehtoja, ja vaihtoehdoilla tietysti omat hyvät ja huonot puolensa.

Koodareiden suosima Git on ihan käypä vaihtoehto: Sen paras puoli on hinta. Git on ilmainen, joten sinne saa avattua pääsyjä rajattomasti. Gitissä on versionhallinta, mutta esimerkiksi kahden päällekkäisen version pitäminen ei oikein ole mahdollista. Tämä on vähän huono juttu, kun tehdään uudelleenkäytettäviä tekstimoduuleita. Git on versionhallintatyökalu, joka on saatavilla erinimisinä tuotteina kuten esimerkiksi GitLab ja Bitbucket.

Dokumentoinnin sisällönhallintajärjestelmien mersuksi voisi sanoa SDL Knowlegde Centeriä. Se on käyttäjien mielestä aivan ihana, mutta hintansa vuoksi vaatii kymmeniä käyttäjiä ollakseen järkevä hankinta.

Olemme RD Velholla tehneet pienimuotoisen tutkimuksen aiheesta ja päädyimme sen jälkeen valitsemaan meille sopivaksi sisällönhallintajärjestelmäksi Intuillionin DITAToon. Asiakkaat saavat pääsyn lähdemateriaaliin virtuaaliverkkolevyltä, jossa on Git-tyyppisiä ominaisuuksia, joten asiakkaan vinkkelistä kuvio ei muutu uuden järjestelmän myötä.

Meidän työmme helpottuu, koska…

  • Git on mennyt solmuun muutaman kerran haastavan käytön vuoksi.
  • Selainliittymää ei tarvita, vaan kaikki hoituu samalla käyttöliittymällä.
  • DITAToo mahdollistaa dokumentaation haaroittamisen ja samanaikaisten rinnakkaisten versioiden ylläpidon.
  • Pystymme jäljittämään kuvat.
  • Pystymme seuraamaan käännösten kulkua.
  • Pystymme julkaisemaan pdf:t suoraan CMS:stä.
  • Pystymme konvertoimaan word-to-dita työkalulla näppärästi materiaalia XML:ään.
  • Sisältää laajennuksia joilla voimme ehkä lisätä tarjontaamme dokumentoinnin saralla.

On kiva saada uusia työkaluja, varsinkin kun ne helpottavat työtä ja parantavat laatua!

Teksti: Emmi Helanne ja Timo Laaksosaari

Like (4) 

Lisää uusi kommentti

Latauslinkki lähetetään sähköpostiin

Yhteystiedot

Käytössäsi yli 200 asiantuntijan osaaminen

Lue meistä