Preskočite na sadržaj

Pisanje dokumentacije programskog koda i web aplikacija

doc. dr. sc. Vedran Miletić, vmiletic@inf.uniri.hr, vedran.miletic.net

Fakultet informatike i digitalnih tehnologija Sveučilišta u Rijeci, akademska 2021./2022. godina


Dokumentacija softvera

Prema Wikipediji:

  • pisani tekst (opcionalno s ilustracijama) koji prati računalni softver ili je ugrađen u izvorni kod; važan dio softverskog inženjerstva
  • objašnjava ili kako softver radi ili kako ga koristiti, a ljudima u različitim ulogama može značiti različite stvari

    • programski inženjer može koristiti dokumentaciju aplikacijskih programskih sučelja, koja sadrži npr. potpise funkcija ili popis metoda i putanja na koje se mogu uputiti HTTP zahtjevi
    • operativni inženjer može koristiti upute za postavljanje aplikacije, koja sadrži npr. popis očekivanja koja aplikacija ima od okoline i upute za konfiguraciju
    • korisnik može koristiti upute za tipične radnje u aplikaciji

Dokumentacija softvera (nast.)

Prema Wikipediji:

  • vrste dokumentacije uključuju:

    • zahtjevi – izjave koje identificiraju atribute, sposobnosti, karakteristike ili kvalitete sustava; temelj za ono što će biti ili je provedeno
    • arhitektura/dizajn – pregled softvera; uključuje odnose s okolinom i načela konstrukcije koja će se koristiti u dizajnu softverskih komponenti
    • tehnički – dokumentacija koda, algoritama, sučelja i aplikacijskih programskih sučelja (API-ja)
    • krajnji korisnik – priručnici za krajnjeg korisnika, administratore sustava i pomoćno osoblje
    • marketing – kako plasirati proizvod na tržište i analiza potražnje na tržištu

Dokumentiranje programskog koda


Primjeri dokumentacije programskog koda


Popratna dokumentacija (zahtjevi, arhitektura/dizajn, krajnji korisnik, marketing)


Primjeri popratne dokumentacije

Author: Vedran Miletić