Linux-dokumentaatiotyöpaja Kumpula, Exactum, B221 keskiviikko
Erilaisia tiedontarpeita ● Yleisoppaat: kerrontaa aiheesta – Taustoja, selvityksiä, perehdyttävää materiaalia ● Yhden tavoitteen ohjeet – Haluan tehdä tietyn asian, miten tämä onnistuu? ● Virhetilanteesta toipumisen täsmäohjeet – Ohjelma x ei toimi niin kuin pitäisi, missä vika? – Esim. “minua auttoi tämä” tai “kokeile tätä”
Internet auttaa ● Parhaat oppaat usein yhä kirjoina, mutta: ● Mitä muuttuvampaa tietoa, sitä enemmän kannattaa kaivaa verkkoa ● Yhden tavoitteen ohjeita koottu usein sivustoiksi – Esim. linuxprinting.org, HOWTO-ohjeet ● Virheistä toipumisen ohjeet hajallaan esim. sovellusten bugitietokannoissa, Google löytää
Dokumentointityöpaja ● Omaan tarpeeseen, erityisesti ohjeet & oppaat ● Paikannetaan, opitaan ja dokumentoidaan – Linkkejä valmiisiin hyviin ohjeisiin – Suomennoksia, koosteita – Uuttakin asiaa mikäli tarpeen
Wikit ja sisällönhallinta ● Puhuttiin sitten wikeistä ja sisällönhallinnasta – Linux.fi-wiki: Linux-ohjeita, omia saa lisätä ja olemassaolevia parantaa – Muita wikejä esim. Wikipedia -tietosanakirja (ei ohjeille, vaan tietosanakirja-artikkeleille) ● Wikit ja sisällönhallintaohjelmat säästävät HTML- koodin käsinkirjoitukselta – Wikit parhaimmillaan epämääräiselle käyttäjäjoukolle; Mediawiki myös mukavan vakaa – Sisällönhallintajärjestelmä rajatulle joukolle
Wikin pystytys ● Wiki on ohjelma, joka asennetaan palvelimelle – Sitä pitää myös ylläpitää, ohjelmavirheiden ja tietoturvareikien varalta ● Wikia.com on sivusto, josta voi hankkia itselleen wikitilaa omaan tarkoitukseen asentamatta ikiomaa wikiohjelmistoa
Wikin muokkaus ● Muokkaamista voi harjoitella kunkin wikin hiekkalaatikolla – Esim. ● Uudet sivut luodaan tekemällä olemassaolevalle sivulle linkki uudelle (esim. linux.fi-wikissä [[Uusi sivuni]]), tallentamalla ja klikkaamalla linkkiä.