Tagged: Tekninen kirjoittaminen

Kirja yhteisökirjoittamisesta

“Kerro minulle… ja unohdan.
Näytä minulle… ja muistan.
Ota minut mukaan… ja ymmärrän.”

- Kungfutse

Anne Gentlen kirja Conversation and Community: The Social Web for Documentation on julkaistu jo vuonna 2009, mutta se on FLOSS Manuals -projektin kannalta luultavasti ainoa relevantti teknistä kirjoittamista käsittelevä kirja, joka on Kindleeni päätynyt. Kirja ei tunnu vanhentuneen parissa vuodessa, vaikka sen käsittelemät ilmiöt kehittyvät todella nopeasti.

Anne Gentle on tekninen kirjoittaja, joka pitää Just Write Click -blogia ja on aktiivinen englanninkielisen FLOSS Manualsin puolella. Conversation and Community perustuu Gentlen kokemuksiin FLOSS Manualsissa ja muissa dokumentaatioprojekteissa ja käsittelee wikejä ja sosiaalista mediaa ammattimaisen teknisen kirjoittajan näkökulmasta.

Loppukäyttäjät eivät välttämättä välitä dokumentaation kirjoittajan ammattitaidosta tai ohjeiden virallisuuden asteesta, vaan etsivät Googlen avulla toimivia ohjeita verkosta. Niinpä käyttäjän kannalta toimivaa dokumentaatiota voivat olla ohjelmistoprojektin virallisten julkaisujen lisäksi keskustelupalstat, wikit, blogit tai postilistat. Lisäksi informaatioähkystä muutenkin kärsivät käyttäjät tahtovat tiedon helposti ja heti.

Paras dokumentaatio perustuu Gentlen mukaan käyttäjien kysymyksiin ja kirjoittamisprojekti kannattaa aloittaa usein kysytyt kysymykset -listasta. Hakukoneoptimoinnista on tullut olennainen dokumentaatiossa tarvittava taito, koska käyttäjät esittävät kysymyksensä ensin hakukoneelle. Gentle opastaa kirjoittajia myös vastaamaan lukijoilleen suoraan käyttäen erilaisia verkon mahdollistamia viestintätyökaluja.

Teknisten keskustelupalstojen osallistujat eivät yleensä ajattele kirjoittavansa dokumentaatiota, vaikka kirjoittavatkin käyttöohjeita näppäimistö rutisten. Tästä ei ole pitkää matkaa yhteisöllisen wikin editoimiseen. Wikin perustaminen ei kuitenkaan takaa yhteisön muodostumista sen ympärille.

Gentle opastaa dokumentoijia rakentamaan yhteisön neljässä vaiheessa. Ensin tulisi kuunnella käyttäjien juttuja verkossa. Toisessa vaiheessa tulee osallistua käyttäjien keskusteluihin. Kolmas vaihe on jakaa sisältöä verkossa. Neljännessä vaiheessa tämä sisältö tarjotaan vuorovaikutuksen ja muokkaamisen mahdollistavalla alustalla.

Dokumentaatiowikien tekijät päätyvät teknisen kirjoittamisen lisäksi toimimaan myös yhteisöjen ylläpitäjinä, jotka joutuvat perehtymään myös erilaisten flame war -tyyppisten ilmiöiden ongelmakenttään.

Kirjassa esitellään myös FLOSS Manualsin käyttämä yhteisöllisen kirjoittamisen booksprint-menetelmä, jossa pyritään saamaan aikaan kokonainen kirja lyhyessä ajassa. Englanninkielisellä puolella pidetään tosin yleensä muutaman päivän extreme-kirjapyrähdyksiä, joissa kirjoittajat kokoontuvat yhteen huoneeseen ja keskittyvät vain yhteen asiaan, kun taas suomenkielisellä puolella olemme yleensä pitäneet hitaampia ja pidempiä booksprinttejä, joissa istuntoja on vain muutama ja suurin osa kirjoittamisesta tehdään verkossa.

