Mis on tarkvara dokumentatsioon?

Tarkvara viitab arvutisüsteemi jaoks välja töötatud rutiinidele ja programmidele, mis võimaldavad seda kasutada ülesannete täitmiseks või muul viisil arvutiga suhtlemiseks. Tarkvara võib pakkuda tootja süsteemikomponendina või eraldi rakendustena tootja või kolmandate isikute poolt. Dokumentatsioon on toote ja selle kasutamise kirjeldus. Tarkvara dokumentatsioon kirjeldab tarkvararakendusi ja nende kasutamist.

Trükitud tarkvaradokumentatsioon, mida mõnikord nimetatakse tarkvara käsiraamatuteks, on sageli koostatud nagu raamat, millel on tiitelleht, sisukord, keha ja register ning neil on sageli mõned tüüpilised komponendid. Esimene komponent, mida enamik kasutajaid vajab, on installijuhend ning erinevate operatsioonisüsteemide jaoks, milles tarkvara töötab, antakse vajadusel eraldi juhendid. Installijuhendis on loetletud tarkvara käitamiseks vajalikud spetsifikatsioonid, sealhulgas arvuti operatsioonisüsteem(id), RAM, kõvakettaruum, Interneti-ühendus ja muud nõuded või lisandmoodulid, näiteks välisseadmed. Sellele järgneb installimise samm-sammult juhised, mis võivad pärineda näiteks CD-ROM-ilt, DVD-lt või allalaaditavast failist. Üldiselt selgitatakse installija ebatavalisi funktsioone ja kohandatud installivalikute selgitusi, nagu alternatiivsed asukohad või sujuvamad installid.

„Kiire alustamise” juhend on sageli kasutatava trükitud tarkvara dokumentatsiooni järgmine osa. Kiirjuhend, mis jätkub sealt, kus installijuhend lõpeb, aitab kasutajal tarkvara ja selle põhitoimingutega alustada. Seda jaotist võib vastavalt konkreetsele tarkvarale korraldada mitmel viisil. Üks populaarne meetod ülesandele orienteeritud rakenduste jaoks on projektipõhine sissejuhatus, mille käigus kasutaja õpib tarkvara põhifunktsioone ja samal ajal mõnda minitundi.

Muud elemendid, mida võiks trükitud tarkvaradokumentatsioonist leida, hõlmavad funktsioonide täielikku ülevaadet, rõhuasetusega uusima versiooni uutel funktsioonidel; värskenduste loend alates eelmistest versioonidest, sealhulgas parandatud vead; teave tehnilise toe saamise kohta; veateadete selgitused; ja teave edasijõudnud või “võimsatele” kasutajatele. Mängud ja muud tarkvararakendused võivad sisaldada oma dokumentatsioonis petulehti või vihjeid.

Trükitud tarkvaradokumentatsioon ei ole ainus. Esiteks võib trükitud dokumentatsioon olla kättesaadav ka veebis või pdf-vormingus. Täiendav dokumentatsioon võib olla saadaval ka tööriistanäpunäidete ja rakenduses endas abikuvade kujul, KKK-d – korduma kippuvate küsimuste loendid koos vastustega, otsitavad artiklid, veebikoolitus, videod ja muud vormingud.
Tarkvara dokumentatsiooni kvaliteet on üsna erinev ja see kehtib eriti tarkvara käsiraamatute kohta. Head võivad olla suurepärased, samas kui need, mis pole hästi teostatud, võivad kasutajatel tekitada palju küsimusi. On ka kasutajaid, kes ei viitsi enne tarkvaratootja foorumites küsimuste esitamist dokumentatsioonist otsida.