Retorikailag hatékony használati utasítások készítése

Kézikönyvek

A használati utasításokat sokan készülékekkel, számítógépes kiegészítőkkel és összeszerelést igénylő termékekkel (pl. bútorokkal) azonosítják. Mivel nem vesszük észre, hogy rendszeresen használjuk őket, vagy csak bizonyos kontextusokban számítunk rájuk, könnyen elfelejtjük, hogy mennyire fontosak. Egy jól megtervezett használati utasítás minősége észrevétlen maradhat. Mégis, amikor frusztrációval találkozunk egy könyvespolc vagy játék összeállítása során, vagy amikor megpróbáljuk kitalálni, hogyan változtassunk vagy aktiváljunk egy adott készülék beállítását, világossá válik a jól megtervezett használati utasítás jelentősége.

A használati utasítások retorikai helyzetének megértése

A használati utasításokat, mint más típusú szövegeket, egy retorikai helyzet alakítja. A műszaki írók tartalmi és formai döntései a használati utasítás céljától, a célközönségtől és attól a kontextustól függnek, amelyben a kézikönyvet használják. Amikor saját használati utasítását írja, vegye figyelembe a retorikai szituációval kapcsolatos alábbi gondolatokat és kérdéseket.

Cél

A használati utasítás célja általában az, hogy megismertesse a felhasználót a termékkel és/vagy végigvezesse a felhasználót egy lépéssorozaton, amely egy feladat elvégzéséhez vezet. Azonban minden használati utasításnak van egy konkrétabb eredménye is. Ha azonosítja, hogy mi ez a konkrét eredmény, akkor hatékonyabb retorikai döntéseket hozhat a tartalommal és a tervezéssel kapcsolatban. Tegye fel magának a kérdést:

Melyek az utasítások konkrét tervezett eredményei? (pl. sütemény sütése a semmiből, légkondicionáló berendezés beszerelése stb.)
Amellett, hogy segíti a felhasználókat a fő kívánt eredmény(ek) elérésében, vannak-e más célok, amelyeket az útmutató szolgál? (pl. hibaelhárítási tanácsokat nyújt, megtanítja a felhasználókat, hogyan végezzenek el további, a fő cél eléréséhez szükséges egyszerű feladatokat)

A közönség

A célközönség (azaz a dokumentum elsődleges célzott felhasználója) profiljának megalkotása alapvető fontosságú a terjedelemre, tartalomra és kialakításra vonatkozó átgondolt döntések meghozatalához. Az írás előtt vegye figyelembe a következő kérdéseket a célközönséggel kapcsolatban:

Milyen a célközönség ismertsége vagy szakértelme a használati útmutató témáját illetően?
Milyen a célközönség általános komfortérzete a szoftverrel, alkalmazásokkal, receptekkel stb. kapcsolatos új készségek elsajátításával kapcsolatban?
Milyen a célközönség “tipikus” hozzáállása a tanuláshoz? Hogyan fog a használati útmutatója a közönség tanulási stílusát, céljait és a feladattal kapcsolatos igényeit figyelembe venni?

Kontextus

A kontextus alatt a használati útmutató elkészítését és használatát körülvevő időbeli, társadalmi, technológiai és kulturális helyzetet érti. A következő kérdések segítenek a kontextus azonosításában:

Mennyi ideje lesz a használati utasítás elkészítésére?
A felhasználóra vonatkozó időbeli korlátok?
Milyen technológiai korlátokat kell figyelembe vennie a használati utasítás elkészítése során? Vegye figyelembe a technológiai ismereteit és a hozzáférés szintjét.
Hogyan fog a közönség hozzáférni a kézikönyvhöz? (pl. a közönség online hozzáférhet a kézikönyvhöz egy vállalati weboldalon keresztül)
Milyen további eszközökről vagy anyagokról feltételezi, hogy a közönség már rendelkezik? Hozzá fognak-e férni az utasítások követéséhez szükséges technológiához vagy anyagokhoz? (pl. egy könyvespolc sikeres felépítéséhez a felhasználónak szüksége lesz kalapácsra, csavarhúzóra és nyitott munkaterületre)
Milyen kulturális nézőpontból írja a használati útmutatót? A közönség osztozik majd ebben a kulturális kontextusban? (pl. egy német receptet, amely vaníliás cukrot igényel, egy olyan összetevőt, amely az Egyesült Államokban nem könnyen hozzáférhető, esetleg módosítani kell az amerikai felhasználók számára)

A retorikai helyzet ismeretének felhasználása a hatékony retorikai választásokhoz

