Što je softverska dokumentacija?

Softver se odnosi na rutine i programe razvijene za računalni sustav koji omogućuju korištenje za obavljanje zadataka ili na drugi način interakciju s računalom. Softver bi mogao biti osiguran od strane proizvođača kao komponenta sustava, ili ga može stvoriti kao zasebne aplikacije od strane proizvođača ili trećih strana. Dokumentacija je opis proizvoda i načina korištenja. Dokumentacija o softveru opisuje softverske aplikacije i kako ih koristiti.

Tiskana softverska dokumentacija, koja se ponekad naziva softverskim priručnicima, često je postavljena poput knjige, s naslovnom stranicom, sadržajem, tijelom i indeksom, a često imaju neke tipične komponente. Prva komponenta koja je većini korisnika potrebna je vodič za instalaciju, a odvojeni su vodiči za različite operacijske sustave na kojima softver radi, prema potrebi. Vodič za instalaciju navodi specifikacije koje su potrebne za pokretanje softvera, uključujući operacijski sustav(e), RAM, prostor na tvrdom disku, internetsku vezu i sve druge zahtjeve ili dodatke, kao što su periferne jedinice. Nakon toga slijede upute korak po korak za instalaciju, koje mogu biti na primjer s CD-ROM-a, DVD-a ili preuzimanja. Općenito se objašnjavaju sve neobične značajke instalatera i objašnjenja prilagođenih izbora instalacije, kao što su alternativna mjesta ili pojednostavljene instalacije.

Vodič za “brzi početak” često je sljedeći dio korištene tiskane softverske dokumentacije. Nastavljajući tamo gdje vodič za instalaciju prestaje, vodič za brzi početak pomaže korisniku da započne rad sa softverom i njegovim osnovnim operacijama. Ovaj odjeljak može biti raspoređen na različite načine, kako odgovara određenom softveru. Jedna popularna metoda za aplikacije usmjerene na zadatke je uvod koji se temelji na projektu u kojem korisnik uči osnovnu funkcionalnost softvera dok ispunjava neke mini-lekcije.

Ostali elementi koje bi se očekivalo pronaći u tiskanoj softverskoj dokumentaciji uključuju potpuni pregled značajki, s naglaskom na značajke koje su nove u najnovijoj verziji; popis ažuriranja od prethodnih verzija, moguće uključujući ispravljene greške; informacije o tome kako dobiti tehničku podršku; objašnjenja poruka o greškama; i informacije za napredne ili “napredne” korisnike. Igre i druge softverske aplikacije mogu uključivati ​​cheat sheets ili savjete u svojoj dokumentaciji.

Tiskana softverska dokumentacija nije jedina vrsta. Prije svega, tiskana dokumentacija također može biti dostupna online ili kao pdf. Dodatna dokumentacija također može biti dostupna u obliku savjeta za alate i zaslona pomoći unutar same aplikacije, FAQ – popisa često postavljanih pitanja zajedno s odgovorima, pretraživih članaka, web obuke, videozapisa i drugih formata.
Softverska dokumentacija prilično se razlikuje u kvaliteti, a to se posebno odnosi na softverske priručnike. Oni dobri mogu biti izvrsni, dok oni koji nisu dobro izvedeni mogu korisnicima ostaviti mnoga pitanja. Postoje i korisnici koji se neće truditi pretraživati ​​dokumentaciju prije postavljanja pitanja na forumima proizvođača softvera.