Alkalmazások fejlesztése A D O K U M E N T Á C I Ó F E L É P Í T É S E

Átírás

1 Alkalmazások fejlesztése A D O K U M E N T Á C I Ó F E L É P Í T É S E

2 Követelmény A beadandó dokumentációját a Keszthelyi Zsolt honlapján található pdf alapján kell elkészíteni /A_dokumentacio_felepitese.pdf A további formai követelményeket a következő diákon bemutatjuk A formai követelmények a szakdolgozat dokumentációjának a formai követelményei

3 Miért fontos egy programhoz dokumentáció Teremtsünk minél jobb kommunikációt a megrendelővel, hogy megértsük, hogy mik az elvárásai Nem szeretnénk fölöslegesen dolgozni azért, mert rosszul értelmeztük az elvárásait Segítsük azoknak a programozóknak a munkáját, akik utánunk fogják fejleszteni, karbantartani a projektet nem szeretnénk 10x annyi időt rászánni a más kódjának a megértésére Biztosítsuk be magunkat egy pontos és precíz dokumentációval, hogy a felelősségünk a ténylegesen elvégzett munkánkkal álljon párhuzamban, ne valaki másnak az elképzeléseivel nem szeretnénk olyan hibákért felelni, ami a mi elképzelésünk szerint nem is hiba

4 Dokumentáció formai követelményei Minimum 15 oldal fedőlap 1 oldal tartalomjegyzék 1 oldal bevezető 1 oldal felhasználói dokumentáció 6 oldal fejlesztői dokumentáció 6 oldal Képek, ábrák lehetnek a dokumentációban, de ez max a negyedét tegye ki a teljes dokumentumnak Oldalszámok legyenek

5 Tartalomjegyzék Generált tartalomjegyzék Tartalomjegyzék nincs oldalszámozva

6 A cím és alcímek 1. Times New Roman 14 félkövér 1.1 Times New Roman 12 félkövér aláhúzott Times New Roman 12 félkövér A címek a sor elején kezdődnek, nincs tab előttük

7 A szöveg Sorkizárt Time New Roman 12 betűméret Tagoljuk a szöveget, egy bekezdés 3-5 mondatból állon Lehetőleg kerüljük az idegen szavakat, ha elkerülhetetlen, akkor viszont mindenhol azt használjuk ( file helyett fájl ) Fájlneveket Courier New 12 betűtípussal Technológiákat dőltbetűvel Osztály és függvényneveket félkövér Courier New 12 betűtípussal Internetcímeket teljesen kiírjuk, Courier New 11 betűtípusal formázzuk, és az irodalomjegyzékben feltüntetjük a hivatkozás dátumát (az internet változik)

8 A szöveg Hivatalos szöveg lévén kerüljük a poénos megjegyzéseket, közvetlenül az olvasóhoz intézett mondatokat, szmájlikat, egyes szám első személyben megírt mondatokat, ne legyen szerintem, szeretném, csináltam, akarok helyette legyen: lett tervezve, került kivitelezésre

9 A szöveg

10 Képek Csak az éppen adott szöveghez kapcsolódó képeket helyezzünk a dokumentumba Minden képhez tartozzon képaláírás és ábra szám Hivatkozzunk a képekre a számukkal

11 Fejezetek tagolása Bevezető Feladat és annak értelmezése Alkalmazott technológiákról Felhasználói dokumentáció Rendszerkövetelmények Telepítés Gui bemutatása Fejlesztési dokumentáció Követelmények és megvalósítás Használati esetek Osztályok leírása Tesztelés Összegzés Irodalomjegyzék

12

13 Tartalom Forrás: mentacio_felepitese.pdf 1. Követelmény feltárás A követelmény feltárás során felmérik és összegyűjtik a megrendelt szoftverrel szemben támasztott felhasználói követelményeket, elemzik az alkalmazási szakterületet. ajánlott fejezet: Bevezető 1.1. Célkitűzés, projektindító dokumentum A projektindító dokumentum egy viszonylag rövid, szöveges leírás, mely a megrendelő legfontosabb elvárásait tartalmazza. ajánlott fejezet: Bevezető

14 Tartalom 1.2. Szakterületi fogalomjegyzék A fejlesztett szoftver által támogatott szakterület fogalmainak gyűjteménye, magyarázata. Szükséges a szoftver fejlesztői-, felhasználói dokumentációjának megértéséhez. A fogalomjegyzék a fejlesztés előrehaladása során folyamatosan bővül. ajánlott fejezet: Bevezető vége 1.3. Használatieset-modell, funkcionális követelmények A programmal szemben támasztott funkcionális- és szakterületi követelményeknek használati esetek felelnek meg. A használatiesetmodell használati eset diagramokat és ezek szöveges leírását tartalmazza. A megrendelő számára is érthető termék, mely segíti a megrendelő és a fejlesztő közti kommunikációt. A használati eseteket a teljes fejlesztési folyamat során figyelembe kell venni. ajánlott fejezet: Fejlesztési dokumentáció eleje

