TEHNILINE DOKUMENTATSIOON
Tehniline juhend on kasulik ainult siis, kui see vastab tegelikule seadmele ja selle kasutusele. Probleemid tekivad sageli siis, kui seadet on muudetud, kuid dokumentatsioon jääb vana versiooni järgi.
Puudulik dokumentatsioon võib mõjutada nii kasutamist, hooldust, töötajate juhendamist kui ka seadme üleandmist kliendile.
Juhend kirjeldab teist seadmeversiooni
Kui konstruktsiooni, juhtimist või komponente muudetakse, võivad varasemad juhised enam mitte kehtida.
Dokumentatsioon peaks kirjeldama seda versiooni, mis tegelikult kasutusse või kliendile läheb.
Olulised töövõtted jäävad kirjeldamata
Kasutaja vajab infot käivitamise, tavakasutuse, seiskamise, hoolduse ja võimalike ohuolukordade kohta.
Kui kriitilised tegevused on jäetud ainult töötajate kogemuse hooleks, suureneb sõltuvus üksikutest inimestest.
Juhend ja riskihindamine ei lähe kokku
Kui riskihindamises on tuvastatud konkreetne oht, peaks ka kasutus- või tööjuhend andma selle kohta praktilise tegevusjuhise.
Dokumentatsioon on koostatud liiga üldiselt
Üldine juhend võib kirjeldada seadme tüüpi, kuid mitte konkreetse masina tegelikku konfiguratsiooni.
Sellisel juhul tekivad vastuolud jooniste, seadme, riskihindamise ja kasutusjuhendi vahel.
Dokumentatsioon peaks muutuma koos seadmega
Kui masinat või süsteemi oluliselt muudetakse, tasub alati hinnata ka seda, millised dokumentatsiooni osad vajavad uuendamist.
Hea tehniline dokumentatsioon peaks võimaldama kolmandal inimesel aru saada, mis seade see on, kuidas seda kasutatakse ja milliseid ohte tuleb arvestada.