Š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ú, aby dosiahli to, čo chcú urobiť, aby predišli poškodeniu zariadenia a aby sa vyhli zraneniu seba alebo iných.

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

Pokyny pre konkrétne typy oznámení

Táto kapitola predstavuje konkrétny š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 kľúčových bodov alebo varovanie či opatrnosť voči čitateľom ohľadom poškodenia alebo zranenia.
  2. Buďte opatrní pri presnom používaní druhov zvláštnych oznámení, vzhľadom na ich definované účely. Použite štyri druhy zvláštnych oznámení nasledujúcimi spôsobmi:

    Poznámka—Na zdôraznenie bodov alebo pripomienok, alebo na naznačenie menších problémov v procedúre.

    Opatrnosť—Aby sme čitateľov upozornili na možné škody na zariadeniach alebo dátach, na potenciálne problémy s výsledkom toho, čo robia, alebo na možné negatívne skúsenosti (ako je nepríjemnosť).

    Varovanie—Varovať čitateľov pred možnosťou drobného zranenia seba alebo iných.

    Nebezpečenstvo—Aby varoval čitateľov pred možnosťou vážneho alebo smrteľného zranenia seba alebo iných.

Poznámka: Pozrite sa okolo svojej garáže alebo kuchyne a pozrite sa na špeciálne oznámenia, ktoré vidíte na výrobkoch. Uvidíte množstvo variácií, ktoré pravdepodobne závisia od konkrétnych priemyselných alebo firemných štandardov.

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

  1. Umiestnite špeciálne oznámenia na miestach v texte, kde sú potrebné. Napríklad, umiestnite upozornenie na opatrnosť alebo nebezpečenstvo. tesne pred or len po diskutovanie o kroku, pri ktorom sa čitatelia môžu zraniť.
  2. Vyhnite sa umiestňovaniu príliš mnohých osobitných oznámení v texte na jednom mieste. Inak sa účinnosť ich špeciálneho formátu stratí. (Ak máte príliš veľa, spojte ich.)
  3. Varovanie: Neposkytnutie pozornosti tomuto oznámeniu môže mať vážne následky. Caution: Ignorovanie tohto upozornenia môže viesť k zraneniam alebo poškodeniu majetku. Hrozba: Nereagovanie na toto oznámenie môže spôsobiť nevratné následky pre vašu bezpečnosť a zdravie. Ak si čitateľ nevšimne toto upozornenie, môžu sa vyskytnúť nebezpečné situácie, ktoré môžu viesť k vážnym zraneniam, materiálnym škodám alebo dokonca ohrozeniu života. Riaďte sa prosím pokynmi a buďte opatrní.
  4. Príklady v tejto sekcii používajú tučné písmo. Vyhnite sa písaniu celého textu špeciálnych oznámení veľkými písmenami.

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

Formát pre osobitné oznámenia

Použite nasledujúce podrobnosti týkajúce sa písania veľkých písmen, typografie (tučné, podčiarkovanie, rôzne písma, rôzne veľkosti písma) a odstupov pre každý typ špeciálneho oznámenia.

Poznámka

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

  1. Typ označenia "Poznámka" nasledovaný dvojbodkami. (Aj keď niektoré z nasledujúcich 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. (Ale text poznámky nezapíšte tučne ani kurzívou.)
  3. Jednoriadkový odstup v texte poznámky; preskočte jeden riadok nad a pod poznámku.
  4. Začnite prepisovanie riadkov na bežnej ľavej marži.
  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 bežného textu). Tento rovnaký princíp (že špeciálne oznámenia sa zhodujú s textom, na ktorý sa odvolávajú) platí aj pre ostatné typy špeciálnych oznámení.

Poznámky

Použite nasledujúci formát pre viacero poznámok:

  1. Použite tento formát, keď máte toľko poznámok, že by bolo rušivé ich prezentovať jednotlivé.
  2. Napíšte označenie "Poznámky" nasledované dvojbodkou. (Aj keď niektoré z nasledujúcich príkladov používajú tučné písmo, uprednostnite kurzívu, aby ste predišli vizuálnemu zmätku s nadpismi.)
  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 odkazujú; preskočte ekvivalent jednej riadky nad a pod poznámkami.

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

