Kérjük, kattintson ide, hogy segítsen David McMurrey fizetni a webtárhelyért:
Adjon bármilyen kis összeget, amennyit tud !
Az Online Technical Writing továbbra is ingyenes marad.
a legfontosabb
Az elv döbbenetesen egyszerűnek és nyilvánvalónak tűnik. Nagyjából ugyanaz, mintha valakinek azt mondanánk, "Beszélj úgy, hogy előtted álló személy megértse, mit mondasz." Olyan, mintha azt mondanánk, "Ne beszélj rakétatudományról a hatévesednek." Szükségünk van erre egy tanfolyamra? Úgy tűnik, nem. De valójában a közönség elemzésének és az alkalmazkodás hiánya az egyik fő oka a legtöbb problémának, amelyeket a szakmai, műszaki dokumentumokban találunk—különösen az utasításokban, ahol ez a legszembetűnőbben jelentkezik.
Megjegyzések:
- Miután elolvastad a közönségekről szóló részt, próbáld használni a közönség tervező. Kitöltöd az üres mezőket a közönségeddel kapcsolatos részletes kérdésekre adott válaszokkal, majd e-mailben elküldöd azt magadnak és, opcionálisan, az oktatódnak.
- Ezenkívül, ez a fejezet tartalmaz egy részt a helyzet. Próbáld meg használni a helyzettervező hogy képet alkosson arról a helyzetről, amelyben a közönséged találja magát.
Az egyik első teendő, amikor egy közönséget elemzel, hogy meghatározd annak típusát (vagy típusait—ritkán csak egy típus). A közönségek általános felosztása a következő:
- Szakértők: Ők azok az emberek, akik kívül-belül ismerik az elméletet és a terméket. Megtervezték, letesztelték, mindent tudnak róla. Gyakran rendelkeznek tudományos fokozattal, és akadémiai környezetben vagy a kormányzati és technológiai világ kutatás-fejlesztési területein dolgoznak. A nem szakértő olvasó a legkevésbé képes megérteni, mit mondanak—és ugyanakkor a legkevésbé is van oka megpróbálni. Gyakrabban a szakember számára a kommunikációs kihívás az, hogy a technikussal és a vezetővel kommunikáljon.
- Technikusok: Ezek azok az emberek, akik megépítik, üzemeltetik, karbantartják, és megjavítják azokat a dolgokat, amelyeket a szakértők megterveznek és elméletben tárgyalnak. Az övék is rendkívül műszaki jellegű tudás, de sokkal inkább gyakorlati természetű.
- Vezetők: Ezek azok az emberek, akik üzleti, gazdasági, igazgatási, jogi, kormányzati, politikai döntéseket hoznak azokkal a dolgokkal kapcsolatban, amelyeken a szakértők és a technikusok dolgoznak. Ha ez egy új termék, ők döntenek arról, hogy legyártsák-e és forgalmazzák-e. Ha ez egy új energiatechnológia, ők döntenek arról, hogy a városnak be kell-e vezetnie. A vezetőknek valószínűleg ugyanolyan kevés műszaki ismeretük van a témáról, mint a nem szakembereknek.
- Nem szakértők:
Közönség elemzés
Fontos meghatározni, hogy az imént tárgyalt négy kategória közül melyikbe tartoznak az Ön dokumentumának lehetséges olvasói, de ezzel még nincs vége. A közönséget, a kategóriától függetlenül, továbbá olyan jellemzők alapján is elemezni kell, mint az alábbiak:
- Háttér—ismeretek, tapasztalat, képzés:
- Szükségletek és érdeklődési körök: Ahhoz, hogy megtervezd a dokumentumodat, tudnod kell, mit vár tőle a közönséged. Képzeld el, hogyan fogják az olvasók használni a dokumentumodat; mit fognak elvárni tőle. Például, képzeld el, hogy egy új okostelefon nem miről szeretnél olvasni?
- Különböző kultúrák: Ha nemzetközi közönségnek ír, vegye figyelembe, hogy az idő- és dátumformátumok, a pénzösszegek és a számok jelölésének formátumai világszerte eltérnek. Legyen tisztában azzal is, hogy a humor és a képletes nyelv (például a "hit a home run") valószínűleg nem lesz érthető a saját kultúránkon kívül. A Texas A&M Egyetem elérhetővé teszi 6. fejezet Műszaki információk jelentése, Elizabeth Tebeaux, és mások. A szabványokért lásd Stíluskalauzok listája a Wikipédiáról. (Köszönet a névtelen vendégnek, aki hozzájárult ezekhez a fontos ötletekhez.)
- Egyéb demográfiai jellemzők: És persze még sok más jellemző van az olvasóidról amelyek lehet befolyással vannak arra, hogyan kell megtervezned és megírnod a document—például, életkorcsoportok, a lakóhely típusa, a lakóhely szerinti terület, nem, politikai preferenciák és így tovább.
A közönségelemzést legalább két másik tényező is bonyolíthatja: egy dokumentumhoz tartozó vegyes közönségtípusok, a közönségen belüli nagyfokú változatosság, és ismeretlen közönségek.
- Egynél több közönség. Valószínűleg azt fogja tapasztalni, hogy a dokumentuma több közönségnek szól. Például műszaki emberek (szakértők és technikusok) és adminisztratív személyek (vezetők) is olvashatják. Mit tegyen? Vagy megírhatja az összes szakaszt úgy, hogy a dokumentum valamennyi célközönsége megértse azokat (sok szerencsét!). Vagy megírhatja minden szakaszt kizárólag annak a közönségnek, akit az érdekel, majd használjon címsorokat és szakaszbevezetéseket, hogy tájékoztassa az olvasókat arról, hová menjenek és mit hagyjanak ki a dokumentumból.
- Nagy változékonyság a közönségben. Lehet, hogy rájössz: bár a közönséged csak egy kategóriába sorolható, a hátterük nagyban változó. Ez egy nehéz ügy—ha az írásodat az olvasók legalacsonyabb közös nevezőjéhez igazítod, valószínűleg egy nehézkes, unalmas, könyvszerű valami lesz a vége, ami elriasztja az olvasók többségét. De ha nem írsz arra a legalacsonyabb szintre, elveszíted az olvasóidnak azt a szegmensét. Mit tegyél? A legtöbb író a többségre törekszik, és feláldozza azt a kisebbséget, amely több segítségre szorul. Mások a kiegészítő információkat függelékekbe teszik, vagy hivatkozásokat illesztenek kezdőknek szóló könyvekre.
Közönség-elemzés példa
Ha műszaki szövegírási kurzust végzel, előfordulhat, hogy elvárják, hogy mellékelj egy közönségleírást a műszaki dokumentumaidhoz. Íme egy példa:
| Megjegyzés az oktatónak: Ezek az utasítások azoknak szólnak, akik szeretnék egyszerűsíteni számításaikat Microsoft Excel használatával, makrók alkalmazásával, hogy hatékonyan kiszámítsák adataikat. Tudják, hogyan kell adatokat bevinni a Microsoft Excelbe, és alapvető ismeretekkel rendelkeznek a Microsoft Office csomagról. Magabiztosak a Windows alapú szoftverek használatában, és rendelkeznek alapvető számtani készségekkel, hogy ellenőrizzék számításaikat és felderítsék a logikai hibákat a számításokban. |
Közönséghez igazítás
Oké! Tehát addig elemezted a közönségedet, hogy jobban ismered őket, mint önmagadat. Mire jó ez? Hogyan használod fel ezt az információt? Hogyan kerülöd el, hogy olyasmit írj, ami az olvasóid számára még mindig érthetetlen vagy haszontalan lesz?
Az írás üzlete hoz/hez/höz a közönségednek sok köze lehet a veleszületett tehetséghez, az intuícióhoz és akár a misztériumhoz. De vannak olyan technikák, amelyeket alkalmazhatsz, hogy nagyobb eséllyel kapcsolódj az olvasóiddal. A következő "controls" többnyire arról szólnak, hogyan teheted a műszaki információkat érthetőbbé a nem szakértő közönség számára:
- Add meg azokat az információkat, amelyekre az olvasóknak szükségük van ahhoz, hogy megértsék a dokumentumodat. Ellenőrizze, hogy hiányzik-e bizonyos kulcsfontosságú információ—például egy utasítássorozat kritikus lépései; fontos háttér, amely segít a kezdőknek megérteni a fő témát; kulcsfogalmak meghatározása. (Lásd a fejezetet a ötletek a tartalommal kapcsolatban a részletekért.)
- Hagyd ki azokat az információkat, amelyekre az olvasóidnak nincs szükségük. A felesleges információk zavarhatják és frusztrálhatják az olvasókat—hiszen, ott van, és úgy érzik, kötelességük elolvasni. Például, valószínűleg elhagyhatod az elméleti részt az alapvető utasításokból.
- Változtasd meg a jelenleg rendelkezésedre álló információ szintjét. Lehet, hogy megvan a megfelelő információ, de az "pitched" túl magas vagy túl alacsony műszaki szinten van. Előfordulhat, hogy rossz típusú közönségnek szól—például, szakértői közönségnek, nem pedig technikusi közönségnek. Erre leggyakrabban akkor kerül sor, amikor a terméktervezési jegyzeteket utasításokként adják el.
- Adj példákat, hogy az olvasók megértsék. A példák az egyik leghatásosabb módjai annak, hogy kapcsolatot teremtsünk a közönséggel, különösen az utasításokban. Még nem oktató jellegű szövegben is, például amikor egy műszaki fogalmat próbálsz elmagyarázni, a példák nagy segítséget jelentenek—különösen az analógiák.
- Módosítsd a példáid szintjét. Előfordulhat, hogy példákat használsz, de a technikai tartalom vagy a szint nem megfelelő az olvasóid számára. A házi példák nem biztos, hogy hasznosak a szakértőknek; a túlságosan technikai példák pedig teljesen elkerülik a nem szakértő olvasóidat.
- Változtasd meg az információid szervezését. szerkezet és szervezet egy dokumentumban található információ.)
- Erősítsd az átmeneteket. Az olvasók számára, különösen a nem szakembereknek, nehéz lehet meglátni a kapcsolatokat a dokumentum fő részei között, az egyes bekezdések között, és néha még az egyes mondatok között is. Sokkal világosabbá teheti ezeket a kapcsolatokat azzal, hogy hozzáad átvezető szavak és visszhangozva kulcs szavak nem jó ötlet a szóhasználat változtatása—ugyanazokat a szavakat használni, hogy az emberek ne legyenek még jobban összezavarodva, mint amennyire már lehetnek. (Lásd a fejezetet a átmenetek.)
- Írjon erősebb bevezetőket—mind a teljes dokumentumhoz, mind a főbb szakaszokhoz. bemutatkozások mind a teljes jelentésekre, mind a jelentéseken belüli szakaszokra.)
- Készítsen témamondatokat bekezdésekhez és bekezdéscsoportokhoz. áttekintések és témamondatok használata.)
- Változtasd meg a mondat stílusát és hosszát. lenni igei megfogalmazás. Mindebből az következik, hogy az írásod közvetlenebb és azonnalibb lesz—az olvas gyakori mondatstílus-problémák részletekért.)
És nyilvánvalóan, a mondathossz is számít. Átlagosan mondatonként valahol 15 és 25 szó között van az ideális; a 30 szónál hosszabb mondatok gyanúsak. - Dolgozz a mondatok világosságán és tömörségén. gyakori mondatstílusbeli és érthetőségi problémák részletekért.)
- Használjon több vagy más grafikát. grafika további részletekért.)
- Oszd fel a szöveget, vagy egyesítsd azt értelmes, használható részekre. Nem szakértő olvasók számára előfordulhat, hogy rövidebb bekezdésekre van szükség. Talán egy 6–8 soros bekezdés a szokásos maximum. Figyelje meg, mennyivel hosszabbak a bekezdések a szakértőknek írt műszaki dokumentumokban.
- Adj kereszthivatkozásokat a fontos információkhoz. A műszaki információkban segíthet a nem szakértő olvasóknak azáltal, hogy háttérforrásokra irányítja őket. Ha egy témát nem tud azonnal teljesen elmagyarázni, mutasson rá arra a szakaszra vagy fejezetre, ahol az megtalálható. (Lásd a fejezetet a kereszt-hivatkozások részletekért.)
- Használj címsorokat és listákat. Az olvasókat megfélemlíthetik a nagy, sűrű szövegblokkok, amelyeket legfeljebb időnként tör meg egy üres sor. Keress a vázlataidban olyan módokat, hogyan iktathatnál be címsorokat—keress témaváltozásokat vagy alfejezet-váltásokat. Keress a szövegedben felsorolásra alkalmas elemeket—ezeket függőleges listákká lehet alakítani. Keresd a páros felsorolásokat, például a kifejezéseket és definícióikat—ezeket kétoszlopos listává lehet alakítani. Természetesen légy óvatos, hogy ne kényszerítsd rá ezt a speciális formázást—ne vidd túlzásba. (Lásd a fejezeteket a címsorok és listák a részletekért.)
- Használj speciális tipográfiát, és dolgozz margókkal, sorhosszúsággal, sorközzel, betűmérettel és betűstílussal. A nem szakértő olvasók számára érdemes olyan dolgokat alkalmazni, mint a sorok rövidebbé tétele (a margók behúzásával), nagyobb betűméretek használata és egyéb hasonló módszerek. Egyes betűstílusokat barátságosabbnak és olvashatóbbnak tartanak, mint másokat. (Próbáljon meg találni valakit a kiadói szférában, hogy tanácsot kapjon a betűtípusokról.)
Helyzetelemzés & Feltalálás
Nem elég csupán kiválasztani egy témát és meghatározni a közönséget egy műszaki szövegírási projekthez. Tudnod kell (vagy kitalálnod) a helyzet amiben ez a közönség működik—mik a céljai: egy problémát megoldani, fejlesztést lehetővé tenni, támogatni a döntéshozatalt? A műszaki dokumentáció írásának helyzetei valószínűleg éppoly végtelenek, mint az emberi társas kapcsolatok. Egy műszaki dokumentációs helyzet magában foglal egy közönséget, amely bizonyos típusú műszaki dokumentációt igényel vagy kér a saját speciális szükségleteihez és felhasználásaihoz. Részletekért lásd: Helyzetelemzés és feltalálás
Kapcsolódó információk
Olvasási kvíz. Használd ezt a kvízt, hogy teszteld ennek a fejezetnek a megértését.
Képzés elérhető. Szerezz egy kis gyakorlatot az írásban McMurrey mint az oktatód.
Kérdőívek használata a közönség mélyebb megismeréséhez. BrightTalk
Közönség. Észak-karolinai Egyetem (Chapel Hill)
Értékelném a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban: a válaszod—David McMurrey