15 Használati eset diagram Szöveges sablon Használati eset neve Leírás Előfeltétel Utófeltétel

16 Tartalom 1.4. Szakterületi követelmények A fejlesztett szoftver által megcélzott alkalmazási terület szabályszerűségei. ajánlott fejezet: Bevezető vége 1.5. Nem funkcionális követelmények Használati esetekkel nem leírható követelmények listája. A futtatáshoz szükséges operációs rendszer: Tetszőleges operációs rendszer, melyhez létezik JRE 6 implementáció A futtatáshoz szükséges hardver: Operációs rendszerek szerint megadva Egyéb követelmények: Intuitív felhasználói felület, könnyű kezelhetőség ajánlott fejezet: Bevezető vége

17 Tartalom 2. Tervezés 2.1. A program architektúrája A program legfontosabb elemeinek és ezek kapcsolatainak meghatározása. A megoldáshoz felhasznált tervezési minták megadása. ajánlott fejezet: Fejlesztési dokumentáció eleje

18 Tartalom 2.2. Osztálymodell Az osztálymodell a program statikus modellje, mely megmutatja a program szerkezeti felépítését. Osztálydiagramokból és osztályleírásokból áll. Ebben a részben kell meghatározni a probléma megoldáshoz szükséges osztályokat, az osztályok feladatait és kapcsolatait. Az osztályokon belül először csak a legfontosabb adatokat és metódusokat kell megadni. Először célszerű szakterületi osztálydiagramot készíteni. Ezen csak olyan osztályok szerepelnek, melyeket a programozói tudással nem rendelkező megrendelő is megért. A szakterületi osztálydiagram segíti a megrendelő és a fejlesztő közti kommunikációt. A szakterületi osztálydiagramon nem szerepelnek a fejlesztőeszköz osztálykönyvtárának osztályai. ajánlott fejezet: Fejlesztési dokumentáció közepe.

19 Tartalom 2.5. Felhasználói-felület modell Képernyőtervek. A felhasználói-felületet modellezhetjük CASE eszközzel. A modell megmutatja, hogy a program milyen ablakokkal rendelkezik, és ezek hogyan kapcsolódnak egymáshoz Részletes programterv A részletes programterv osztálydiagramokból és szöveges osztályleírásokból áll. Bemutatja a programban definiált összes osztályt, az osztályok összes adatát, metódusát. ajánlott fejezet: Fejlesztési dokumentáció közepe

20 Tartalom 3. Implementáció 3.1. Fejlesztőeszközök Milyen fejlesztőeszközöket, technológiákat, munkamódszereket használunk. ajánlott fejezet: Fejlesztési dokumentáció eleje 4. Tesztelés A teszteléshez választhatjuk a feketedoboz módszert. A feketedoboz módszer dinamikus tesztelési eljárás. Adatvezérelt, nem veszi figyelembe a program belső szerkezetét. A teszteseteket a használati esetek lehetséges forgatókönyvei alapján kell összeállítani. ajánlott fejezet: Fejlesztési dokumentáció vége

21 Tartalom 5. Felhasználói dokumentáció 5.1. A futtatáshoz ajánlott hardver-, szoftver konfiguráció 5.2. Telepítés 5.3. A program használata A felhasznált irodalom jegyzéke (nyomtatott és internetes anyagok)

22 UML diagram fejlesztő eszköz Enterprise Architect Kiváló eszköz nagy projektek tervezéséhez, megértéséhez Ami a beadandóhoz kelleni fog, és az Enterprise Architect kiválóan alkalmas rá: class diagram generálása use case diagram készítése activity diagram készítése sequence diagram készítése diagram projektből forráskód generálása

23 Első beadandó A beadandót a témabejelentőben leírtak alapján kell elkészíteni Tartalmaznia kell: Használati eseteket (use case diagram) Felhasználói felület tervek (képernyőterv) Osztálymodell A diagramokat, a használati esetek szöveges leírását és a képernyőterveket egy PDF dokumentumba összeszerkesztve kell ben elküldeni az edu.adam.ujvari@gmail.com címre, a tárgy a következő legyen: ALKFEJL_1_BEAD_NEPTUNKÓD Beadási határidő: :00 (péntek éjfél)

24 Kérdések