Pripreme za razvoj softvera(6)

Dokumentacija - ogledalo vašeg rada i nakon prezentacije

Uvod

To je pisani sažetak cjelokupnog rada učenika s kojim se učenik natječe. On je jako bitan jer najčešće ovisi o njemu hoćete li proći na državnu razinu ili ne. Zato ćemo malo proći samu izradu dokumentacije i prikazati par loših, ok i odličnih primjera.

Što mora imati dokumentacija?

 

• Uvod - ovdje se opisuje temeljna ideja projekta, kako je stvorena, te par riječi o samim autorima cjelokupnog rada.
• Detaljan opis rada – ovdje se treba pokazati kako funkcionira rješenje i koje su mu osobine, te slikama ilustrirati svaki pojedini funkcionalni dio rada.
• Tehničke informacije – ovdje treba opisati kako je rješenje napravljeno, koje su se tehnologije koristile, te kakva je sistemska konfiguracija sustava potrebna za primjenu ponuđenog rješenja. 

Ovo je temelj. Ukoliko imate sva tri poglavlja sa točno navedenim opisima napravili ste već pola posla.
U nekim drugim natjecanjima koje provodi AZOO traži se da dokumentacija ima isto sadržaj i to ako je moguće na početku, a ne na kraju.
Primjeri nekoliko dokumentacija:

• Dokumentacija_1
• Dokumentacija_2

Gore navedeni primjeri su softverskih rješenja koja su se natjecala na OSR 2011. Pokušat ću doći do dokumentacija od sudionika sa finala Infokupa 2012 tako da dobijete još bolji uvid kako to treba izgledati.

Zaključak

Zašto bi dokumentacija bila ogledalo vašeg rada i nakon prezentacije?
Upravo zato što kada vaša prezentacija završi i povjerenstvo ide odlučiti oni imaju vašu dokumentaciju i ona možete biti presudan faktor u vašem rezultatu, ali puno detaljnije i sa više primjera u sljedećem članku.