< Különleges értesítések

A különleges közlemények a professzionális műszaki dokumentáció fontos elemei: kiemelik azokat a különleges információkat, amelyeket az olvasóknak tudniuk kell ahhoz, hogy megértsék, amit olvasnak, hogy el tudják végezni, amit szeretnének, hogy megakadályozzák a berendezés károsodását, és hogy elkerüljék saját vagy mások sérülését.

Nagyon különleges értesítések. A legmodernebb értesítések találékony megjegyzésekkel.

Irányelvek a konkrét értesítéstípusokhoz

Ez a fejezet egy adott értesítési stílust mutat be. Legyen nagyon tisztában azzal, hogy más stílusok és formátumok is léteznek.

  1. Használjon speciális figyelmeztetéseket a kulcsfontosságú pontok kiemelésére, vagy hogy figyelmeztesse az olvasókat a károsodás vagy sérülés veszélyére.
  2. Ügyelj arra, hogy a speciális értesítések típusait pontosan, a meghatározott céljaiknak megfelelően használd. A négyféle speciális értesítést az alábbi módokon használd:

    Megjegyzés—Pontok vagy emlékeztetők hangsúlyozására, illetve egy eljárás kisebb problémáinak jelzésére.

    Vigyázat— Az olvasók figyelmeztetése a lehetséges berendezés- vagy adatkárosodásról, a tevékenységük eredményében felmerülő lehetséges problémákról vagy potenciális negatív élményekről (például megszégyenülésről).

    Figyelmeztetés— Az olvasók figyelmeztetése a saját vagy mások kisebb sérülésének lehetőségére.

    Veszély— Figyelmeztetni az olvasókat arra, hogy saját maguk vagy mások súlyos vagy halálos sérülést szenvedhetnek.

Megjegyzés: Nézzen szét a garázsában vagy a konyhájában, és nézze meg a termékeken található különleges értesítéseket. Sokféleséget fog látni, amely valószínűleg az adott iparági vagy vállalati szabványoktól függ.

Eldönteni, hogy melyik típusú értesítést használjunk, nem egzakt tudomány. Csak ne használjon veszélyjelzést, ha egy figyelmeztetés alkalmasabb (ez ugyanaz, mint farkast kiáltani). Emellett az értesítéseket következetesen használja az egész dokumentumban. Tegye nem Hozz létre saját értesítéseket, például úgy, hogy a "Fontos:" feliratot használod a "Figyelmeztetés." helyett.

  1. Helyezze el a különleges közleményeket a szöveg azon pontján, ahol szükség van rájuk. Például helyezzen el egy „Óvatosság” vagy „Veszély” figyelmeztetést. éppen azelőtt vagy rögtön utána egy lépés megvitatása, amelyben az olvasók megsérülhetnek.
  2. Kerülje, hogy egy adott ponton túl sok speciális értesítés legyen a szövegben. Ellenkező esetben a speciális formátumuk hatékonysága elvész. (Ha túl sok van belőlük, egyesítse őket.)
  3. Figyelmeztetések, óvintézkedések és veszélyre figyelmeztető közlemények esetén magyarázza el a figyelmeztetés figyelmen kívül hagyásának következményeit. Határozza meg, mi történik, ha az olvasó nem veszi figyelembe a közleményt.
  4. A példák ebben a szakaszban félkövérrel szerepelnek. Kerülje a teljes nagybetűs írást bármely különleges értesítés szövegén.

Megjegyzés: Megfelelően kialakított publikációs környezetben a műszaki íróknak nem kellene eldönteniük, hogy melyik típusú közleményt használják, sőt még a közlemény megfogalmazását sem nekik kellene elkészíteniük. Ennek a szervezet jogászainak a feladata kellene legyen. Ugyanakkor ezek a jogászok túl elfoglaltak lehetnek ahhoz, hogy áttekintsék a közleményeidet, így a teher továbbra is rajtad — mint műszaki író vagy szerkesztő — maradhat.

Speciális értesítések formátuma

Használja a következőt az egyes különleges értesítéstípusok nagybetűhasználatára, tipográfiájára (félkövér, aláhúzás, különböző betűtípusok, különböző betűméretek) és térközére vonatkozó részletes előírásokhoz.

Megjegyzés

