FLOSS ManualsLaadukasta dokumentaatiota avoimen lähdekoodin

ohjelmille

Avoimen lähdekoodin dokumentaatio

Tomi Toivio, open source coordinator, m-cult

Mitä FLOSS Manuals ei ole

● FLOSS Manuals ei sisällä hammaslankojen

käyttöohjeita

● FLOSS = Free/Libre Open Source Software

● FLOSS = Vapaat ja Avoimen Lähdekoodin

Ohjelmat

● FLOSS Manuals on dokumentaatiowiki avoimen lähdekoodin

ohjelmille.

● FLOSS Manuals tarjoaa ilmaisia käyttöoppaita, jotka julkaistaan

GPL-lisenssin alaisuudessa.

● Alkuperäinen versio oli englanniksi, nyt olemassa on myös

lokalisaatiot suomeksi, persiaksi ja hollanniksi.

Mikä on FLOSS Manuals?

● Ihannetilanteessa dokumentaation kirjoittajat käyttävät

loppukäyttäjien tietomäärään sopivaa kieltä.

● Kaikki käsitteet tulisi selittää henkilölle, joka ei ymmärrä

tietojenkäsittelytiedettä.

● FLOSS Manuals rakentaa siltaa ohjelmien ja mahdollisten käyttäjien

välille.

Dokumentaation tarve

● Pelkkä käyttöoppaan kääntäminen ei riitä, sitä täytyy jatkuvasti

päivittää, laajentaa ja lokalisoida sopimaan paikalliseen kulttuuriin.

● Pidämme työpajoja koulujen, kansalaismediakeskusten ja

käyttäjäyhteisöjen kanssa.

● Tämän tavoitteena on tuoda uusia käyttäjiä ja kirjoittajia avoimen

lähdekoodin yhteisöön.

Käyttäjien ja kirjoittajien

yhteisön rakentaminen

FLOSS Manualsin tausta

● Adam Hyde tahtoi lähettää videokuvaa netissä

avoimen lähdekoodin ohjelmilla

● Kyllästyi tarjolla olemaan dokumentaatioon

● FLOSS Manuals perustettiin Amsterdamissa

vuonna 2006

● Englanninkielisessä versiossa lähemmäs 2000

kirjoittajaa

● Uusia käyttöoppaita laaditaan kirjapyrähdyksillä

FLOSS Manualsin rakenne

● Lue – käyttöoppaiden julkaistut versiot

● Kirjoita – käyttöoppaiden kehitysversiot, vaatii

rekisteröinnin

● Remiksaa – käyttöoppaiden remiksaus,

julkaiseminen AJAX-muodossa jne.

● Tietoa – uutiset ja muuta

Avoimen dokumentaation tila

“LUE LÄHDEKOODIA”

