Skip to content

Latest commit

 

History

History
130 lines (101 loc) · 8.51 KB

readme.md

File metadata and controls

130 lines (101 loc) · 8.51 KB
Raw

English version

For english version please click here.

Bevezetés

A jelen leírás csak ajánlásokat, "jó tanácsokat", ötleteket tartalmaz a szakdolgozat (BSc) vagy diplomamunka (MSc) elkészítéséhez. Nem minden, a dokumentumban leírt ajánlás kötelező érvényű.

A szakdolgozat / diplomamunka célja: önálló, mérnöki munka, az egyetem alatt elsajátított tudáson alapszik, azt kiegészíti, alkalmazza, tervezési végrehajtási és tesztelési lépéseken keresztül.

Határidők

A dokumentáció Szakdolgozatkészítés I. és II. valamint a Diplomamunka I. és II. tárgyakból legkésőbb vizsgaidőszak előtt 2 héttel érkezzen meg. Ugyanis jegyet csak a vizsgaidőszak első pár napjában lehet adni, de addigra át kell nézni és javítani kell 5-15 darab ~25 illetve ~60 oldalas munkát.

A szakdolgozat (1A) és diplomamunka (1C) engedélyező adatlapok leadási határideje általában a dolgozat megkezdése előtti félév vizsgaidőszaka előttre esik.

Ezekről mindig pontos tájékoztatás található a tanszéki honlapon.

A dolgozat készítése

Ahogy egy összetett szoftverrendszernél a szakdolgozat/diplomamunka készítésénél is jellemző a következő munkafolyamat: Követelményelemzés, tervezés, megvalósítás (írás), refactor, tesztelés és a teljes munkafolyamat ismétlése, amíg kész nincs.

Nyelvezet

  • Tényszerűség.
  • Műszaki jellegű leírás.
  • Az olvasónak feltételezhetünk egy mérnököt, aki általános ismeretekkel rendelkezik a dolgozatban tárgyalt témáról, de a speciális tématerületet nem ismeri.

Konzulensek

  • Belső konzulens: az egyetem formai követelményeinek betartása
  • Külső konzulens: a technikai és terület specifikus kérdések tisztázása

A konzulenssel történő kapcsolatfelvétel és rendszeres kapcsolattartás a hallgató feladata és felelőssége! Ez általában emailben vagy személyesen történhet, továbbá a kódok megosztására célszerű valamilyen nyilvános repositoryt használni (pl GitHub, GitLab, Bitbucket, Assembla, stb.)

Stilisztikai megkötések

Helyesírás

Hasznos oldalak:

Figyeljünk az informatikában nem egységes rövidítésekre, betűszavakra:

  • JSON, C++, ZigBee, JavaScript, TCP/IP, GitHub, MySQL, MSSQL, Ruby on Rails, NumPy

Képek

Ha a felbontás nem nyomdai minőségű (300 dpi), rajzoljuk újra, akár vektorosan. Ha a dolgozatban magyar nyelven említünk egy fogalmat, a képen is úgy szerepeljen. Képekre célszerű kereszthivatkozással hivatkozni. Így elkerülhető, hogy új kép beszúrása esetén átszámozódjanak a képeink.

Logók

