Vsebina
Navodila za uporabo so odlična aplikacija na področju tehničnega pisanja. Dober priročnik za uporabo bo uporabniku povedal vse, kar mora storiti, da bo lahko učinkovito in varno sledil dani nalogi.
Navodila
-
Prepoznajte ljudi, ki jim bo naloga dodeljena, in napišite razmišljanje o njihovi ravni razumevanja. Poznavanje vaše ciljne skupine je ključni del tehnike pisanja.
-
Na začetku priročnika napišite povzetek, če bo vseboval več kot nekaj strani. Če je priročnik predolg, vključite kazalo na hrbtni strani.
-
Napišite kratek uvod, ki opisuje nalogo kvalitativno. Dajte uporabniku idejo o nalogi in kakšen bo končni rezultat. To priložnost je treba uporabiti za zagotavljanje pomembnih nasvetov, ki bodo uporabniku pomagali, da delo opravi pravilno in učinkovito.
-
Po potrebi navedite seznam ustrezne opreme in predmetov, ki jih mora uporabnik opraviti. Če je vaš priročnik za montažo izdelka in je priložen izdelku, ki ga želite sestaviti, vključite ločen seznam vseh delov, ki bi morali biti dobavljeni uporabniku.
-
Jasno navedite vsako pomembno tveganje, ki bi lahko povzročilo poškodbe, smrt, materialno škodo in druge nevarnosti. Uporabite ustrezen jezik z zakoni kraja, kjer bo priročnik prodan.
-
Vsako dejanje izjave napišite v ločenem koraku in vnesite vse informacije, ki jih bo uporabnik potreboval za dokončanje tega koraka. Pisanje mora biti dobesedno, naravnost do točke in ne sme biti dvoumno.
-
Če je v vašem priročniku prostor, vključite številke in diagrame vsakič, ko uporabniku očistite težaven korak.
-
Če je potrebno, ustvarite in vključite seznam nasvetov, ki uporabnika vodijo do zaključka naloge.