“ET VAIN OSAA”+++++ +++++ initialize counter (cell #0) to 10

[ use loop to set the next four cells to 70/100/30/10

> +++++ ++ add 7 to cell #1

> +++++ +++++ add 10 to cell #2

> +++ add 3 to cell #3

> + add 1 to cell #4

<<<< - decrement counter (cell #0)

]

> ++ . print 'H'

> + . print 'e'

Avoimen dokumentaation tila

Ongelmia:

1. Suljettu alusta (esimerkiksi CVS)

2. Suljettu – formaatti (esimerkiksi docbook)

3. Suljettu – lisenssi (esimerkiksi tavallinen

tekijänoikeus)

4. Suljettu - organisaatio (kustantamo käyttää

avointa lisenssiä)

5. Ohjelman kehittäjät kirjoittaneet

ulkomuististaan

Avoimen dokumentaation tila

6. Ei ylläpidetä (vanhentunut)

7. Rajoittunut yleisö (dokumentaation

ymmärtäminen vaatii liikaa teknisiä taitoja)

8. Vaikea löytää

9. Maksaa (maksullinen dokumentaatio ilmaisille

ohjelmille)

Vapaan dokumentaation tulevaisuus

1. Avoin alusta (wiki)

2. Avoin formaatti (xhtml)

3. Avoin lisenssi (GPL)

4. Avoin organisaatio (FLOSS Manuals)

5. Kirjoitettua ohjelmia käyttäessä

6. Yhteisön ylläpitämä

7. Laajempi yleisö

8. Helppo löytää

9. Ilmainen ja vapaa!

Vapaa dokumentaatio tarvitsee

1. Alusta

2. Yhteisö

3. Sisältö

4. Vapaan dokumentaation

sektori

Vapaan dokumentaation sektori

1. Tarvitsee sisäisen arvostuksen

2. Tarvitsee ulkoisen arvostuksen

3. Tarvitsee tulonlähteitä

4. Tarvitsee onnistuneita malleja

5. Tarvitsee joukon erilaisia taitoja

6. Täytyy olla hauskaa, sosiaalista ja

merkityksellistä

FLOSS Manualsin ominaisuuksia

1. Helppo kirjoittaa (WYSIWYG)

2. Vetovalikko sisällysluettelon luomiseen

3. Julkaisu napinpainalluksella

4. Kirjan muotoilu CSS:n avulla

5. Käyttöoppaiden uudelleenmiksaus

6. Tekijänoikeudet tekijöille

7. Käännöstyökalut

8. Lokalisaatiotyökalut

9. Sivuille sulautettu kirjakauppa

10. Elävät käyttöoppaat (AJAX)

11. Kirjapyrähdyksen sosiaalinen malli

Kirjapyrähdys

1. Luodaan yhteisö käyttöoppaan ympärille

2. 5-6 kirjoittajaa samassa huoneessa

3. Ruoka, asunto ja matkat järjestetään

4. Käyttöoppaiden sisältösuunnitelma etukäteen

5. Sisällysluettelo rakennetaan ensimmäisenä

päivänä

6. 4 päivää kirjoittamista

7. 1 päivä viimeistelyä ja oikolukemista

Medios-projekti

● Medios-projekti on osallistuvan median

menetelmien ja työkalujen kehittämishanke

● Projektissa mukana Helsingin

kaupunginteatteri, Metropolia ja m-cult

● M-cult lokalisoi Suomen FLOSS Manualsin ja

järjestää sen pohjalta avoimen lähdekoodin

ohjelmien mediatyöpajoja

● Muuta m-cultin toimintaa esimerkiksi M2HZ-

kanava

Tapahtumia

● Suomen FLOSS Manuals -lokalisaatio avattu

syyskuussa 2009

● 22 käyttöopasta käännetty

● Avoimen lähdekoodin audiovisuaalisten

työkalujen koulutusta esimerkiksi kirjastojen

kanssa

● Käännöspyrähdyksiä esimerkiksi yliopistojen

kanssa

● Avoimen lähdekoodin ohjelmien kenttästudio

Kirjapyrähdysideoita

● Opas avoimen lähdekoodin ja kulttuurin

lisenssien käyttöön (GPL, Creative Commons)

● Scribus-käyttöopas

● Streaming-prosessiopas

● Avoimen videon tuotanto-opas

● Irssi-käyttöopas

● Arduino-opas

● Ruby-verkkoalustan käyttöopas

Assimiloimme...

● Kääntäjiä

● Käyttöoppaiden päivittäjiä uusiin

ohjelmaversioihin

● Terminologian asiantuntijoita

● Graafikoita

● Käyttöoppaiden kirjoittajia

● Oikolukijoita

● Kaikki

Booki

● Nykyinen alusta perustuu Tinwikiin

● Uusi Booki-alusta on demovaiheessa

● Bookia tukee Archive.org

● Booki ei ole rajoittunut käyttöohjeisiin

● FLOSS Manuals on vain yksi Bookin

kirjoittajaryhmistä

● Bookiin voi perustaa esimerkiksi

tieteiskirjallisuutta kirjoittavan ryhmän

Samankaltaisia projekteja

Vastaavia wikejä:

● Linux.fi – Linuxin dokumentaatiowiki

● Wikibooks – esimerkiksi laaja Ubuntu-opas

● Ohjelmien lokalisointi:

● Lokalisointi.org – tietoa ohjelmien lokalisoinnista

suomeksi

Kiitos!

Tomi Toivio

tomi@flossmanuals.net

http://fi.flossmanuals.net