Zvýraznenie a dôraz

Povedz nám, kde sa nachádzaš!

Obsah tejto kapitoly

Zvýraznenie základov
Špecifické techniky dôrazu

Bežné problémy s zvýrazňovaním
Ďalšie prieskumy
Značkovací schéma

Vaše komentáre k tejto kapitole

Hľadaj!

Hlavný index

Zvýraznenie, ako sa tento pojem používa tu, je používanie typografických efektov na upútanie pozornosti na text. Tieto efekty môžu zahŕňať kurzívu, tučné písmo, veľké písmená, úvodzovky, farbu a podobne. Zvýraznenie priťahuje pozornosť čitateľov—alebo "naznačuje"—im akcie, ktoré musia vykonať, alebo informácie, ktoré musia dôkladne zvážiť.

Jedným z problémov v technickom písaní—konkrétne v technickom písaní o počítačoch—je použitie rôznych techník na zdôraznenie. Bohužiaľ, niektoré technické texty to preháňajú s použitím rôznych techník zdôraznenia, ktoré sú tu prediskutované.

Základy zvýrazňovania

Zvážte niektoré základné princípy dôrazu:

• Prakticky akýkoľvek špeciálny textový efekt, ktorý sa líši od bežného textu, môže slúžiť ako technika dôrazu. Veci ako kurzíva, tučný text, podčiarkovanie, písanie veľkými písmenami, rôzne veľkosti písma, alternatívne písma, farba, rôzne grafické nápady (zobrazenie, obrátené farby, kontúrové písmo) môžu pôsobiť ako techniky dôrazu.
• Použité v nadbytku, akákoľvek technika dôrazu alebo kombinácia techník dôrazu môže stratiť svoju schopnosť zdôrazniť a stať sa preplnenou a rušivou. Použité v nadbytku, akákoľvek technika dôrazu alebo kombinácia techník dôrazu môže spôsobiť, že čitatelia sa budú zdráhať čítať text, ak ho úplne nebudú obchádzať. Všimnite si, ako nečitateľná je príliš zvýraznená verzia oznámenia v tomto. vyskakovacie okno; tiež si všimnite, že nepoužíva odporúčaný typ oznámenia v oznámenia.
• Keď je potrebné zdôrazniť dlhší text, použite špeciálne-oznámenie formát (namiesto vytvárania celkom tučných alebo celkom veľkých odsekov, napríklad).
• Musí existovať starostlivo naplánovaný funkčný vzťah medzi textom, ktorý je zdôraznený, a technikou zdôraznenia, ktorá sa používa.
• Techniky dôrazu musia byť používané konzistentne, aby sa predišlo zmätku čitateľov.
• Aby ste podporili konzistenciu, musíte použiť štýlový sprievodca alebo štýlový list, ktorý zaznamenáva a potom určuje všetky vaše rozhodnutia o tom, ako budete používať techniky dôrazu.
• Aby ste pomohli svojim čitateľom pochopiť váš systém zvýraznenia, môžete zahrnúť krátku časť niekde vo vašom dokumente (zvyčajne v predslove), ktorá vysvetľuje, ako plánujete používať techniky dôrazu.

V nasledujúcej diskusii si všimnete, že akýkoľvek systém techník zvýraznenia môže byť dosť zložitý a pre spisovateľov a redaktorov ťažko zapamätateľný. Všimnete si, že existuje mnoho rovnako platných spôsobov, ako používať techniky zvýraznenia: napríklad v niektorých prípadoch je na vás, či použijete tučný alebo kurzívny text na jednoduché zvýraznenie. Aby ste tento problém vyriešili, musíte zdokumentovať svoje pokyny k zvýrazneniu v štýlovom sprievodcovi, na ktorý sa môžu odvolávať spisovatelia a redaktori (alebo len vy). A príručka štýlu je to jednoducho záznam rozhodnutí, ktoré ste vy a váš tím dokumentácie prijali o tom, ako chcete, aby vaše dokumenty vyzerali.

Vaši čitatelia by mali byť tiež informovaní o schéme zvýraznenia, ktorú plánujete použiť. Toto môžete riešiť v predslove: zahrňte sekciu nazvanú "Zvýraznenie" alebo "Typografické konvencie", kde uvediete, ako používate kurzívu, tučné písmo, písma a iné také efekty. Pre príklad si pozrite diskusiu o predslovoch v kapitole o štandardné komponenty technických kníh

