Info Draft Booktype suomeksi

Kirjasta

Tästä oppaasta

Tämä käyttöopas on tuotettu FLOSS Manuals -dokumentaatiowikissä. Suomenkielinen FLOSS Manuals löytyy osoitteesta: http://fi.flossmanuals.net

Jos sinulla on parannusehdotuksia tähän oppaaseen, voit päivittää sitä vapaasti wikissä.

FLOSS Manuals on dokumentaatiowiki vapaille ja avoimen lähdekoodin ohjelmille. Alussa wiki oli tarjolla vain englanniksi, mutta nyt se on lokalisoitu myös suomeksi, ranskaksi, persiaksi ja hollanniksi. 

Lyhenne FLOSS tulee sanoista Free/Libre/Open Source Software. Suomeksi lyhenne käännetään yleensä sanoiksi Vapaat ja Avoimen Lähdekoodin Ohjelmat eli VALO. FLOSS Manualsin voisi siis suomentaa VALO-käyttöohjeiksi.

Vapaan ohjelman tunnusmerkit ovat neljä perusvapautta (joiden numerointi aloitetaan yleisen ohjelmointitavan mukaan nollasta):

  • vapaus 0: ohjelmaa saa käyttää mihin tahansa tarkoitukseen
  • vapaus 1: ohjelman toteutustapaa saa tutkia, ja ohjelmaa saa muokata omien tarpeiden mukaiseksi
  • vapaus 2: ohjelman kopioita saa jakaa edelleen lähimmäisen auttamiseksi
  • vapaus 3: ohjelman muokattuja versioita saa jakaa muille, niin että niistä on hyötyä koko yhteisölle.

FLOSS Manuals tarjoaa vapaille ohjelmille vapaita käyttöoppaita, jotka julkaistaan ilmaiseksi useimpien ohjelmien käyttämän GNU GPL -lisenssin alla.

Uusi käyttöopas tuotetaan usein kirjapyrähdyksessä, jossa ohjelmasta kiinnostuneet ihmiset kokoontuvat kirjoittamaan käyttöopasta. Kirjapyrähdys voi usein tuottaa uuden käyttöoppaan muutamassa päivässä.

FLOSS Manuals -verkosto on saanut maineen laadukkaan dokumentaation tuottajana. Sitä tukevat avainprojektit, kuten One Laptop Per Child ja Internet Archive. Kieliyhteisö laajenee nopeasti, käyttöoppaita käännetään nyt yli kahdellekymmenelle kielelle.

Dokumentaation tarve

Vapaiden ja avoimen ohjelmien maailmassa on paljon ohjelmoijia. Usein teknisistä kirjoittajista on kuitenkin pulaa. Yleisen vitsin mukaan uusi käyttäjä yrittää käyttää avoimen lähdekoodin ohjelmaa, mutta häntä neuvotaan ohjelman keskustelupalstalla tai postilistalla lukemaan lähdekoodia.

Tämän vuoksi tarvitsemme FLOSS Manualsia. Dokumentointi ja tekninen kirjoittaminen on se alue, joka on toistaiseksi ollut heikoin avoimen lähdekoodin yhteisössä.

Ihannetilanteessa dokumentaatio vastaa tavallisten käyttäjien taitotasoa. Loppukäyttäjä ei luultavasti ole kiinnostunut käytetyn ohjelmointikielen hienouksista tai vastaavista teknisistä seikoista, jotka ovat äärimmäisen kiehtovia kehittäjille. Käyttäjä tahtoo käyttää ohjelmaa.

Niinpä dokumentaatiossa käytetyn kielen tulisi olla ymmärrettävää käyttäjille. Sitä ei tulisi kirjoittaa ohjelmointigurujen teknisellä jargonilla, kaikki dokumentaatio tulisi kirjoittaa henkilölle, joka ei ole opiskellut tietojenkäsittelytiedettä, mutta tahtoo tuottaa ohjelmiston avulla jotain.

Tarvitsemme FLOSS Manualsin kaltaisen wikin rakentaaksemme sillan koodaajan, dokumentoijan ja käyttäjän välille.

Käyttäjien ja kirjoittajien yhteisön rakentaminen

Pelkkä käyttöoppaan suomentaminen ei riitä. Sitä täytyy jatkuvasti päivittää, laajentaa ja lokalisoida sopimaan paikallisiin olosuhteisiin. Tämän vuoksi jokainen FLOSS Manualsin lokalisaatio tarvitsee kirjoittajien ja lukijoiden yhteisöä.

Erilaisia osallistujia tarvitaan: uusia ohjelmien käyttäjiä ja pitkän linjan harrastajia, teknisiä kirjoittajia, kehittäjiä, graafikoita, kääntäjiä, lokalisoijia, oikolukijoita... Kuka tahansa voi osallistua FLOSS Manualsin kehittämiseen. 

Wikiin pohjautuva yhteistyö merkitsee sitä, että lukemattomien käyttäjien pienistä lisäyksistä muodostuu valtava määrä sisältöä.

FLOSS Manuals tahtoo antaa kaikille wikiin osallistuneille kunnian kirjoituksistaan, minkä vuoksi kirjoittajia pyydetään rekisteröitymään omalla nimellään.

FLOSS Manuals pyrkii luomaan ratkaisun uuden käyttäjän kohtaamaan ongelmaan: mistä löydän käyttöohjeen tälle ohjelmalle?