Sisse ärikirjutamine, tehniline kirjutamineja muud vormid kompositsioon, juhiseid on kirjalikud või suulised juhised protseduuri või ülesande täitmiseks. Seda nimetatakse ka õpetlik kirjutamine.
Samm-sammult juhistes kasutatakse tavaliselt teise inimese vaatepunkt (sina, sinu oma). Juhised antakse tavaliselt välja aktiivne hääl ja hädavajalik meeleolu: pöörduge oma poole publik otse.
Juhised kirjutatakse sageli nummerdatud kujul nimekiri et kasutajad saaksid toimingute järjestust selgelt ära tunda.
Tõhusad juhised sisaldavad tavaliselt visuaalseid elemente (näiteks pilte, diagramme ja vooskeemid), mis illustreerivad ja selgitavad tekst. Rahvusvahelisele publikule mõeldud juhised võivad tugineda täielikult piltide peal ja tuttav sümbolid. (Neid nimetatakse sõnadeta juhised.)
Vaatlused ja näited
"Head juhised on üheselt mõistetavad, arusaadavad, täielikud, järjekindlad ja tõhusad." (John M. Penrose jt, Ärisuhtlus juhtidele: täiustatud lähenemisviis, 5. toim. Thomson, 2004)
Juhiste kergem külg: Hiljuti surnute käsiraamat
Juno: Okei, kas sa oled juhendit uurinud?
Adam: Noh, proovisime.
Juno: Kummitamise vahepealne peatükk ütleb kõik. Viige nad ise välja. See on sinu maja. Kummitusmaju pole kerge tulema.
Barbara: Noh, me ei saa seda päris hästi.
Juno: Ma kuulsin. Tore oma nägu ära. Ilmselt ei tee see midagi head, kui tõmmata pead inimeste ees maha, kui nad sind ei näe.
Adam: Kas peaksime siis alustama lihtsamalt?
Juno: Alustage lihtsalt, tehke seda, mida teate, kasutage oma andeid, harjutage. Te oleksite pidanud neid tunde õppima esimesest päevast peale. (Sylvia Sidney, Alec Baldwin ja Geena Davis aastal 2006) Beetlejuice, 1988)
Põhifunktsioonid
"Juhised järgivad tavaliselt järjepidevat samm-sammulist mustrit, olenemata sellest, kas kirjeldate, kuidas kohvi teha või kuidas mootorimootorit kokku panna. Siin on juhiste põhifunktsioonid:
- Konkreetne ja täpne pealkiri
- Sissejuhatus taustteabega
- Vajalike osade, tööriistade ja tingimuste loetelu
- Järjestikku tellitud sammud
- Graafika
- Ohutusteave
- Järeldus mis annab märku ülesande täitmisest
Järjestikku järjestatud sammud on juhiste komplekti keskpunkt ja need võtavad tavaliselt suure osa dokumendi ruumist. "
(Richard Johnson-Sheehan, Tehniline suhtlus täna. Pearson, 2005)
Kirjutamisjuhiste kontrollnimekiri
- Kasutage lühikesi lauseid ja lühikesi lõike.
- Järjesta oma punktid loogilises järjekorras.
- Tehke oma avaldused konkreetne.
- Kasuta hädavajalik meeleolu.
- Pange iga lause kõige olulisem element algusesse.
- Öelge igas lauses üks asi.
- Valige oma sõnad hoolikalt, vältides kõnepruuk ja tehnilisi tingimusi, kui saate.
- Andke näide või analoogia, kui arvate, et avaldus võib lugejat segadusse ajada.
- Esitluse loogika osas kontrollige oma valmis mustandit.
- Ärge jätke samme tegemata ega otseteid.
(Kohandatud alates Täpselt kirjutades autor: Jefferson D. Bates. Pingviin, 2000)
Kasulikke näpunäiteid
"Juhised võivad olla kas eraldiseisvad dokumendid või mõne muu dokumendi osad. Mõlemal juhul on kõige levinum viga muuta need publiku jaoks liiga keeruliseks. Kaaluge hoolikalt oma lugejate tehnilist taset. Kasutage valge ruum, graafikat ja muid kujunduselemente, mis muudavad juhised ahvatlevaks. Kõige tähtsam on kindlasti lisada viited ettevaatusele, hoiatusele ja ohule enne samme, mille suhtes neid kohaldatakse. "
(William Sanborn Pfeiffer, Tehnilise suhtluse taskujuhend, 4. toim. Pearson, 2007)
Testimisjuhised
Juhiste komplekti täpsuse ja selguse hindamiseks kutsuge üks või mitu isikut teie juhiseid järgima. Vaadake nende edusamme, et teha kindlaks, kas kõik sammud on mõistliku aja jooksul õigesti täidetud. Kui protseduur on lõpule viidud, paluge sellel katserühmal teada anda kõigist ilmnenud probleemidest ja pakkuda soovitusi juhiste täiustamiseks.