Sisu
Kasutusjuhendid on suurepärane rakendus tehnilise kirjutamise valdkonnas. Hea käsiraamat ütleb kasutajale kõike, mida ta vajab selleks, et antud ülesannet tõhusalt ja ohutult jälgida.
Juhised
-
Tuvastage inimesed, kellele ülesanne on määratud, ja kirjutage mõtlemine nende mõistmise taseme kohta. Teie sihtgrupi tundmine on kirjutamismeetodi võtmetähtsusega osa.
-
Kirjutage käsiraamatu esiküljel kokkuvõte, kui see sisaldab rohkem kui paari lehekülge. Kui käsiraamat on liiga pikk, lisage tagaküljel indeks.
-
Kirjutage lühike sissejuhatus, mis kirjeldab ülesannet kvalitatiivselt. Andke kasutajale ülesande idee ja lõpptulemus. Seda võimalust tuleks kasutada selleks, et anda olulisi nõuandeid, mis aitavad kasutajal tööd õigesti ja tõhusalt teha.
-
Vajadusel esitage nimekiri asjakohastest seadmetest ja üksustest, mida kasutaja peab ülesande täitma. Kui teie kasutusjuhend on mõeldud toote kokkupanemiseks ja komplekteeritava tootega kaasas, lisage eraldi nimekiri kõigist osadest, mis oleks pidanud kasutajale tarnima.
-
Märkige selgelt kõik olulised ohud, mis võivad põhjustada vigastusi, surma, varalist kahju ja muid ohte. Kasutage sobivat keelt selle koha seadustega, kus kasutusjuhendit müüakse.
-
Kirjutage iga avalduse toiming eraldi etapis, andes kogu teabe, mida kasutaja peab selle sammu täitma. Kirjutamine peab olema sõna otseses mõttes otsekohene ja ei saa olla ebaselge.
-
Kui teie käsiraamatus on ruumi, lisage arvud ja diagrammid iga kord, kui kasutajal on raske samm.
-
Vajadusel looge ja lisage nimekiri nõuandest, mis juhendavad kasutajat ülesande täitmiseks.