Špeciálne oznámenia sú dôležitou súčasťou profesionálneho technického písania: zdôrazňujú špeciálne informácie, ktoré čitatelia potrebujú vedieť, aby porozumeli tomu, čo čítajú, dosiahli to, čo chcú dosiahnuť, zabránili poškodeniu zariadenia a ochránili seba alebo iných pred zranením.

Veľmi špeciálne oznámenia. Najmodernejšie oznámenia s inteligentnými komentármi.

Pokyny pre špecifické typy oznámení

Táto kapitola predstavuje špecifický štýl oznámení. Buďte si veľmi vedomí, že existujú aj iné štýly a formáty.

  1. Použite špeciálne upozornenia na zdôraznenie hlavných bodov alebo na varovanie či opatrnosť pred poškodením alebo zranením.
  2. Buďte opatrní pri presnom používaní typov špeciálnych oznámení, pre ich definované účely. Použite štyri typy špeciálnych oznámení nasledujúcimi spôsobmi:

    Poznámka—Aby sa zdôraznili body alebo pripomienky, alebo aby sa naznačili drobné problémy v postupe.

    Opatrnosť—Varovať čitateľov pred možným poškodením zariadenia alebo dát, pred potenciálnymi problémami v výsledku toho, čo robia, alebo pred potenciálnymi negatívnymi skúsenosťami (ako napríklad nepríjemné pocity).

    Výstraha—Varovať čitateľov o možnosti drobného zranenia seba alebo iných.

    Nebezpečenstvo—Varovať čitateľov o možnosti vážneho alebo smrteľného zranenia seba alebo iných.

Poznámka: Pozrite sa okolo seba vo svojej garáži alebo kuchyni a pozrite si špeciálne upozornenia, ktoré vidíte na produktoch. Uvidíte množstvo variácií, ktoré pravdepodobne závisia od konkrétnych odvetvových alebo firemných noriem.

Rozhodovanie, aký typ oznámenia použiť, nie je presná veda. Len nepoužívajte upozornenie o nebezpečenstve, keď je varovanie vhodnejšie (rovnako ako "plač vlka"). Taktiež používajte oznámenia konzistentne v celom dokumente. Urobte nie vytvorte si svoje vlastné oznámenia, ako napríklad vložením "Dôležité:" namiesto "Upozornenie."

  1. Umiestnite špeciálne oznámenia na miesta v texte, kde sú potrebné. Napríklad umiestnite upozornenie na opatrnosť alebo nebezpečenstvo. tesne pred alebo len po diskutovanie o kroku, v ktorom si čitatelia môžu ublížiť.
  2. Vyhnite sa príliš množstvu špeciálnych oznámení na jednom mieste v texte. Inak sa efektívnosť ich špeciálneho formátu stratí. (Ak máte príliš veľa, spojte ich.)
  3. S upozorneniami, opatrnosťami a znakmi nebezpečenstva vysvetlite následky nevenovania pozornosti oznámeniu. Uveďte, čo sa stane, ak čitateľ na oznámenie nebude reagovať.
  4. Príklady v tejto sekcii používajú tučný text. Vyhnite sa písaniu všetkých písmen veľkými písmenami pre text akýchkoľvek špeciálnych oznámení.

Poznámka: V správne nastavenom publikačnom prostredí by technickí spisovatelia nemuseli rozhodovať, aký typ oznámenia použiť, ani vytvárať jazyk oznámenia. To by mala byť práca právnikov organizácie. Napriek tomu môžu byť títo právnici príliš zaneprázdnení na to, aby prešli vaše oznámenia, a tak môže byť záťaž stále na vás, technickom spisovateľovi alebo redaktorovi.

Formát pre špeciálne oznámenia

Použite nasledujúce podrobnosti o písaní veľkých písmen, typografii (tučné, podčiarknuté, rôzne písma, rôzne veľkosti písma) a medzerách pre každý typ špeciálneho oznámenia.

Poznámka

