< Kiemelés

Kiemelés, ahogyan ezt a kifejezést itt használják, a tipográfiai hatások alkalmazását jelenti a szöveg figyelemfelkeltése érdekében. Ezek a hatások közé tartozhatnak a dőlt betű, a félkövér, a teljes nagybetűs írásmód, az idézőjelek, a szín és így tovább. A kiemelés felhívja az olvasók figyelmét—vagy "jelez" nekik"— a teendőkre, amelyeket el kell végezniük, vagy olyan információkra, amelyeket gondosan meg kell fontolniuk.

A műszaki írás egyik problémája—különösen a számítógépekről szóló műszaki írás—a hangsúlyozás különböző technikáinak használata. Sajnos néhány műszaki szöveg túlzásba viszi az itt tárgyalt különféle hangsúlyozási technikák használatát.

A kiemelés alapjai

Vegyünk figyelembe néhány alapvető hangsúlyozási elvet:

A következő megbeszélésben észre fogod venni, hogy bármely hangsúlyozási technikák rendszere meglehetősen bonyolulttá és nehezen megjegyezhetővé válhat az írók és szerkesztők számára. Észre fogod venni, hogy sok egyenértékűen helyes módja van a hangsúlyozási technikák használatának: például egyes esetekben tetszőleges, hogy félkövér vagy dőlt betűt használsz-e egyszerű hangsúlyozáshoz. A probléma megoldásához dokumentálnod kell a kiemelési irányelveidet egy stíluskalauzban, amelyhez az írók és a szerkesztők (vagy egyszerűen te magad) fordulhatnak. Egy stílus útmutató Ez egyszerűen egy nyilvántartás azokról a döntésekről, amelyeket Ön és a dokumentációs csapata hoztak arról, hogyan szeretnék, hogy a dokumentumok kinézzenek.

Az olvasóidnak azt is tudniuk kell, milyen kiemelési sémát tervezel használni. Ezt az előszóban lehet kezelni: tartalmazzon egy „Kiemelés” vagy „Tipográfiai konvenciók” című szakaszt, amelyben felsorolod, hogyan használod a dőlt betűt, a félkövért, a betűtípusokat és az ehhez hasonló hatásokat. Példaként lásd az előszókról szóló megbeszélést a ... fejezetben Műszaki könyvek szabványos összetevői

Konkrét hangsúlyozási technikák

A következő rész sorra veszi a különböző kiemelési technikákat, és ismerteti a bevett gyakorlatokat.

Megjegyzés: Az egyszerűség kedvéért, a problémák kiemelésére asztalok, ábrák, címsorok, listák, és értesítések Az említett szakaszokban kerülnek bemutatásra.

Félkövér

A kiadói gyakorlatban, különösen a műszaki kiadványoknál, megosztott a vélemény arról, hogy alapvető hangsúlyozáshoz félkövér vagy dőlt betűt használjanak. Például, ha hangsúlyozni szeretnéd, hogy az olvasók ne kapcsolják ki a számítógépet anélkül, hogy előbb leállítanák, a „nem” lehet félkövér vagy dőlt. Hagyományosan dőlt betűt alkalmaztak, de talán a számítógépek miatt a félkövér is gyakran használatos.

Bármely technikát is használod, alkalmazd következetesen az egész szövegben vagy a kapcsolódó szövegek gyűjteményében. Egyébként az olvasók valószínűleg nem fogják tudni megkülönböztetni a hangsúlyozás fokozatait: például ha dőlt betűt használsz a fontos szöveghez és félkövért a nagyon fontoshoz, azt a legtöbb olvasó valószínűleg nem veszi észre.

Ha csábítást érzel arra, hogy az egész bekezdést félkövérré tedd, emlékezz az egyik fent tárgyalt hangsúlyozási elvre: a hangsúlyozó technika túlzott használata elveszíti a technika hatását. Nemcsak ez, de a túl sok hangsúlyozás csökkenti az olvasók olvasási hajlandóságát. Ahelyett, hogy figyelmesen elolvasnák egy teljesen félkövér bekezdést, az olvasók egyszerűen teljesen figyelmen kívül hagyhatják azt!

Egy teljesen félkövér bekezdés létrehozása helyett használd a különleges értesítési formátum. Ebben egy kulcsszó (például Fontos, Megjegyzés, Veszély, Vigyázat, Figyelmeztetés) félkövérrel van kiemelve, míg a többi szöveg normál római marad (azaz ugyanaz a betűtípus és stílus, mint a normál törzsszöveg).

