Diplomamunkák, szakdolgozatok és Önálló labor dokumentációk formai és tartalmi követelményei Takách Géza NYME FMK Informatikai és Gazdasági Intézet 2008. január 24 Az Önálló labor tárgy keretében beadott dolgozatok arra sarkalltak, hogy röviden áttekintsem a dolgozatok készítésénél követendő szabályokat. Szerencsére nem kell teljes művet írnom, ilyen írások már léteznek. Az FMK honlapjáról letölthető egy tartalmi és formai követelményrendszer [1], mely gyors kiindulópontként szolgálhat a dolgozatok megírásához. A dokumentum által megfogalmazott legalapvetőbb követelmények: papírméret: A4; margók: 2,5 cm, plusz a kötésnek 1 cm; terjedelem: 30-60 oldal (ábrákkal, táblázatokkal, de mellékletek nélkül); Csak a megértéshez elengedhetetlenül szükséges ábra, táblázat, forráskód stb. kerüljön a szövegbe, a többi mellékletbe! fedél, illetve belső címlap formátuma: lásd a dokumentum mellékletét; javasolt betűméret: 12pt; tartalomjegyzék előre, a címlap után; tagolás: o bevezetés: téma jelentősége, témaválasztás indokoltsága, saját vizsgálatok célkitűzései; o irodalmi áttekintés: korábbi vizsgálatok áttekintése, irodalmi hivatkozásokkal (nem másolás, összeollózás, hanem a dolgozat szempontjai szerinti összefoglalás); Informatikai tárgyú dolgozatban ennek megfelelhet a használt nyelv, rendszer, környezet bemutatása. o saját vizsgálatok, saját munka leírása; Ezen rész tagolása lehet pl. a módszerek leírása, majd az eredmények értékelése. Nagyon sok Önálló labor dokumentációból hiányzik ez a rész, vagy nem válik el elég élesen az előzőtől! o következtetések, javaslatok; o összefoglalás; o (köszönetnyilvánítás); o irodalomjegyzék; beadás digitális formátumban: CD. Ugyanakkor felhívom a hallgatóság figyelmét, hogy az [1] dokumentum tartalmaz olyan kitételeket, amelyek kritizálhatóak, illetve olyan megkötéseket, amelyek alól az Informatikai és Gazdasági Intézet felmenti az informatikus hallgatókat: 1
A dolgozatot A/4-es méretű, legalább 70 g/m2 négyzetméter tömegű, famentes papírra, lehetőleg Microsoft Word szövegszerkesztővel, másfeles sortávolsággal, sorkizárással kell leírni. [1] A dolgozatot tetszőleges szövegszerkesztővel el lehet készíteni. Praktikus azonban a CD-mellékleten való csatoláshoz egy mindenki által egyszerűen olvasható fájlformátumot választani, amely e tájékoztató írásakor szinte kötelező módon a PDF-formátum. A legtöbb szövegszerkesztőhöz vagy tartozik PDF-export funkció, vagy használhatunk egy olyan nyomtató drivert, amely fizikai nyomtatás helyett PDF-fájlt generál a dokumentumból. A dolgozat elkészítésénél nem kell ragaszkodnunk a másfeles sorközhöz. Egy hosszabb lélegzetű mű esetén ez pazarló, és nem is feltétlenül esztétikus. Válasszuk nyugodtan a szimpla sorközt, esetleg minimális sorritkítást, pl. 1,15-öset. A nyomdászati szakirodalom pl.??? [7] általában 10 20%-os sorritkítást javasol. A betűritkítást azonban kerüljük el, mert nagyon megnehezíti az olvasást. Ragaszkodjunk a sorkizárt szedéshez és ennek megfelelően az elválasztáshoz is! Egy diagram sorszáma és címe az ábra alatt: 14. ábra Gőzölt akác fűrészáru száradási sebessége a fűrészáru vastagságának és a szárító levegő hőmérséklet változásának függvényében; Táblázat sorszáma és címe a táblázat fölött: 8. táblázat Különböző típusú rönkvágó szalagfűrészgépek fontosabb műszaki adatai) [1] Az ábra, táblázat szó után is pont szerepel, pl. 14. ábra. Gőzölt akác fűrészáru, kivéve ha az ábra sorszámát és címét külön sorba írjuk. Tartózkodjunk a floppy-melléklettől, mellékeljünk CD-t, vagy ha a méret indokolja, DVD-t. A CDmelléklet tartalmazza a dolgozatot mindenki által olvasható formában (javasolt a PDF), esetleg az eredeti formátumban (MS Word, OpenOffice, LaTeX stb.). Ugyancsak tartalmazza az elkészített program, rendszer forráskódjait, telepítéséhez szükséges fájlokat (pl. SQL-szkripteket, tesztadatokat), esetleg telepítőkészletet, mérési adatokat, ábrákat, táblázatokat. A CD-t tegyük papírtokba és ragaszszuk a dolgozat hátsó fedelének belső oldalára. A lemezen fel kell tüntetni a hallgató nevét és a dolgozat (rövid) címét. Elegáns megoldás, ha a CD-re ragasztható nyomtatott matricát készítünk, de megfelel az alkoholos filctoll és a kézírás is. Az irodalomjegyzék és az irodalmi hivatkozások formátumára vonatkozóan számos standard létezik, egy lehetséges megoldást közöl [1], de sokkal inkább javasoljuk a jelen összefoglalóban is alkalmazott, [2] által részletezett formátum. Fontos, hogy az irodalomjegyzék minden elemére legyen hivatkozás a dokumentum szövegében, akár csak annyi, mint például Az XML nyelv alapjairól bővebben ld. XY [n] könyvét.. A dolgozathoz csatolni kell az NYME által egységesített nyilatkozatot [3], amelyben a dolgozat készítője nyilatkozik a munka önálló voltáról. Ugyancsak csatolni kell az eredeti feladatkiírást. A helyes sorrend: üres lap, címoldal, feladatkiírás, nyilatkozat, tartalomjegyzék. Az oldalszámozás szerint a feladatkiírás kapná az 1. számot, de oldalszám először a tartalomjegyzéknél jelenik meg: normál esetben ez lesz a 3. oldal. 2
Az FMK által közzétett tájékoztató gépelésével, szerkesztésével kapcsolatban számos kritika fogalmazható meg 1, amely különösen zavaró egy olyan dokumentumban, amely a diplomamunkák formai követelményeit is tartalmazza: Ne használjunk vízszintes térköz előállítására szóközt, függőleges térköz előállítására sortöréseket! Különösen rossz szokás az oldaltörés eléréséhez használt sorozatos sortörés. Használjunk egységes elnevezéseket, jelöléseket, rövidítéseket, tipográfiát. A magyar helyesírás szabályai és az informatikai tudomány hagyományai általában egyértelműsítik az írásmódot! Amennyiben vitatott az írásmód, válasszunk megfontoltan, de akkor is legyen egységes a dokumentum. A magyar helyesírás szabályai értelmezésem szerint az NYME írásmódot írják elő (lásd [4]), de az új alapító okiratba az NymE rövidítés került. Ne használjunk túl sok féle kiemelési formát ugyanabban a dokumentumban (dőlt, félkövér, dőlt félkövér, aláhúzott stb.)! Rengeteg tipográfiai szabály közül kiemelném a kötőjel és a gondolatjel közti különbséget, bővebben lásd [2], 13. oldal. Mivel [1] megírásakor nem fogalmaztak meg külön informatikai témájú dolgozatokra vonatkozó elveket, ezeket a következőképpen foglalom össze: Informatikai témájú diplomamunkával illetve szakdolgozattal szemben alapvető elvárás, hogy készítője??? (Műszaki témájú diplomamunkával szemben alapvető elvárás, hogy készítőjének vizsgálataira épített következtetéseket, eredményeket tartalmazzon.) Teljes forráskódokat a dolgozat mellékletében kell elhelyezni, a dolgozatban csak a különösen lényeges, és a dolgozat szövegében elemzett kódrészletek kerüljenek. A dolgozat készítője a témavezetővel egyeztesse, hogy mely kódok kerüljenek nyomtatott mellékletbe is, és melyek csak a CD-mellékletre. Remélhetőleg senki sem kezd hozzá manapság állandó szélességű betűtípussal (pl. Courier New CE) megírni egy dolgozatot. Ugyanakkor az állandó szélességű betűtípusok alkalmasok a kódrészletek akár blokk szintű, akár sorközi kiemeléséhez. A dokumentumban egységesen emeljük ki a forráskódokat és a kód egyes elemeit, beleértve a folyószövegben használt változóneveket, függvényneveket, fájlneveket stb. Az ábrákhoz hasonlóan a hosszabb programkódok esetében is alkalmazható a kódrészlet alá helyezett cím, például 1. kódrészlet. Ilyenkor a szövegben hivatkozunk a kódrészletekre. Amennyiben csak egy kifejezésnyi kóddal van dolgunk, alkalmazhatjuk azt a megoldást is, hogy a kifejezés a sorközi vagy kiemelt matematikai képletekhez hasonlóan egy mondatba ágyazva szerepel, lásd a 3.5. szakaszt Jeney [2] munkájában. Az irodalomjegyzékben gyakran szerepelnek URL-ek. Ilyen esetben lehetőleg szerepeljen az oldal címe is, amely a böngészőablak fejlécében és/vagy a dokumentumban szerepel. Szerepeltessük a teljes URL-t, azaz a protokollt, a dokumentum elérési útját is, valamint a megtekintés időpontját! Térjünk ki a felhasznált eszközök, szoftverek licencelésére, megkülönböztetve az esetleges oktatási, kutatási, non-profit illetve az üzleti környezetben való felhasználhatóságra. 1 Remélem, hogy a jelen dokumentummal kapcsolatban kevesebb. 3
Felhívom a hallgatóság figyelmét Jeney [2] összefoglalójára, amelyben részletesen elemzi az igényes dokumentumok elkészítéséhez vezető utat. Sok példával segíti az olvasó munkáját. Ugyancsak érdemes tanulmányozni a [6] vázlatot, amely lényegre törően foglalja össze a diplomamunka szerkezetét, az egyes részek szerepét, de további hasznos információkat is tartalmaz. Sokat tanulhatunk a humán tudományok művelői által készített tanulmányokból is, mint Sz. Varga [5], de ezek számunkra bizonyos területeken túl részletesek, más területeken pedig kevés információt közölnek. Jellemző, hogy az irodalmi hivatkozások tekintetében más rendszerben dolgoznak. Végül a teljesség igénye nélkül néhány további tanács: Legyen egységes a dokumentumod! Készítsd, nyomtasd ugyanabban a rendszerben a teljes dokumentumot! Definiálj stílusokat, és kerüld a helyi formázásokat! Óvatosan járj el egy-egy oldal színes nyomtatásától, mert az ábrák ugyan szépek lesznek, de az oldal szövege elüthet a többi oldalétól! Használj helyesírás-ellenőrzőt, de ne bízz benne vakon! Olvastasd át minél többször a dolgozatot a témavezetőddel, az évfolyamtársaiddal, bárkivel, aki hajlandó átolvasni és korrektúrázni. Készíts biztonsági másolatot, ments sűrűn! Nyomtatás előtt járj utána, hogy mekkora szélességet vesz el az oldalból a kötés, fűzés, spirálozás, és igyekezz ennyivel nagyobb belső margót beállítani. (Ugyan diplomamunka esetében nem alkalmazunk kétoldalas nyomtatást, de ha a későbbiekben kétoldalasan nyomtatott dokumentumot készítesz, akkor ennek megfelelően állítsd a margókat!) Ha úgy érzed, készen vagy, olvasd át sokszor a dolgozatot, egyszerre mindig csak egy-két szempontra figyelve! (Pl. Minden pont, vessző, zárójel stb. előtt/után rendben vannak-e a térközök? vagy Minden kódrészletet kiemeltem-e másbetűtípussal? ) Legyen tartalomjegyzék, oldalszámozás! A tartalomjegyzékben ne szerepeljen a tartalomjegyzék! Használhatsz fejlécet és/vagy láblécet, de a fejezetek kezdő oldalán mellőzd a fejlécet! Egy 30-60 oldalas dokumentum esetén már érdemes a fejezeteket új oldalon kezdeni. Lexikai egység (fejezet) mindig folyó szöveggel kezdődik, sosem alegységgel (alfejezet), felsorolással, ábrával, táblázattal vagy forráskóddal. Ha nincs jobb ötleted, akkor írj egy sablon mondatot: Ebben a fejezetben áttekintjük a Az ábrák, táblázatok nem kettőspont után, vagy mondatba foglalva szerepelnek, hanem külön egységként, a szövegben pedig hivatkozunk rájuk. Összefoglalók A szakdolgozatok és diplomamunkák elejére be kell csatolni egy magyar nyelvű és egy angol nyelvű, maximum 1-1 oldalas Kivonat-ot (angolul Abstract). A kivonatok helye a tartalomjegyzék előtt van így a sorrend: üres lap, címoldal, feladatkiírás, nyilatkozat, kivonat, abstract, tartalomjegyzék. 4
Ugyancsak elkészítendő egy 3-4 oldalas tézisszerű összefoglaló, amelyet nem kell bekötni a dolgozatba, hanem azzal együtt kell beadni. Az összefoglalót egy A5-ös méretű füzet formájában nyomtassuk vagy fénymásoljuk, azaz egy fekvő A4-es kettéhajtott papírra. Hivatkozások [1] Diplomamunkák/szakdolgozatok készítésének tartalmi és formai követelményei, NYME FMK, Sopron, 2002. http://fmk.nyme.hu/fileadmin/dokumentumok/fmk/dekan/diplomaterv_k_vetelm_nyek.doc [2] Jeney Gábor, Hogyan néz ki egy igényes dokumentum?, BME, 2007. május 9. http://mcl.hu/~jeneyg/kinezet.pdf [3] Nyilatkozat dolgozatokhoz, NYME, 2007. http://fmk.nyme.hu/fileadmin/dokumentumok/fmk/dekan/nyilatkozat_dolgozatokhoz.doc [4] A magyar helyesírás szabályai/a rövidítések és a mozaikszók http://hu.wikisource.org/wiki/mhsz: A rövidítések és a mozaikszók, 2008. január 24., 16:55 [5] Sz. Varga Lajos, Szakdolgozati kalauz, PTE PMMK, Pécs, 2004. http://ped.pmmk.pte.hu/index.php?cbsmodul=letolt&id=1301, 2008. január 25., 12:28 [6] Diplomatervezés formai követelményei, BME VIK ITT. http://itm.bme.hu/desktopdefault.aspx?tabindex=2&tabid=77, 2008. január 25., 12:34 [7] Mohai István, Tipográfiai alapismeretek (Kiadványszerkesztés), PE, Székesfehérvár,2006. http://oktav-prepress-06.freeblog.hu/files/tipogáfia.pdf, 2008. január 26., 08:05 5