Kaj je dokumentacija programske opreme?

Programska oprema se nanaša na rutine in programe, razvite za računalniški sistem, ki omogočajo uporabo za izvajanje nalog ali drugačno interakcijo z računalnikom. Programsko opremo lahko zagotovi proizvajalec kot sistemsko komponento ali pa jo ustvari kot ločene aplikacije proizvajalec ali tretje osebe. Dokumentacija je opis izdelka in načina njegove uporabe. Dokumentacija programske opreme opisuje programske aplikacije in način njihove uporabe.

Tiskana dokumentacija programske opreme, ki jo včasih imenujemo tudi priročniki za programsko opremo, je pogosto sestavljena kot knjiga, z naslovno stranjo, kazalo vsebine, telo in kazalo ter pogosto vsebuje nekaj tipičnih komponent. Prva komponenta, ki jo večina uporabnikov potrebuje, je vodnik za namestitev, po potrebi pa so podana ločena vodnika za različne operacijske sisteme, na katerih deluje programska oprema. V priročniku za namestitev so navedene specifikacije, ki so potrebne za zagon programske opreme, vključno z operacijskim(-i) sistem(i), RAM-om, prostorom na trdem disku, internetno povezavo in vsemi drugimi zahtevami ali dodatki, kot so zunanje naprave. Temu sledijo navodila po korakih za namestitev, ki so lahko na primer s CD-ROM-a, DVD-ja ali prenosa. Na splošno so razložene vse nenavadne funkcije namestitvenega programa in razlaga izbir namestitve po meri, kot so nadomestne lokacije ali poenostavljene namestitve.

Vodnik za “hitri začetek” je pogosto naslednji del uporabljene tiskane dokumentacije programske opreme. Vodnik za hitri zagon uporabniku pomaga pri zagonu programske opreme in njenih osnovnih operacij, kjer se vodnik za namestitev konča. Ta razdelek je lahko razporejen na različne načine, kot ustreza določeni programski opremi. Ena priljubljena metoda za aplikacije, usmerjene v naloge, je predstavitev, ki temelji na projektih, v kateri se uporabnik med dokončanjem nekaterih mini lekcij nauči osnovne funkcionalnosti programske opreme.

Drugi elementi, ki bi jih pričakovali v tiskani dokumentaciji programske opreme, vključujejo popoln pregled funkcij s poudarkom na funkcijah, ki so nove v zadnji različici; seznam posodobitev od prejšnjih različic, morda vključno s popravljenimi napakami; informacije o tem, kako pridobiti tehnično podporo; pojasnila sporočil o napakah; in informacije za napredne ali “močne” uporabnike. Igre in druge programske aplikacije lahko vključujejo goljufije ali namige v svoji dokumentaciji.

Tiskana dokumentacija programske opreme ni edina vrsta. Prvič, tiskana dokumentacija je lahko na voljo tudi na spletu ali kot pdf. Dodatna dokumentacija je lahko na voljo tudi v obliki nasvetov o orodjih in zaslonov pomoči v sami aplikaciji, pogostih vprašanj – seznamov pogosto zastavljenih vprašanj skupaj z odgovori, članki po iskanju, spletnim usposabljanjem, videoposnetki in drugimi oblikami.
Dokumentacija programske opreme se po kakovosti precej razlikuje, kar še posebej velja za priročnike za programsko opremo. Dobri so lahko odlični, tisti, ki niso dobro izvedeni, pa lahko pustijo uporabnike veliko vprašanj. Obstajajo tudi uporabniki, ki se ne bodo trudili brskati po dokumentaciji, preden bodo postavljali vprašanja na forumih proizvajalca programske opreme.