Lihtsusega eksimuste vastu: kirjasõna kvantiteedist ja kvaliteedist

Parim rakendus oli kord see, mille kasutusjuhendit ei pidanud mitte kunagi avama. Kui see remark tundus kohane viie aasta eest, siis paratamatult on aeg see välja vahetada. Tänapäeva parim rakendus on see, mille jaoks polegi kasutusjuhendit tarvis. Intuitiivsus, kiirus ja rikkalik tagasiside sillutavad teed uute lahenduste vaprasse maailma. Kahjuks pole mitte iga rakendus iPadi peal rõngaste joonistamiseks, mille otsekohesus võrdub selle sisulise väärtusega; aga püüdlus lihtsustada ka kõige keerukam toode käepäraseks kasutamiseks peaks olema kaasaegse arenduse mantraks. Kuidas sellesse uude mõttelaadi kvaliteedi termin sobitub ja kuidas kvaliteeti kui taolist sootuks tõlgendada, sellest mõne sõnaga pikemalt.

Kasutajajuhendid on pelgalt jäämäe tipp. Tõeline dokumentatsioon, nõuded, analüüs, testiplaanid, koosolekute märkmed ja arendajate kommentaarid algkoodis – kõik see, mis eelneb kasutajajuhendi koostamisele – omab kordades suuremat väärtust ja kaalu ning selle ajakohane loomine ühes otstarbelise kasutamisega on suuteline andma toote tegelikule arendusele vääramatu suuna ja põhimõttelise tugevuse. Kahjuks on aeganõudev ja närve kulutav kirjatöö vaid väheste jaoks meelt mööda. Kuid panus, mille kvaliteetne dokumentatsioon võib anda kvaliteetse toote tekkesse, on möödapääsmatu tähtsusega.

Suhtumise küsimus

Suhtumine dokumentatsiooni ja selle tekitamisse arenduskeskkonnas on alati olnud valuline. Ühelt poolt tundub dokumenteerimine triviaalse tegevusena. Triviaalsus selles kontekstis tähendab, et kirja pandust ei ole mitte midagi uut õppida. Arendajad ja analüütikud tunnetavad seda ennekõike teravalt, sest omaenda projektis, kus nagunii iga koma ja punkt teada on, ei ole alati kannatlikkust või siis isegi hoolimist kõiki nüansse kirja panna. See siin ongi projektisisese dokumenteerimise Achilleuse kand: nende jaoks, kes on teemas sügavalt sees, tundub kõik vahetu ja arusaadav. Teistele, kes vaatavad asjade kulgu kõrvalt, paistab lugu pooleldi musta maagiana. Mõned osapooled tunnevad endid kahtlemata kõrvale jäetuna ja lõpeks kannatab terve projekti kulg. Triviaalsus on seega ohtlik konnotatsioon, mille ära tundmine tekitab sama palju vastumeelsust kui selle teadlik esile kutsumine. Teadaoleva informatsiooni edasi andmine kolmandale osapoolele, näiteks professionaalsele dokumenteerijale, tundub seega aja raiskamisena, sest mistahes infovahetus puhtalt infovahetuse väärtusega omandab koheselt negatiivse väärtuse, mille eest keegi justkui maksta ei soovi.

Proeksperdi tuumikväärtustega käsikäes

Kvaliteetne dokumentatsioon peab alati vastama loogilistele nõuetele: see peab olema kergesti leitav, kergesti identifitseeritav, täpne ja arusaadav. Sellele loetelule lisan mina omalt poolt veel ühe omaduse: lihtsuse. Lihtsus läheb kokku ka tõeks tunnistatud Proeksperdi põhiväärtustega. Ning lihtsuse saavutamine on sedavõrd loomulik, sedavõrd iseenesest mõistetav, et sellele võiks sageli enam rõhku pöörata. Miks kasutada viite sõna, kui saab mõtte edasi anda kolmega? Miks tekitada polüsüllaabilisi monstrumeid, kui sõnavara võimaldab viidata kontseptidele palju lihtsamate, koduste terminite abil. Taas kord tuleb võidelda uhkeldava, kirju keelekasutuse vastu maailmas, kus sellele tegelikku kohta sootuks ei leia. Lihtsus teksti puhul annab lugejale hindamatu eelise aja ees: energia ja tempo, millega tekstimassiivis sisalduvat informatsiooni hoomata, väheneb eksponentsiaalselt. Kahtlemata ei saa lihtsuse ees ohverdada keerukamat informatsiooni, kui see on vajalik, aga kogemus dikteerib, et kolmel juhul viiest saab sellestki lihtsate sõnadega ümber.

Lihtsuse tegelik väärtus on ülim, mida tarkvaraarenduses edasi on võimalik anda: lihtsa, ent täpse teksti tulemusena on igal osapoolel võimalik üheselt mõista, mis on antud sõnumi sisuks. Lihtsus ja konkreetsus elimineerivad tehtest tõlgendamise tüütu tegevuse – kui miski on pandud kirja, must valgel, ja sellest aru saamine ei kujuta endast hiina mõistatust, siis on juba astutud esimene samm absoluutse tootekvaliteedi poole.

Tehnilise dokumentatsiooni ettekirjutusi on veel, rohkem, kui blogisein neid kvaliteetselt edasi on suuteline andma. Kuid nende edasi andmiseks ei ole põgus artikkel just parim vorm.

Kvaliteetne dokumentatsioon tagab eeldused kvaliteetse toote arenduse jaoks. Peale arendajate on korrektsest dokumentatsioonist hindamatu abiline testimise ja kasutajatoe juures: iga peenemgi nüanss, kui see on kunagi kirja saanud ja vastab tegelikkusele, on kohe varnast võtta. Kuigi avalõigus nimetatud kasutajajuhendita maailm on veel verisulis, siis kaugel see enam ei ole. Areng ja uudsus ei ole fenomenid, mida miski saaks peatada. Ning kuigi täna veel peab näiteks ühe Danfossi draivi konfiguratsiooni tekitamise jaoks läbi töötama pühakirja mõõtu torni manuaale, siis ühel kaunil päeval oleme kord ka toote ees, mis teeb seda kõike sama hästi ja mille kasutamisega saab kasvõi koolieelik hakkama. Banaalsena kõlab mõte, et põhjalik ettevalmistustöö projekti algset dokumentatsiooni luues teeb kogu hilisema elu kergemaks, aga selle väite tõesuses ei tohi kahelda.

One thought on “Lihtsusega eksimuste vastu: kirjasõna kvantiteedist ja kvaliteedist”

Leave a Reply

Your email address will not be published. Required fields are marked *