Špecifické techniky dôrazu

Táto nasledujúca časť prechádza jednu po druhej rôznymi technikami dôrazu a vysvetľuje bežné praktiky.

Poznámka: Aby sme to udržali jednoduché, upozorňujeme na problémy pre stoly, figúry, nadpisy, zoznamy, a oznámenia sú predstavené v týchto sekciách.

Tučný

V publikovaní, najmä technickom publikovaní, je používanie tučného písma alebo kurzívy na základné zdôraznenie rozdelené. Napríklad, ak chcete zdôrazniť, že čitatelia by nemali vypnúť počítač, kým ho najprv nevypnú, slovo "nemali" môže byť tučné alebo kurzívou. Tradične sa používala kurzíva, ale možno kvôli počítačom sa takéž často používa tučné písmo.

Akúkoľvek techniku použijete, používajte ju konzistentne v celom svojom texte alebo v knižnici súvisiacich textov. Mimochodom, čitatelia pravdepodobne nebudú schopní rozlíšiť medzi úrovňami dôrazu: napríklad používanie kurzívy pre dôležitý text a tučného písma pre veľmi dôležitý text pravdepodobne pre väčšinu čitateľov nedosiahne svoj účinok.

Ak máte pokušenie urobiť celý odseok tučný, pamätajte na jednu z princípov zdôraznenia, o ktorých sme sa vyššie rozprávali: použitie príliš veľkého množstva techniky zdôraznenia spôsobuje stratu účinku tejto techniky. Nielen to, ale prílišné zdôraznenie robí čitateľov menej naklonenými čítať. Namiesto dôkladného čítania celého tučného odseku ho čitatelia môžu úplne ignorovať!

Namiesto vytvárania celého odseku v tučnom písmene, použite špeciálne-oznámenie formát. V ňom je kľúčové slovo (napríklad Dôležité, Poznámka, Nebezpečenstvo, Opatrnosť, Varovanie) tučné, zatiaľ čo zvyšok textu je ponechaný v bežnom písmene (t.j. v rovnakom písmene a štýle ako bežný text).

Legitímne použitie tučného písma v technických textoch sa veľmi líši. Pokiaľ vyviniete schému, ktorá je priamo spojená s potrebami čitateľa a charakteristikami textu (alebo technológie) a nevedie k prehnanosti, vaše použitie tučného písma by malo fungovať dobre.

Tu sú niektoré bežné, štandardné použitia tučného písma:

• Jednoduchý dôraz. Ako bolo diskutované vyššie, niektoré technické texty používajú tučný písmo na jednoduché zdôraznenie namiesto tradičných kurzív. Napríklad, "Urobte nie "Vypni počítač pred jeho vypnutím."
• Príkazy. Počítačové texty bežne používajú tučný písmo pre príkazy, napríklad „Použite the premiestniť príkaz na premenovanie súborov UNIX. Pozrite si sekciu o zvýraznení počítačového textu pre prehľad kompletného súboru techník dôrazu.
• Tlačidlá, ktoré spúšťajú príkazy. V grafickom používateľskom rozhraní niektoré tlačidlá spúšťajú príkazy. Napríklad "stlačte the Výstup "Tlačidlo na ukončenie aplikácie."
• Popisy polí. Aj keď niektoré počítačové texty zvýrazňujú názvy polí tučným písmom, nie je to bežná prax, pretože vedie k prehnanému zvýrazneniu. Napríklad, "V Zarovnanie oblasť dialógového okna, kliknite na Ľavá." Bežnejšie je používať štýl písma, ktorý sa používa na obrazovke. Je lepšie napísať toto: "V oblasti odsadenia dialógového okna kliknite na Ľavý."
• Ikony alebo klávesy na klávesnici alebo tlačidlá myši. Aj keď nie je univerzálne dodržiavaná, ďalšia technika zvýraznenia, ktorá logicky vychádza z tohto systému, je tučné písmo pre názov klávesy na klávesnici alebo tlačidla myši. Napríklad, "Stlačte tlačidlo Q kľúč alebo vľavo myš tlačidlo." V súlade s týmto systémom je tiež používať tučný text na ikonách: "Kliknite na Začiatok ikona."
• Štítky na hardvéri. Ďalšou praxou, ktorá je bežná v oblasti počítačového publikovania, je vystupovať názov hardvérovej značky tučným písmom. Napríklad, "Stlačte Resetovať tlačidlo na reštartovanie počítača.