A félkövér jogos használata a műszaki szövegekben nagyon változó. Ha olyan rendszert dolgozol ki, amely közvetlenül kapcsolódik az olvasó igényeihez és a szöveg (vagy a technológia) jellemzőihez, és nem megy túlzásba, a félkövér használata jól fog működni.

Íme néhány gyakori, szabványos felhasználási mód a félkövér formázásnak:

Észre fogod venni, hogy a megelőző megbeszélés nem állapított meg abszolút szabályokat. Így van ez—a műszaki kiadói gyakorlat meglehetősen változó. A fő ötlet az, hogy dolgozz ki egy logikus, szabályozott kiemelési rendszert, használd következetesen, és dokumentáld egy stílusútmutatóban, hogy te és a dokumentációs csapatod tagjai hivatkozhassatok rá.

Dőlt betűk

Íme néhány általános eset, amikor dőlt betűt használunk:

Alulvonások

Szinte semmi oka nincs az alsóvonások (underscore) használatának műszaki szövegben. A gépírásos korszakban bizonyosan volt. Azonban manapság, amikor a félkövér, a dőlt és más hasonló tipográfiai hatások könnyen elérhetők, az alsóvonások elavultnak tűnnek. Ha valamit ki szeretnél emelni, kövesd a szokásos irányelveidet—például használj dőlt betűt vagy félkövért. Ne próbálj hangsúlyozási fokozatokat létrehozni: például a dőltől a félkövérig, majd az alsóvonásig terjedő, növekvő fontosság skáláját az olvasóid nem fogják érzékelni.

Ha technikai szövegben jól alkalmazzák az alulvonásokat, az valószínűleg a címsorok kialakításában fordul elő.

Nagybetűzés

A műszaki kiadványszerkesztésben úgy tűnik, folyamatos vita dúl a műszaki írók és a műszaki szakértők között a nagybetűhasználatról. A műszaki szakértők szívesen alkalmaznak kezdőnagybetűt gyakorlatilag a rendszerben található minden komponens és folyamat nevéhez. Emellett a műszaki szakértők (és a vezetés) rendszerint teljes nagybetűs írást használnak az olyan szöveghez, amelyet fontosnak tartanak, és amelyre az olvasók figyelmét fel szeretnék hívni. Eközben a műszaki írók és szerkesztők (joggal) ragaszkodnak ahhoz, hogy nagybetűt csak sajátnevekhez használjanak.

Mint műszaki író, állj ellen a nagybetűhasználatnak. A nagybetűk elvonják a figyelmet; a teljes nagybetűs szöveg kényelmetlen olvasni. A nagybetűk zsúfolttá teszik a szöveget, ami sok felesleges jelzést küld. A nagybetűket hagyományosan tulajdonnevekhez használják, például a Microsoft, Netscape, Gateway, Dell Computers, WordPerfect és így tovább. A műszaki kiadványszerkesztés klasszikus irányelve, hogy nagybetűvel írják a neveket. külön megrendelhető termékek Csak. Azonban a szervezetek politikája lényegesen meghajlítja ezt az irányelvet. Ha egy cég büszke egy bizonyos, az új kiadásában szereplő funkcióra, például az EnergyMiserre, nagybetűvel írja azt, még akkor is, ha külön nem lehet megrendelni.

Íme néhány tipikus irányelv a nagybetűk használatához:

Egyszeres vagy dupla idézőjelek

A műszaki szövegekben az idézőjeleket gyakran tévesen használják hangsúlyozásra. Műszaki szövegíróként korlátozd az idézőjelek használatát a hagyományos alkalmazásra, amely magában foglalja az idézett beszédet, valamint a számokat, betűket vagy olyan szavakat, amelyekre így hivatkoznak. Az idézőjelek, akárcsak a nagybetűk, hajlamosak zsúfolt, zavaró szöveget létrehozni, ezért kerülendők.

A dupla idézőjelek egyik jogos használata a szavak furcsa, különc, nem szabványos használata (amit "ijesztő idézőjeleknek" neveznek a Chicago stílus kézikönyve). Például:

Egy memóriakép során a számítógép az összes adatot egyetlen fájlba 'felöklendezi'.

A jól megtervezett számítógépes szöveg meglehetősen határozottan kerülni szokta az idézőjeleket. Az egyik fő oka az, hogy egyes olvasók tévesen azt feltételezhetik, hogy a beírandó parancsokba is bele kell foglalniuk az idézőjeleket.

Ahelyett Használd a „move” parancsot.
Írj Használja a mozogni parancs.
helyett Írja be "copy install installnow."
Írj Írja be másolás telepítés telepítés most

