Rakenteinen dokumentointi
Mitä rakenteisella dokumentaatiolla tarkoitetaan?
Rakenteinen dokumentaatio on tapa hallita sisältöä valmiin rakennemallin avulla. Dokumenttimallin avulla sisältö jaetaan pieniin yksittäisiin rakenteisiin, mikä helpottaa sisältöosioiden hallintaa, kääntämistä ja julkaisua erilaisissa julkaisukanavissa.
Dokumentaation rakennemallit ovat yleensä XML-muotoisia tiedostoja, joita voidaan käsitellä erilaisilla editoreilla. Rakenteinen dokumentointitapa erottaa sisällön ja dokumentin ulkoasun täysin toisistaan, näin samasta sisällöstä voidaan luoda tehokkaasti esimerkiksi tuotteen PDF-muotoinen käyttöohje ja verkkosivu.
Miksi dokumentoida rakenteisesti?
Rakenteinen dokumentaatio helpottaa sisällön hallintaa, muokkausta ja keskitettyä julkaisua. Tietosisältö muutetaan vain kerran, rakenteiseen alkuperäisdokumenttiin, ja sen jälkeen eri julkaisukanavat hyödyntävät tätä originaalia tuotettaessa valmiita dokumentteja.
Työnkulun helpottumisen lisäksi (Ei enää saman teknisen tiedon päivittämistä useaan eri paikkaan!) rakenteinen dokumentaatiotapa varmistaa sen, että tieto on oikeellista ja ajantasaista kaikissa julkaisukanavissa. Myös kääntäminen ja dokumenttien variointi helpottuu huomattavasti.
Sopiiko rakenteinen dokumentointi yrityksellenne?
Ota yhteyttä meihin. Keskustelemme mielellämme dokumentoinnin tarpeestanne ja selvitämme mitä hyötyä rakenteisesta dokumentaatiosta olisi organisaatiollenne.