Určite si všimnete, že predchádzajúca diskusia neuviedla žiadne absolútne pravidlá. Tak to je—technická publikácia je dosť rôznorodá. Hlavná myšlienka je vyvinúť logický, kontrolovaný systém zvýrazňovania, používať ho konzistentne a zdokumentovať ho v štýlovom manuáli, aby ste sa naň mohli odvolávať vy a členovia vášho dokumentačného tímu.

Kurzíva

Tu sú niektoré štandardné použitia kurzívy:

• Jednoduchý dôraz. Ako bolo spomenuté skôr, používanie je zmiešané, pokiaľ ide o to, či použiť tučné písmo alebo kurzívu na jednoduché zdôraznenie, aj keď kurzíva bola tradičná: napríklad, "Rob nie "Vypnite počítač pred jeho vypnutím." Akýkoľvek spôsob použijete, buďte s ním konzistentní a zaznamenajte ho do svojho štýlového sprievodcu alebo štýlového listu, aby ho každý člen vášho dokumentačného tímu mohol vidieť. Ak si nie ste istí, ktorý použiť, použite kurzívu na jednoduché zdôraznenie: je to menej rušivé.
• Premenné . V počítačovom publikovaní je jedným z najbežnejších použití kurzívy pre premenné. Napríklad:
  
  skopírujte starápáka novápáka
  
  Používatelia vedia, že nemajú písať stará súbor or nový súbor ale namiesto toho, aby použili svoje vlastné názvy súborov.
• Definície v definíciách (dvojstĺpcové) zoznamy. Hoci je tučný text bežnejší pre položky v ľavom stĺpci dvojstĺpcového zoznamu, kurzíva sa tiež používa. (Pozrite si diskusiu o dvojstĺpcových zoznamoch v predchádzajúcej časti o tučnom písmene.)
• Podmienky, kde je termín definovaný. Pekný detail je kurzívou zvýrazniť slovo, kde je definované v bežnom texte.

Podtržníky

Takmer neexistuje dôvod na používanie podčiarkovania v technickom texte. V časoch písaného textu to určite malo zmysel. Avšak v týchto časoch, keď sú tu k dispozícii tučné, kurzívou a iné typografické efekty, podčiarkovanie vyzerá zastaralo. Ak chcete niečo zdôrazniť, použite svoje štandardné pokyny—napríklad, použite kurzívu alebo tučné písmo. Nepokúšajte sa vytvárať stupnice dôrazu: napríklad stupnica rastúcej dôležitosti od kurzívy po tučné písmo po podčiarknutie bude vašim čitateľom skrytá.

Ak vidíte dobré použitie podčiarkovníkov v technickom texte, pravdepodobne sa objaví v dizajne nadpisov.

Kapitalizácia

V technickom vydavateľstve sa zdá, že prebieha neustála bitka medzi technickými spisovateľmi a technickými expertmi ohľadom veľkých písmen. Technickí experti radi používajú veľké písmená pre prakticky každý komponent a proces v systéme. Taktiež technickí experti (a manažment) zvyčajne používajú všetky písmená veľké pre text, ktorý považujú za dôležitý a na ktorý chcú, aby čitatelia venovali pozornosť. Medzitým technickí spisovatelia a editori (správne) trvajú na používaní veľkých písmen iba pre vlastné mená.

Ako technický spisovateľ, dodržiavajte pravidlo proti veľkým písmenám. Veľké písmená sú rušivé; text písaný veľkými písmenami je nepríjemné čítať. Veľké písmená vytvárajú preplnený text, ktorý vysiela veľa zbytočných signálov. Veľké písmená sú tradične určené pre vlastné mená ako Microsoft, Netscape, Gateway, Dell Computers, WordPerfect a tak ďalej. Klasické pravidlo v technickom publikovaní je písať s veľkým písmenom názvy samostatne objednateľné produkty iba. Avšak, politika organizácií výrazne ohýba túto smernicu. Ak je spoločnosť hrdá na určitú vlastnosť vo svojej novej verzii, napríklad EnergyMiser, bude ju písať veľkými písmenami, aj keď ju nie je možné objednať samostatne.

