RUAZOSA: Upute za predaju projekta

Projekt se predaje preko sustava Moodle kao jedna datoteka prema sljedeim uputama. Potrebno napraviti arhivu ZIP, RAR ili TAR.GZ.

Organizacija datoteka u arhivi

Preporueni i led strukture datoteka je sljedei: -+---README.TXT <ascii file> +---PROJEKT <direktorij>

+---SOFTWARE <direktorij> +---DOKUMENTI <direktorij> +---OSTALO <direktorij>

Slijedi kratki opis pojedinih dijelova. 1. README.TXT README.TXT <isti text (ASCII) file> ------------------------------------------------------------Projekt iz predmeta RUAZOSA, ak. god. 20xx/yy Naslov projekta: [naslov projekta] Imena i prezimena lanova tima: [Ime1 Prezime1, Ime2, Presime2, ...]

Sadraj CD-a: - kratki opis sto je sve na CD-u i kako je organizirano, po potrebi reference na README datoteke u pojedinim direktorijima ------------------------------------------------------------2. PROJEKT <direktorij, s pod-direktorijima po potrebi> - README.TXT s opisom to je to

sadraj: - PLAN PROJEKTA - popravljeni plan projekta na osnovu komentara s Moodlea, - JAVADOC - generirana dokumentacija JavaDoc i - DOKUMENTACIJA - pratei dokument.

Pratei dokument ne treba biti previe sloen i bo at, ali mora imati cjeline koje slijede ispod. Arhitektura. Opis komponenti od kojih se projekt sastoji. Nacrtajte sliku koja prikazuje povezanost komponenti. Sami odaberite one vrste dijagrama (npr. UML) koji vam se ine naji raajnijim. Dizajn i implementacija. Opis svake komponente i klase to radi i koja je funkcija te kako su dijelovi pove ani. Sami odaberite dija rame koji e prika ivati najvanije interakcije u aplikaciji. Tipini primjeri su: ER dija ram ba e podataka, dija ram klasa i/ili dija ram odnosa i meu komponenti/klasa (a re acija, kompozicija), slijedni dijagram (sequence diagram) a opis tipinih akcija, objektni dija ram sa opis strukture podataka. U opis dija ramima moete staviti i dijelove koda koji su bitni a razumijevanje rada aplikacije. Vano: ako odaberete npr. dijagram hijerarhije klasa, ne treba na jednom dija ramu prika ati apsolutno sve klase, ne o samo one ije odnose elite istaknuti! Takoer, kuica a jednu klasu ne treba sadravati sve mo ue detalje. Istaknuti samo metode/atribute kljune a ra umijevanje. Pokretanje i koritenje. Najvanije je priloiti upute a isprobavanje aplikacije za tipine sluajeve. Treba zapisati detaljnu specifikaciju svih parametara i oekivano ponaanje aplikacije (npr. izgled aplikacije - screenshot). Eksplicitno argumentirati oekivano ponaanje aplikacije, tako da se ocjenjiva moe uvjeriti da je vae oekivanje ispravno. Kritika projekta (projekt i dorada projekta). Iznesite vlastiti ukupni dojam o uinjenom. to je uspjelo, to nije, to je i ostavljeno i plana projekta. Navedi te ideje a poboljanja koje ste eventualno uoili, a niste sti li provesti.

NAPOMENA: a. konane datoteke trebaju biti u formatu word processora koriteno a obradu teksta (npr. MS Word, LaTeX, OpenOffice, Pa es,), predloak se nala i na sljedeoj poveznici: http://www.fer.hr/_download/repository/FER2_Projekt_Tehnicka_Dokumentacija%5 B1%5D.doc, b. konana datoteka u PostScript ili PDF formatu i

c. za slike ili grafove, koji su napravljeni s pomou neko dru o alata (npr. snapshot-i, crtei u Visiu, rafovi i sl.), staviti pod-direktorij s datotekama u originalnom formatu.

3. SOFTWARE <direktorij, s pod-direktorijima po potrebi>

- README.TXT

s opisom to je to

- INSTALL.TXT upute za instalaciju i eventualno postavljanje varijabli okoline ako postoje - ZIP, RAR ili TAR.GZ arhiva softvera: SVE to je napravljeno ili koriteno u radu, osim komercijalno , atieno , ili uobiajeno ili lako dobavljivo softvera a. ako se koriste integrirane programske okoline (npr. Eclipse, Netbeans, ...) staviti arhivirani projekt i upute s verzijom okoline (npr. Eclipse EE 3.5) postupkom dodavanja projekta u okolinu, b. ako se ne koriste integrirane okoline onda treba staviti izvorni kod s uputama a prevoenje koda (skripte - ant, makefile, maven ili neto tree), c. u poseban direktorij staviti i vrne ver ije koje se mo u samo instalirati (be prevoenja).

FAQ: Kako mo u procijeniti treba li ili ne staviti neto u projektnu dokumentaciju?

U dokumentaciji treba biti sve ono to bi vam bilo potrebno da u relativno kratkom vremenu (od oko par sati) instalirate, konfigurirate i pokrenete svoj softver u sluaju i nimne situacije kao to je kvar tvrdo diska raunala na kojem radite (ili npr. kad dobijete novo raunalo za rad ili kada bi va kole a, koji nije radio na projektu, trebao ispoetka instalirati i pokrenuti projekt.

NAPOMENA: Upute svakako prije predaje isprobati na raunalu (npr. virtualni stroj) na kojem nije nita instalirano od ahtijevano softvera jer ete tako najbolje provjeriti da li su upute u redu.

4. OSTALO <direktorij, s pod-direktorijima po potrebi>

- README.TXT - tu ide sve - s opisom to je to, to ne spada pod PROJEKT ili SOFTWARE, npr: - Web sjedita, bookmark (HTML) file