2019-benaz egytem új arcualtot vezetett be (https://eszk.sze.hu/szearculat). Értelemszerűen a diplomamunka / szakdolgozat is az új arculatnak megfelelő kinézet az elvárt. Az új egyetemi logó: Az új tanszéki logó:

Képletek

Használjunk képletszerkesztőt.

Forráskódok

Szintaxis kiemelés és monospaced betűtípus (ajánlott Consolas, kerülendő Courier New mert alig van benne különbség a kerek és a kapcsos zárójel karakterek között), például:

Kódrészleteket, sose képként, hanem szintaxis kiemeléssel másoljunk be. Itt érdemes lehet használni vagy a vs code-ot, vagy a notepad++ nppexport szintaxis kiemelőjét (esetleg valamilyen online módszert, mint a pastebin-t).

Például:

void CoordinateTransition::Init() {}

void CoordinateTransition::LatLonToUTMXY(const double lat, const double lon, double &utm_x, double &utm_y)
{
  MathLanLonToXY(DegToRad(lat), DegToRad(lon), UTMCentralMeridian(lon), utm_x,utm_y);
  utm_x = utm_x * kUTMScaleFactor + kUTMXCompensation;
  utm_y = utm_y * kUTMScaleFactor;
  if (utm_y < 0.0)
  {
    utm_y += kUTMYCompensation;
  }
}

Hivatkozásjegyzék

  • Generáljuk, IEEE formátum.
  • A források túlnyomórészt könyvek / azonosítóval (ISBN, DOI, ISSN) ellátott források legyenek "sima" internetes források helyett.
  • Ajánlott pl. itt forrásokat keresni:
  • Megkülönböztetünk szó szerinti idézést és parafrázis, vagyis egy gondolat átfogalmazását. Az elsőt tegyük idézőjel közé, de mindkettőt hivatkozzuk.
  • A legfontosabb kitétel a munka eredetisége és önállósága. Nem megengedett, sőt, súlyosan szankcionált bármely korábban készült szakdolgozat átvétele, másolása, a hivatkozás nélküli átvételeket tartalmazó szakdolgozat beadása! Mindez a szakdolgozat elutasítását és a záróvizsgára bocsátás megtagadását vonja maga után!
  • A hivatkozások ajánlott száma legalább 20, legfeljebb 50 db. Továbbá erősen ajánlott a túlnyomórészt nyomtatott vagy valamilyen azonosítóval (ISBN, DOI, ISSN) ellátott források használata. Ezek ugyanis könnyebben visszakereshetők, védhetők, mint az internetes források. Az internetes forrásokkal a probléma, hogy kis túlzással naponta változhatnak és nincs garancia arra, hogy később is fellelhető lesz az adott változatuk.
  • Hasznos lehet a régebbi szakdolgozatokat átnézni, pl. ötletet meríteni. Ezeket a következő címeken lehetséges elérni:
  • Egyetemi Könyvtárban, az olvasótermi számítógépeken hozzáférhetők a könyvtár által állományba vett elektronikus szakdolgozatok. Ezeken a számítógépeken kizárólag a SzeRep online dokumentumtárának megtekintésére, és katalógushasználatra van lehetőség. A gyűjteményből elérhetők a Széchenyi István Egyetem diplomaleadó rendszerébe 2015-től feltöltött szakdolgozatok, az elektronikus tananyagok, továbbá a doktori iskolákban készített PhD-disszertációk.
  • A rendszerben tárolt szakdolgozatok kizárólag helyben használhatók.

Példa a hivatkozásokra:

Első félév

  • Szakdolgozatkészítés I., Szakdolgozati konzultáció I. és Diplomatervezés I. NGB_IN092_1, GKLB_INTM096 és NGB_IN093_1
  • A választott témakör körülhatárolása, általános tájékozódás
  • A program specifikálása (pl. UML / SysML diagramok készítése is)
  • A szükséges technikák, technológiák elsajátítása (eddig ismeretlen SDK, API, programozási nyelv megismerése)
  • Szakirodalmi anyagok gyűjtése, feltárása, a vonatkozó szakirodalom körének meghatározása, ez az első féléves dokumentum irodalomjegyzékébe kerüljön
  • A rendelkezésre álló anyagok rendszerezése, feldolgozása
  • Kockázatok elemzése
  • Tesztprogramok írása, deszkamodell készítése (a cél, a technikai kockázatok minimalizálása: célszerű a legnehezebb vagy a legkevésbé ismert részfeladattal kezdeni, hogy ez ne a következő félévre maradjon)
  • Nagyjából 25 oldalas dokumentum, aminek tartalma később felhasználható a szakdolgozatban/diplomamunkában

Második félév

  • Szakdolgozatkészítés II., Szakdolgozati konzultáció II. és Diplomatervezés II. NGB_IN092_2, GKLB_INTM097 és NGB_IN093_2
  • Programírás és tesztelés
  • A dolgozat végső megfogalmazása, elkészítése
  • A leírtak pontosítása, formai megoldások véglegesítése, a tanszéki követelmények maradéktalan betartása
  • A dolgozat elektronikus formában történő rögzítése, nyomtatása, köttetése, leadása
  • A dolgozat terjedelme (melléklet nélkül) 50–70 oldal. (2022-es információ, a hivatalos mindig a tanszéki honlapon)

Linkek