Formai Követelmények

A jogszabályok nem határozzák meg egyértelműen a dokumentáció formai és tartalmi követelményeit. Mindig a képző intézmény szava dönt! Az alábbiak csak tájékoztató jellegűek.

Fejezetek, alfejezetek alkalmazása

• A dokumentációt tagolni kell Címsor1, Címsor2, … stílusokkal!
• A tartalomjegyzéket ezek alapján kell generálni!
• Ábrajegyzéket szintén a stílusok alapján kell generálni!

Karakter formátum

• Az alap betűméret: 12-es. Ettől csak speciális helyeken térj el (pl. címek, lábjegyzet).
• Olvasható, nem túl speciális betűtípus, pl. Times New Roman vagy hasonló egyszerű betűtípus.
• Vastag és dőlt betűt alkalmazhatsz, de csak mértékkel, a fontos részek kiemelésére.
• Kerüld a túl sok kiemelést, mert zavaró lehet!

Bekezdés formátum

• A bekezdések igazítása lehetőleg sorkizárt legyen.
• A bekezdések első sorának legyen kb. 1 cm-es behúzása.
• 1,5-es sorközt alkalmazz.
• Kódrészletekhez javasolt a Courier New vagy más, fix szélességű betűtípus.
• A kód legyen szövegként beillesztve, ne képként!

Oldal formátum

• Az oldalak legyenek számozva, az oldalszám a láblécben középen jelenjen meg.
• Az 1. oldalszám a Bevezetés fejezettel induljon.
• A dokumentációban csak az egyik oldalára kerüljön szöveg.
• A páros/páratlan oldalak elrendezése legyen azonos.
• Legyen fejléc, amely az aktuális fejezet vagy alfejezet címe.
• Használd az alapértelmezett margókat, de nyomtatáskor célszerű lehet kötésmargót is beállítani.

Helyesírás-ellenőrzés, elválasztás

• Nagyon komoly hiba a helyesírási hibákkal leadott dokumentáció – mindig kapcsold be az ellenőrzést!
• Automatikus elválasztás használata ajánlott – szebb az oldalkép, nincsenek nagy szóközök.

Terjedelem

A vizsgaremek szöveges részének terjedelme függ a választott témától és a technológiától. Jellemzően képekkel, diagramokkal, táblázatokkal együtt 25–35 oldal (~30.000 karakter).

A tartalom számít, nem a mennyiség!

Beadás

A vizsgaremek beadásaként a kész csomagot a vizsga előtt minimum 14 nappal kell a vizsgabizottsághoz benyújtani GitHub, vagy más hasonló szolgáltatás segítségével megosztva. A megosztott anyagnak tartalmaznia kell az alábbiakat:

• A szoftver forráskódja.
• Natív asztali alkalmazások esetén a program telepítőkészlete.
• Az adatbázis adatbázismodell-diagramja.
• Az adatbázis export fájlja (dump).
• A szoftveralkalmazás dokumentációja.
• A tesztekhez végzett kód, valamint a teszteredmények dokumentációja.

Beadás előtt érdemes ellenőrízni az alábbi weboldalon található lista segítségével a munkádat: Infojegyzet - Önellenőrző lista