A JátékFejlesztésről - 2. rész

A múlt hónapban egy egyszerű - ám a valóságban sokszor előforduló - történettel próbáltam szemléltetni, milyen problémákba ütközhet egy játékfejlesztő csapat, ha nincs, vagy nem megfelelő a Dokumentációja az adott program elkészítéséhez.

 

Miért fontos egy jó Dokumentáció? Mert segítségével sokkal könnyebbé, rugalmasabbá, egyértelműbbé, gyorsabbá válik a fejlesztés. Egy jó Dokumentáció mindenkinek csak a hasznára válhat!

Ahhoz, hogy egy jó; jól működő; a későbbiekben továbbfejleszthető, átlátható, és kész programhoz jussunk, nagyon sok tervezésre van szükségünk. De nézzük, mi is a Dokumentáció legfontosabb szerepe:

átfogónak, és átláthatónak kell lennie, hogy bárki a fejlesztők közül megérthesse azt, és segítségével el tudja készíteni a rá kiszabott feladatot (vagy feladatokat). Fontos, hogy úgy kell megfogalmazni, összeállítani a Dokumentációt, hogy szükség esetén külső, a programról eddig nem is halló ember is viszonylag könnyen megértse azt, és fel tudja használni a későbbiekben (például: ha csapatunkból távozik egy modellező, akkor az új, frissen felvett kollegánk is megértse, mit, hogyan, miért, mikorra stb. kell elkészítenie).

Amennyiben nem magunk találtuk ki a programot (alapötlet, sztori stb.), akkor a Dokumentációnak még több feladatot kell ellátnia. Úgy kell azt megfogalmazni, hogy a nem szakember megbízónk is könnyedén megértse azt, és amennyiben nem felel meg igényének 1-1 részlet, Ő is gond nélkül meg tudja fogalmazni, hol, mit szeretne másképp viszontlátni (ennek ugye feltétele, hogy teljesen megértse azt, amit a Dokumentációban megfogalmaztunk, vagy céloztunk rá, stb.).

A Dokumentáció egyik lényege, hogy a fejlesztésnek ebben a szakaszában programunkból gyakorlatilag még egy sor kód, egy darab grafika sincs kész. Így tehát, mikor elkészül a rendszerterv, és a csapattagok, megbízók, stb. elolvassák azt, könnyedén lehet még változtatni bármely pontján (értsd: ha találunk hibát, akkor csak a Dokumentációban kell javítanunk azt, nem kell programkód, modell stb. módosítással foglalkozni). Képzeljük el, hogy milyen helyzet lehet az, amikor már le van gyártva egy seregnyi modell, és akkor közlik velünk, hogy Ők nem is ilyet szerettek volna, ez így nem lesz jó-! Valamint képzeljük el azt is, amikor egy Dokumentációval nem rendelkező program fejlesztése közepén közli velünk a kiadó, hogy itt, vagy ott át kell alakítani (írni) a programot. Nagy botrányt keltene ki a programozók körében, ha át kéne nézniük több ezer (több tízezer) sor kódot, mert nincs Dokumentáció, ami alapján könnyedén meg lehetne találni egy-egy problémás részt.

Így, a Dokumentációnak fontos szerepe van a későbbi hibajavításoknál, módosításoknál és továbbfejlesztéseknél.

A Dokumentáció elkészítésére az egyik legjobb módszer, ha először összegyűjtjük a legfontosabb dolgokat, azokból összeállítunk egy ”elnagyolt” tervet, majd azt ”továbbfejlesztve” készül el a részletes leírás. Először tehát csak körvonalakban írjuk le a dolgokat, majd azt egyre jobban elkezdjük részleteire bontani, és ezt folytatjuk addig, míg a megfelelő (a fentebb leírtak alapján: bárki számára megérthető) részletességi fokra el nem jutunk. Mikor elkészül a részletes Dokumentáció, akkor még célszerű minél több olyan emberrel elolvastatnunk, akik esetleg tudhatnak segíteni, kijavítani az általuk hibáknak és/vagy hiánynak vélt dolgokat. Azaz, megérheti egy kicsit várni, érleltetni a Doksinkat. Minél több ember véli úgy, hogy jó a Dokumentációnk, annál kisebb arra az esélyünk később valami hatalmas hibával találjuk magunkat szemben.

 

De mit is kell tartalmaznia a Dokumentációnak, hogyan építsük fel azt?

A Dokumentáció egy része a felmerülő részfeladatokból áll, és ott a következőket kell megfogalmaznunk:

a megoldási lehetőségeket fel kell derítenünk, és leírnunk valamennyit

amennyiben mi magunk ki tudjuk választani a helyes ”megoldást”, ki kell azt dolgoznunk a lehető legrészletesebben.

A megoldás(ok) kidolgozása rettentő sok időt vesz igénybe a Dokumentációt íróktól. Miért?

mert sokrétű feladatkört fog át

több embernek kell sikeresen együttműködnie

az alatt a sok idő alatt, míg a megoldáson dolgoznak, többször is felvetődhetnek újabb és újabb ötletek, javaslatok, megoldási lehetőségek stb.

utólag is sokszor kell(het) módosítani / továbbfejleszteni egy-egy megoldást leíró részt

érthetően kell fogalmazni, és jó minőségű munkát kell elvégezniük az íróknak

 

A Dokumentációval szemben támasztott formai követelményekről:

könnyen áttekinthetőnek kell lennie, így célszerű fejezetekre - és alfejezetekre - tagolni azt

első ránézésre is rendezettnek kell lennie, (sokat dobhat a megbízónk szemében, ha egy megnyerő külsejű leírást tart a kezében) valamint jól olvashatónak kell lennie

egy-egy bonyolultabb feladathoz célszerű ábrákat is készítenünk, hogy mások is könnyen megértsék mire gondoltunk, céloztunk az adott résznél

a tartalmi áttekintést segítse tartalomjegyzék!! Tartalomjegyzék nélküli Dokumentációt ki se adjunk kezünkből! (pláne, ha már nagy a terjedelme)

A következő részben részletesen fogunk foglalkozni a Dokumentációnak a tartalmi követelményeiről.

Keleti István - jatekfejlesztes@freemail.hu