Technikai írás technikusoknak

A műszaki írás egyik leggyakoribb és legfontosabb felhasználási területe az utasítások – azok a lépésről lépésre történő magyarázatok, amelyek azt mutatják be, hogyan kell valamit csinálni: összeszerelni valamit, működtetni valamit, megjavítani valamit, vagy elmagyarázni egy személyes folyamatot (például a főiskolára való beiratkozást), hogy az olvasó jobban megértse, és esetleg maga is használhassa.

A folyamatszövegek rendkívül gyakoriak az iskolában és a szakmákban. Az iskolában a tanárok gyakran adnak folyamatfeladatokat. A bölcsészprofesszorok például kérhetik egy művészeti vagy irodalmi korszak fejlődésének leírását; a történelemtanárok egy kultúra vezetőinek hozzájárulását az idők folyamán; a társadalomtudományok professzorai a találmányok kronológiáját; a mérnökprofesszorok annak magyarázatát, hogyan alakul át a hang elektromos jellé; az üzleti tanárok a Federal Reserve működését vagy egy termék eladását.

Naponta olvasunk leíró folyamatokat, például recepteket, új szoftverek felhasználói kézikönyveit vagy tanácsadó rovatokat arról, hogyan lehet fogyni vagy hogyan lehet sikeres az iskolában vagy egy szakmában. Ezek a szövegek a következő kérdések valamelyikének megválaszolására összpontosítanak:

• “Hogyan kell ezt csinálni?”
• “Hogyan tudom ezt megcsinálni?”

Míg egy folyamatleírás vagy egy használati utasítás témái változhatnak, sokukban vannak hasonlóságok: a legtöbbet azért írják, hogy elmagyarázzák, hogyan működik valami, a legtöbbjük időrendben, számozott lépésekkel van felépítve, és a legtöbbjük nagymértékben támaszkodik vizuális eszközökre. Egy új szoftverprogram megtanulására vonatkozó utasítás megírásakor az írók például képernyőfotókat és/vagy képernyővideókat használhatnak, hogy végigvezetik a felhasználókat az oktatóanyagon.

Általában jó, ha az utasításokban szöveges és vizuális elemek egyaránt szerepelnek, mivel a célközönség valószínűleg különböző tanulási stílusú emberekből áll. A vizuális anyagok használata azonban a célközönségtől és az utasítások tervezett felhasználásától függően változhat. A vizuális eszközök segítenek tisztázni egy olyan fogalmat, amelyet csak szavakkal nehéz elmagyarázni. A grafikák használhatók arra, hogy megmutassák, hogyan néz ki valami, hogyan kell kinéznie valaminek a lépés befejezése után, hogyan történik vagy épül fel valami, tendenciákat vagy összefüggéseket mutatnak be, élénkebbé teszik a projektet, vagy egyszerűen csak segítenek az információk rendszerezésében. A grafikák azért hasznosak, mert szinte mindenki (beleértve a gyerekeket és az idegen nyelvűeket is) megérti a vizuális utasításokat, és pontosan látja, hogy mit kell elvégeznie.

Az utasítások típusai

A folyamatszövegeknek három fő típusa van:

• • • • Leíró folyamatok: ezek arra a kérdésre válaszolnak, hogy “Hogyan kell ezt csinálni?”. Ezek a szövegek leírják, hogyan zajlik egy folyamat, hogy az olvasók jobban megértsék azt. Ha például leíró folyamatot írsz arról, hogyan jelentkeztél be egy kurzusra online, nem pedig személyesen, az hasznos lehet annak, aki még soha nem végzett online regisztrációt.
  • • • • Preskriptív folyamatok: ezek magyarázó jellegűek; előírják, hogyan kell (vagy kellene) valamit csinálni, hogy az olvasók maguk is meg tudják csinálni. Ezek az oktató dokumentumok leggyakoribb típusai. Például írhat egy előíró folyamatokat tartalmazó útmutatót a felhasználók számára, amelyben elmagyarázza, hogyan végezzenek alapvető karbantartási munkálatokat az autójukon, például hogyan cseréljenek olajat, ellenőrizzék a gyújtógyertyákat vagy cseréljék ki a fékbetéteket. *Az alább felsorolt minták az előíró folyamatok példái.
    • • • A kevert leíró és előíró folyamatok a dokumentum fő részét leíró folyamatnak teszik ki, miközben néhány szakasz összefoglalja, hogyan végezhetik el az olvasók a folyamatot. Más szóval az írók egy szöveg különböző részeiben egyaránt foglalkozhatnak a “Hogyan csinálhatom ezt?” és a “Hogyan kell ezt csinálni?” kérdésekkel. Alternatív megoldásként ugyanannak a dokumentumnak különböző változatait dolgozhatják ki két közönség – a felhasználók és az érdeklődők közönsége – számára.”

  Kezdés

  

  Az utasítás-írási projekt vagy feladat kezdetén fontos, hogy figyelembe vegyük a célközönséget, és meghatározzuk annak az adott eljárásnak a jellemzőit (a feladatok és lépések számát), amelyről írni kívánunk.

  A közönség és a helyzet: A folyamat korai szakaszában határozza meg az utasításai célközönségét és helyzetét. Ne feledje, hogy a közönség meghatározása azt jelenti, hogy meg kell határoznia a közönség tudásszintjét és a témával való ismeretét. Néha hasznos, ha először saját magának írja le a célközönséget, majd a végén ennek alapján értékeli az üzenetét, hogy megbizonyosodjon arról, hogy az megfelel a célközönségnek.

  A feladatok száma: Fontos szempont, hogy hány feladat van abban az eljárásban, amelyhez utasításokat ír. Az eljárás kifejezést használhatja az utasításaiban tárgyalt tevékenységek összességére, míg a feladatot használhatja az eljáráson belüli tevékenységek egy félig független csoportjának meghatározására. Például a modem beállítása egy feladat a számítógép internetre való csatlakoztatásának átfogó eljárásában.

  Egy másik példa: egy olyan egyszerű eljárás, mint az autó olajcseréje, csak egy feladatot tartalmaz; nincsenek más tevékenységek félig független csoportjai. Egy összetettebb eljárás, mint például egy mikrohullámú sütő használata, rengeteg félig független feladatot tartalmaz, mint például az óra beállítása, a teljesítményszint beállítása, az időzítő használata, a mikrohullámú sütő tisztítása és karbantartása és így tovább.

  Néhány utasításnak csak egyetlen feladata van, de ezen az egyetlen feladaton belül sok lépésből áll. Képzeljünk el például egy gyermekhinta összeszerelésére vonatkozó utasítást. Az egyik hatékony megközelítés az lenne, ha a hasonló és egymáshoz kapcsolódó lépéseket fázisokba csoportosítanánk, majd minden új fázisnál átszámoznánk a lépéseket. A fázis egy egyfeladatú eljáráson belüli hasonló lépések csoportja. A hintaágy példájában a keret felállítása lenne az egyik fázis; a dolog földbe horgonyzása egy másik; és a dobozhinta összeszerelése még egy másik.

  Az utasítások fókuszálása

  Egy másik szempont, amelyet talán nem tudsz korán meghatározni, az, hogy hogyan fókuszáld az utasításokat. A legtöbb utasítás esetében összpontosíthatsz a feladatokra, vagy összpontosíthatsz a szükséges eszközökre.

  • • • • A telefonos üzenetrögzítő használatára vonatkozó utasítások feladatközpontú megközelítésében lennének olyan szakaszok, amelyek az üdvözlés rögzítéséről, az üzenetek lejátszásáról, az üzenetek mentéséről, az üzenetek továbbításáról és az üzenetek törléséről szólnak. Ezek feladatok – a tipikus dolgok, amelyeket a felhasználók a géppel szeretnének elvégezni.
  • • • Másrészt a fénymásoló használatára vonatkozó utasítások eszközalapú megközelítésében a másolás gombról, a törlés gombról, a nagyítás/ kicsinyítés gombról, az összevonás/kapcsozás gombról, a papírtálcáról, a másolatméret gombról stb. lennének szakaszok. Ha ezen a terven tervezne egy használati utasítást, valószínűleg a fénymásoló minden egyes gombjának vagy funkciójának használatára vonatkozó lépéseket írna.

