Špeciálne upozornenia 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ú urobiť, predišli poškodeniu zariadenia a chránili seba aj ostatných.

Veľmi špeciálne oznámenia. Inovatívne oznámenia s bystrými poznámkami.

Pokyny pre konkrétne 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 oznámenia na zvýraznenie kľúčových bodov alebo varovanie čitateľov 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—Na zdôraznenie bodov alebo pripomienok, alebo na naznačenie menších problémov v postupe.

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

    Varovanie—Upozorniť čitateľov na možnosť 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 svojho 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é sú pravdepodobne závislé 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 vhodnejšie varovanie (rovnako ako "plač vlka"). Taktiež používajte oznámenia konzistentne v celom dokumente. Urobte nie vytvorte si vlastné oznámenia, ako je napríklad vloženie "Dôležité:" namiesto "Varovanie."

  1. Umiestnite špeciálne upozornenia tam, kde sú potrebné. Napríklad umiestnite upozornenie na opatrnosť alebo nebezpečenstvo. tesne pred or hneď po diskutovanie o kroku, v ktorom by si čitatelia mohli ublížiť.
  2. Vyhnite sa tomu, aby ste mali príliš veľa špeciálnych oznámení v jednom okamihu v texte. Inak sa účinnosť ich špeciálneho formátu stratí. (Ak máte príliš veľa, skombinujte ich.)
  3. S varovaniami, upozorneniami a nebezpečenstvami vysvetlite dôsledky nedbanlivosti na oznámenie. Uveďte, čo sa stane, ak čitateľ na oznam nedá pozor.
  4. Príklady v tejto sekcii používajú tučný text. Vyhnite sa písaniu celého textu osobitných oznámení veľkými písmenami.

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

Formát pre Špeciálne Oznámenia

Použite nasledujúce na špecifické detaily týkajúce sa kapitalizácie, typografie (tučné, podčiarkovanie, rôzne písma, rôzne veľkosti písma) a rozostupov 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. (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.)
  2. Začnite písať text poznámky jeden medzerou po dvojbodke.
  3. Jednoriadkové spacing v texte poznámky; preskočte jeden riadok nad a pod poznámkou.
  4. Začnite pokračovanie riadkov pravidelným ľavým okrajom.
  5. Zarovnajte poznámku s textom, na ktorý sa odvoláva (ako je ilustrované v druhom príklade).

    6. Example of a simple note
    Príklad jednoduchého 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 plynulého textu). Tento istý princíp (že špeciálne oznámenia sú v súlade 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é prezentovať ich jednotlivé.
  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é ani kurzívové písmo pre jednotlivé poznámky.)
  4. Zarovnajte poznámky s textom, na ktorý sa odkazujú; 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. **"Upozornenie":**
  2. Preskočte jeden riadok a začnite text upozornenia zarovnaný so začiatkom štítka upozornenia.
  3. Jednoducho rozosteľte text varovania; preskočte jeden riadok nad a pod oznámením.
  4. Zarovnajte upozornenie o opatrnosti s textom, na ktorý sa odvoláva (v predchádzajúcom sa upozornenie o opatrnosti 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 tento rámček 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. Typ označenia "Upozornenie," kurzívou a nasledujte ho dvojbodkou.
  2. Buď prejdite na začiatok textu varovania, alebo použite formát s visiacim odsekom (ktorý je oveľa lepší). Formát s visiacim odsekom pre varovanie v príklade nižšie používa 0,63 palca pre oba, tabulátor aj visiací odsek, ale veľkosti písma spôsobia, že táto hodnota sa bude líšiť.
    Poznámka: Vidieť Vytvorte zavesený odsadenie pre video o vytváraní formátu zaveseného odsadenia v Microsoft Word.
  3. Použite bežné písmo na text varovného oznámenia (žiadne tučné, žiadne kurzíva, žiadne veľké písmená, žiadna farba).
  4. Zarovnajte varovný oznam 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 varovného oznámenia. Použite tento 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. Preskočte jeden riadok nad a pod upozornením na nebezpečenstvo; jedným medzery v texte upozornenia na nebezpečenstvo.
  4. Použite tučné písmo na text upozornenia na nebezpečenstvo, ak ho máte (ale nikdy nie veľkými písmenami).
  5. Ak máte grafické schopnosti, nakreslite okolo upozornenia na nebezpečenstvo rámček (vrátane štítka).
    6. Example of a danger notice
    Upozornenie na nebezpečenstvo. Použite tento text na upozornenie čitateľov na možnosť vážneho zranenia alebo úmrtia.

Oznámenie Obrázky (Ikony)

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

Iné problémy s formátovaním

Tu sú niektoré ďalšie body na zváženie týkajúce sa osobitných oznámení:

Špeciálne zarovnanie. Špeciálne oznámenia musia byť zarovnané na text, 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 s odrážkami, musíte tú poznámku zarovnávať na text z mázkované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 riadkový text. Všetky príklady a diskusia v tejto jednotke sú založené na jednozdružkovom texte. Nechajte medzi bežným textom a špeciálnymi oznámeniami—buď jednu prázdnu líniu, v závislosti od toho, čo vyzerá najlepšie. (A samozrejme, aj bežný text, ako aj text špeciálnych oznámení by boli jednozdružkové.)

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

Jedna technika, ktorú používajú veľmi opatrní autori (možno tí, ktorí už zažili nepríjemnosti), je umiestniť všetky vážne oznámenia (varovania, upozornenia a nebezpečenstvá) niekde na začiatku dokumentu a potom ich jednotlivé opakovať tam, kde sú relevantné. Organizácia pravdepodobne má štýlový sprievodca, ktorý uvádza požiadavky na umiestnenie oznámení.

Tabuľka zvláštnych oznámení a ich významov. Používateľské príručky často umiestňujú tabuľku pre významy rôznych typov oznámení v predslove, ako je čiastočne ilustrované v spodnej časti tejto obrázku. Vezmite na vedomie, že v tomto príklade nie je žiadny typ oznámenia o opatrnosti, len ilustruje, ako sa oznámenia líšia v rôznych odvetviach:

Chart of notice types
Poznámková tabuľa. V tomto príklade nie je typ upozornenia na opatrnosť, čo ilustruje, ako sa upozornenia líšia naprieč odvetviami.

Viaceré osobitné oznámenia. Narazíte na situácie, kde máte tri alebo štyri osobitné oznámenia, všetky stlačené dohromady v tej istej časti textu, pričom každé nasleduje jedno za druhým. To je problém, pretože celý zmysel osobitného formátovania oznámení je stratený: niečo je osobitné, pretože je iné ako okolie. Riešením tohto problému je vytvoriť jeden identifikujúci nadpis (napríklad "Poznámky a upozornenia") a potom uviesť oznámenia (buď s odrážkami, alebo číslované) pod ním.

Súvisiace informácie

ANSI definície pre značky nebezpečenstva, varovanie, opatrnosť alebo oznámenie. 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é sú významy rôznych farieb bezpečnostných značiek?. obsahuje stiahnuteľné obrázky. Kreatívne bezpečnostné vybavenie Prečo blikajúce "12:00" sa stalo konečným symbolom technologickej frustrácie 90. rokov. Sydney Butler, howtogeek.com

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