Szemeszter projekt (önállólabor, szakdolgozat, diplomaterv)
követelmények a CrySyS Laboratóriumban

Ha a CrySyS laborban szeretnéd csinálni a szemeszter projektedet, akkor válassz egy számodra érdekes projektet az aktuális kínálatból és keresd fel személyesen a projekt megjelölt konzulensét. Ehhez előre egyeztess időpontot a konzulenssel e-mail-ben vagy telefonon. A személyes találkozón a konzulens a kiírásnál részletesebben is be tudja mutatni a feladatot, és te is tehetsz fel kérdéseket, hogy minden világos legyen a feladattal kapcsolatban. Ha a személyes találkozó után a konzulens és te is úgy gondolod, hogy az adott projektet választod, akkor jelentkezz a projektre a tanszéki weboldalon is. Jelentkezésed akkor érvényes, ha visszajelzést kapsz a tanszéki rendszerből, hogy a konzulens elfogadta a jelentkezésedet.

Rendszeres konzultáció

A projekt végrehajtása során rendszeresen konzultálnod kell a közvetlen konzulenseddel, aki lehet a labor valamelyik oktatója vagy doktorandusza, vagy céges feladat esetén a cég alkalmazottja. Ez tipikusan azt jelenti, hogy hetente legalább egy alkalommal találkozol a konzulenssel, beszámolsz arról, hogy hogyan haladtál, és megbeszélitek a következő lépéseket. Esetleg vezethetsz projektnaplót is, mely tartalmazhat rövid bejegyzéseket mindenről amit csinálsz. A konzultációk mellett tanácsos rendszeresen bejárni a laboratóriumba, és ott végezni a feladatok legalább egy részét. Ez lehetőséget ad a labor munkatársaival való megismerkedésre, és az esetlegesen felmerülő problémák gyorsabb megoldására (gyorsabban találsz valakit magad körül aki tudja a választ a kérdéseidre, mint ha kizárólag otthon dolgoznál).

Mérföldkövek

Általános probléma szokott lenni, hogy a hallgatók a szemeszter elején nem fektetnek elég munkát a projektbe, aztán a szemeszter végén a sok ZH és házi beadás miatt végleg elvesztik a kontrollt a projekt felett, és nem tudják elérni a kitűzött célokat. Ezért javasoljuk a következő mérföldköveket a projekt végrehajtása során:

  • 2. hét: A feladat pontosításának befejezése, a projekt céljának világos megfogalmazása
  • 3. hét: Munkaterv készítése, mely a célhoz vezető lépéseket tartalmazza heti bontásban
  • 4. hét: Szükséges munkakörnyezet kialakítása (tesztkörnyezet létrehozása, szükésges szoftverek telepítése, konfigurációja, stb. a feladattól függően) + git repo létrehozása a labor git rendszerében
  • 5. hét: A feladat tervezési részének befejezése
  • 8. hét: Mid-term prezentáció és feedback a labor munkatársaitól
  • 12. hét: A feladat implementációs részének befejezése
  • 13. hét: Tesztelés, eredmények értékelése
  • 14. hét: Dokumentáció (szoftver dokumentáció és projekt riport) befejezése, minden anyag feltöltése a git repo-ba
  • 15. hét: Projekt prezentáció

A fenti program szerinti haladást a konzulens ellenőrzi és a rendszeres konzultációk segítik.

Mid-term prezentáció

A 8. hét környékén egy ún. mid-term prezentációt kell tartanod, melyben beszámolsz a projekt haladásáról, az eddig elvégzett munkáról. A mid-term prezentáció max 5 perces legyen, és az alábbi elemeket tartalmazza:

  • a projekt háttere, motivációja (1 slide)
  • a projekt céljának pontos megfogalmazása (1 slide)
  • az elképzelt megoldás tömör ismertetése (1 slide)
  • a munkaterv bemutatása (1 slide)
  • a projekt aktuális állapotának ismertetése (hol tartasz a munkatervhez képest?) (no slide)
  • az eddigi haladási ütem értékelése (no slide)

A mid-term prezentáció célja, hogy lássuk, hogyan haladsz a feladattal, és még időben tudjunk tanácsokat adni a sikeres befejezéshez. A mid-term prezentációnak nem célja az elvégzett munka részletes ismertetése. Ezt tartsd szem előtt, mikor az előadást tervezed, különben nem férsz bele az 5 percbe!

A prezentációk beosztását a schedule oldalon találjátok!

Projekt riport

A projekt végén le kell adnod egy projekt-riportot, mely két részből áll:

  1. Fő rész (max 10 oldal), mely tartalmazza a következőket:
    • a feladat pontos megfogalmazását
    • a megoldás tömör ismertetését
    • saját eredmények leírását (pl. implementáltam a Yarrow-160 véletlenszám generátort, 2000 sor egyszerű, 150 sor értékes C kód, 2 hét debug-golás)
    • az elsajátitott ismeretek listáját
    • a projekt során felmerült, nem várt nehézségek leírását
    • önértékelést (mi ment a legjobban? min kell javítani?)
  2. Függelék, mely kiegészitő- és segédanyagokat tartalmaz. Pl.:
    • háttérinformáció, mely a feladat és a feladat környezetének megértését jobban elősegíti
    • (kommentezett) forráskód, szimulációs eredmények
    • felhasználói kézikönyv, program dokumentáció
    • egyéb fontosnak ítélt információ

Mikor a riportot készíted, gondolj arra, hogy valaki esetleg folytatni fogja a munkádat. A projekt riportot nem kell kinyomtatni, azt elegendő elektronikus forműában eljuttatni a konzulensnek.

Projekt prezentáció

A projekt végén egy max 12 perces (esetleges demóval egybekötött) előadást kell tartanod a munkádról. Koncentrálj a következőkre:

  • a projekt háttere, motivációja
  • a projekt céljának pontos megfogalmazása
  • a megoldás ismertetése (esetleg demó)
  • a megoldás értékelése
  • saját eredmények hangsúlyozása (természetük, mennyiségük, és minőségük)
  • lehetséges továbbfejlesztési irányok

A prezentációk beosztását a schedule oldalon találjátok!

Archiválás

A projekt teljes anyagának (munkaterv, napló, projekt riport, projekt előadás, (kommentezett) forráskód, dokumentáció, felhasználói segédlet, telepítési útmutató, háttér anyagok (pl. cikkek, linkek), stb.) fel kell kerülnie a labor git rendszerébe, egy előre meghatározott könyvtár-struktúrába, melyről a konzulens ad részletes felvilágosítást. Az aláírást csak akkor kapod meg, ha minden, a projekthez kapcsolódó anyag fent van a repo-ban.

A gitben a következő mappa-struktúrát követjük:

  • A-Resources
  • B-Tools
  • C-Implementations
  • D-Reports
  • E-Memo