Instrukciók tartalma

Az utasítások elkészítése előtt mindenképpen olvassa el a “Dokumentumtervezés” című részt. Tartalmazza a következő elemeket:

Bevezetés: Az utasítások bevezetésének gondos megtervezése során ügyeljen arra, hogy:

• • • • • Adja meg, hogy milyen konkrét feladatokat vagy eljárást kell elmagyarázni.
        • Adja meg, hogy a közönségnek milyen ismeretekre és háttérismeretekre van szüksége az utasítások megértéséhez.
        • Adjon általános képet az eljárásról és arról, hogy mit ér el vele.
        • Adja meg, hogy milyen körülmények között kell (vagy nem szabad) használni ezeket az utasításokat.
        • Adjon áttekintést az utasítás tartalmáról.

Általános figyelmeztetés, óvatosság, veszélyre való figyelmeztetés: Az utasításoknak arra is fel kell hívniuk az olvasók figyelmét, hogy tönkretehetik a felszerelésüket, elronthatják az eljárást és/vagy megsérülhetnek. Az utasításoknak továbbá ki kell emelniük a legfontosabb pontokat vagy kivételeket. Ezekre a helyzetekre speciális megjegyzéseket kell használni, mint például a Megjegyzés, Figyelmeztetés, Óvatosság és/vagy Veszély.

Technikai háttér vagy elmélet: Egyes utasítások elején (általában a bevezetés után) szükség lehet az eljáráshoz kapcsolódó háttéranyag tárgyalására. Bizonyos utasításoknál ez a háttér kritikus fontosságú – máskülönben az eljárás lépéseinek nincs értelme. Bizonyos esetekben az utasítások íróinak jelentős időt kell fordítaniuk arra, hogy elmagyarázzanak dolgokat az olvasóknak, mielőtt rátérnének az eljárás tényleges lépéseire.

Együttesek és kellékek: A legtöbb használati utasítás tartalmaz egy listát azokról a dolgokról, amelyeket az eljárás megkezdése előtt össze kell gyűjtenie. Ide tartoznak a felszerelések, vagyis az eljárás során használt szerszámok (például keverőtálak, kanalak, kenyértálak, kalapácsok, fúrók és fűrészek) és a kellékek, vagyis az eljárás során felhasznált dolgok (például fa, festék, olaj, liszt és szögek). Az utasításokban ezeket általában vagy egy egyszerű függőleges listában, vagy az utasítás elején két oszlopos listában sorolják fel. A kétoszlopos listát akkor használja, ha néhány vagy az összes elemhez specifikációkat kell hozzáadni – például márkaneveket, méreteket, mennyiségeket, típusokat, modellszámokat és így tovább.

A lépések tárgyalása: Amikor rátér a lépések tényleges megírására, mindenképpen gondosan fontolja meg e lépések szerkezetét és formátumát, az esetlegesen szükséges kiegészítő információkat, valamint az utasítások nézőpontját és általános írásmódját. A műszaki írásokban használt egyik nézőpont a második személy, amely a közönséget Önként szólítja meg.

*Az utasítások íróinak általában a következőkre kell törekedniük:

• • • • Ahol csak lehet, használjon világos, egyszerű írást.
  • • • • Legyen alapos ismerete a folyamatról annak minden technikai részletében.
    • • • • Munkálkodjon azon, hogy az utasításait használó olvasó helyébe képzelje magát.

    

    Tanulói utasításminták

    • Hegesztési utasításminta (tanulói minta)
    • Mechatronikai utasításminta – Diódák vizsgálata. & Tranzisztorok (tanulói minta)
    • Autó/Diesel Utasítások – Hogyan cseréljük ki a hátsó lengőkarokat egy Toyota Corollán (tanulói minta)
    • Ágyak Áthelyezési utasítások (tanulói minta)
    • Hogyan cseréljünk gitárhúrokat (tanulói minta)

    Szakmai utasítási minták

    • Hegesztés Utasítás minta 1 (szakmai minta)
    • Barbie álomház (szakmai minta)
    • Trambulin összeszerelése (szakmai minta)