Megjegyzés: Bár néhány műszaki szövegben jól meghatározott az egyszeres idézőjelek használata, általánosságban nincs szabványos alkalmazásuk az egyszeres idézőjeleknek a hagyományos idézeten belüli idézet szabályán és a szokatlan használat szabályán kívül. Amikor műszaki szövegben egyszeres idézőjeleket látunk, általában nincs több ésszerű indok a használatukra, mint amennyi a dupla idézőjelek használatára van.

Alternatív betűtípusok

Az egyik leggyakoribb stílus, amely váltakozó betűtípusokat használ, az, hogy Courier-t vagy valamilyen hasonló, monospaced, régi írógép-stílusú betűtípust alkalmaznak a szokásos törzsszöveg-betűtípussal (például Times New Roman vagy Helvetica) szemben. Ezt a hatást egy 1web-oldalon létrehozhatja egy olyan CSS-stílussal, mint <span class="example_text">. Például, "gépel telepítés a program telepítéséhez.

Íme egy áttekintés az alternatív betűtípusok gyakori felhasználásáról:

Szín

A színek használata a műszaki szövegben gyakori, de költséges és nehéz kezelni a kiadványozási ciklus során.

A színek könnyen használhatók az online információkban. Gyakran előfordul például, hogy a hiperhivatkozások színt használnak. Az online súgók általában zöldet használnak, míg a weboldalak az új hivatkozásokat tipikusan kékkel, a már megtekintett hivatkozásokat pedig lilával jelölik.

A hajlam, hogy megkülönböztetés nélkül használjunk színeket az online információkban, nagyon hasonló ahhoz a hajlamhoz, hogy a nyomtatott anyagokban túlzásba vigyük a félkövér és dőlt betűket, a különböző betűméreteket és az alternatív betűtípusokat. Az érzés valami ilyesmi lehet: „Ott van, menő, hát használjuk!”

Ha színt szeretne használni, gondosan tervezze meg. Ne számítson rá, hogy az olvasók emlékezni fognak arra, hogy a piros egy ötletet jelez, a kék egy másikat, a zöld pedig még egy harmadikat. Egyszerűen ragaszkodjon egy színhez. Általában kerülje a szín használatát hosszabb szövegek esetén. Ahelyett, hogy az egész figyelmeztető értesítést pirosra színezné, csak a „Figyelmeztetés” címkét tegye pirossá, és hagyja a figyelmeztető szöveget normál római betűsnek (olyan szövegnek, mint a szokásos törzsszöveg).

Még jobb, ha elolvas néhány alapvető szakirodalmat a műszaki kommunikáció területén a színekről. Vannak általános tervezési kérdések és nemzetközi kérdések:

Az előzőek kombinációi

Általánosságban rossz ötlet kombinálni a kiemelési technikákat, például a félkövér és a dőlt betűt. Nem professzionális műszaki szövegekben gyakran látni ilyen rikító kombinációkat, mint a csupa nagybetűs, félkövér–dőlt szedés, vagy a csupa nagybetűs, félkövér–dőlt szedés dupla idézőjelekkel. Kerüld ezeket!

Egy elfogadott kombináció a dőlt betű alkalmazása alternatív betűtípusokkal. Például, amikor egy parancs szintaxisát mutatod, az egész szöveget Courier betűtípussal szeretnéd, de a változókat dőlt betűvel:

másolat Régi fájlnév Új fájlnév

Karakterstílusok és címkék funkcionális nevei

Ha valaha is megfordultál a kiadói ipar környékén, előfordulhat, hogy találkoztál valamivel, amit úgy hívnak szemantikus jelölés. Ez azt jelenti, hogy a szöveg szakaszait azok alapján nevezzük el, hogy milyen szerkezeti szerepet töltenek be a dokumentumban—például, címsor. Az olvasó nem látja ezeket a neveket, de fontos szerepet játszanak abban, hogy a dokumentum hogyan van formázva és hogyan használható újra.

Ugyanez az elv érvényes a szövegben található kifejezések szavaira is. Például egy weboldal HTML-jében használhatod a <b>félkövér szó</b> Tagek egy szó félkövérré tételéhez. De a félkövér formázás nem jelzi a szó vagy kifejezés funkcióját. Ehelyett, parancs lenne vagy interfész_címke lenne. Ezért a HTML és a CSS használatán alapuló szemantikus jelölés esetén a dolgok funkcionálisabbak, ha így néznek ki: <span class="command">félkövér szó</span>.

HTML-t és CSS-t használó fájlokat általában más médiákra, például PDF-re vagy akár XML-be és XML-ből konvertálják. Használva funkcionálisan A fentebb leírt nevezett kiemelési stílusok nagymértékben megkönnyíthetik az átalakítási folyamatot.

További felfedezések

