Moderni dokumentointijärjestelmä auttaa ladukkaan dokumentaation tuottamisessa

Moderni dokumentointijärjestelmä auttaa ladukkaan dokumentaation tuottamisessa

Mitä on laadukas dokumentaatio ja miten se syntyy? Ei varmaan tule yllätyksenä, että dokumentointijärjestelmien toimittajan mielestä keskeisessä asemassa ovat ammattitaitoisten tekijöiden lisäksi dokumentointijärjestelmät. Seuraavassa muutama nosto siitä, miten moderni dokumentointijärjestelmä auttaa laadukkaan dokumentaation tuottamisessa:

Laadukas dokumentaatio edellyttää asiantuntemusta. Laadukas sisältö syntyy, kun sen tuottamiseen osallistuu kyseisen asian parhaiten tunteva henkilö. Yhdellä ja samalla henkilöllä ei todennäköisesti ole parasta asiantuntemusta kovin laajalta alueelta, joten dokumentointiin on hyvä ottaa mukaan useampi asiantuntija. Osansa annettavana voi olla niin tuotehallinnalla, kouluttajille, suunnittelijoilla, markkinoinnilla kuin lakiosastollakin. Moderni dokumentointijärjestelmä mahdollistaa hallitun yhteistyön dokumentointiin osallistuvien osapuolten välillä. Dokumentoija voi esimerkiksi lähettää tietyn kohdan käyttöohjeesta suunnittelijan täydennettäväksi ja hyväksyttäväksi, tai lakiosasto voi huolehtia käyttöohjeen klausuuleista ilman sen kummempaa dokumenttien sähköpostipallottelua.

Laadukkaassa dokumentaatiossa kunkin dokumentin sisältö on tarkoituksenmukainen. Julkaisuissa ei ole mukana mitään ylimääräistä eikä sieltä toisaalta puutu mitään. Vain kyseisen dokumentin tarkoituksen kannalta olennainen tieto on mukana. Modulaarisessa dokumentoinnissa sisältö jaetaan pieniin osiin ja valmiit dokumentit koostetaan näiden perusteella enemmän tai vähemmän automaattisesti. Näin dokumenttien tuottaminen on nopeaa ja voidaan tehdä helposti esimerkiksi tarkasti projektikohtaisia dokumentteja, jolloin mukaan saadaan vain lukijan kannalta olennainen tieto. Moderni dokumentointijärjestelmä tukee modulaarista dokumentointia.

Laadukas dokumentaatio edellyttää, että dokumentaatiota kehitetään jatkuvasti. Jatkuvan kehityksen avulla dokumenttien rakenteet ja sisältö pysyvät kunnossa. Jatkuvaa kehittämistä helpottaa yksilähteistäminen. Yksilähteistäminen tarkoittaa, että sama sisältö on olemassa vain kerran ja tätä tietoa käytetään uudelleen mahdollisimman monessa eri tarkoituksessa. Kehitys kohdistetaan aina uusimpaan versioon eikä järjestelmään synny toisistaan poikkeavia kehityshaaroja. Tehokas yksilähteistäminen edellyttää modulaarista dokumentointia. Kun sisältö on modulaarisen dokumentoinnin periaatteiden mukaisesti pilkottu osiin, uudelleen käytettävää sisältöä on enemmän. Moderni dokumentointijärjestelmä ohjaa yksilähteistämiseen.

Laadukas dokumentaatio on helppolukuista. Tähän auttaa tietysti isolta osaltaan ammattitaitoinen tekstin tuottaja. Tärkeää on myös, että dokumentti on saatavilla kielellä, jota lukija osaa – parhaassa tapauksessa lukijan äidinkielellä. Moderni dokumentointijärjestelmä tekee käännösprosessien ja käännösten hallinnasta vaivatonta ja mahdollistaa eri kieliversioiden tuottamisen kustannustehokkaasti. Helppolukuinen dokumentaatio on myös ulkoasultaan selkeä ja yhtenevä. Rakenteisessa dokumentaatiossa ulkoasu erotetaan sisällöstä, jolloin se pysyy yhtenevänä ja sen laadusta vastaa ammattitaitoinen vastuuhenkilö. Moderni dokumentointijärjestelmä tukee rakenteista dokumentointia.

Laadukas dokumentaatiota on virheetöntä. Tätä tukevat jo mainitut asiantuntevat kirjoittajat, jatkuva kehittäminen ja yksilähteistäminen, mutta myös hyvin suunniteltu ja hallittu tuotantoprosessi. Kun tuotantoprosessi on suunniteltu niin, että vastuualueet ovat selvät ja sisällön tarkastuskierrot ovat riittävät, estää tämä osaltaan virheiden lipsumisen dokumentteihin. Modernin dokumentointijärjestelmän avulla työnkulkujen hallinta ja ohjaus onnistuu vaivattomasti.

Haluan nostaa laadukkaan dokumentaation osaksi myös saatavuuden. Parhaastakaan dokumentista ei ole mitään hyötyä, jos sitä ei ole saatavilla silloin, kun sitä tarvitaan siellä missä tarvitaan. Moderni dokumentointijärjestelmä tehostaa dokumentaation tuotantoa työnkulkujen, yksilähteistämisen ja uudelleenkäytön avulla. Tämä auttaa aikatauluhaasteiden kanssa. Moderni dokumentointijärjestelmä myös mahdollistaa monikanavajulkaisun, minkä avulla dokumentteja voidaan julkaista nopeasti tarkoituksenmukaisella formaatilla suoraan kohteeseen, esimerkiksi asiakkaan tabletille.

Nämä nyt nostoina näin dokumentointijärjestelmän toimittajan näkökulmasta. Alla vielä kuva, johon hahmottelin laadukkaan dokumentaation osa-alueiden ja dokumentointijärjestelmän ominaisuuksien välisiä yhteyksiä.

Mainiota joulunaikaa kaikille ja palataan asiaan ensi vuonna.
Paavo

Tilaa DoX-Blogi sähköpostiisi


Antamalla tietosi, hyväksyt, että Fenten voi olla sinuun yhteydessä sähköpostilla. Jos et jaksa odotella seuraava blogia, ota yhteyttä!
Rekisteriseloste

Paavo Korhonen
paavo.korhonen@fenten.fi

Paavo työskentelee Fentenillä asiantuntijana DoX-järjestelmien parissa.

-->