Hogyan írjunk utasításokat?

Tartalomjegyzék:

Anonim

Sokan nem fogják elolvasni az utasításokat, kivéve utolsó lehetőségként. Miután az emberek elolvasta őket, csak akkor hasznosak, ha világos, tömör nyelven írják. Ha megérti a közönséget, akkor jobban felkészül a bevezetésre, majd az utasításokat.

Tanulmányozza a közönséget

Az utasítások általában tájékoztatják az olvasót arról, hogyan kell csinálni, építeni, működtetni vagy karbantartani egy terméket vagy eljárást. Először is, győződjön meg arról, hogy milyen jól érti a témát. Például, ha az új bérbeadásokra vonatkozó utasításokat ír elő, azokat egyszerű nyelven kell megírni, míg a felső vezetés utasításai tartalmazhatnak több ipari lingót. Használja az olvasóknak megfelelő nyelvet, és tartalmazza a feladat elvégzéséhez szükséges részleteket.

Bevezetés létrehozása

Nagyon gyakran az olvasók kihagyják a narratív bevezetést, és jobbra mozognak az utasításokban. Az egyik módja annak, hogy segítsen az olvasóknak a bevezetéseken keresztül mozogni, az, hogy a bekezdésforma helyett számozott listában írjon le egy magyarázatot vagy okot az utasításokhoz. Az olvasók nagyobb valószínűséggel vizsgálják felül a listát. Adja meg az utasítások célját, aki elolvassa a dokumentumot, és mit tartalmaz, mindegyik külön fejezetben. Ez a bevezetés az olvasók számára is nyomot ad arra vonatkozóan, hogy mi nem terjed ki.

Használja az aktív hangot

Ne használjon passzív hangot, például „A fehér vezetéket be kell helyezni az A dugaszolóaljzatba”. Helyette írjon utasításokat, amelyek aktív hangot igényelnek, például „Helyezzük be a fehér vezetéket az A. dugaszba”. egy narratíva vagy füzet, a hosszú mondatokat több lépéssel bontja le a fejezetek alatt felsorolt ​​rövid utasításokba. Szüntesse meg a „és” szót tartalmazó mondatokat rövidebb külön mondatokban. Ahelyett, hogy „A kábelt össze kellene kötni, és a piros kimenetbe kell helyezni”, írjon két mondatot, melyek az akció igékkel kezdődnek, mint például a „Kábel csatolása. Helyezze a csatolt kábelt a piros aljzatba. ”Egy világos, merész fejléc mondhatna valami olyasmit, mint a„ Hook Up the Wires ”.

Külön magyarázó információk

Nagyon gyakran, az utasításoknak magyarázatokra is szükségük van. Írjon magyarázó megjegyzéseket két módon. Merészítse meg az aktuális utasításokat, hogy kitűnjön, vagy adjon meg magyarázatot egy külön oszlopban referenciaként. Az egyik taktika az, hogy a lépéseket a dokumentum egyik oldalára helyezzük, a magyarázatokat egy rövid bekezdésben, egy egymás melletti oszlopban. Egy másik, hatékonyabb módja az, hogy a magyarázatot írásban merészeljük és teljesítsük a lépést. Például: „Nyomja meg a piros gombot három másodpercig (félkövér). Ez lehetővé teszi a fény aktiválását.