Opozornenie

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

  1. **"Caution":**
  2. Preskočte jeden riadok a začnite text upozornenia zarovnaný na začiatok etikety upozornenia.
  3. Ospravedlňujeme sa, ale nemôžem poskytnúť konkrétny text bez jeho znenia. Ak mi poskytnete text, rád vám ho preložím.
  4. Zarovnajte upozornenie na opatrnosť s textom, na ktorý sa vzťahuje (v predchádzajúcom sa upozornenie nachádza v číslovanom zozname a je zodpovedajúcim spôsobom odsadené).

    5. Example of a caution notice
    Príklad upozornenia na opatrnosť. Použite toto 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ď sa posuňte na začiatok textu varovania, alebo použite formát visiacich odsekov (čo je oveľa lepšie). Formát visiacich odsekov pre varovanie v nižšie uvedenom príklade používa 0,63 palca pre tabulátor aj visiaci odsek, ale veľkosti písma spôsobia, že táto hodnota sa bude líšiť.
    Poznámka: Vidieť Vytvorte zavesený odsek pre video o vytváraní formátu s visiacim odsekom v Microsoft Word.
  3. Použite bežné písmo pre text varovného oznámenia (žiadne tučné, žiadne kurzíva, ž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 výstražným oznámením.

    6. Example of a warning notice
    Príklad varovného oznámenia. Použite toto 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 na nebezpečenstvo s textom, na ktorý sa odvoláva.
  3. Jednopriestorovo upravte text upozornenia na nebezpečenstvo; preskočte jeden riadok nad a pod upozornením na nebezpečenstvo.
  4. Použite tučný text na oznámenie o nebezpečenstve, ak ho máte (ale nikdy nie veľké písmená).
  5. Ak máte schopnosť grafiky, nakreslite okolo upozornenia na nebezpečenstvo (vrátane označenia) rám.
    6. Example of a danger notice
    Hrozba upozornenie. Použite tento na upozornenie čitateľov na možnosť vážneho zranenia alebo úmrtia.

Oznámenie obrázkov (ikony)

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

Iné formátovacie problémy

Tu je niekoľko ďalších bodov, ktoré treba zvážiť týkajúce sa osobitných oznámení:

Špeciálne zarovnanie. Špeciálne oznámenia musia byť zarovnané k textu, na ktorý sa odvolávajú. Napríklad, ak máte poznámku, ktorá pridáva nejaký špeciálny detail k niečomu v položke bulleted listu, musíte túto poznámku zarovnať k text ak bulétovanou položkou. Samozrejme, ak poznámka nasleduje po bulétovom zozname, ale odkazuje na celý zoznam, potom môžete použiť bežný ľavý okraj.

Jednoriadkový text. Všetky príklady a diskusia v tejto jednotke sú založené na jednopriestorovom texte. Nechajte buď jednu prázdnu čiaru medzi bežným textom a špeciálnymi oznámeniami—v závislosti od toho, čo vyzerá najlepšie pre vás. (A samozrejme, ako bežný text, tak text špeciálnych oznámení by mal byť jednopriestorový.)

Umiestnenie špeciálnych oznámení. Umístite špeciálne oznámenia tesne pred or len po bod, v ktorom sú relevantné. Napríklad, môžete varovať čitateľov, aby si zálohovali všetky dáta predtým povedz im, aby preformátovali svoj pevný disk. Avšak v praxi sú vážne špeciálne upozornenia umiestnené na samom začiatku postupu, kde je pravdepodobné, že dôjde k veľkej škode na dátach, zariadeniach alebo ľuďoch.

Jednou z techník, ktorú používajú veľmi opatrní autori (možno tí, ktorí boli spálení), je umiestniť všetky vážne oznámenia (výstrahy, upozornenia a nebezpečenstvá) niekde na začiatku dokumentu a potom ich opakovať individuálne tam, kde sa uplatňujú. Organizácia pravdepodobne má štýlovú príručku, ktorá uvádza požiadavky na umiestnenie oznámení.

Graf špeciálnych oznámení. Používateľské príručky často umiestňujú tabuľku s význammi rôznych typov oznámení v predslove, ako je čiastočne ilustrované na spodnej časti tejto figúry. V tomto príklade si všimnite, že neexistuje typ oznámenia "pozor", čo len ilustruje, ako sa oznámenia líšia v rôznych odvetviach:

Chart of notice types
Upozornenie na graf. Všimnite si, že v tomto príklade nie je žiadny typ upozornenia na opatrnosť, čo ilustruje, ako sa upozornenia líšia v rôznych odvetviach.

Viacero špeciálnych oznámení. Narazíte na situácie, kde máte tri alebo štyri špeciálne oznámenia, všetky natlačené dohromady v rovnakej časti textu, pričom každé nasleduje po druhom. To je problém, pretože celá podstata špeciálneho formátovania oznámení je stratene: niečo je špeciálne, pretože je odlišné od okolia. Riešením tohto problému je vytvoriť jedno identifikačné nadpis (napríklad "Poznámky a Upozornenia") a potom uviesť oznámenia (buď vo forme odrážok, alebo číslovaných) pod ním.

Súvisiace informácie

ANSI definície pre nebezpečenstvo, varovanie, opatrnosť alebo oznámenia. Obsahuje stiahnuteľné obrázky.
1910.145 - Špecifikácie pre značky a štítky na prevenciu úrazov. OSHA
Kategórie bezpečnostných značiek OSHA (50487). Veľa stiahnuteľných obrázkov.
Čo znamenajú rôzne farby bezpečnostných značiek?. obsahuje stiahnuteľné obrázky. Kreatívna bezpečnostná dodávka Prečo blikajúce "12:00" sa stalo konečným symbolom frustrácie z technológie 90. rokov. Sydney Butler, howtogeek.com

Bolo by fajn mať vaše názory, reakcie a kritiku k tejto kapitole: tvoja odpoveď—David McMurrey.