DoX Systemsin yhteistyö teknisen viestintää Suomessa opettavien tahojen kanssa jatkuu. Kirjoitin aiemmin yhteistyön aloittamisesta Vaasan yliopiston kanssa. Tänä syksynä vastaavaa yhteistyötä on laajennettu myös Tampereen yliopiston teknisen kommunikaation maisteriohjelmaan.
Vaasan yliopisto
Kerroin Vaasan yliopistolla kokemuksistani teknisenä kirjoittajana DoX Systemsillä ja näkökulmastani alaan järjestelmän tarjoajan ja asiakaspalvelijan näkökulmasta sekä kesäkurssilla että syyslukukauden alettua.
Tällä luennolla kerroin taidoista ja kokemuksista, joista oli hyötyä minulle alan vaihtajana. Lisäksi kerroin omista tehtävistäni pienessä ohjelmistoyrityksessä sekä teknisen kirjoittamisen parissa että sen ohessa.
Esimerkiksi unettomuus vaikuttaa olevan varsin yleistä teknisten kirjoittajien parissa. Onneksi monet voivat työskennellä liukuvan työajan puitteissa.
Saamani palautteen perusteella alan opiskelijat ovat kiinnostuneita työelämän todellisuudesta.
Tampereen yliopisto
Pidin Tampereen yliopistolla kaksi vierailuluentoa. Ensimmäisen niistä aihe oli sama kuin Vaasan yliopistolla. Toinen luento keskittyi enemmän rakenteiseen kirjoittamiseen sekä siihen liittyviin hyviin käytänteisiin.
Toisen luennon tarkka aihe oli ’Ennalta valmistelun ja ennakoinnin merkitys rakenteisessa kirjoittamisessa’. Alustin aiheen käymällä läpi aiheeseen liittyviä avainkäsitteitä kuten ’rakennepuu’.
Tämän jälkeen keskustelin kolmesta rakenteisen kirjoittamisen periaatteesta, joiden vuoksi ennalta valmistelu ja ennakointi ovat erityisen tärkeitä:
- Generatiivisuus: Kaikki yksityiskohdat eivät ole suoraan käyttäjien hallinnoitavissa. Dokumenttien tuottaminen on osittain riippuvaista automaattisista järjestelmistä kuten formaattikohtaisista kasaajista.
- Yksilähteistäminen: Oikein valmistellussa ympäristössä samoja sisältökokonaisuuksia voi käyttää uudelleen ja silti hallinnoida kaikissa sijainneissa yhden lähdeversion avulla.
- Ehdollistaminen: Sisällöt voi merkitä ennalta käytettäviksi vain tietyt ehdot täyttävissä julkaisuissa. Tällöin niitä ympäröivät osuudet säilyvät yksilähteistettyinä näiden julkaisujen kesken.
Seuraava osuus koski näiden kolmen periaatteen soveltamista osana sisällön valmistelemista ja sisällön valmistelemista tavalla, joka huomioi kunkin niistä. Esimerkiksi otsikkosisällöt täytyy järjestellä tavoilla, jotka huomioivat käytetyt tyylitiedostot sekä käytettyjen kasaajien rajoitteet. Olen kirjoittanut tästä aiheesta aiemmin täällä.
Luennon yleinen sanoma oli, että asianmukainen rakenteinen dokumentointi vaatii sekä suunnittelua että valmistelua parhaiden tuloksien ja käyttökokemuksen saavuttamiseksi. Käyttäjien täytyy ymmärtää, kuinka erilaiset sisällöt sekä järjestelmät vuorovaikuttavat, jotta he kykenevät käyttämään niitä asianmukaisesti. Tällainen ymmärrys kattaa myös mahdolliset tulevat laajentamistarpeet sekä ilmeisten tarpeiden esimerkiksi muuttujien osalta tiedostamisen ennen leipätekstin kirjoittamista. Tällä tavoin leipätekstin voi kirjoittaa kerralla tulevat lisätarpeet ennakoivalla tavalla ja ilman tarvetta keskeyttää kirjoittaminen leipätekstin tarvitsemien uusien lisäpalasien kuten muuttujien järjestelmään lisäämistä varten.