Diplomamunka információk

(Ezek az információk nem a hivatalos GDF álláspontot tükrözik, csak saját kútfőből születtek, Majzik Zsuzsa útmutatásai alapján - Rigó Ernő)

Az időzítésről

Amikor leadja a hallgató a diplomamunka-tervet, még kb 1-2 hónap, mire elfogadják. A diplomamunka leadása után pedig pedig 2 hónap a bírálási átfutási idő. Vagyis államvizsga előtt minimum 2 hónappal le kell adni a kész diplomamunkát. Néhány hallgatót nagyon szorít az idő, ők azonnal menjenek halasztást kérni, ha látják, hogy nem lesznek készen.

A diplomamunka-terv

A diplomamunka-terv formai követelményei megtalálhatók a GDF honlapján.

A mintanyomtatvány három oldalból áll, az első kitöltése kézenfekvő, az első oldalt a konzulensnek, az utolsó oldalt pedig a hallgatónak alá kell írnia.

A terv lényegi része a "középső" oldal. Ennek tartalmi követelményei a következők:

A diplomamunka

A diplomával végzett munka általában két fő feladatból áll. Egy gyakorlati feladat megoldása, irodalomkutatással, tervezéssel, programozással, stb. és egy ezt bevezető, indokló, leíró és elemző dokumentáció elkészítésével. A hallgatók gyakran esnek abba a hibába, hogy a hangsúlyt az elsőre helyezik, elhanyagolva vagy összecsapva a második (valójában fontosabb) feladatot.

Nyilvánvaló, hogy a gyakorlati feladat megoldását nagyon nehéz önmagában értékelni, ezért a dokumentáció, azaz a végleges "diplomamunka" elkészítésekor mindig próbáljunk a leendő bíráló fejével gondolkodni. Ne feltételezzük, hogy mindennek utána fog nyomozni, "tegyük alá a széket". Elsődleges fontosságú, hogy minden eredményünk, észrevételünk, nagyobb problémamegoldásunk helyet kapjon a dokumentációban, vagyis minél jobban, tiszta és logikusan követhető szerkezetben látszódjék az önálló munka.

A diplomamunka dolgozat tartalmi követelményei:
A diplomamunka tartalmi követelményei az Informatikai Intézet szerint itt olvashatók.

A diplomamunka dolgozat formai követelményei: Lásd itt.

A diplomamunka dolgozat elkészítésének javasolt menete

  1. Kezdjük a tartalomjegyzékkel. Fogalmazzuk meg magunk számára, mit szeretnénk elérni és hogyan, majd a megadott tartalmi követelményeket figyelembe véve foglaljuk ezt a tervet egy logikus 2-3 szint mélységben alábontott tartalomjegyzékbe, mely megfelelő arányban dolgozza fel a dolgozat által átfogott témákat. Ez legyen a későbbiekben mindig az útmutatónk.
  2. A tartalomjegyzék által meghatározott szerkezetben minden leendő fejezet helyére írjunk 1-2 mondatnyi tervet magunk számára, melyben leírjuk, az adott helyen milyen dolgokat szeretnénk részletezni, mit nem szabad elfelejtenünk a későbbiekben.
  3. Írjuk meg a bevezető első verzióját, határozzuk meg a célokat, dokumentáljuk terveinket. Ne essünk abba a hibába, hogy már az elején minden út közben előkerülő problémát felvetünk és megválaszolunk. Ez az analitikus rész feladata.
  4. Kezdjük meg a gyakorlati kutatást, készítsük el a leendő rendszer terveit, a szükséges diagramokat és dokumentációt. Elképzelhető, hogy a későbbiek során ezeken módosítanunk kell, ez azonban nem baj, már önmagában is leírható az analitikus részben.
  5. A gyakorlati munka mellett folyamatosan dokumentáljuk a vizsgált vagy számításba vett munkaeszközöket, a környezet kialakításának lépéseit, a szakirodalmi kutatásokat, a tervezési döntéseket indoklásait.
  6. A gyakorlati munka elkészültével végezzük el a rendszer végdokumentációját, adjuk meg a végleges rendszer felhasználói, adminisztrációs és rendszerszemléleti paramétereit, elemezzük az elkészült munkát a dolgozat elején meghatározott problémafelvetés és célkitűzések tükrében, térjünk ki a gyakorlati használhatósági és továbbfejlesztési lehetőségekre.
  7. Készítsük el a dolgozatot záró szintézist, összefoglalást.
  8. Vizsgáljuk át a dolgozat szerkezetét, ellenőrizzük a helyesírást és a formázást, valamint a tartalmi szövegarányokat.

