intro määritteleekäsikirja . Selitä , jotka pitäisi lukeaasiakirjan ja kuka sitä ole tarkoitettu , mitä tietoja on mukana ja missä tilanteissa sitä tarvitaan . Saat tuotteen käyttöohjeissa olettaalukijan on ostanuttuotteen ja on valmis oppimaan , miten sitä käytetään . Pidäjohdanto lyhyt, jotenkäyttäjä pääseetekniset näkökohdatohjeen mahdollisimman nopeasti .
Linjaukset
Tekniset käsikirjat ovat usein aseteltu kohtien ja alakohtien , joka myösihanteellinen ääriviivat . Listaa kaikkisuunnitellut osiotoppaat ja mukana yksityiskohtaiset momentissa tarvittaessa . Älä pelkää järjestääkohdat edetessä . Vain koska olet ajatellut aiheensimmäinen ei tarkoitalukija tarvitsee että vähän tietoa ensin . Lopullinen järjestysosien olisi heijastettavaluonnollinen kehitysaskelkäyttäjä tekee samalla opitaanaiheeseen . Käytäsubstantiivi ja verbiryhmän otsikko määritelläkohde ja toimetosiossa .
Olla aktiivinen
Jokainen askeltekninen käsikirja neuvoo lukija yhdeksi toiminnaksi , että kun suoritetaan muihin toimenpiteisiin , johtaatäydellinen toiminta . Numerovaiheet tai olla graafinen " luoteja " osoittamaanvaiheita . Joissakin tilanteissavaiheet saattavat olla alavaiheet yksilöity numeroilla tai kirjaimilla perusturvaan vaiheet . Kirjailijoiden on tiettyä harkintavaltaa, miten ne tunnistaa kohdat , mutta pitäisi olla johdonmukainen kokoohjeen .
Keep It Simple
Käytäyksinkertaista kieltä kuin että riittävästi välitätietoa . Et tiedä kuka lukeeoppaat ja kuinka hyvin he perehtynyttekninen jargon aiheen . Vältä korkeita yksityiskohtia tai tiedot ole tarpeen välittäätietoa . Pitkät tuomiot , yli 20 sanaa , tyypillisesti saavat lukijoita . Lauseet on alle 10 sanaa voi antaaasiakirjanpaloittelu ääni .
ValaiseAihe
Käytä valokuvia , kaavioita tai kaavioita havainnollistamaanaihetta . Nämä kuvat voivat olla enemmän kuin tuhat sanaa ja taipumus kiinnittäälukijan silmään . Jos graafisia kuvia ei ole mahdollista , käytä kuvailevia lauseita . Sanallinen ja havainnollisten esimerkkien myös avulla lukija hahmottaaaiheeseen .