Süsteemi dokumentatsioon

Allikas: Teadmusbaas

Süsteemi dokumentatsioon

Suurte süsteemide korral, millised on arendatud kasutajanõuete põhjal (või vastavalt neile), peaks süsteemi dokumentatsioon sisaldama:

  1. Nõuete dokument ja sellega seotud aluspõhimõtted (olemasolu, vajaduse põhjendus);
  2. Dokument, mis kirjeldab süsteemi ülesehitust (system architecture);
  3. Iga süsteemi programmi kohta selle programmi ülesehituse kirjeldus (architecture);
  4. Iga süsteemi osa kohta tema ülesannete kirjeldus ja liidesed (functionality and interfaces).
  5. Programmikoodi loetelud. Peavad sisaldama kommentaare keerukate koodiosade kohta ja andma aimu kasutatud koodistandardi kohta.
  6. Õigsuspärasuse dokumendid (Validation documents) kirjeldavad, kuidas süsteemi tarkvara õigsust kontrollida vastavalt süsteemi nõuete dokumendis kirjeldatud nõuetele
  7. Süsteemi hooldusjuhend

Tavaliselt sisaldavad süsteemi dokumendid (aga ka kasutajate dokumendid) erinevaid skeeme, milliseid tarkvara arendaja peab oskama lugeda ja luua. IKT valdkonnas kasutatavad skeemid on tavaliselt UML skeemid ja peavad vastama kindlatele reeglitele

Tagasi dokumentatsiooni lehele