Miután elolvastad az előzőt, érdemes ezután műszaki kiadványokat böngészni, hogy megnézd, milyen kiemelési sémákat használnak. Figyeld, hogy az olyan hatásokat, mint a félkövér, dőlt, nagybetűk, alternatív betűtípusok és egyéb hasonló megoldások hogyan alkalmazzák. Valószínűleg nagyon eltérő használatot fogsz látni attól, amit itt olvastál. Ahogy tanulmányozod őket, gondolkodj azon a logikán, amelyet az általad látott hangsúlyozó technikák követnek; próbáld meg megfogalmazni azokat a szabályokat, amelyeket a szerzők láthatóan alkalmaznak; figyelj a kiemelések következetlenségeire; és kritikusan vizsgáld meg a látott használatot—logikus ez? túlzás? "túl kevés?"

Miután végeztél némi ilyesfajta felfedezéssel, a következő logikus lépés az, hogy elolvasd a fejezetet a stílus útmutatók, ha még nem tetted meg. A kiemelési sémákat dokumentálni kell a stílusútmutatókban, hogy ne felejtsd el őket, és hogy a dokumentációs csapat tagjai hivatkozhassanak rájuk.

Kiemelési séma

Ha az előbb ismertetett összes opció és alternatíva túl soknak tűnik számodra, fontold meg a következő kiemelési séma alkalmazását. Ez azon a kiemelési módszeren alapul, amelyet sok UNIX-, Windows- és Linux-dokumentumban találsz.

Mezők, mappák, párbeszédablakok (dobozok), menük nevei (bármely felhasználói felület objektum, amit a felhasználók tesznek nem kattintson erre) Nagybetű-stílus a képernyőn; normál római
Ikonok nevei Nagybetűs stílus a képernyőn; félkövér
Gombok (vagy azok funkcionális megfelelője, ha nem így vannak megjelölve) Nagybetűs stílus a képernyőn; félkövér
Menüválasztások, kiválasztható opciók Nagybetűs stílus a képernyőn; félkövér
Parancsok szó szerint megadva, paraméterek és kapcsolók nélkül Félkövér
Beírt vagy megjelenített szöveg Courier New (ha szükséges, a törzsszöveg betűméreténél 1 ponttal kisebb)
Változók Dőlt betű; normál római
Programozási kód Courier New; normál római; ha szükséges, a törzsszöveg betűméreténél 1 ponttal kisebb.
Címkék a hardveren Courier New; félkövér; ha szükséges, 1 ponttal kisebb, mint a törzsszöveg betűmérete

  • Megjegyzések:

    1. Normál római Arra utal, hogy a törzsszöveghez bármilyen betűtípust és betűméretet használnak.
    2. Bár ezek az ajánlások a „képernyőn alkalmazott nagybetűs stílust” javasolják, a fejlesztők néha sajnálatos módon hajlamosak mindent nagybetűvel írni. Mivel az összes nagybetűs stílus rontja az olvashatóságot, mindazonáltal használjon kezdő nagybetűket (címszerű nagybetűzést).
    3. Ha megmutatod a felhasználóknak, hogyan írjanak be egy parancsot példa szöveggel együtt, ne tedd félkövérré azt a parancsot, amely a példa szövegben szerepel:
    4. Használja a mv parancs a fájl nevének vagy helyének megváltoztatásához, például:
      mozgat ezafájl.txt azafájl.txt.

    5. Ha megmutatod a felhasználóknak, hogyan kell beírni egy parancsot példaszöveget is tartalmazva, és a példaszövegben *változókat* is szerepeltetsz, a *változókat* dőlt betűvel tüntesd fel.
    6. Használja a mozgat parancs a fájl nevének vagy helyének megváltoztatásához:
      mozgat I don't see the file contents. Please paste the text from my_file.txt that you want translated. a_fájlod.txt.

    7. Ha egyszerűen egy olyan képernyő vagy menü nevét említi, amelyre nem kattintanak és amely nem indít el semmilyen eseményt, használja a nagy kezdőbetűs stílust a képernyőneveknél, és a normál római stílust.
    8. Egyes stílusok félkövérrel emelik ki azt a műveletet, amelyet a felhasználóknak végre kell hajtaniuk (például, sajtó, belépni, törlés). Az bizonyosan egy lehetőség, de számomra ez túl sok kiemelés.

    A felhasználói útmutatók gyakran az előszóban helyeznek el egy táblázatot a kiemelésre használt betűtípusok, színek és tipográfia jelentéséről:

    Highlighting chart


    Értékelném a gondolataidat, reakcióidat és kritikádat ezzel a fejezettel kapcsolatban: a válaszod.