Dokumentáció

Itt két kategóriát különböztetünk meg:
- a felhasználók számára készített kezelési útmutató,
- a nálunk maradó fejlesztési dokumentáció.

Felhasználói dokumentáció
Erre természetesen akkor van szükség, ha a program készítôje és felhasználója nem ugyanaz a személy. (De bárki használja is, fontos az, hogy a program felhasználóbarát legyen: mondja el önmagáról, mi a funkciója, ehhez milyen adatokat kér, milyen bánásmódot igényel. Vélhetôen a program megírása után fél évvvel már magunk sem emlékszünk rá,, hogy például a ? mögé milyen adatot kell beírnunk, és milyen eredményt fogunk kapni.)
A hivatásos programozók által írt programok zömét különféle helyeken változatlan formában használják olyan emberek, akiknek semmi részük nem volt az elkészítésében, sôt nem is számítástechnikai szakemberek. Számukra szakmai zsargon nélküli, világos és gyakorlatias dokumentációt kell készíteni. Ennek a következôket kell tartalmaznia:
- A felhasználási terület és a program tevékenységének leírása.
- A program által igényelt adatok leírása.
- A kiírt eredmények tartalmi és formai leírása.
- A program kezelésének részletes leírása.
- A kiírt üzeneteknek, hibajelzéseknek a magyarázata és a választevékenységek leírása.
- A felhasználási lehetôségek és korlátok ismertetése.

Fejlesztôi dokumentáció
- A legelsô eleme már elkészült, ott a programterv, amelybôl az algoritmus világosan kiderül. Erre a tesztelés során szükségessé vált javításokat rá kell vezetnünk, így két hónap múlva is tudni fogjuk, hogyan mûködik a program! - A program forrásnyelvi listájának is dokumentálnia kell önmagát, azaz fûzzünk megjegyzéseket a program kritikus részeihez, az adatokhoz, stb.
A programok dokumentálásáról megint csak egy konkrét programozási nyelv ismeretében lehet bôvebben beszélni.
Most elegendô annyit megjegyeznünk, hogy a munka végeztével a programtervet, a programlistát és a felhasználói kézikönyvet célszerû elraknunk magunknak. Bármikor szükségünk lehet módosításra, illetve esetenként elemeket, ötleteket tudunk átvenni a már befejezett alkotásunkból.

Vissza