Sajnos nagyon nem értek a Programozás Dokumentáció készítéséhez. Ezen múlik vagy bukik hogy mi lesz az év végi jegyem. Aki be tudja ide nekem másolni azt nagyon szépen megköszöném!?

Akkor majd jövőre újra próbálkozol. :)

Ha azon a szinten vagy, hogy egy netes csalástól függ a kegyelemkettesed, akkor az azt jelenti, hogy alapvető hiányosságaid vannak. Ha most át is csúszol egy kamukettessel, jövőre az erre épülő anyagokat még ennyire sem fogod érteni. Akkor pedig már jobb, ha ezt az évet ismétled. Így lehetőséged lesz újra elsajátítani az alapokat. Vagy szakot váltani, ha ennyire nem megy a programozás.

"Most nem tudnám áttanulmányozni."

Most nem azért... nem akarok álszent lenni, én sem voltam soha az a kölyök, aki mindent aznap, ahogy feladták a leckét, egyből aprólékosan megtanult, de azért amit te művelsz, az durva túlzás. Az ugye megvan, hogy nem a dolgozat előtti percekben kell rádöbbenni, hogy valamit nem értesz? Ezt tanuljátok szeptember óta. Tényleg nem mondom azt, jogy naponta ürákat tölts ennek a megtanulásával, de azért néha illett volna elő-előveszegetni a jegyzeteidet, és amit nem értesz, abból segítséget kérned.

"Nálunk először a dokumentációt kell megcsinálni. És arra a program."

Egy rendes dokumentáció írása jóval a kódolás előtt kezdődik, egész pontosan a feladat specifikációjával. Ezután következik a feladat megvalósíthatóságának a vizsgálata, illetve egy vázlatos terv arról, hogy milyen eszközökkel és technikákkal, mi módon lehet azt megvalósítani. (Nagyon egyértelmű esetben ezektől el lehet tekinteni.) Aztán illendő a program működését megtervezni. Egyéntől és capattól függ (csapatmunka vagy cég esetén), hogy ezt milyen formában és mennyire alaposan várják el, van, aki a pszeudo-kódra esküszik, van, aki UML-re, van, aki Jackson-ábrára, van, aki folyamatábrára (bár ez inkább a kezdők kedvelt eszköze), de sokszor elég csak vázlatpontokba szedve összefoglalni a program máködését. Viszont annak egyértelműen ki kell derülni, hogy a programot milyen részfeladatokra (függvények, eljárások, objektumok) bontottad szét.

Aztán nem árt, ha van egy kis adminisztratív része is a doksinal, ahol kigyűjtöd a használt eljárások, függvények, változók, konstansok, objektumok típusait, jellegét (pl. változó esetén: kimeneti, bemeneti, munka), feladatát, stb. Ezt már a kódolás közben/után is lehet csinálni, hiszen lesznek olyan változók, amik a használt programozási nyelv sajátosságai miatt kerülnek bele a kódba, és a pszeudo-kód még nem tartalmazza őket.

Ezután következik a program tesztelése, amit szintén dokumentálni kell. Nem mennék bele mélyen a tesztelési módszerekbe, de érdemes az egyes részprogramokat külön-külön is letesztelni, és a körülményekhez mérten elvárható módon megállapítani, hogy a program hogyan viselkedik a várt, illetve nem várt (lehetetlen) beviteli adatok feldolgozásakor. A tesztadatokat, és a program/programrész által adott eredményeket a dokumentációban fel kell tüntetni.

Esetleg még ha olyan jellegű a program, teljesítményteszteket is lehet mellékelni a dokumentációhoz. Továbbá ha hibajavításra került sor, azt is dokumentálni kell. Végül opcionálisan belekerülhet a doksiba, hogy milyen továbbfejlesztési lehetőségei vannak a programnak.

Persze, a dokumentáció tartalma ettől eltérő is lehet, erre nincs szabály, hogy pontosan mit, és hogyan kell tartalmaznia.

Illetve: ez a fejlesztői dokumentáció, a felhasználói dokumentáció pedig a program használati útmutatóját jelenti, kezdve a program telepítésétől.