Tu sú niektoré typické pokyny pre veľké písmená:

• Použite presný štýl veľkých písmen pre správy zobrazené na počítačovej obrazovke, menu alebo názvy obrazoviek, názvy polí, štítky hardvéru a podobne. (V starších rozhraniach sa na veci ako názvy polí, menu a obrazoviek používali veľké písmená. Bežnou praxou v týchto prípadoch je použiť počiatočné veľké písmená pre odkazy na tieto veci v bežnom texte. Princípom je, že zbytočné používanie veľkých písmen v bežnom texte je rušivé.)
• Do nie použite ITALIKY alebo TUČNÝ TEXT namiesto veľkých písmen na zdôraznenie.
• Nepožívajte veľké písmená pre žiadny rozšírený text; používajte špeciálne-oznámenie formát namiesto.
• Nerobte veľké písmená názvov komponentov alebo procesov produktu. Veľké písmená používajte iba pri názvoch produktov, teda komponentov, ktoré je možné objednávať samostatne.
  
  Napríklad váš produkt sa môže volať WordStuff a samozrejme by mal byť písaný s veľkým písmenom podľa štýlu, ktorý určujú marketingoví a produktoví plánovači. Avšak jedna z funkcií WordStuffu nazvaná "kontrola pravopisu" by nemala byť písaná s veľkým písmenom—nemá to takmer nikto. Avšak WordStuff môže mať funkciu nazvanú "ZippyFormat" a ďalšiu nazvanú "Image Worker." Hoci tieto nie sú objednávateľné samostatne, budete chcieť použiť štýl s veľkým začiatočným písmenom kvôli ich osobitnému štýlu a marketingovej hodnote. "Image Worker" je zjavne niečo, čo chce WordStuff, Inc., predviesť—preto veľké písmená.
  
  Ale keď musíte porušovať pravidlá takto, výnimky by mali byť zahrnuté v štýlovom sprievodcovi alebo štýlovom liste.

Jednoduché alebo dvojité úvodzovky

Úvodzovky sa často nesprávne používajú ako techniky na zvýraznenie v technickom texte. Ako technický spisovateľ obmedzte úvodzovky na tradičné používanie, ktoré zahŕňa citované vyjadrenie; čísla, písmená alebo slová uvedené ako také. Úvodzovky, podobne ako veľké písmená, majú tendenciu vytvárať rušivý, preplnený text a preto by sa im malo vyhýbať.

Jedným legitímnym použitím úvodzoviek je zvláštne, originálne, nestandardné použitie slov (nazývané "strašidelné úvodzovky" od Chicago Manuel štýlu). Napríklad:

V core dump-e počítač "vyvrhne" všetky údaje do jedného súboru.

Dobre navrhnutý text na počítači sa vyhýba úvodzovkám celkom dôrazne. Jedným z hlavných dôvodov je, že niektorí čitatelia by si mohli nesprávne myslieť, že musia zahrnúť úvodzovky do príkazov, ktoré zadávajú.

Poznámka: Hoci niektoré technické texty majú jasne definované použitie pre jediné úvodzovky, vo všeobecnosti neexistuje štandardný spôsob použitia jedných úvodzoviek, okrem tradičného pravidla citácie v citácii a pravidla podivného použitia. Keď vidíte jediné úvodzovky v technickom texte, zvyčajne nie je viac dôvodu pre ich použitie ako pre dvojité úvodzovky.

Alternatívne písma

Jedným z najbežnejších štýlov zahŕňajúcich alternatívne písma je použitie písma Courier alebo niektorého podobného monospaced, staro-tlačiarenského štýlu v kontraste so štandardným telom písma (ako je Times New Roman alebo Helvetica). Tento efekt môžete vytvoriť na webovej stránke použitím CSS štýlu ako <span class="example_text">. Napríklad "typ nainštalovať na inštaláciu programu."

Tu je prehľad bežného používania alternatívnych písiem:

• Príklad textu. Na signalizáciu, že sa zobrazuje príklad, skôr ako požadovaný údaj, sa často používa alternatívne písmo, ako je Courier:

Napríklad, ak chcete skopírovať súbor, zadajte skopíruj svojsubor.txt mojflek.txt. Súbor s názvom mojefajl.txt bude vytvorený a jeho obsah bude rovnaký ako vášsúbor.txt.

