Functioning Form -blogissa meneillään olevassa 9 Lessons from 9 Years of Interface Design -juttusarjassa ollaan edetty kuudenteen osaan, joka käsittelee dokumentointia, lempiaihettani: Documentation takes time. Make it worth the effort.
Jos käytettävyys jää monessa firmassa muiden, nk. tärkeämpien osa-alueiden jalkoihin, niin väittäisin, että vielä useammin ylenkatsotaan tuotettuja dokumentteja, jotka kuitenkin ovat se osuus, joka jää käteen kun palaverit on pidetty ja hommat tehty. Hyvä dokumentti ei synny tuosta vain, mutta sen tekemiseen kannattaa panostaa – onhan se samalla eräänlainen todiste tehdyn työn laadusta, ja usein myös työväline seuraavien vaiheiden toteuttamiseksi. Jos pitäisi valita huonoa kieltä ja kirjoitusvirheitä vilisevän tai huolellisen ja fiksusti kirjoitetun dokumentin välillä, niin kumman ottaisit?
Mielestäni tärkeintä on, että tehty dokumentti tavoittaa kohderyhmänsä niin, että sen pohjalta on helppoa jatkaa töiden tekemistä – tähän tapaan: ”The target audience can put the documented concepts to use easily and quickly. Their needs are reflected in the structure of the information. This, of course requires the author of the documentation to understand the needs of their audience. Surprisingly lots of design documentation is written by the author for the author but – like any other design process – user needs should be a key driver for documentation.”
Olen nähnyt monia konseptipapereita ja käyttöliittymäoppaita, mutta yksi niistä on jäänyt mieleeni ylitse muiden. Siinä on huolella ja vaivaa säästämättä kuvattu kaikki mitä ko. verkkopalvelun kehittäjien ja sisällöntuottajien tulee tietää, poikkeukset mukaanlukien. Kaikki tämä sellaisella kielellä, jota kuka tahansa voi ymmärtää ja soveltaa. Sen dokumentin pariin palaan aina silloin, kun fingelska ja väärinkirjoitus saavat aivoni savuamaan.
Haluatko kertoa muillekin, mikä tämä maanmainio dokumentti on?