Mikä on ohjelmistodokumentointi?

Ohjelmisto viittaa tietokonejärjestelmään kehitettyihin rutiineihin ja ohjelmiin, jotka mahdollistavat käytön tehtävien suorittamiseen tai muutoin vuorovaikutukseen tietokoneen kanssa. Valmistaja voi toimittaa ohjelmiston järjestelmän osana tai valmistaja tai kolmas osapuoli voi luoda sen erillisinä sovelluksina. Dokumentaatio on kuvaus tuotteesta ja sen käytöstä. Ohjelmistodokumentaatiossa kuvataan ohjelmistosovelluksia ja niiden käyttöä.

Painetut ohjelmistoasiakirjat, joita joskus kutsutaan ohjelmistokäsikirjoiksi, on usein järjestetty kirjan tapaan, ja niissä on otsikkosivu, sisällysluettelo, runko ja hakemisto, ja niissä on usein joitain tyypillisiä osia. Ensimmäinen komponentti, jota useimmat käyttäjät tarvitsevat, on asennusopas, ja erilliset oppaat annetaan tarvittaessa eri käyttöjärjestelmille, joilla ohjelmisto toimii. Asennusoppaassa luetellaan ohjelmiston suorittamiseen tarvittavat tiedot, mukaan lukien tietokoneen käyttöjärjestelmät, RAM-muisti, kiintolevytila, Internet-yhteys ja muut vaatimukset tai lisäosat, kuten oheislaitteet. Tätä seuraa vaiheittaiset asennusohjeet, jotka voivat olla esimerkiksi CD-ROM-levyltä, DVD-levyltä tai ladattavalta tiedostolta. Asentajan epätavalliset ominaisuudet ja mukautettujen asennusvaihtoehtojen selitykset, kuten vaihtoehtoiset sijainnit tai virtaviivaiset asennukset, selitetään yleensä.

”Pika -aloitusopas” on usein seuraava osa käytettyä ohjelmistoasiakirjaa. Pika -aloitusopas auttaa käyttäjää aloittamaan ohjelmiston ja sen perustoiminnot, kun asennusopas loppuu. Tämä osa voidaan järjestää monella eri tavalla tietyn ohjelmiston mukaan. Yksi suosittu tapa tehtäväkeskeisiin sovelluksiin on projektipohjainen johdanto, jossa käyttäjä oppii ohjelmiston perustoiminnot samalla kun hän suorittaa minitunteja.

Muita elementtejä, joita voidaan odottaa löytyvän painetuista ohjelmistoasiakirjoista, ovat ominaisuuksien täydellinen ajaminen, painottaen uusimpaan versioon uusia ominaisuuksia; luettelo päivityksistä edellisten versioiden jälkeen, mukaan lukien mahdollisesti korjatut virheet; tiedot teknisen tuen saamisesta; virheilmoitusten selitykset; ja tietoja edistyneille tai “tehokkaille” käyttäjille. Pelit ja muut ohjelmistosovellukset voivat sisältää huijausarkkeja tai vihjeitä asiakirjoissaan.

Painettu ohjelmistoasiakirja ei ole ainoa laji. Ensinnäkin painettu dokumentaatio voi olla saatavilla myös verkossa tai pdf -muodossa. Lisäasiakirjoja voi olla saatavana myös työkaluvihjeinä ja itse sovelluksen ohjenäytöinä, usein kysytyistä kysymyksistä – usein kysyttyjen kysymysten luetteloista sekä vastauksista, haettavissa olevista artikkeleista, verkkokoulutuksesta, videoista ja muista muodoista.
Ohjelmistoasiakirjojen laatu vaihtelee melko paljon, ja tämä pätee erityisesti ohjelmisto -oppaisiin. Hyvät voivat olla erinomaisia, kun taas ne, jotka eivät ole hyvin toteutettuja, voivat jättää käyttäjille monia kysymyksiä. On myös käyttäjiä, jotka eivät vaivaudu etsimään asiakirjoja ennen kuin he esittävät kysymyksiä ohjelmiston valmistajan foorumeilla.