Uvod definira priručnik . Objasnite tko bi trebao pročitati dokument , a tko nije namijenjena , koje podatke je uključena iu kojim okolnostima je to korisno . Za uporabu proizvoda , pretpostavljamočitatelj je kupio proizvod i da je spremna učiti kako ga koristiti . Držite uvođenje kratko tako da korisnik dobiva na tehničkim aspektima priručniku što je brže moguće .
Iznio
Tehnički priručnici često su izložena u kategorije i potkategorije , koji također čine idealan obris . Popis svih planiranih sekcije za uporabu i uključiti detaljne pododjeljke gdje je to potrebno . Ne bojte se preurediti dijelove kako napredujete . Samo zato što ste mislili na temu A prvo ne značičitatelj treba tu malo informacija na prvom mjestu. Konačni poredak sekcija treba odražavati prirodnu progresijukorisnik će napraviti , a učenje temu . Koristite imenicu i glagol u dijelu tarifni definirati predmet i djelovanje unutar sekcije .
Biti aktivni
Svaki korak u tehničkom priručniku upućuje čitatelj u jednoj akciji koja , kada se izvodi s drugim koracima , dovodi do potpunog djelovanja . Broj koraci ili imaju grafičke " metke " kako bi ukazali korake . U nekim situacijama , koraci mogu biti pod- koraka identificirani brojevima ili slovima pod osnovnih koraka . Pisci imati određenu diskreciju u kako oni identificiraju korake , ali bi trebao biti dosljedan u cijelom priručniku .
Keep It Simple
Koristite najjednostavniji jezik koji adekvatno prenosi informacije . Vi ne znate tko će pročitati priručnik i kako su se dobro upućen u tehničkom žargonu teme . Izbjegavajte visoke razine detalja ili detalja nije potrebno prenijeti informacije . Duge rečenice , više od 20 riječi , potiču čitatelje . Kazne za manje od 10 riječi može predati dokument je cijepanje zvuk .
Ilustriraju temu
Pomoću fotografije, grafikone ili grafikone za ilustraciju temu . Te slike mogu biti vrijedi tisuću riječi i imaju tendenciju privući čitatelja oči . Ako grafički prikazi nisu moguće , koristite opisne rečenice . Verbalni primjeri i ilustracije također omogućitičitatelju predočiti temu .