Noha a legtöbb használati utasítás bizonyos standard konvenciókra támaszkodik, minden használati utasítást úgy kell kialakítani, hogy egy adott kontextusban egy adott célt érjen el egy adott közönség számára. A következő szakasz a használati utasítások néhány általános jellemzőjét mutatja be, miközben figyelembe veszi a retorikai helyzetet is, és azt, hogy az hogyan követelheti meg az egyes konvencióktól való eltérést.

Kiterjedés

A retorikai helyzet segít meghatározni, hogy milyen részletességgel kell egy használati utasításban szerepelnie. Például egy íróasztal összeszereléséről szóló használati utasítás terjedelmét könnyű meghatározni, mert csak egyetlen kimenetele van: az íróasztal összeszerelése. Egy digitális tükörreflexes fényképezőgép (DSLR) használati utasítása azonban amatőr és tapasztaltabb fényképezőgép-felhasználók számára egyaránt készülhet, és tartalmazhat utasításokat az alapvető feladatok elvégzésére (pl. az akkumulátor és a memóriakártya beszerelése), valamint a haladóbb feladatokra (pl., a beállítások beállítása az adott felvételi környezethez).

Tartalom

A használati utasítások egyes szabványos részei közé tartozik az előlap, a bevezetés, a lépések sorozata, a befejezés és a hátlap, bár előfordulhat, hogy egyes kézikönyvek nem használják mindezeket a részeket, vagy nem így jelölik őket. Kiterjedt elülső és hátsó rész például gyakran megtalálható a hosszabb, összetettebb kézikönyvekben. A legtöbb használati utasítás azonban tartalmaz egy bevezetőt, amely a lépések biztonságos és hatékony elvégzéséhez szükséges információkat tartalmazza. A bevezetés tartalmazhat magyarázatot arról, hogy kinek kell elvégeznie a feladatot (esetleg a felhasználónak rendelkeznie kell egy bizonyos készséggel), a szükséges anyagokról, a felhasználó által betartandó óvintézkedésekről (biztonsági tanácsok vagy egyéb figyelmeztetések), és bizonyos esetekben becslést arról, hogy mennyi ideig fog tartani a folyamat (ez a receptek gyakori jellemzője). Bizonyos esetekben magyarázatot kell fűzni ahhoz, hogy a felhasználónak miért kell követnie az utasításokat. Például egy autó olajcseréjére vonatkozó utasításban meg lehet magyarázni, hogy miért szükséges a feladat a jármű megfelelő működéséhez.

A bevezető anyag után következik a lépésről-lépésre történő utasítások sorozata. Az egyértelmű és hatékony lépések megfogalmazásának módjáról lásd a következő, “Nyelvezet” című részt. Végül egy használati utasítás tartalmazhat egy “Hibaelhárítási útmutatót” vagy egy “Tippek” részt, hogy segítse a felhasználókat a gyakori problémák kezelésében, amelyekkel az utasítások követése közben vagy a folyamat befejezése után találkozhatnak.

Nyelv

A “Célközönség” és a “Kontextus” fenti kérdései segíthetnek a hatékony nyelvi választásban. A következő alfejezetek az utasítások gyakori nyelvi jellemzőinek magyarázatát tartalmazzák, valamint tippeket az ebben a műfajban való világos és tömör íráshoz.

Imperatív hangulat

Az utasítások, akárcsak a parancsok, gyakran használják az imperatívusz hangulatot. Ha így akarsz írni, szólítsd meg közvetlenül a közönséget, aktív hangot és konkrét igéket használva. Az alábbiak közül melyik adja a legegyértelműbb utasítást?

“A játék megkezdéséhez nyomja meg a piros gombot”
“A piros gomb megnyomásakor a játék elkezdődik”
“A kezelőnek meg kell nyomnia a gombot”

Noha egy felhasználó valószínűleg bármelyik mondatot értelmezni tudná, az első adja a legegyértelműbb magyarázatot arra, hogy a felhasználónak milyen műveletet kell végrehajtania. A második, passzív szerkezet nem határozza meg, hogy kinek kell megnyomnia a gombot. A harmadik példa egy homályos alanyra, a “kezelőre” utal, ami összezavarhatja a felhasználót.

Szavak megválasztása

Az utasítások írásakor fontos a szóválasztás gondos megfontolása, mert bizonyos esetekben a felhasználó biztonsága forog kockán. Ezért törekedjen az egyértelműségre és a tömörségre. A szóválasztással kapcsolatos hatékony döntések meghozatalához vegye figyelembe az elsődleges célközönség szakismereti szintjét és kulturális hátterét. Előfordulhat, hogy szükségesnek találja

