Dokumentaatiotekniikassa

Dokumentaatiotekniikassa tarkoitetaan teknisten ja käytettävyystiedon sisällön suunnittelun, rakenteen ja ylläpidon menetelmiä. Alalla painottuvat sekä ohjelmistojen että laitteiden käyttöohjeet, käyttöliittymä- ja API-dokumentaatio sekä näiden julkaisuprosessien hallinta koko tuotteen elinkaaren ajan. Tavoitteena on selkeä, johdonmukainen ja uudelleenkäytettävä sisältö sekä joustava julkaisu- ja lokalisaatioprosessi.

Keskeisiä periaatteita ovat aihepohjainen kirjoittaminen, moduulipohjainen sisältö ja sisällön uudelleenkäyttö. Rakenteen määrittely perustuu tietoarkkitehtuuriin, metatietoihin ja luokitteluun, mikä helpottaa etsimistä ja käännöksiä. Käytännön toteutuksessa hyödynnetään rakenteellisia malleja ja sisällön hallintaa, mikä mahdollistaa sisällön vientiin eri kanaviin sekä yhteensopivuuden ohjelmisto- ja teknisten dokumentaatioiden kanssa. Kirjoittamisessa painotetaan ilmaisun selkeyttä, johdonmukaisuutta ja saavutettavuutta.

Tekniikan ja työkalujen tasolla dokumentaatiotekniikka käyttää merkkaus- ja julkaisutekniikoita kuten XML/HTML sekä kevyempiä muotoja (Markdown, reStructuredText) sekä sisällönhallintajärjestelmiä, versionhallintaa ja automatisoituja julkaisuputkia. Työkalupakissa voivat olla ammattitukityökalut (esimerkiksi FrameMaker, MadCap Flare) sekä vähemmän tekniset ratkaisut. Lokalisoinnissa hyödynnetään käännöshallintaa ja muistivarastoja, jotta sisältö päivittyy nopeasti ja yhdenmukaisesti.

Prosessi ja organisaatio seuraavat sisältöelinkaarta, jossa suunnittelu, kirjoitus, tarkastus, hyväksyntä ja julkaisu sekä ylläpito toteutetaan hallitusti. Laatu- ja saavutettavuusvaatimukset sekä turvallisuusnäkökohdat ohjaavat tuotantoa. Roolit vaihtelevat teknisestä kirjoittajasta informaation arkkitehtiin sekä käännös- ja laadunvarmistusasiantuntijoihin.