Použite nasledujúci formát pre jednoduché poznámky:

  1. Napíšte označenie "Poznámka" nasledované dvojbodkou. (Hoci niektoré z nasledovných príkladov používajú tučný text, uprednostnite kurzívu, aby ste predišli vizuálnemu zmätku s nadpismi.)
  2. Začnite písať text poznámky jeden priestor po dvojbodke.
  3. Jednoduché riadky v texte poznámky; preskočte jeden riadok nad a pod poznámku.
  4. Začnite pretiahnuté riadky na bežnej ľavej hrane.
  5. Zarovnajte poznámku s textom, na ktorý sa odvoláva (ako je znázornené v druhom príklade).

    6. Example of a simple note
    Príklad jednoduchej poznámky

    Example of a note within a bulleted list
    Príklad poznámky v rámci odrážkového zoznamu (nie v bežnom textovom prúde). Tento istý princíp (že špeciálne oznámenia sú zladené s textom, na ktorý odkazujú) sa vzťahuje aj na ostatné typy špeciálnych oznámení.

Poznámky

Použite nasledujúci formát pre viaceré poznámky:

  1. Použite tento formát, keď máte toľko poznámok, že by bolo rušivé prezentovať ich samostatne.
  2. "Poznámky":
  3. 1. Použite číslovaný zoznam pre jednotlivé poznámky; v ňom dodržujte pravidlá pre číslované zoznamy. 2. (Nepoužívajte tučné alebo kurzívne písmo pre jednotlivé poznámky.)
  4. Zarovnajte poznámky s textom, na ktorý sa odvolávajú; preskočte ekvivalent jednej línie nad a pod poznámkami.

    5. Example of a multiple note
    Príklad viacerých poznámok. Použite tento formát, ak máte veľa poznámok a chcete ich všetky zhromaždiť na jednom mieste, aby ste predišli rozptýleniu.

Opatrnosť

Použite nasledujúci formát pre upozornenia na opatrnosť:

  1. **"Caution":**
  2. Vynechajte jeden riadok a začnite text upozornenia zarovnaný s začiatkom štítku upozornenia.
  3. Upozornenie: Buďte opatrní, aby ste sa vyhli potenciálnym rizikám. Upozornenie:
  4. Zarovnajte upozornenie na opatrnosť s textom, na ktorý sa vzťahuje (v predchádzajúcom prípade sa upozornenie nachádza v číslovanej zozname a je podľa toho zarovnané).

    5. Example of a caution notice
    Príklad upozornenia na opatrnosť. Použite túto položku na upozornenie čitateľov na možné poškodenie zariadenia alebo problémy s postupom.

Varovanie

Použite nasledujúci formát pre upozornenia:

  1. "UPOZORNENIE," kurzíva:
  2. Buď tabujte na začiatok textu upozornenia, alebo použite formát s visiacim odsadením (ktorý je oveľa lepší). Formát s visiacim odsadením pre upozornenie v nižšie uvedenom príklade používa 0,63 palca pre oba, tabulátor a visiacie odsadenie, ale veľkosti písma spôsobia, že sa táto hodnota môže líšiť.
    Poznámka: Vidieť Vytvorte zavesený odsaz. pre video o vytváraní formátu s visiacim odsadením v Microsoft Word.
  3. Použite bežné písmo pre text varovania (žiadne tučné, žiadne kurzívy, žiadne veľké písmená, žiadna farba).
  4. Zarovnajte upozornenie s textom, na ktorý sa odvoláva.
  5. Preskočte ekvivalent jednej línie nad a pod upozornením.

    6. Example of a warning notice
    Príklad výstražného oznámenia. Použite tento text na upozornenie čitateľov na možnosť drobného zranenia.

Nebezpečenstvo

Použite nasledujúci formát pre upozornenia na nebezpečenstvo:

  1. **"DANGER"**
  2. Zarovnajte upozornenie o nebezpečenstve s textom, na ktorý sa odvoláva.
  3. Jednoduché medzery v texte varovania o nebezpečenstve; vynechajte jeden riadok nad a pod varovaním o nebezpečenstve.
  4. Použite tučné písmo na text upozornenia na nebezpečenstvo, ak ho máte (ale nikdy nie veľké písmená).
  5. Ak máte možnosť grafiky, nakreslite okolo upozornenia na nebezpečenstvo rámček (vrátane štítku).
    6. Example of a danger notice
    Upozornenie na nebezpečenstvo. Použite tento na varovanie čitateľov o možnosti vážneho zranenia alebo smrteľného úrazu.