az összetett kifejezések definiálását.
A betűszavakat az első alkalommal történő bevezetésükkor ki kell írni (pl, digitális egylencsés tükörreflexes fényképezőgép, DSLR).
kerülje a hasonlatok, metaforák, szleng vagy helyettesítések használatát, amelyek összezavarhatják a felhasználókat.
használjon egyszerű nyelvet, mert bizonyos esetekben súlyos jogi következményekkel járhat, ha egy utasítás nem egyértelmű. Az egyszerű nyelvezetről bővebben lásd: http://www.plainlanguage.gov/index.cfm
az utasítások több nyelvre történő fordítását is tartalmazza.
használjon rövid és informatív címsorokat és alcímeket

Konzisztencia és párhuzamosság

A párhuzamos szerkezet vagy párhuzamosság azt jelenti, hogy ugyanazt a nyelvtani szerkezetet használja az információk vagy gondolatok bemutatására. A párhuzamosságot gyakran használják az olvashatóság javítása és a következetesség megteremtése érdekében.

Ez a numerikus utasításlista egy olyan lépést tartalmaz, amely megtöri a párhuzamos szerkezetet. Melyik lépés tűnik másnak, mint a többi?

Az elemtartó rekesz kinyitásához távolítsa el a csavart.
Az elemeket az elemtartón lévő képet követve helyezze be.
Most bezárhatja a rekeszt, és becsavarja.

A harmadik lépés megtöri a lista párhuzamos szerkezetét, mert nem direktív igével kezdődik.

A következő címszavak párhuzamos szerkezetet használnak? Miért vagy miért nem?

“Az akkumulátorok beszerelése”
“A készülék ki/be kapcsolása”
“Hogyan töltse fel a készüléket”

Design

A dokumentum designja az információ megszervezésének és megjelenítésének módjára utal. Mivel a vizuális elemek feldolgozása kevesebb időt igényel, a felhasználók jellemzően előbb veszik észre – és reagálnak rá – a design minőségét, mint a tartalom minőségét. Még ha úgy dönt is, hogy nem tartalmaz képeket vagy grafikákat, akkor is figyelembe kell vennie a dizájnt. Minimális esetben ez magában foglalja az elrendezéssel, az információk sorrendjével, a betűmérettel, a betűtípussal, a címsorokkal, a színekkel és a fehér térrel kapcsolatos döntéseket. A tervezési elemeknek zökkenőmentesen kell vezetniük a felhasználót a kézikönyvben. Ez azt jelenti, hogy a dokumentumot szkennelhetővé kell tenni; a szkennelhető dokumentum lehetővé teszi a felhasználók számára, hogy a tartalomban navigálva megtalálják a konkrét információkat. Mint minden dokumentum esetében, a tervezéssel kapcsolatos döntéseknél is figyelembe kell venni a célközönséget, a célt és az általános könnyű használhatóságot.

Konzisztencia/ismétlés

A tervezési elemeknek az egész dokumentumban egységes módon történő használata eligazítja a felhasználókat azáltal, hogy érzékelteti velük, mire számíthatnak (pl. azonos betűtípus és méret minden címsor esetében; azonos elrendezés oldalról oldalra).

Kontraszt

Egy tervezési elem használata a kézikönyv bizonyos információinak vagy jellemzőinek kiemelésére (pl. egy szó nagybetűs kiemelése a hangsúlyozás érdekében; doboz vagy keret elhelyezése egy elem körül; a színek megváltoztatása a hangsúlyozás érdekében). A kontraszt elsősorban akkor hatékony, ha a dokumentum összességében következetességet alkalmaz. Ha hiányzik a következetesség, nehezebb kontrasztot létrehozni.

Kiegyenlítés

Az elemek vízszintes és/vagy függőleges igazítással történő rendezése egy oldalon hierarchiát és struktúrát hoz létre, és felhasználható az egyensúly, a kontraszt vagy a következetesség elérésének elősegítésére. Ez a dokumentum például függőleges igazítást használ, hogy hierarchiát hozzon létre egy tervezési elem neve, amely balra van igazítva, és a leírása között, amely behúzva van.

Balance

Az elemek egyenletes elosztása egy adott térben. Ennek eléréséhez figyelembe kell venni az egyes elemek súlyát – vagyis azt, hogy a szem mennyire hajlamos egy elem felé vonzódni -. Mivel például egy képnek nagyobb a súlya, mint a szövegnek, a kép elhelyezésével kapcsolatos döntéseknél figyelembe kell venni, hogyan lehet egyensúlyt teremteni a kép súlya és a többi elem között a vizuális zavar elkerülése érdekében.

Fehér tér

A fehér tér használata a professzionális, kiegyensúlyozott dokumentum létrehozásához. Ez a tervezési elem ahelyett, hogy a tér színét jelölné, inkább a képek és a szöveg hiányára utal. A fehér tér segít megkülönböztetni az egyes elemeket és elemcsoportokat (pl. a kézikönyv szakaszait), és megkönnyíti a dokumentumok beolvasását.