• Zobrazený text. Počítače a iné zariadenia zvyčajne zobrazujú veci ako varovania, stavové kódy alebo chybové správy. Tieto sa objavujú na monitore alebo na LCD paneloch a podobne. Keď sa odvolávate na tento zobrazený text, môžete použiť alternatívne písmo, ako je Courier. Napríklad, "Ak adresár neexistuje, systém odpovie s Žiadny taký súbor alebo adresár." Alebo, "Keď sa počítač zapína, digitálny displej zobrazí 8888."
• Rozšírené ukážky kódu. V textoch o počítačovom programovaní sú rozšírené programové vzory často zobrazené v písme Courier, napríklad:

#skontrolujte priemerných hackerov if ($address1 eq "" & $address2 eq "") { &wicked_address (500, "Chyba pri vyhľadávaní", "Prosím zadajte meno."); } elsif ($address1 =~ /[;<>&\*`\|]/ | $address2 =~ /[;<>&\*`\|]/) { &wicked_address (500, "Chyba pri vyhľadávaní", "Nesprávna e-mailová adresa. Prosím, nezničte našu chudobnú, skromnú, virtuálnu školu s jednou miestnosťou!."); }

Farba

Farba sa používa v technických textoch, ale je nákladná a ťažko sa s ňou manipuluje počas vydavateľského cyklu.

Avšak farba je ľahko použiteľná v online informáciách. Je bežné vidieť hypertextové odkazy, napríklad, ktoré používajú farbu. Online nápovedy typicky používajú zelenú, zatiaľ čo webové stránky zvyčajne používajú modrú pre nové odkazy a fialovú pre odkazy, ktoré už používateľ preskúmal.

Tendencia používať farby bez rozlišovania v online informáciách je veľmi podobná tendencii šialene používať tučný text, kurzívu, veľkosti písma a rôzne fonty v tlačených informáciách. Pocit musí byť niečo ako: „Je to tam, je to cool, tak to použime!“

Ak chcete používať farbu, naplánujte si to starostlivo. Neočakávajte, že si čitatelia zapamätajú, že červená signalizuje jednu myšlienku, modrá inú myšlienku a zelená ešte nejakú ďalšiu myšlienku. Držte sa jednoducho jednej farby. Všeobecne sa vyhnite používaniu farby pre dlhšie texty. Namiesto toho, aby ste celú upozornenie spravili červené, jednoducho spravte červený štítok Upozornenie a nechajte text upozornenia v bežnej rímskej (text ako bežný text tela).

Ešte lepšie, prečítajte si niektorú z odborných publikácií o farbe v oblasti technickej komunikácie. Existujú všeobecné dizajnové otázky a medzinárodné otázky:

• Používanie farieb. Poskytované systémom webového dizajnu USA (USWDS).
• Medzinárodný sprievodca používaním farieb v marketingu a reklame. Rôzne významy, ktoré má červená, napríklad, medzinárodne. Pozrite sa na jej Medzinárodná tabuľka symbolizmu farieb. Zdroj: Six Degrees, LLC
• Pamätaj, že podľa článok Na Wikipédii sa uvádza, že približne 8 % mužov a 0,4 % žien je postihnutých slepotou na červenú a zelenú farbu rôznymi spôsobmi, či už ide o jednu farbu, farebnú kombináciu alebo inú mutáciu.

Kombinácie predchádzajúceho

Vo všeobecnosti nie je dobrý nápad kombinovať techniky dôrazu, napríklad tučné písmo a kurzívu. V neprofesionálnych technických textoch uvidíte také krikľavé kombinácie ako celé písané tučné-kurzíva alebo celé písané tučné-kurzíva s dvojitými úvodzovkami. Vyvarujte sa toho!

Jednou z legálnych kombinácií je používanie kurzívy s alternatívnymi písmami. Napríklad, keď ukazujete syntaktický zápis príkazu, chcete, aby bol celý text v Courieri, ale zároveň chcete, aby boli premenné v kurzíve:

skopírovať StarýNázovSúboru NovýNázovSúboru

Funkčné názvy pre štýly postáv a značky

