Savjeti o Pisanje Upute za uporabu

Izbjegavanje zbunjujuće žargon i usredotočio se na jasan , precizan opis tehnologije koju opisuje omogućuje stvaranje jednostavno i intuitivno korisničko priručnik bez obzira na temu prirode . Prije pisanja priručnika , pažljivo pripremiti sadržaj , planirati kako ćete ga razviti u nastavni proze i suditi razinu detalja potrebnih . Uvijek pazite da ne bičitatelj osjeća zatrpani složenim , overworked opisa . Prvi dojmovi

ružna , teška , jarkih boja priručnik s puno ilustracija , šale i nepotrebnih detalja će staviti većinu čitatelja off čak i otvaranje na potrebnu stranici . Kao takav ,cover , veličina i dizajn priručnika , a prvih nekoliko stranica igrati važnu ulogu . Napravite jednostavan , informativan poklopac i uvod i zadržati opće čitatelja na umu u svakom trenutku . Učinkovita priručnik će imati dobro napisan , jednostavan za korištenje sadržajnu stranicu s točnim popisom relevantnih naslova poglavlja , brojeve stranica i potkategorije za brzo i jednostavno pretraživanje .

Detalji i dizajn

Hard - copy korisničkih priručnika s jednostavnim , prostran, crno- bijeli izgleda sunajlakši za čitanje i probaviti . Priručnik treba sadržavati dovoljno informacija kako bi se omogućiločitatelju da ispunite sve potrebne poslove vezane uz proizvod ili zadatka u pitanje (primjerice , upute za rad i popravak mikrovalna pećnica ) , ali to ne bi trebalo biti tako velik i tehnički detaljan da ona postaje teška i tako teško za prijevoz po kući . Težiti ispravan ravnotežu između dizajna i sadržaj; nemojte upasti u zamku stvaranja lijepo dizajniran priručnik s loše koncipiran koncepata i lošeg pisanja . Isti princip vrijedi i za bilo dijagrame i slike : Držite ih jednostavno, jasno , dobro pozicioniran na stranici i relevantni . PNG datoteke imaju male , rukovanje veličine datoteka , ali ne zaboravite da provjerite reproducirati sliku za jasnoću i čitljivost .
Know Your Subject

Ne možemo svi imati koristi isto mikrovalna , računalo ili šiljilo . Razviti jasno razumijevanje kako jedan ili dva modela opreme rada , a zatim početi razmišljati o tome kako najbolje možete opisati svaku komponentu . Koristite standardnu ​​terminologiju , i nikada ne čine se imena za različite komponente . Ponašaj se prema potencijalnim čitateljima kao da imaju saznanja o točki na nekoj razini , ali je potrebna dodatna pomoć s detaljima; inače , mogli riskirati da ih otuđuje od strane vrijeđanje njihove inteligencije . Dodajte što više detalja moguće , ali prezentirati ga jednostavno i prijateljski , koristan način .
Boja
kodiranja

Ako mislite da možete dodati u osnovnoj priručniku vas stvorili , nježno boja-kod određene činjenice i povezati ih u cijelom tekstu . ( Nemojte koristiti fluorescentno ružičaste , staviti na svjetlo , jednostavne boje poput pastelnim zelje i blues . ) Ova veza jevrsta " indeksiranje " i koristi ljudi spoznaje i psihologije čitanja . To im omogućuje da razviju bolje razumijevanje funkcioniranja i funkcija komad opreme , a ne dajući im pojednostavljena ili " flat " krajolik misli .

Različitih stilova proze

Razviti i poboljšati učinkovitost vašeg priručniku eksperimentirajući s malo drugačijim stilovima pisanja . Break svaki dio i podskupinu dolje u kratkom opisnom stavka za uvođenje , daje osnovni opis elemenata koji su uključeni , a zatim dodajte korak-po - korak skup uputa nakon štoprvi stavak reći čitatelju točno kako ispunitiodređene popravak ili funkcija . Ova tehnika čuvapriručnik teče i zanimljiva , a prenosim najviše znanja u kratkom vremenskom razdoblju . Čak i kada se pokušava napredne tehnike za stvaranje korisnički priručnik , uvijek ide natrag na osnove : Provjerite pravopis , gramatiku , dosljednost, jezik i oblikovanje redovito

.