Raapaisu rakenteisesta dokumentoinnista & tekninen kirjoittaminen

Minä en ole kirjoittaja, mutta kerron nyt kuitenkin kirjoittajista ja rakenteisesta dokumentoinnista. Tämän jälkeen saan varmasti meidän kirjottajilta palautetta ”tämäntyylistä sisältöä ei koskaan kirjoteta passiivissa!”(eikä tämäntyylistä ole yhdyssana) Aikamuoto muuttuu kesken jutun! Lukumäärän ja yksikön väliin tulee aina välilyönti! Tekemisestä kertova steppilista ei voi olla kirjaimina! Näin ei voi kirjottaa, koska se on vastoin rakenteisen dokumentaation periaatteita… Eli suokaa anteeksi virheeni. 🙂

Tyypillisiä tilanteita dokumentoinnissa –> siksi rakenteinen:

• Meillä on tietty perustuote, mutta usein toimituksessa on jotain räätälöityä, esimerkiksi pumppu tai moottori -> Rakenteinen dokumentointi pohjautuu muuttujiin, moduuleihin ja profiileihin. Näistä elementeistä kasataan haluttuja julkaisuja ja voidaan tehdä toimituskohtaisia dokumentteja.
• Meillä tämä tuote on myynnissä eri nimillä eri maissa -> Tehdään tuotenimi muuttujana ja omat profiilit eri kielille. Julkaisussa sitten valitaan haluttu profiili.
• Tämä varoitus on sama joka dokumentissa -> Tehdään varoitukset tekstimoduulina, joka voidaan sijoittaa varoitus-osioon dokumentin alussa sekä tarvittaviin kohtiin huolto- ja asennus-ohjeisiin. Jos sanamuotoon tulee muutos, käydään muokkaamassa moduulin tekstiä, mistä muutos sitten siirtyy eteenpäin.

Rakenteinen dokumentointi sopii laajoihin asiakokonaisuuksiin, esimerkiksi laitteiden tai ohjelmistojen asennus-, käyttö- ja huolto-ohjeisiin.

Ja mihin sitä teknistä kirjoittajaa tarvitaan?

• Meidän tuotesuunnittelijat ovat perinteisesti kirjoittaneet huolto- ja käyttöohjeet – mihin tarvitaan teknistä kirjoittajaa? Tekninen kirjoittaja on oman alueensa asiantuntija. Hyvä kirjoittaja on tulkki insinöörin ja käyttäjän välillä, ja osaa viestiä asiasta oleellisen antamatta ristiriitaista tietoa. Tekninen kirjoittaminen on erilaista kuin romaanin kirjoittaminen: kirjoitetaan asiallista tekstiä, josta tekijä ei erotu tyylillään. Tekninen kirjoittaja on tyypillisesti Tampereen yliopistossa opiskellut humanisti, joka puhuu releasesta, konversiosta, versionhallinnasta, branchista, stagesta, gitistä, Docbookista ja DITA mapista.
• Dokumentoijat ovat puurtavia pilkunviilaajia. No niin olemme ja tässä työssä se on hyve.

RD Velholla tekniset kirjoittajat kirjoittavat suomea ja englantia. Työkaluna on oXygen XML, josta tehdään julkaisuna selainpohjaisia webhelppejä sekä pdf:t.

Teksti: Emmi Helanne