Csoportosítás/közelség

Összefüggő képek vagy tartalmak egymáshoz közel helyezése. Például az adott feladat elvégzéséhez szükséges összes anyag képének csoportosítása.

Színek

A színek kiválasztása a kontraszt és a hangsúlyok megteremtése, az olvasók térben való vezetése és a vizuálisan kellemes dokumentum kialakítása érdekében. A következetes színséma kialakítása érdekében figyelembe kell vennie a dokumentum egészét. Ha például kék színt szeretne használni a dokumentumban, gondoskodnia kell arról, hogy azt következetesen használja, és kiegészítse a dokumentum többi színét. Ez különösen fontos a színes grafikák és/vagy képek integrálásakor.

Képek

A kézikönyv adott kontextusának és céljának megfelelő képek kiválasztása. Mérlegelnie kell, hogy a képeket önállóan vagy az írásos utasítások kiegészítésére szánja-e. Vegye figyelembe a képek típusait, például a rajzokat, fényképeket és grafikus illusztrációkat, valamint azt, hogy szükség van-e további feliratokra vagy megjegyzésekre a kép egyes részeinek kiemelésére. A képeket úgy kell kiválasztani, hogy kiegészítsék a kézikönyv egyéb tervezési elemeit.

Következtetés

A jó használati utasítás a retorikai helyzet – a cél, a célközönség és a kontextus – gondos mérlegelésével kezdődik. Ez az információ kulcsfontosságú ahhoz, hogy megfelelő és hatékony döntéseket hozhassunk a tartalom, a nyelvezet és a design tekintetében. Egy ideális időrendben a műszaki íróknak lehetőségük van használhatósági tesztek elvégzésére, amelyek célja annak felmérése, hogy egy dokumentum mennyire jól teljesíti a célját. A használati utasítás tesztelése után a kapott visszajelzéseket beépítve véglegesítheti a tervezést és a tartalmat.

GYakorlat 1 – Ismerkedjen meg a használati utasításokkal

A következő weboldal számos példát tartalmaz nyílt forráskódú használati utasításokra. Kövesse ezt a linket, böngésszen a listán, és válasszon ki egy kézikönyvet, amelyet alaposan megnéz. Lapozza át a kézikönyvet, hogy megismerje annak tartalmát és felépítését. Ezután az oktatónak vagy az osztálytársainak írt feljegyzésben foglalkozzon a következőkkel:

A retorikai szituáció azonosítása

Ki a célközönség? Honnan tudod, hogy ki a közönség? Mit feltételezhetsz a közönségről a kézikönyvben szereplő tartalmi és formai döntések alapján?
Mi a dokumentum célja? Honnan tudja, hogy ez az elsődleges cél (azaz milyen tartalmi és tervezési döntések jelzik a célt)?
Milyen kontextusból származik a kézikönyv írott tartalma és tervezése?

Vizsgálja meg a szerkesztési döntéseket

Írd le a kézikönyv általános terjedelmét és szervezését. Mennyire részletes a kézikönyv? Mire terjed ki a kézikönyv? Hogyan vannak megszervezve az információk?
A kézikönyv a tartalom minden “standard jellemzőjét” tartalmazza? Miért vagy miért nem? Vannak további funkciók? Melyek ezek, és mi a céljuk (céljaik)?
Helyezzen meg és írjon le példákat a hatékony nyelvhasználatra. Magyarázza meg, miért tartja ezeket hatékonynak.
Lokalizálja és írja le a hatékony tervezés példáit. Magyarázza meg, miért találja ezeket hatékonynak.
Ha ön lenne ennek a kézikönyvnek a szerzője, mit csinált volna másképp és miért?

2. gyakorlat – Egy használati utasítás megtervezése

Képzelje el, hogy egy olyan folyamat vagy termék használati utasítását írja, amelyet ismer, és válaszoljon a következő felkérésekre.

Határozza meg a retorikai helyzetet

Válassza ki a célközönséget, és hozzon létre egy 2-3 mondatos profilnyilatkozatot
azonosítsa a használati utasítás konkrét célját
Névsorolja fel a figyelembe veendő fontos kontextuális információkat

Készítsen tervet

Névsorolja fel azokat a részeket, amelyeket tartalmazni fog
Névsorolja fel a legfontosabb tényezőket, amelyeket a közönség és a cél szempontjából figyelembe kell venni (pl.g., nyelvhasználat, képek beépítése, szövegméret stb.)
Készítsen egy vázlatot, amely bemutatja a dokumentum elrendezését, azonosítja az írott részek helyét, és megmutatja, hol lesznek beépítve képek.