Kun sama käyttöohje julkaistaan PDF-tiedostona, verkkosivuna ja huoltoteknikon tabletille, ongelmat alkavat usein kopioinnista. Teksti liitetään uuteen tiedostoon, ja jokainen muutos on tehtävä useaan kertaan. Lopulta eri kanavissa kiertää eri versioita samasta ohjeesta.
Monikanavainen julkaisu ratkaisee tämän yhdellä periaatteella: sisältö kirjoitetaan kerran, ja kanavat muodostetaan siitä automaattisesti. Tätä kutsutaan englanniksi nimellä single source publishing. Tässä artikkelissa edetään periaatteesta käytäntöön: ensin sisältömalli, sitten julkaisuputki, sen jälkeen kanavien erot ja lopuksi laadunvarmistus.
Sisältömalli kanavariippumattoman julkaisun perustana
Sisältömalli on sopimus siitä, millaisista osista dokumentaatio koostuu ja miten osat liittyvät toisiinsa. Kanavariippumaton sisältö kuvaa merkityksen, ei ulkoasua. Kun otsikko, varoitus ja työvaihe on merkitty rakenteena eikä fontilla ja lihavoinnilla, jokainen kanava voi esittää ne omalla tavallaan.
Rakenteinen sisältö jaetaan pieniin, itsenäisiin komponentteihin. Tyypillisiä tyyppejä ovat esimerkiksi toimintaohje, käsite ja viiteaineisto. DITA-standardi ja sen kevyt LwDITA-muunnelma tarjoavat valmiita tyyppejä, joita voi käyttää sellaisinaan tai sovittaa omaan tuotteistoon.
Rakenne ja ulkoasu pidetään erillään
Wordissa kirjoittaja päättää samalla sekä sisällöstä että ulkoasusta. Rakenteisessa mallissa nämä erotetaan. Kirjoittaja merkitsee, että kappale on varoitus, ja julkaisuvaihe päättää, näkyykö se PDF:ssä keltaisena laatikkona ja verkossa kuvakkeella varustettuna huomautuksena.
XML ja Markdown
Rakenteen voi tallentaa usealla tavalla. XML-pohjaiset muodot, kuten DITA, tarjoavat tiukan rakenteen, metatiedot ja vahvan uudelleenkäytön. Markdown on kevyempi ja helpompi omaksua, mutta sen rakenteelliset ilmaisukeinot ovat suppeammat. Teknisessä dokumentaatiossa, jossa on variantteja, kieliversioita ja säädösvaatimuksia, XML-pohjainen malli on yleensä perustellumpi valinta.
Esimerkki: konepajan nostolaitteen huolto-ohjeessa on öljynvaihtotoimenpide. Kun se kirjoitetaan yhdeksi komponentiksi, sama toimenpide voi esiintyä kolmen laitemallin ohjeessa ja yhdessä koulutusmateriaalissa. Muutos tehdään yhteen paikkaan, ja se päivittyy kaikkialle. Juuri tätä sisällön uudelleenkäyttö tarkoittaa käytännössä.
Julkaisuputken rakentaminen PDF:lle ja verkkoon
Julkaisuputki on ketju, joka muuttaa rakenteisen lähdesisällön valmiiksi tulosteeksi. Se koostuu kolmesta vaiheesta: sisällön kokoaminen, muunnos ja jakelu. Kun malli on kunnossa, putken rakentaminen on pitkälti toistettavien sääntöjen määrittelyä.
Putki etenee tyypillisesti näin:
- Kokoaminen: valitaan komponentit ja järjestetään ne julkaisuksi, esimerkiksi tietyn laitemallin käyttöohjeeksi.
- Suodatus: mukaan otetaan vain kohdemallia, markkina-aluetta tai kieltä koskeva sisältö.
- Muunnos: lähdesisältö muunnetaan PDF:ksi, HTML:ksi tai muuksi kanavamuodoksi tyylimääritysten avulla.
- Jakelu: valmis julkaisu viedään verkkoportaaliin, latauskirjastoon tai asiakkaalle toimitettavaan pakettiin.
Tässä kohdassa näkyy edellisen luvun rakenne-ulkoasu-erottelun hyöty. Koska ulkoasu on määritelty erikseen, yksi lähde tuottaa sekä paginoidun PDF:n että navigoitavan verkkoversion ilman käsityötä.
Käytännössä putken pystyttäminen kokonaan itse vaatii paljon erikoisosaamista. Selainpohjainen CCMS-järjestelmä, kuten DoX CMS, sisältää rakenteisen kirjoittamisen, versionhallinnan ja usean tulostemuodon julkaisun valmiina. Tällöin tiimin ei tarvitse rakentaa muunnoksia alusta alkaen.
Kanavakohtaiset erot ja yleiset sudenkuopat
Vaikka lähde on yksi, PDF ja verkko toimivat eri tavoin, ja ero kannattaa ottaa huomioon jo mallinnusvaiheessa. PDF luetaan usein alusta loppuun tai tulostetaan, kun taas verkkosisältöä selataan hakien ja hyppien. Samaa tekstiä ei siis aina kannata esittää samalla tavalla.
PDF ja verkko vertailussa
- Navigointi: PDF nojaa sisällysluetteloon ja sivunumeroihin, verkko hakuun, linkkeihin ja valikkoihin.
- Kappaleiden pituus: verkossa lukija ei välttämättä saavu sivulle alusta, joten jokainen komponentti on ymmärrettävä myös yksinään.
- Viittaukset: ”katso sivu 42” ei toimi verkossa, eikä pelkkä ”katso edellinen kappale” toimi missään. Käytä rakenteisia ristiviittauksia, jotka kanava muuntaa omaan muotoonsa.
- Kuvat ja taulukot: leveä taulukko mahtuu A4-sivulle mutta rikkoo mobiilinäkymän.
Yleisimmät sudenkuopat
Ensimmäinen virhe on pitää komponentteja liian suurina. Jos yksi komponentti on kymmenen sivun kokonaisuus, sitä on vaikea käyttää uudelleen. Toinen virhe on kirjoittaa kontekstisidonnaista tekstiä, kuten ”kuten edellä todettiin”, komponenttiin, joka päätyy eri julkaisuun eri järjestyksessä.
Kolmas virhe on käyttää muotoilua rakenteen korvikkeena. Jos varoitus tehdään vain punaisella lihavoinnilla, mikään kanava ei tunnista sitä varoitukseksi. Neljäs on mallin liiallinen monimutkaistaminen: jos tyyppejä ja attribuutteja on enemmän kuin kirjoittajat jaksavat käyttää, malli jää käyttämättä.
Laadunvarmistus ja julkaisuprosessin ylläpito
Single source -malli siirtää riskin: yksi virhe lähteessä monistuu kaikkiin kanaviin. Siksi laadunvarmistus on rakennettava osaksi putkea, ei jätettävä loppuun yhdeksi tarkistuskierrokseksi.
Hyvä käytäntö on tarkistaa kolme tasoa. Ensin sisältö validoidaan mallia vasten, jolloin puuttuvat pakolliset osat ja rikkinäiset viittaukset paljastuvat jo kirjoitusvaiheessa. Sitten sisältö käy läpi katselmointityönkulun, jossa asiantuntija hyväksyy muutokset. Lopuksi jokaisesta kanavasta tarkistetaan otanta: näyttääkö PDF oikealta, toimivatko verkkolinkit ja tulevatko kuvat mukaan.
Ylläpito on yhtä tärkeää. Sovi, kuka omistaa sisältömallin ja kuka saa muuttaa tyylimäärityksiä. Versionhallinta kertoo, mikä komponentti on muuttunut ja milloin, ja se tukee dokumentaation hallintaprosessia myös sääntelyn tarkastelutilanteissa. Kun tuote muuttuu tai uusi kieliversio tulee mukaan, päivitys tehdään yhdessä paikassa ja julkaistaan uudelleen.
Aloita pienestä: valitse yksi tuotelinja, mallinna sen tyypillisimmät sisältötyypit ja rakenna putki kahdelle kanavalle. Kun toimintatapa on osoittautunut käyttökelpoiseksi, laajenna muihin tuotteisiin. Jos haluat keskustella omasta dokumentointitilanteestasi, ota yhteyttä DoX Systemsin asiantuntijaan.
Sisältö on yleisluonteista tietoa teknisen dokumentaation hallinnasta, eikä se korvaa tuotekohtaisten turvallisuus- tai vaatimustenmukaisuusvaatimusten asiantuntija-arviointia.