Használd a következő formátumot egyszerű jegyzetekhez:

  1. Írja be a "Megjegyzés" feliratot, majd egy kettőspontot. (Bár néhány a következő példa közül félkövérrel szerepel, részesítse előnyben a dőlt betűt, hogy elkerülje a vizuális összezavarodást a címsorokkal.)
  2. Kezdje el begépelni a jegyzet szövegét egy szóközzel a kettőspont után. (De ne tegye a jegyzet szövegét félkövérrel vagy dőlt betűvel.)
  3. A megjegyzés szövegében használj egyszeres sorközt; hagyj egy üres sort a megjegyzés fölött és egyet alatta.
  4. Kezdje a folytató sorokat a megszokott bal margón.
  5. Igazítsa a megjegyzést ahhoz a szöveghez, amelyre vonatkozik (ahogyan azt a második példa is szemlélteti).


    6. Egy egyszerű jegyzet példája


    Példa egy megjegyzésre egy pontozott listában (nem folyó szöveg). Ugyanez az elv (miszerint a speciális megjegyzések igazodnak ahhoz a szöveghez, amelyre hivatkoznak) érvényes a többi típusú speciális megjegyzésre is.

Jegyzetek

Több jegyzet esetén használja a következő formátumot:

  1. Használd ezt a formátumot, ha olyan sok jegyzeted van, hogy zavaró lenne őket egyenként bemutatni.
  2. Írd be a "Notes" címkét, majd tegyél utána kettőspontot. (Bár a következő példák némelyike félkövérrel van, részesítsd előnyben a dőlt betűt, hogy elkerüld a vizuális összezavarodást a címsorokkal.)
  3. Használj számozott listát az egyes jegyzetekhez; abban kövesd a számozott listák szabályait. (Ne használj félkövér vagy dőlt betűt az egyes jegyzetekhez.)
  4. Igazítsa a megjegyzéseket a hozzájuk tartozó szöveghez; hagyjon ki egy-egy sort a megjegyzések fölött és alatt.


    5. Példa egy többszörös megjegyzésre. Használd ezt a formátumot, ha sok jegyzeted van, és mindet egy helyre szeretnéd gyűjteni, hogy elkerüld a figyelemelterelést.

Vigyázat

A figyelmeztető értesítésekhez használja a következő formátumot:

  1. Írd be a címkét "Vigyázat", kövesd azt kettősponttal, és tedd félkövérré mind a címkét, mind a kettőspontot.
  2. Hagyjon ki egy sort, és kezdje el a figyelmeztetés szövegét úgy, hogy az a figyelmeztetés címkéjének kezdetével legyen igazítva.
  3. A figyelmeztetés szövegét egyes sorközzel írja; hagyjon egy üres sort a közlemény fölött és alatta.
  4. Igazítsa a figyelmeztetést ahhoz a szöveghez, amelyre vonatkozik (az előzőben a figyelmeztetés egy számozott listán belül szerepel, és ennek megfelelően van behúzva).


    5. Példa egy figyelmeztető értesítésre. Használja ezt az olvasók figyelmeztetésére a berendezés esetleges károsodására vagy az eljárással kapcsolatos problémákra.

Figyelmeztetés

Használja a következő formátumot a figyelmeztetésekhez:

  1. Írd be a címkét "Figyelmeztetés,", dőlt betűvel, és tedd utána kettőspontot.
  2. Vagy nyomja meg a Tab billentyűt, hogy a figyelmeztetés szövegének elejére ugorjon, vagy használja a lógóbehúzásos formátumot (ami sokkal jobb). A lógóbehúzásos formátum a lenti példában mind a tabulátorra, mind a lógóbehúzás mértékére 0,63 hüvelyket használ, de a betűméretek miatt ez az érték változhat.
    Megjegyzés: Lásd Hozzon létre függő behúzást Egy videóhoz a Microsoft Wordben a függő behúzás formátum létrehozásáról.
  3. A figyelmeztető értesítés szövegéhez használjon normál törzsszöveg-betűtípust (ne félkövér, ne dőlt, ne teljesen nagybetűs, ne színes).
  4. Igazítsa a figyelmeztető értesítést a rá vonatkozó szöveghez.
  5. Hagyjon ki egy sort a figyelmeztetés fölött és egy sort alatta.


    6. Figyelmeztető értesítés példája. Használja ezt arra, hogy figyelmeztesse az olvasókat a kisebb sérülések lehetőségére.

Veszély

