IRF házi feladat minták

Semester: 
2011. tavasz

A házi feladatok során a megoldást részletesen dokumentálni kell. Itt egy igényes, mérnöki dokumentációt várunk el. Hogy egyértelműbb legyen, hogy mit értünk ez alatt, készült egy rövid útmutató is, azonban a legtöbbször könnyebb példák segítségével bemutatni ilyesmit.

Ezért a 2011-es tavaszi félév házi feladataiból kiválasztottunk néhányat, és a szerzők engedélyével közzétesszük itt őket. Ezek mind nagyon jól sikerült dokumentációk, könnyen áttekinthető, világos szerkezetűek, a megoldás lényegi részeit pontosan bemutatják. Azt érdemes megfigyelni, hogy bár hasonló feladatokat oldottak meg, de a megoldások mind-mind eltérőek. Hasonló elemek találhatóak nyilván mindegyikben (bevezetés, megoldás bemutatása, tesztelés, összefoglalás és értékelés), de a fejezetek pontos elnevezése és csoportosítása, a tartalom jellegzetességei mindig a szerző saját stílusának megfelelően alakulnak. Tehát a későbbiek során nem azt érdemes tenni, hogy ezeket egy az egyben gondolkodás nélkül másoljuk, hanem megpróbáljuk felfedezni a jellegzetességeiket, hogy mi teszi ezeket jó, igényes dokumentációkká, és ez alapján alakítjuk a saját munkánkat.

[Megjegyzés: Természetesen mivel minden dokumentáció értékelése részben szubjektív is (ki hogy szeret fogalmazni, milyen stílust használ, stb.), ezért minden itt közzétett házi feladat esetében is a részleteken el lehetne kezdeni vitatkozni, hogy hogyan lehetne módosítani rajta, de összességében mindegyik dokumentáció nyugodtan használható mintaként, sokat lehet belőlük tanulni.]