Kötelezően alkalmazandó a Szoftver technológia tárgy feladatának elkészítésénél.
Prezentációk formátuma
A prezentációk az alábbi formátumok valamelyikében készítendők el:
A dokumentumok formátuma
Valamennyi dokumentumot, ami nem tiszta forráskód, szabványos HTML formátumban kell beadni. A dokumentumok csak egyszerű formázott szöveget, táblázatokat és beillesztett képeket tartalmazhatnak. A tartalmat decimális számozású fejezet – alfejezet rendszerbe kell rendezni, és tartalomjegyzéket kell készíteni. A HTML dokumentumokat elkészítésére ajánlott programok:
Szabványos kimenetet generáló html szerkesztő (például az ingyenes Nvu), esetleg az OpenOffice által készített html.
A Microsoft Word által közvetlenül generált HTML formátumot nem fogadjuk el!
A dokumentumok file-neve csak ékezet nélküli betűket, számjegyeket, a kötőjel és az _ (aláhúzás) karaktereket tartalmazhat. (Helyközt sem.) Ha egy dokumentumot több verzióban is el kell készíteni, a névnek a verziószámra is utalnia kell.
A dokumentumok (kivéve a munkanaplót) felépítése az alábbi:
Minden dokumentumnak a letölthető minta szerinti résszel („cimlap”) kell kezdődnie, amelynek formátuma nem változtatható meg.
Ezután egy „history”-t (az elkészülés történetét) kell tartalmaznia, az alábbiak táblázat szerint:
Dátum |
Verzió |
Leírás |
Szerző |
---|---|---|---|
2222. 12. 31. |
0.9 |
Első verzió |
Kis Pál |
2223. 01. 01. |
1.0 |
Itt kell leírni, hogy miben különbözik az előző verziótól |
Nagy Józsi |
Ezután a tartalomjegyzék található, amely ugró link az egyes fejezetekre.
Utána a tényleges tartalom kezdődik.
Segítségül bizonyos dokumentumokhoz letölthető mintát adunk, amelyektől – a feladat jellegétől függően – értelemszerűen el lehet térni. (Természetesen a fenti formai szabályok betartásával.)
Az UML ábrák szerkesztéséhez bármely olyan (jogtiszta) program használható, amelyből az ábrákat át lehet emelni a dokumentumokba. Ajánljuk a StarUML programot, amely a labor gépeire telepítve van, ingyenesen letölthető verziója pedig letölthető innen.
Munkanapló
A következő táblázatot folyamatosan vezetni kell, és az aktuális állapotát le kell adni minden részhatáridőre. A dokumentum fájl neve:
Munkanaplo<datuma>.html
ahol a dátum a beadas dátuma, hat számjeggyel leírva. Például: Munkanaplo060324.html.
Ez a dokumentum is a letölthető minta („címlap”) szerint kell kezdődjön, de nem kell történetet és tartalomjegyzéket tartalmaznia.
Munkanapló:
Kezdet |
Időtartam (óra) |
Resztvevők |
Tevékenység |
Eredmény |
2005-02-21 |
1 |
Kiss Ákos Nem Tom nemecsek ernő |
Megbeszélés a konzulenssel |
Megbeszélés jegyzőkönyve |
2005-02-22 |
0,5 |
Kiss Ákos |
Kockázat elemzés |
Vizió dokumentum 9. pontja |
2005-02-22 |
1,5 |
Nem Tom |
Felhasználók körének felderítése, termék jellemzőinek meghatározása |
Vizió dokumentum 3. 4. pontja |
2005-02-23 |
1 |
Nem Tom nemecsek ernő |
A vizió dokumentum összeillesztése, pontosítása |
Kész Vizió dokumentum |
Magyarázat a munkanapló táblázat kitöltéséhez (nem része a dokumentumnak):
Az első 3 oszlop egyértelmű.
4 . oszlopba kerül a tevékenység leírása saját szavakkal. Például:
szoftver megismerése,
fejlesztési környezet telepítése,
adatbázis létrehozása,
megbeszélés (konzulenssel – ekkor az eredmények között mindig kell szerepelnie a jegyzőkönyvnek - , vagy tagok egymással – ilyenkor lehet jegyzőkönyv, vagy kritériumok, tények)
állapotdiagramok szerkesztése
Használati eset diagramok ellenőrzése
X, Y, Z osztályok szkeletonjának implementálása
Szkeleton tesztelése
5. oszlop eredmény oszlop (itt a tárgyi (dokumentumok), nem tárgyi (kódok, táblák, elvek)):
Jegyzőköny
Vizió dokumentum
Állapot diagram
Néző, látogató, szolgáltató táblák
X,Y,Z osztályok forráskódjai (szkeleton)
Döntés
Értékelési táblázat
Ezt a táblázatot a H5 részhatáridőre a többi anyaggal együtt el kell küldeni, és kivételesen kinyomtatva, valamennyi csoporttag által aláírva is le kell adni.
Név |
Összidőszakra (?100%) [%] |
Kiss Ákos |
10 |
Nem Tom |
45 |
nemecsek ernő |
45 |