A veszélyre figyelmeztető értesítésekhez a következő formátumot használja:

  1. Írd be a "VESZÉLY" címkét teljes nagybetűkkel és félkövérrel.
  2. Igazítsa a veszélyre figyelmeztető értesítést a hozzá tartozó szöveghez.
  3. A veszélyjelzés szövegét egysoros sorközzel írja; hagyjon egy üres sort a veszélyjelzés fölött és egyet alatta.
  4. Használjon félkövér betűt a **veszélyre figyelmeztető felirat szövegén**, ha van ilyen (de soha ne írja teljesen nagybetűkkel).
  5. Ha van grafikai képességed, rajzolj egy keretet a veszélyre figyelmeztető értesítés köré (beleértve a címkét).

    6. Veszélyjelzés. Ezt használja arra, hogy figyelmeztesse az olvasókat a súlyos sérülés vagy halál lehetőségére.

Értesítési képek (ikonok)

Kérem, nézze meg általános értesítési képek.

Egyéb formázási problémák

Íme néhány további szempont, amelyet érdemes figyelembe venni a különleges értesítésekkel kapcsolatban:

Különleges összehangolás. A különleges értesítéseket a hozzájuk tartozó szöveghez kell igazítani. Például, ha van egy megjegyzés, amely egy felsorolás pontjában szereplő valamire vonatkozó különleges részletet ad hozzá, akkor azt a megjegyzést ahhoz a szöveg a felsorolás elemének. Természetesen, ha a megjegyzés egy felsorolólistát követ, de az az egész listára vonatkozik, akkor használhatod a szokásos bal margót.

    • Egyszeres sorközű szöveg. Az egységben található összes példa és vita az egyszeres sortávolságú szövegen alapul. Hagyjon egy üres sort a folyamatos szöveg és a különleges közlemények—közé, attól függően, hogy melyik tűnik Önnek a legjobbnak. (És természetesen mind a folyamatos szöveg, mind a különleges közlemények szövege egyszeres sortávolságú lenne.)

    Különleges értesítések elhelyezése. Helyezzen ki különleges közleményeket éppen előtte vagy rögtön utána a pont, ahol relevánsak. Például figyelmeztetheted az olvasókat, hogy készítsenek biztonsági másolatot minden adatukról előtt megmondod nekik, hogy újraformázzák a merevlemezüket. Azonban a gyakorlatban a súlyos, különleges figyelmeztetéseket az eljárás legelső részébe helyezik, ott, ahol jelentős kár fenyegetheti az adatokat, a berendezést vagy az embereket.

    Egy módszer, amelyet nagyon óvatos írók használnak (talán azok, akiket korábban megégettek), az, hogy az összes komoly értesítést (figyelmeztetések, óvintézkedések és veszélyek) valahol a dokumentum elejére helyezik, majd egyenként megismétlik őket ott, ahol alkalmazandók. Egy szervezet valószínűleg rendelkezik olyan stílus útmutatóval, amely meghatározza az értesítések elhelyezésére vonatkozó követelményeket.

    A különleges értesítések jelentéseinek táblázata. Felhasználói útmutatók gyakran az előszóban helyeznek el egy táblázatot a különböző értesítéstípusok jelentéséről, ahogy ez részben látható ennek az ábrának az alján. Vegye figyelembe, hogy ebben a példában nincs figyelmeztetés típusú értesítés, ez csupán azt mutatja be, hogyan változnak az értesítések az iparágak között:

    Chart of notice types
    Értesítési diagram. Vegye figyelembe, hogy ebben a példában nincs figyelmeztetés típusú értesítés, ami szemlélteti, hogy az értesítések iparáganként eltérnek.

    Több különleges értesítés. Előfordulhat, hogy olyan helyzetbe kerül, amikor három vagy négy különleges közlemény zsúfolódik össze ugyanabban a szövegrészben, egymás után következve. Ez problémát jelent, mert a közlemények különleges formázásának egész célja elveszik: valami különleges azért különleges, mert eltér a környezettől. A megoldás az, hogy létrehoznak egy azonosító címsort (például „Megjegyzések és figyelmeztetések”), majd alatta felsorolják a közleményeket (vagy felsorolással, vagy számozással).

    Kapcsolódó információk

    ANSI definíciók a „Veszély”, „Figyelmeztetés”, „Vigyázat” vagy „Közlemény” jelzésekhez. Tartalmaz letölthető képeket.
    1910.145 - Balesetmegelőző táblák és címkék előírásai. Munkahelyi Biztonsági és Egészségügyi Hivatal
    OSHA biztonsági jelzések kategóriái (50487). Sok letölthető kép.
    Mit jelentenek a különböző színű biztonsági táblák?. Tartalmaz letölthető képeket. Kreatív Biztonsági Ellátó

    Szívesen fogadnám a gondolatait, reakcióit és kritikáját ezzel a fejezettel kapcsolatban: a válaszod—David McMurrey.