A műszaki írás egyik leggyakoribb és legfontosabb felhasználási területe az utasítások megadása, vagyis annak lépésről lépésre történő magyarázata, hogyan kell valamit összeszerelni, működtetni, megjavítani vagy rutinszerű karbantartást végezni. Bár intuitívnak és egyszerűen megírhatónak tűnik, az utasítások a legrosszabbul megírt dokumentumok közé tartoznak. A legtöbbünknek valószínűleg sok bosszantó tapasztalata volt már rosszul megírt utasításokkal. Ez a fejezet megmutatja, hogy a szakemberek mit tartanak a legjobb technikáknak az utasítások megadásában.
Egy hatékony utasításkészlethez a következőkre van szükség:
- Tiszta, pontos és egyszerű írás
- Az eljárás alapos megértése annak minden technikai részletében
- A képesség, hogy az olvasó helyébe képzelje magát, annak a személynek a helyébe, aki megpróbálja használni az utasításait
- A képesség, hogy az eljárást részletesen elképzelje, és ezt a tudatosságot papírra vesse
- A készség, hogy az utasításait olyan személyen tesztelje, akinek írta.
Az utasítás megírására irányuló projekt kezdetén fontos meghatározni annak az adott eljárásnak a szerkezetét vagy jellemzőit, amelyről írni fog. Íme néhány követendő lépés:
Végezzen alapos célközönség- és feladatelemzést
A folyamat korai szakaszában határozza meg az utasítás célközönségét és helyzetét. Ne feledje, hogy a célközönség meghatározása annak meghatározását jelenti, hogy az olvasói mennyire ismerik a témát.
Meghatározni a feladatok számát
Hány feladat van abban az eljárásban, amelyről ír? Használjuk az eljárás kifejezést azon tevékenységek összességére, amelyekről az utasításai szólnak. A feladat az eljáráson belüli tevékenységek félig független csoportja: például a mikrohullámú sütő órájának beállítása egy feladat a mikrohullámú sütő működtetésének nagy átfogó eljárásában.
Egy egyszerű eljárás, mint például az autó olajcseréje, csak egy feladatot tartalmaz; nincsenek félig független tevékenységcsoportok. Egy összetettebb eljárás, mint például egy mikrohullámú sütő használata, több félig független feladatot tartalmaz: többek között 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.
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 utasítást egy gyerekhinta összeszereléséhez. Saját tapasztalatom szerint több mint 130 lépésből állt! Ez egy kicsit ijesztő lehet. Jó megközelítés, ha a hasonló és egymáshoz kapcsolódó lépéseket fázisokba csoportosítjuk, és minden új fázisnál elkezdjük átszámozni a lépéseket. A fázis tehát hasonló lépések csoportja egy egyfeladatú eljáráson belül. A hintaágy-példában a keret felállítása lenne egy fázis; a dolog földbe horgonyzása egy másik; a dobozhinta összeszerelése még egy másik.
3. Határozza meg a lépésről lépésre történő megbeszélés legjobb megközelítését
A legtöbb utasítás esetében összpontosíthat a feladatokra, vagy összpontosíthat az eszközökre (vagy az eszközök jellemzőire). Egy telefonos válaszadó szolgáltatás használatára vonatkozó utasítás feladatközpontú (más néven feladatorientált) megközelítésében ezek a szakaszok lennének:
- Az üdvözlés felvétele
- Az üzenetek visszahallgatása
- Az üzenetek mentése
- Az üzenetek továbbítása
- Az üzenetek törlése, és így tovább
Ezek a feladatok – a tipikus dolgok, amelyeket a géppel szeretnénk csinálni.
Másrészt, a fénymásoló használatára vonatkozó utasítások szerszámos megközelítésében valószínűleg lennének olyan szakaszok, amelyek az egyes funkciók használatáról szólnának:
- Másolás gomb
- Megszakítás gomb
- Nagyítás/csökkentés gomb
- Összegyűjtés/tűzés gomb
- Másolási méret gomb, és így tovább
Ha erre a tervre terveznénk egy használati utasítást, akkor a fénymásoló minden egyes gombjának vagy funkciójának használatához írnánk lépéseket. Az ilyen eszközös megközelítést használó utasításokat nehéz működőképessé tenni. Néha a gomb neve nem egészen egyezik a hozzá tartozó feladattal; néha nem csak egy gombot kell használni a feladat elvégzéséhez. Mégis, lehetnek olyan esetek, amikor az eszközök/funkciók megközelítés előnyösebb lehet.
4. Tervezze meg a feladatok csoportosítását
A feladatok felsorolása nem feltétlenül elegendő. Lehet, hogy olyan sok feladat van, hogy csoportosítania kell őket, hogy az olvasók könnyebben megtalálják az egyes feladatokat. Például a következő gyakori feladatcsoportosítások szerepelnek az utasításokban:
- Kicsomagolási és beállítási feladatok
- Telepítési és testreszabási feladatok
- Az alapvető üzemeltetési feladatok
- Rutinszerű karbantartási feladatok
- Hibaelhárítási feladatok.
Az utasítások gyakori szakaszai
A következőkben áttekintjük az utasításokban gyakran előforduló szakaszokat. Ne feltételezze, hogy mindegyiknek szerepelnie kell a ténylegesen megírt utasításokban, sem azt, hogy az itt bemutatott sorrendben kell lenniük, sem azt, hogy ezek az egyetlen lehetséges szakaszok egy utasításban.
Az alternatív formátumokért tekintse meg a példa utasításokat.
Bevezetés: gondosan tervezze meg az utasításai bevezetését. Ez tartalmazhatja az alábbiak bármelyikét (de nem feltétlenül ebben a sorrendben):
- Adja meg az ismertetendő konkrét feladatokat vagy eljárást, valamint a terjedelmet (mi kerül és mi nem)
- Adja meg, hogy a hallgatóságnak milyen ismeretekre és háttérismeretekre van szüksége az utasítás 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 kell) használni az utasítást
- 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 gyakran fel kell hívniuk az olvasók figyelmét arra a lehetőségre, hogy tönkretehetik a felszerelésüket, elronthatják az eljárást és megsérülhetnek. Emellett az utasításoknak gyakran ki kell emelniük a kulcsfontosságú pontokat vagy kivételeket. Ezekre a helyzetekre speciális megjegyzéseket – figyelmeztetés, figyelmeztetés, óvatosság és veszély – használ. Figyelje meg, hogyan használja ezeket a speciális megjegyzéseket a fent felsorolt példa utasításokban.
Technikai háttér vagy elmélet: Bizonyos típusú utasítások elején (a bevezetés után) szükség lehet az eljárással kapcsolatos 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. Például lehet, hogy már volt némi tapasztalata azokkal a szoftveralkalmazásokkal, amelyekben a piros, zöld és kék csúszkák mozgatásával határozhatja meg a saját színeit. Ahhoz, hogy igazán megértsd, mit csinálsz, szükséged van némi háttérismeretre a színekről. Hasonlóképpen elképzelhető, hogy bizonyos, kamerákat használó utasításokhoz némi elméletre is szükség lehet.
Készülékek és kellékek: Vegye észre, hogy a legtöbb utasítás tartalmaz egy listát azokról a dolgokról, amelyeket össze kell gyűjtenie, mielőtt elkezdi a műveletet. 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 jellemzően vagy egyszerű függőleges listában, vagy 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 a lépések tényleges megírásához érünk, több dolgot is szem előtt kell tartanunk: (1) e lépések felépítését és formátumát, (2) az esetlegesen szükséges kiegészítő információkat, valamint (3) a nézőpontot és az általános írásmódot.
Szerkezet és formátum: Általában úgy képzeljük el az utasításokat, hogy azok függőleges, számozott listák formájában vannak megformázva. És a legtöbbjük valóban így is van. Normális esetben a tényleges lépésenkénti utasításokat is így formázzuk. Van azonban néhány variáció, valamint néhány egyéb megfontolás:
- A rögzített sorrendű lépések olyan lépések, amelyeket a bemutatott sorrendben kell végrehajtani. Például, ha egy autóban olajat cserélünk, az olaj leeresztése olyan lépés, amelynek az új olaj betöltése előtt kell következnie. Ezek számozott listák (általában függőleges számozású listák).
- A változó sorrendű lépések olyan lépések, amelyeket gyakorlatilag bármilyen sorrendben végre lehet hajtani. Jó példák erre azok a hibaelhárítási útmutatók, amelyek azt mondják, hogy ellenőrizd ezt, ellenőrizd azt, ahol valamit meg akarsz javítani. Az ilyen típusú lépéseket gyakorlatilag bármilyen sorrendben elvégezhetjük. Ennél a típusnál a felsorolásos lista a megfelelő formátum.
- Alternatív lépéseknek nevezzük azokat a lépéseket, amelyekben ugyanazon dolog elvégzésének két vagy több módja kerül bemutatásra. Az alternatív lépéseket akkor is használják, ha különböző feltételek állhatnak fenn. Ennél a típusnál használjunk felsorolásos listákat, az alternatívák közé beillesztett VAGY-val, vagy az alternatívák bemutatására utaló bevezetővel.
- A beágyazott lépések olyan esetekben használhatók, amikor az eljáráson belüli egyes lépések önmagukban meglehetősen összetettek, és azokat allépésekre kell bontani. Ebben az esetben tovább behúzza, és az allépéseket a, b, c, stb. sorrendbe állítja.
- “Lépés nélküli” utasítások. akkor használható, ha valóban nem lehet számozott függőleges listát használni, vagy egyenes, utasításszerű stílusú utasítást adni az olvasónak. Egyes helyzeteket annyira általánosítani kell, vagy annyira változónak kell lennie, hogy nem lehet lépéseket megadni.
Kiegészítő megbeszélés: Gyakran nem elég egyszerűen megmondani az olvasónak, hogy ezt vagy azt tegye. Kiegészítő magyarázó információkra van szükségük, például arra, hogyan kell kinéznie a dolognak a lépés előtt és után; miért kell törődniük azzal, hogy ezt a lépést megtegyék; milyen mechanikai elv áll a lépés mögött; még mikroszintűbb magyarázat a lépésről – a lépést alkotó konkrét cselekvések tárgyalása.
A kiegészítő tárgyalással azonban az a probléma, hogy elrejtheti a tényleges lépést. Azt akarjuk, hogy a tényleges lépés – a konkrét cselekvések, amelyeket az olvasónak meg kell tennie – kiemelkedjen. Nem akarja, hogy az egészet egy halom szóba temessük. Legalább két technika létezik ennek a problémának az elkerülésére: az utasítást és a kiegészítést külön bekezdésekre oszthatod; vagy félkövérrel kiemelheted az utasítást.
Írásstílus
A legfontosabb felhasználói lépések félkövérrel való feltüntetése nagyon hasznos módja lehet annak, hogy egyértelműen jelezd, mit kell tennie az olvasónak. Gyakran a parancsoló ige félkövérrel van kiemelve; néha a félkövér betűtípus kiemeli a tárgyalt kulcselemet.
A passzív hang használata az utasításokban problémás lehet. Valamilyen furcsa oknál fogva egyes utasítások így hangzanak: “A kijelző ideiglenes leállításához a szünet gombot kell megnyomni.” Nemcsak a szünet gomb lelki egészségéért aggódunk, hanem azon is elgondolkodunk, hogy vajon kinek kellene megnyomnia azt a valamit (nindzsáknak?). Sokkal hasznosabb lenne jelezni, hogy mikor kell az olvasónak “megnyomnia a szünet gombot”. Vegyük például ezt a példát: “Az időzítő gombot ezután 3:00-ra állítjuk”. Ismét megkérdezhetnénk, hogy “ki állítja be? Nindzsák?” Az ilyen utasításokat követő személy azt gondolhatja, hogy ez egyszerűen csak utalás valamilyen létező állapotra, vagy elgondolkodhat: “Hozzám beszélnek?”. A harmadik személy használata szintén kínos helyzethez vezethet: “A felhasználónak ezután meg kell nyomnia a Szünet gombot”. Az utasításokat általában parancsoló igealakot használva és “te” személyben kell megírni, hogy tökéletesen egyértelmű legyen, mit kell tennie az olvasónak.
Az utasítások illusztrálása
A grafika talán még a műszaki írás bármely más formájánál is fontosabb az utasításoknál. Néha a szavak egyszerűen nem tudják elmagyarázni a lépést. Az illusztrációk gyakran döntő fontosságúak ahhoz, hogy az olvasó szemléletesen el tudja képzelni, mit kell tennie. Ügyeljen arra, hogy a grafikák az olvasó szemszögéből ábrázolják a képet.
Az utasítások formázása
Mivel az emberek ritkán akarnak utasításokat olvasni, de gyakran kénytelenek, formázza az utasításokat úgy, hogy azok ne legyenek szívesen olvashatók. Próbáld elérni, hogy az olvasód el akarja olvasni őket, vagy legalábbis ne legyen ellenálló a gondolattal szemben, hogy elolvassa őket. A jól olvasható formátum lehetővé teszi az olvasók számára, akik már maguktól rájöttek az utasítások egy részére, hogy átugorják azt a részt, ahol elakadtak. Használja a fejlécekről, listákról, vizuális elemekről és passzív térről tanultakat a hatékony és olvasható utasítások létrehozásához:
Fefejlécek: Általában fejléceket szeretne az esetleges háttérszakaszokhoz, a felszerelések és kellékek szakaszhoz, egy általános fejlécet a tényleges utasítások szakaszához, és alcímeket az egyes feladatokhoz vagy fázisokhoz a szakaszon belül.
Listák: Hasonlóan, az utasítások általában széles körben használnak listákat, különösen számozott függőleges listákat a tényleges lépésről-lépésre történő magyarázatokhoz. Az egyszerű függőleges listák vagy a kétoszlopos listák általában jók a felszerelések és kellékek szakaszhoz. A mondaton belüli listák akkor jók, ha áttekintést ad a további dolgokról.
Speciális megjegyzések: Előfordulhat, hogy figyelmeztetnie kell az olvasót azokra a lehetőségekre, amelyekben kárt tehet a felszerelésében, elpazarolhatja a készleteket, az egész eljárás meghiúsulását okozhatja, saját magát vagy másokat – akár súlyosan vagy halálosan – megsebesítheti. Vállalatokat pereltek már be ezen különleges figyelmeztetések hiánya, rosszul megírt különleges figyelmeztetések vagy a helyükön nem megfelelő különleges figyelmeztetések miatt. Lásd a Különleges értesítések című fejezetben e különleges értesítések megfelelő használatának, valamint formátumuknak és az utasításokban való elhelyezésüknek a teljes körű tárgyalását.
Az utasítások újraolvasása és felülvizsgálata során ellenőrizze, hogy azok a következőket teszik-e:
- Az ismertetendő eljárás pontos leírása
- A tartalom áttekintése
- A közönség követelményeinek feltüntetése
- Ahol szükséges, használjon különböző típusú felsorolásokat; különösen az egymást követő lépésekhez használjon számozott listákat
- Használjon címsorokat és alcímeket a főbb szakaszok és alszakaszok logikus, összefüggő sorrendben történő felosztásához
- Szükség szerint használjon speciális megjegyzéseket
- A legfontosabb műveletek és tárgyak szemléltetésére használjon grafikákat
- Szükség szerint adjon további kiegészítő magyarázatot a lépésekhez
- Szükség esetén készítsen egy, a felszereléseket és kellékeket felsoroló részt.
A fejezetet a Creative Commons Attribution 4.0 Nemzetközi licenc alapján adaptáltuk.