Riistvara ja tehniline dokumentatsioon
likult lühike ja pilguga kergesti haaratav. Jutustava teksti asemel tuleks kasutada loetelusid,
eriti kui järjest kirjeldatakse, mida kasutaja peab tegema. Pildid peaksid olema teksti sisse
mähitud, kui nad mahuvad.
Elektroonsed juhendid peaksid olema mistahes kasutajale kättesaadavad, st. esitatud HTML-
või PDF-vormingus.
3.4. Hoolduse dokumenteerimine
Riistvara või tarkvara hoolduse korral on dokumenteerimine üks kindlaid kohustusi. Süstee-
miadministraatoritel on dokumenteerimise kohustus tavaliselt kirjas töölepingus. Põhjus on
50
selles, et kui süsteemiadministraator lahkub töölt, peab ka järgnev töötaja suutma töökohus-
tused sujuvalt üle võtta koos süsteemide kõigi iseärasuste teadmisega.
Arvutifirmade hooldustehnikutel on samuti kohustus kõiki tehtud toiminguid dokumentee-
rida, hooldusprotsessi dokumentatsioon võib koguni olla kliendile nähtavaks tehtud.
annaabi.ee 