Vegyes iránymutatások - válogatások a konzulensi levelezés tanácsai közül

Előkészületek, a munka eltervezése, tartalom

A dolgozatnak legyen egy "íve", vezesse végig az olvasót a fejezeteken és tartalmi elemeken, minden legyen a "helyén", kapcsolódja és egészítse ki az előtte levőket, valamint készítse elő a következő gondolatokat.

UML-t, illetve ábrákat nem _kell_ semmiről csinálni, csak általában javaslom, mert egyrészt jól mutat, másrészt nagy a térfogata, harmadrészt amit az ábrára rajzolt, azt utána leírhatja szóban is, ami egyrészt könnyíti az Ön munkáját, másrészt szerkezetet is ad a dolgoknak.

Az UML nem tartalmaz nagyon sok és erős kötöttséget annak tekintetében, melyik ábra mit jelöl és hogy kell értelmezni, ezért kényelmesen felhasználható akkor is, ha ebben nincs sok tapasztalata, csak az alapszabályokat kell betartani, az egyezményes értelmezési jelöléseket megfelelően használni.

Az USE-CASE, annak ellenére, hogy az összes tervezési lépés alapjául szolgálhat, magában nem adja meg a navigációs szerkezetet, erre esetleg egy állapotdiagram lehet megfelelő választás.

Semmiképp ne készítsen 5-10 oldalnyi ábránál többet, nehogy képeskönyvvé váljon a diplomamunkája.

Ne essen abba a hibába, hogy nekiáll a teljes számítástechnikát, a Windowst, a PHP-t, stb. leírni, csak azért, mert valamit használ.

Irodalomkutatásra, leíró jellegű részekre szükség van, de a térfogatát arányosan kell tartani és minden esetben célszerű arra törekedni, hogy a leírások jelenlétét valamilyen véleménnyel, kritikával, indoklással alátámassza.

Ne írjon le olyan dolgokat, amiknek bőséges (akár internetes) irodalma van, mint pl. az internet explorer, az a apache, vagy a phpdesigner, csak akkor, ha az, amit ön csinál vele, valamiért rendhagyó, vagy sok munkája van benne. Ilyen esetekben is inkább a saját munka kidomborítása a cél, nem a pontos és teljes referencia megadása, pl. a menüszerkezet és a funkciók kimerítő ismertetése. Ezt inkább majd a saját programjával kapcsolatban kell megtennie.

A felhasznált szoftverek és telepítésük leírása ne legyen a diplomamunka számottevő része, maximum 3-5 oldal terjedelmet javaslok.

A szövegbe beemelt forráskódokat mindenképp magyarázza és kommentezze, mert ezzel teremt számukra létjogosultságot.

Szoftver tervezési módszertanok

Hallgatói kérdés: "Szeretnék bővebb felvilágosítást kérni, hogy miről írjak funkcionális terv,adatmodell terv és szerkezeti terv cím szavak alatt. Honnét tudok hozzá anyagot gyűjteni?"

Válasz: Sajnos ezeknek nincs mindig "bevett" módszertana, minden szerző, minden szervezet másképp áll hozzá a kérdéshez, így nem fogok tudni szakirodalmat illetve bővebb anyagot adni hozzá. Megpróbálom leírni, melyik mit jelent tartalmilag. Nagy szabadsága van abban, hogy mit és hogyan dokumentál. A lényeg a logikai szerkezet és a teljeskörűség.

Funkcionális terv: az alkalmazás tervezett funkcióinak részletesebb leírása, akár konkrétan az use-case ábrából kiindulva, vagy arra hivatkozva. Ez gyakorlatilag a feladatkiírás alábontását, funkciók szerinti részletezését jelenti.

http://en.wikipedia.org/wiki/Use_case_diagram

Adatmodell: erre van szakirodalom, megpróbálkozhat pl. egy E-R modellel, de az SSADM (régebbi) és az UML (újabb) is ad erre eszközöket. Gyakorlatban megint egy ábra rajzolására, majd annak részletesebb leírására illetve a felépítés indoklására kell felkészülnie. Tartalmilag az adatmodell az alkalmazás által használt adatbázis illetve az ehhez kapcsolódó belső adatszerkezetek (már ha vannak bonyolultabbak) kapcsolati, funkcionális és tartalmi leírását jelenti.

http://en.wikipedia.org/wiki/Er_diagram
http://en.wikipedia.org/wiki/SSADM
http://en.wikipedia.org/wiki/Unified_Modeling_Language

