Kasutajate dokumentatsioon

Allikas: Teadmusbaas

Kasutajate dokumentatsioon

Süsteemi kasutajad on erinevad ja erineva IKT alase ettevalmistusega, seetõttu peamine kasutatav jaotus on lõppkasutajad ja süsteemi administraatorid:

  • Lõppkasutajad kasutavad tarkvara mõne oma ülesande täitmiseks. Selleks võib olla lennureisi halduse rakendus, kindlustuspoliisi tegemine, raamatu kirjutamine vms. Neid huvitab tarkvara puhul see kui palju ta sellega oma tööd kergendada saab, neid ei huvita üldse selle tarkvara parameetrid või selle haldamine.
  • Süsteemiadministraatorid vastutavad lõppkasutajate tarkvara haldamise eest. Selleks tööks võib olla tegevus operaatorina, kui tegemist on suurarvutisüsteemiga, võrguhaldurina, kui tegemist on arvutivõrgu tööjaamaga või tehnikaguruna, kes lahendab lõppkasutaja tarkvaraprobleeme ja tegutseb lepingu alusel tarkvara tarnija esindajana.
  • Süsteemi funktsionaalne (ülesannete) kirjeldus rõhutab (esitab) süsteemi nõuded ja kirjeldab lühidalt pakutavaid teenuseid. See dokument peaks andma ülevaate süsteemist. Kasutajad peaksid olema võimelised seda dokumenti lugema sellega kaasas oleva sissejuhatava juhendi abil ja otsustama selle põhjal, kas see on see, mida nad vajavad.
  • Süsteemi paigalduse (installeerimise) dokument on mõeldud süsteemi administraatoritele. See peaks olema varustatud üksikasjadega, kuidas paigaldada süsteem konkreetsele tarkvaraplatvormile. See peaks sisaldama süsteemi failide kirjeldusi ja minimaalseid vajalikke riistvara nõudeid. Peavad olema kirjeldatud alalised püsifailid, millised paigalduse käigus peaksid tekkima, süsteem käivitamise kirjeldus ja seadistusest sõltuvad failid, milliseid tuleb muuta, et siduda süsteem konkreetse keskkonnaga. Sekkumiseta tarkvara personaalarvutile paigalduse kasutamise puhul mõeldakse, et mõned tarnijad käsitlevad seda, kui mittevajalikku dokumenti. Tegelikult on see siiski vajalik, et aidata süsteemihalduritel avastada ja parandada paigalduse käigus tekkivaid vigu.
  • Sissejuhatav (tutvustav) juhend peaks esitama süsteemi informatiivse sissejuhatuse
  • Süsteemi viiteline juhend on süsteemi iseärasuste ja nende kasutamise kirjeldus, peab sisaldama kõiki veateateadete kirjeldusi ja nendest taastamise viise.
  • Üldisem süsteemi administraatori giid tuleb luua teatud liiki käsu- ja kontrollsüsteemidele. See peab kirjeldama süsteemidevahelise suhtluse sõnumeid ja nendele reageerimise viise.


Tagasi dokumentatsiooni lehele