Oznámenie obrázky (ikony)

Prosím, pozri. bežné oznámenia obrázky.

Iné problémové formátovanie

Tu sú niektoré ďalšie body, ktoré treba zvážiť ohľadom špeciálnych oznámení:

Špeciálne zarovnanie. Špeciálne oznámenia musia byť zarovnané na text, na ktorý sa odkazujú. Napríklad, ak máte poznámku, ktorá pridáva nejaký špeciálny detail k niečomu v položke bullet listu, musíte túto poznámku zarovnať na text of bulkového bodu. Samozrejme, ak poznámka nasleduje po zozname s odrážkami, ale odkazuje na celý zoznam, potom môžete použiť bežný ľavý okraj.

Jednoducho zarovnaný text. Všetky príklady a diskusie v tejto jednotke sú založené na jednostranovom texte. Zanechajte jeden prázdny riadok medzi bežným textom a špeciálnymi oznámeniami—v závislosti od toho, čo vyzerá najlepšie. (A samozrejme, že aj bežný text, ako aj text špeciálnych oznámení by mali byť jednostranové.)

Umístění zvláštních oznámení. Umiestnite špeciálne oznámenia tesne pred alebo práve po moment, keď sú relevantné. Napríklad môžete čitateľom varovať, aby si zálohovali všetky údaje. predtým povedz im, aby preformátovali svoj pevný disk. V praxi sú však vážne špeciálne upozornenia umiestnené na samom začiatku postupu, kde môže dôjsť k veľkej škode na údajoch, zariadeniach alebo ľuďoch.

Jednou z techník, ktoré používajú veľmi opatrní autori (možno tí, ktorí mali zlé skúsenosti), je umiestniť všetky vážne upozornenia (varovania, upozornenia a nebezpečenstvá) niekde na začiatku dokumentu a potom ich opakovať individuálne tam, kde sa uplatňujú. Organizácia pravdepodobne bude mať štýlový sprievodca, ktorý uvádza požiadavky na umiestnenie upozornení.

Graf špeciálnych oznámení. Používateľské príručky často umiestňujú tabuľku s významami rôznych typov oznámení v predslove, ako je čiastočne uvedené na spodnej časti tejto obrázku. V tomto príklade si všimnite, že neexistuje typ upozornenia na opatrnosť, iba ilustruje, ako sa oznámenia líšia medzi odvetviami:

Chart of notice types
Upozornenie na graf. Všimnite si, že v tomto príklade nie je typ varovného oznámenia, čo ilustruje, ako sa oznámenia líšia naprieč odvetviami.

Viacero osobitných oznámení. Stretávate sa so situáciami, kde máte tri alebo štyri špeciálne oznámenia, všetky natlačené spolu v tej istej časti textu, pričom každé nasleduje po druhom. Je to problém, pretože celý zmysel špeciálneho formátovania oznámení je stratenný: niečo je špeciálne, pretože sa odlišuje od okolia. Riešením tohto problému je vytvoriť jeden identifikačný nadpis (napríklad "Poznámky a upozornenia") a následne uvediť oznámenia (buď odrážkami alebo číslovaním) pod ním.

Súvisiace informácie

ANSI definície pre značky nebezpečenstva, varovania, opatrnosti alebo oznámenia.. Obsahuje stiahnuteľné obrázky.
1910.145 - Špecifikácie pre značky a štítky na prevenciu nehôd. OSHA
Kategórie bezpečnostných značiek OSHA (50487). Veľa stiahnuteľných obrázkov.
Aký význam majú rôzne farby bezpečnostných znakov?. obsahuje stiahnuteľné obrázky. Kreatívne bezpečnostné vybavenie Prečo blikajúce "12:00" sa stalo konečným symbolom frustrácie z technológie 90. rokov. Sydney Butler, howtogeek.com

Budem vďačný za vaše myšlienky, reakcie, kritiku týkajúcu sa tejto kapitoly: vaša odpoveď—David McMurrey.