Kas yra programinės įrangos dokumentacija?

Programinė įranga reiškia kompiuterinei sistemai sukurtas procedūras ir programas, kurios leidžia atlikti užduotis ar kitaip sąveikauti su kompiuteriu. Programinę įrangą gamintojas gali pateikti kaip sistemos komponentą arba sukurti kaip atskiras programas gamintojas ar trečiosios šalys. Dokumentacija – tai gaminio aprašymas ir kaip jį naudoti. Programinės įrangos dokumentacijoje aprašomos programinės įrangos programos ir kaip jas naudoti.

Spausdinta programinės įrangos dokumentacija, kartais vadinama programinės įrangos žinynais, dažnai yra sudaryta kaip knyga su tituliniu puslapiu, turiniu, turiniu ir rodykle, o juose dažnai yra keletas tipiškų komponentų. Pirmasis komponentas, kurio daugeliui vartotojų reikia, yra diegimo vadovas, o prireikus pateikiami atskiri vadovai, skirti įvairioms operacinėms sistemoms, kuriose veikia programinė įranga. Diegimo vadove pateikiamos specifikacijos, kurių reikia norint paleisti programinę įrangą, įskaitant kompiuterio operacinę (-es) sistemą (-as), RAM, vietą standžiajame diske, interneto ryšį ir visus kitus reikalavimus ar priedus, pvz., periferinius įrenginius. Po to pateikiamos nuoseklios diegimo instrukcijos, kurios gali būti, pavyzdžiui, iš CD-ROM, DVD arba atsisiuntimo. Paprastai paaiškinamos visos neįprastos diegimo programos funkcijos ir pasirinktinių diegimo pasirinkimų paaiškinimai, pvz., alternatyvios vietos arba supaprastintas diegimas.

„Greito pradžios“ vadovas dažnai yra kita naudojamos spausdintos programinės įrangos dokumentacijos dalis. Greitos pradžios vadovas, tęsiamas nuo tos vietos, kur baigiasi diegimo vadovas, padeda vartotojui pradėti naudotis programine įranga ir jos pagrindinėmis operacijomis. Šis skyrius gali būti išdėstytas įvairiais būdais, atsižvelgiant į konkrečią programinę įrangą. Vienas populiarus į užduotis orientuotų programų metodas yra projektu pagrįstas įvadas, kuriame vartotojas mokosi pagrindinių programinės įrangos funkcijų, kai baigia keletą mini pamokų.

Kiti elementai, kuriuos galima tikėtis rasti spausdintinėje programinės įrangos dokumentacijoje, apima visą funkcijų išnaudojimą, pabrėžiant funkcijas, kurios yra naujos naujausioje versijoje; atnaujinimų nuo ankstesnių versijų sąrašas, galbūt įskaitant ištaisytas klaidas; informacija apie tai, kaip gauti techninę pagalbą; klaidų pranešimų paaiškinimai; ir informacija pažengusiems, arba „galingiems“ vartotojams. Žaidimų ir kitos programinės įrangos dokumentacijoje gali būti apgaulingų lapų arba užuominų.

Spausdinta programinės įrangos dokumentacija nėra vienintelė rūšis. Visų pirma, spausdintą dokumentaciją taip pat galima rasti internete arba pdf formatu. Papildoma dokumentacija taip pat gali būti pateikiama kaip įrankių patarimai ir pagalbos ekranai pačioje programoje, DUK – dažniausiai užduodamų klausimų sąrašai kartu su atsakymais, straipsniai, kuriuose galima ieškoti, žiniatinklio mokymai, vaizdo įrašai ir kiti formatai.
Programinės įrangos dokumentacijos kokybė labai skiriasi, ir tai ypač pasakytina apie programinės įrangos vadovus. Geri gali būti puikūs, o tie, kurie nėra gerai atlikti, gali sukelti vartotojams daug klausimų. Taip pat yra vartotojų, kurie nesivargins ieškoti dokumentacijos prieš užduodami klausimus programinės įrangos gamintojų forumuose.