Obsah a forma projektovej dokumentácie

Inžinierske dielo (softvérový/informačný/počítačový systém)

Dokumentácia k inžinierskemu dielu bude obsahovať minimálne tieto informácie (pri návrhu štruktúry a rozsahu dokumentácie sa riaďte poznámkami ďalej a poraďte sa s vašim pedagógom):

• Analýza, špecifikácia požiadaviek a hrubý návrh (zimný semester)
• Úvod - o čom je tento dokument, ciele, ohraničenia.
• Analýza problému a špecifikácia riešenia
  (pre tvorbu softvérového systému typicky zahŕňa tieto časti: Kontext systému, Analýza realizovateľnosti systému, Špecifikácia funkcií systému (určí sa aj priorita pre jednotlivé funkcie), Špecifikácia údajov v systéme, Špecifikácia správania systému)
• Hrubý návrh riešenia
• Ďalšie požiadavky a ohraničenia
• Prototyp (zimný semester)
• Cieľ prototypovania, dosiahnuté výsledky
• Podľa dohody s pedagógom, odporúča sa používateľská príručka (pre celý systém)
• Produkt a dokumentácia k produktu (letný semester)
• Stanoví sa podľa povahy projektu. Štandardne zahŕňa tieto časti:
• Používateľská príručka
• Systémová príručka (spolu s návodom na inštaláciu)
• Návrh, implementácia a overenie riešenia (letný semester)
• Zapracovanie nedostatkov špecifikácie a hrubého návrhu
• Návrh systému
  (pre tvorbu softvérového systému typicky zahŕňa tieto časti: Architektúra systému, Fyzický model údajov systému, Návrh algoritmov spracovania)
• Ohraničenia, zmeny špecifikácie, priority riešenia
• Výber implementačného jazyka a prostredia
• Opis realizácie (implementácie jednotlivých modulov, napr. zaujímavé veci, optimalizácia, doplnenia oproti návrhu,...)
• Overenie výsledku (určenie spôsobu overenia výsledku, postup, testovacie údaje, ak sa zmenili oproti návrhu)
• Záznam o používaní systému
• Čo sme nestihli
• Čo sme sa naučili

Riadenie projektu

Dokumenty k riadeniu projektu sa vytvárajú priebežne a sú súčasťou odovzdávanej dokumentácie v každej etape. Obsah zodpovedá etape, v ktorej sa projekt nachádza. Celkovo obsahuje minimálne:

• Úvod (čo sa v tejto časti dokumentácie nachádza)
• Ponuka
• Plán projektu (plány sa spresňujú minimálne raz za 4 týždne)
• Úlohy členov tímu (krátkodobé, dlhodobé), táto časť zahŕňa aj autorov jednotlivých častí dokumentácie k inžinierskemu dielu ako aj jednotlivých častí vytvoreného diela
• Záznamy zo stretnutí
• Štandardy kódovania (štábna kultúra)
• Posudky
• Posudok analýzy a hrubého návrhu iného tímu (zhodnotenie každej časti dokumentácie)
• Posudok tejto analýzy a hrubého návrhu vypracovanú iným tímom
• Vyjadrenie sa k posudku
• Posudok prototypu (funkčnosť, použiteľnosť) iného tímu
• Posudok tohto prototypu vypracovaný iným tímom
• Vyjadrenie sa k posudku
• Posudok dokumentácie návrhu, implementácie a produktu iného tímu (zhodnotenie každej časti dokumentácie a produktu)
• Posudok tejto dokumentácie návrhu, implementácie a produktu vypracovaný iným tímom
• Manažment verzií, konfigurácií a zmien (najmä použité procesy)
• Preberacie protokoly

Upozornenie:

• Jednotlivé strany dokumentácie musia byť očíslované. Prílohy sa číslujú samostatne a označujú písmenami abecedy (A-1, A-2,...; B-1, B-2, B-3,...).
• Na začiatku dokumentácie musí byť obsah, ktorý sa pri každej modifikácii (odovzdávaní) dokumentácie aktualizuje, t.j. v odovzdanej dokumentácii musí byť vždy na začiatku podrobný obsah.
• Odporúča sa názvy kapitol uvádzať aj v hlavičke na jednotlivých stranách (zjednodušuje to výrazne orientáciu v texte).
• Odporúča sa oddeliť jednotlivé časti dokumentácie (najmä zimný a letný semester) farebnými papiermi.
• Treba oddeliť jednotlivé časti dokumentácie aj z hľadiska obsahu: dokumentácia súvisiaca s riadením projektu (plány, zápisy zo stretnutí, posudky, preberacie protokoly, dohodnuté postupy a procesy, štandardy a pod.) a dokumentácia k inžinierskemu dielu (hotovému produktu).
• Vždy treba odovzdať úplnú doteraz vytvorenú dokumentáciu - v číslovaní strán sa pokračuje - zviazanú tak, aby sa dalo v nej listovať. Dokumentácia sa odovzdáva v dvoch exemplároch (učiteľovi a tímu, ktorý posudzuje výstupy) a potvrdí sa vždy preberacím protokolom.
• Pri priebežnom odovzdávaní sa forma odovzdávanej dokumentácie (elektronicky/tlač) dohodne s vedúcim tímu.
• Po dohovore s vedúcim tímu sa stanoví rozsah dokumentácie, t. j. maximálny počet strán v častiach špecifikácia a hrubý návrh, návrh prototypu a v dokumentácii k výsledku/produktu.
• Záverečná dokumentácia musí byť zviazaná tak, aby to bola jedna "kniha" (elektronické médium musí byť pripevnené k obalu).