Ak ste sa niekedy pohybovali v oblasti vydavateľského priemyslu, mohli ste sa stretnúť s niečím, čo sa nazýva sémantické značkovanie. To znamená pomenovať sekcie textu podľa štrukturálnej úlohy, ktorú zohrávajú v dokumente—napríklad, nadpis. Čitateľ tieto názvy nevidí, ale zohrávajú dôležitú úlohu v tom, ako je dokument formátovaný a ako ho možno znovu použiť.

Toto isté pravidlo platí aj pre slová vo frázach v texte. Napríklad v HTML pre webovú stránku môžete použiť <b>tučne slovo</b> tagy na zobrazenie slova tučným písmom. Ale tučné písmo neindikuje funkciu slova alebo výrazu. Namiesto toho, príkaz by alebo rozhranie_štítok by. Preto v sémantickom označovaní pomocou HTML CSS sú veci funkčnejšie, ak vyzerajú takto: <span class="command">tučné slovo</span>.

Súbory používajúce HTML a CSS sú zvyčajne konvertované do iných médií, ako sú PDF alebo dokonca do a z XML. Používajúc funkčne názvové zvýrazňovacie štýly, ako je popísané vyššie, môžu výrazne uľahčiť proces konverzie.

Ďalšie prieskumy

Akonáhle si prečítate predchádzajúce, dobré je preskúmať technické publikácie a zistiť, aké zvýrazňovacie schémy používajú. Sledujte, ako sa používajú veci ako tučný text, kurzíva, veľké písmená, alternatívne písma a iné podobné efekty. Pravdepodobne uvidíte veľmi odlišné použitie, než o čom ste tu čítali. Pri skúmaní premýšľajte o logike techník zdôrazňovania, ktoré vidíte; pokúste sa formulovať pravidlá, ktoré sa zdajú autori používať; sledujte nekonzistencie v zvýrazňovaní; a kriticky premýšľajte o použití, ktoré vidíte—je to logické? prehnané? "nedostatočné?"

Po tom, čo ste vykonali nejaké preskúmanie, je ďalším logickým krokom prečítať kapitolu o štýlové príručky, ak ste tak ešte neurobili. Schémy zvýraznenia musia byť zdokumentované v štýlových príručkách, aby ste si ich nezabudli a aby sa na ne mohli odvolať členovia vášho dokumentačného tímu.

Zvýrazňovacia schéma

Ak vás všetky predtým diskutované možnosti a alternatívy prehlušili, zvážte použitie nasledujúceho zvýrazňovania. Je založené na zvýrazňovaní, ktoré nájdete v mnohých dokumentoch UNIX, Windows a Linux.

Poznámky:

1. Pravidelný román odkazuje na akékoľvek písmo a veľkosť písma, ktoré sa používajú pre text tela.
2. Aj keď tieto návrhy odporúčajú "veľké písmená na obrazovke," vývojári majú niekedy nešťastnú tendenciu používať všetky veľké písmená. Pretože štýl s všetkými veľkými písmenami znižuje čitateľnosť, používajte teda veľké začiatočné písmená (názvový formát).
3. Ak používateľom ukážete, ako zadať príkaz vrátane ukážkového textu, nepravidkujte príkaz, ktorý sa nachádza v ukážkovom texte:

Použite mv príkaz na zmenu názvu umiestnenia súboru, napríklad:
mv toto_súbor.txt tamto_súbor.txt.

4. Ak používateľom ukážete, ako zadať príkaz vrátane príkladového textu a zahrniete premenné v príkladovom texte, používajte na premenné kurzívu.

Použite mv príkaz na zmenu názvu umiestnenia súboru:
mv môj_súbor.txt tvoj_súbor.txt.

5. Ak sa jednoducho odvolávate na názov obrazovky alebo menu, ktoré nie je kliknuté ani nespúšťa žiadnu udalosť, použite veľké písmená na obrazovke a bežné písmo.
6. Niektoré štýly vyzdvihujú akcie, ktoré majú používatelia vykonať (napríklad, tlač, zadajte, odstrániť). To určite je možnosť, ale pre mňa je to príliš veľa zvýrazňovania.

Používateľské príručky často umiestňujú tabuľku pre významy zvýraznenia písiem, farieb a typografie v predslove:

Ocenil by som vaše myšlienky, reakcie a kritiku týkajúcu sa tejto kapitoly: vaša odpoveď.