Szerkezeti terv: ezt nem (sem) kell túlzásba vinni, gyakorlatilag (ha megint csak ábrát akar rajzolni), egy struktúra diagram és leírása a feladat. Tervezze meg, a program milyen szerkezeti egységekből fog felépülni (függvénykönyvtárak, üzleti logika, megjelenítés, adatbázis felület, stb...) és ezek milyen feladatokat fognak ellátni. Megint csak segíthet az UML.

http://en.wikipedia.org/wiki/Unified_Modeling_Language

Irodalomjegyzék

Az irodalomjegyzék-hivatkozás internetes címek esetén legalább az alábbi adatokat tartalmazza (ebben a sorrendben):
  1. ha ismert, akkor a szerző(k) neve, egyébként "ismeretlen szerző"
  2. a dokumentum címe (vagy a rá mutató link szövege)
  3. a teljes URL cím (konkrét html dokumentum! nem csak egy domain!)
  4. ha ismert, akkor a publikáló szervezet neve, egyébként "ismeretlen forrás"
  5. az ön által megtekintett dokumentum dátuma (a letöltés dátuma, napra pontosan)
Célszerűen érdemes a megadott dokumentumokat a CD mellékletre feltenni, ezen esetben érdemes az irodalomjegyzék hivatkozásban a mellékleten található elérési útvonalat is megadni.

Irodalomjegyzék-hivatkozás könyvek esetén legalább az alábbi adatokat tartalmazza (ebben a sorrendben):

  1. A szerző(k) neve
  2. A könyv címe, alcíme
  3. A kiadó neve
  4. A kiadás dátuma
  5. ISBN
Az irodalomjegyzék szerző szerinti ABC sorrendben kerüljön a dokumentum végére, a mellékletek elé! A dokumentumokra való hivatkozásnál fontos az oldalszám, vagy fejezet feltüntetése is!

Formázás és záró mozzanatok

Mindenképp fontos, hogy a szövegszerkesztő (Word) szolgáltatásait kihasználja a dokumentum szerkesztésekor. A legfontosabb, hogy stílusokat alkalmazzon. Például a "címsor" típusú stílusokból a Word képes automatikusan tartalomjegyzéket előállítani. Erre szükségem is lenne ahhoz, hogy a dokumentumát átlássam.

Amire a dolgozat véglegesítésekor biztos szükség lesz, az egy átfogó helyesírás-ellenőrzés, valamint egy átolvasás nyelvhelyességi és nyelvtani logikai szempontból. Ezt akár csinálhatja valamelyik hozzátartozója is, mert az ember a saját hibáit nehezebben veszi észre.

Kérem, hogy ha úgy érzi, készen van és a szerkesztést (kötési és egyéb margók, betűtípusok, méretek, bekezdések távolsága, sorok rendezése, képek minősége és elhelyezkedése, jegyzékek, stb...) véglegesnek tekinti, küldjön nekem belőle egy oldalhelyes PDF változatot, végső átnézésre. PDF változatot word alól legkényelmesebben "nyomtatni" lehet virtuális nyomtatóval. Ilyet talál pl. itt: http://sourceforge.net/projects/pdfcreator/

A diploma formázása szemre legyen jó, ne technikára. Nem az a fontos, hogy 12 vagy 12.5 a betűméret, hanem hogy tetszetős legyen, kellemes látványt nyújtson, vizuálisan és szerkezetileg is jó legyen a megjelenése.

Ha térfogatot akar növelni, számos kevésbé feltűnő módja van. Törtrészekkel is növelheti a margókat, a sorközöket, betűközöket, betűméreteket, paragrafustávolságokat. Ezzel azonban, akármilyen trükköket vet be, kb. 5%-nál nagyobb oldalszám változást nem fog tudni elérni úgy, hogy ne legyen első ránézésre szembetűnő annak, aki ilyen dolgozatokat olvas.

A forráskódok legyenek proporcionális betűvel (pl. courier new), elkülönítve az előttük és utánuk lévő szövegrészektől, esetleg világosszürke háttéren, vastagabb és kisebb betűvel. Nem jó, ha a forráskódban levő sorok a dokumentumban eltörnek, próbálja őket egy sorban tartani, vagy formázza át, de a forráskód szerkesztési szabályoknak megfelelően.

A táblázatoknál létezik egy ún. "címsor", ami minden oldalon megjelenik, ha a táblázat esetleg nem fér el egy lapon, ezt érdemes használnia, főleg a hosszú táblázatoknál. A kisebb táblázatokat érdemes inkább egyben tartani, úgy áttekinthetőbb.