6. A rendszer dokumentálása

iDevice ikon Bevezetés

A rendszer dokumentálása a rendszerfejlesztésnek az a része, mely a legkevésbé népszerű. Különösen igaz ez a dokumentációk újítására, azaz a rendszerkarbantartással egyidejű aktualizálásra. A dokumentáció több szinten és módon készül. Ebben a fejezetben célunk, hogy áttekintsük az egyes dokumentumfajtákat! 

Ezek a dokumentációk szakmai, irányítási célt szolgálnak.

Nagyon fontos, hogy mindig a rendszer aktuális állapotát tükrözzék. Ezért, ha a rendszerben változtatás történik, azt is dokumentálni kell. Tehát a különböző verziójú programokhoz, különböző dokumentációk tartoznak. 

Ebben a fejezetben a következő rendszerszervezés és -tervezés dokumentációkkal ismerkedünk meg:

  • A követelményelemzés dokumentumai
  • Megvalósíthatósági tanulmány, nagyvonalú rendszerterv
  • Részletes rendszerterv
  • Rendszerspecifikáció
  • Logikai és fizikai rendszerterv
  • Programspecifikációk
  • A megvalósítás dokumentumai
  • Szerződés
  • Ütemterv
  • Fejlesztői dokumentáció
  • Tesztelési dokumentáció
  • Az átadás dokumentumai
  • Felhasználói dokumentáció (elektronikus, nyomtatott)
  • Üzembe helyezési kézikönyv
  • Átadás-átvételi jegyzőkönyv