Gentlen ammattimaisen teknisen kirjoittamisen näkökulma aiheuttaa välillä jonkin verran hämmennystä. Hänen mukaansa esimerkiksi wikiin on välttämätöntä luoda tyyliopas, vaikka FLOSS Manualsin postilistalla käydyssä väittelyssä monet keskustelijat näkivät pakollisen tyylioppaan vain nostavan vapaaehtoisten kirjoittajien osallistumiskynnystä ja tukahduttavan luovuutta. Käyttäväthän yhtiöt tyylioppaita paljolti juuri estääkseen kirjoittajien oman tyylin näkymisen julkaistuissa tuotteissa. Eri kirjoittajien omien tyylien sijasta lopputulokseksi tulee standardimallista ja minimalistista tekstiä.

Kirjan parin vuoden ikä näkyy ainoastaan siitä, että FLOSS Manualsin uutta Booki-julkaisualustaa ei käsitellä lainkaan. Booki on suunniteltu mahdollistamaan valmiiden tiedostojen tuottaminen lukulaitetta tai painoa varten napinpainalluksella. Lisäksi siihen on FLOSS Manualsin kokemuksien perusteella lisätty yhteistyötä helpottavia sosiaalisen median ominaisuuksia.

Conversation and Community käsittelee aihepiiriä, jonka pitäisi kiinnostaa kaikkia dokumentaatiowikien harrastajia.

Kirjapyrähdyksiä Kaliforniassa

FLOSS Manuals pitää parhaillaan neljää samanaikaista kirjapyrähdystä Kalifornian Mountain Viewissä Googlen päämajassa. Tavoitteena on saada aikaan neljä julkaisukelpoista käyttöopasta kolmessa päivässä. Tavoite on kunnianhimoinen, mutta näyttää toteutuvan.

Paikalle on saapunut neljän ohjelmistoprojektin edustajia, jotka kirjoittavat nopeaan tahtiin FLOSS Manuals -oppaita ohjelmilleen. Oppaiden edistymistä voi seurata reaaliajassa: OpenStreetMap, Sahana, OpenMRS ja KDE.

Olen paikalla perehtymässä booksprint-menetelmään. Suomalaiset kirjapyrähdykset ovat olleet hieman erilaisia kuin englanninkieliset booksprintit. Mahdollisesti siksi, että tietojemme mukaan yksikään suomalainen ei ole aikaisemmin osallistunut kansainväliseen booksprinttiin. Jatkossa suomenkielisissä kirjapyrähdyksissä on tarkoitus siirtyä samoille linjoille englanninkielisen FLOSS Manualsin kanssa.

Itse olen ollut OpenStreetMap-ryhmässä, koska sain mukavan tuntuman avoimen lähdekoodin karttaohjelmistoihin toimiessani Shalinin GISEEM-projektissa Keniassa vaalimellakoiden aikaan 2007-2008. Sisältöä syntyy ällistyttävän nopeasti, vaikka kieltämättä olemme kierrättäneet avoimen lähdekoodin periaatteiden mukaisesti Learn OSM -sivuston materiaalia.

Suomalaisesta avoimen lähdekoodin väestä paikalla on myös Seravon Tuukka Hastrup, joka on hyvin raskaassa vastuussa FLOSS Manualsin Booki-julkaisualustan toimivuudesta.

Osallistujina on Anne Gentlen ja Janet Swisherin kaltaisia teknisen kirjoittamisen guruja. Paikalla on myös O’Reillyn Andy Oram, joka on blogannut aiheesta joka päivä: päivä 0, päivä 1, päivä 2.

Tiukkapipoisempaa teknistä kirjoittajaa voisi ärsyttää se havainto, ettei kukaan edelleenkään tahdo käyttää minkäänlaista tyyliopasta.

FLOSS Manuals Berliinissä

FLOSS Manualsin kansainvälinen verkosto tapaa Berliinissä 3.-5. lokakuuta.

FLOSS Manualsin maailmassa on tapahtunut paljon kahden vuoden aikana ja pieni ryhmä FLOSS Manualsin keskushahmoja tapaa suunnitellakseen seuraavan vuoden tapahtumia.

Mukana ovat ranskan ja suomen kielikoordinaattorit ja Bookin ohjelmoijat.