` Bijzondere mededelingen

Speciale mededelingen zijn een belangrijk onderdeel van professioneel technisch schrijven: ze benadrukken bijzondere informatie die lezers moeten weten om te begrijpen wat ze lezen, om te bereiken wat ze willen doen, om schade aan apparatuur te voorkomen, en om te voorkomen dat zij zichzelf of anderen verwonden.

Zeer bijzondere mededelingen. Geavanceerde meldingen met slimme opmerkingen.

Richtlijnen voor specifieke soorten kennisgevingen

Dit hoofdstuk presenteert een specifieke stijl van mededelingen. Houd er goed rekening mee dat er ook andere stijlen en formaten bestaan.

  1. Gebruik speciale mededelingen om belangrijke punten te benadrukken of om lezers te waarschuwen of te behoeden voor schade of letsel.
  2. Wees voorzichtig met het nauwkeurig gebruiken van de typen speciale meldingen, voor hun gedefinieerde doeleinden. Gebruik de vier typen speciale meldingen op de volgende manieren:

    Opmerking—Om punten of herinneringen te benadrukken, of om kleine problemen in een procedure aan te geven.

    Waarschuwing—Om lezers te waarschuwen voor mogelijke schade aan apparatuur of gegevens, voor mogelijke problemen met de uitkomst van wat ze doen, of voor mogelijke negatieve ervaringen (zoals schaamte).

    Waarschuwing—Om lezers te waarschuwen voor de mogelijkheid van licht letsel bij henzelf of anderen.

    Gevaar—Om lezers te waarschuwen voor de mogelijkheid van ernstig of dodelijk letsel aan henzelf of anderen.

Opmerking: Neem eens een kijkje in je garage of keuken, en kijk naar de speciale meldingen die je op producten ziet. Je zult veel variatie zien, die waarschijnlijk afhankelijk is van specifieke industrie- of bedrijfsnormen.

Het kiezen van het type melding is geen exacte wetenschap. Gebruik geen melding voor gevaar wanneer een waarschuwing meer op zijn plaats is (hetzelfde als "crying wolf"). Gebruik meldingen ook op een consistente manier in het hele document. Doe niet maak je eigen meldingen, zoals het plaatsen van "Important:" in plaats van "Warning."

  1. Plaats speciale meldingen op het punt in de tekst waar ze nodig zijn. Plaats bijvoorbeeld een waarschuwing of een gevarenaanduiding net voordat of net na het bespreken van een stap waarbij lezers zichzelf kunnen verwonden.
  2. Vermijd te veel speciale meldingen op één punt in de tekst. Anders gaat de effectiviteit van hun speciale opmaak verloren. (Als je er te veel hebt, combineer ze.)
  3. Gebruik waarschuwingen, voorzorgsmaatregelen en gevarenaankondigingen om de gevolgen van het niet letten op de kennisgeving uit te leggen. Geef aan wat er zal gebeuren als de lezer de kennisgeving niet opvolgt.
  4. De voorbeelden in deze sectie gebruiken vetgedrukte tekst. Vermijd volledig gebruik van hoofdletters voor de tekst van speciale mededelingen.

Opmerking: In een goed ingerichte publicatieomgeving, zouden technische schrijvers niet hoeven te beslissen welk type kennisgeving ze moeten gebruiken of zelfs de tekst van de kennisgeving hoeven op te stellen. Dat zou het werk van de advocaten van de organisatie moeten zijn. Toch kunnen die advocaten te druk zijn om uw kennisgevingen te beoordelen, en kan de last dus nog steeds bij u liggen als technisch schrijver of redacteur.

Formaat voor bijzondere mededelingen

Gebruik het volgende voor specifieke details over het gebruik van hoofdletters, typografie (vet, onderstrepen, verschillende lettertypen, verschillende lettergroottes) en de spatiëring voor elk type bijzondere mededeling.

Opmerking

Gebruik het volgende formaat voor eenvoudige notities:

  1. Typ het label "Note" gevolgd door een dubbele punt. (Hoewel sommige van de volgende voorbeelden vetgedrukt zijn, geef de voorkeur aan cursief om visuele verwarring met koppen te voorkomen.)
  2. Begin met het typen van de tekst van de notitie één spatie na de dubbele punt. (Maar zet de tekst van de notitie niet vet of cursief.)
  3. Enkele regelafstand binnen de tekst van de notitie; laat één lege regel boven en onder de notitie.
  4. Begin doorlopende regels op de normale linkermarge.
  5. Lijn de noot uit met de tekst waarnaar deze verwijst (zoals geïllustreerd in het tweede voorbeeld).

    6. Example of a simple note
    Voorbeeld van een eenvoudige notitie

    Example of a note within a bulleted list
    Voorbeeld van een opmerking binnen een opsomming met opsommingstekens (geen gewone doorlopende tekst). Ditzelfde principe (dat speciale meldingen uitgelijnd zijn met de tekst waarop ze betrekking hebben) geldt ook voor de andere typen speciale meldingen.

Notities

Gebruik het volgende formaat voor meerdere notities:

  1. Gebruik dit formaat wanneer je zoveel notities hebt dat het storend zou zijn om ze individueel te presenteren.
  2. Typ het label "Notes" gevolgd door een dubbele punt. (Hoewel sommige van de volgende voorbeelden vetgedrukt zijn, geef de voorkeur aan cursief om visuele verwarring met koppen te voorkomen.)
  3. Gebruik een genummerde lijst voor de individuele aantekeningen; volg daarin de regels voor genummerde lijsten. (Gebruik geen vet of cursief voor de individuele aantekeningen.)
  4. Lijn de aantekeningen uit met de tekst waarop ze betrekking hebben; sla het equivalent van één regel boven en onder de aantekeningen over.

    5. Example of a multiple note
    Voorbeeld van een meervoudige aantekening. Gebruik dit formaat als je veel notities hebt en ze allemaal op één plek wilt verzamelen om afleiding te voorkomen.

Voorzichtig

Gebruik het volgende formaat voor waarschuwingsmeldingen:

  1. Typ het label "Caution", gevolgd door een dubbele punt, en maak zowel het label als de dubbele punt vetgedrukt.
  2. Sla één regel over en begin de tekst van de waarschuwing uitgelijnd met het begin van het waarschuwingslabel.
  3. Gebruik enkelvoudige regelafstand voor de tekst van de waarschuwing; laat één lege regel boven en onder de waarschuwing.
  4. Zorg dat de waarschuwing is uitgelijnd met de tekst waarop deze betrekking heeft (in het voorgaande staat de waarschuwing in een genummerde lijst en is dienovereenkomstig ingesprongen).

    5. Example of a caution notice
    Voorbeeld van een waarschuwingsmelding. Gebruik deze om lezers te waarschuwen voor mogelijke schade aan apparatuur of problemen met de procedure.

Waarschuwing

Gebruik het volgende formaat voor waarswuwingen:

  1. Typ het label "Warning," maak het cursief, en zet er een dubbelepunt achter.
  2. Of tab naar het begin van de tekst van de waarschuwing, of gebruik het hangende-inspringingsformaat (dat veel beter is). Het hangende-inspringingsformaat voor de waarschuwing in het onderstaande voorbeeld gebruikt 0,63 inch voor zowel de tab als de hangende inspringing, maar de lettergrootte kan deze waarde laten variëren.
    Opmerking: Zie Maak een hangende inspringing voor een video over het maken van de hangende inspringing in Microsoft Word.
  3. Gebruik het gewone lettertype voor de tekst van de waarschuwing (geen vet, geen cursief, geen uitsluitend hoofdletters, geen kleur).
  4. Lijn de waarschuwing uit met de tekst waarnaar deze verwijst.
  5. Sla het equivalent van één regel boven en onder de waarschuwingsmelding over.

    6. Example of a warning notice
    Voorbeeld van een waarschuwingsbericht. Gebruik deze om lezers te waarschuwen voor de mogelijkheid van een lichte verwonding.

Gevaar

Gebruik het volgende formaat voor gevaarwaarschuwingen:

  1. Typ het label "DANGER" in vette letters en volledig in hoofdletters.
  2. Lijn de waarschuwing uit met de tekst waarnaar deze verwijst.
  3. Gebruik enkele regelafstand voor de tekst van de gevarowaarschuwing; laat één lege regel boven en één lege regel onder de gevarowaarschuwing.
  4. Zet **de tekst van de waarschuwing** vetgedrukt als je die hebt (maar nooit volledig in hoofdletters).
  5. Als je grafische mogelijkheden hebt, teken dan een kader rond de gevaarwaarschuwing (inclusief het label).
    6. Example of a danger notice
    Gevaarmelding. Gebruik deze om lezers te waarschuwen voor de mogelijkheid van ernstig letsel of overlijden.

Melding Afbeeldingen (Iconen)

Zie alstublieft veelvoorkomende meldingsafbeeldingen.

Andere opmaakproblemen

Hier zijn nog enkele aanvullende punten om te overwegen met betrekking tot speciale mededelingen:

Speciale uitlijning. Speciale opmerkingen moeten worden uitgelijnd met de tekst waarop ze betrekking hebben. Bijvoorbeeld, als je een opmerking hebt die een speciaal detail toevoegt aan iets in een item van een opsomming, moet je die opmerking uitlijnen met de tekst van het opsommingspunt. Natuurlijk, als de opmerking volgt op een opsomming maar betrekking heeft op de hele lijst, dan kunt u de gewone linkermarge gebruiken.

Tekst met enkele regelafstand. Alle voorbeelden en discussies in deze eenheid zijn gebaseerd op tekst met enkelvoudige regelafstand. Laat één lege regel staan tussen doorlopende tekst en speciale mededelingen—afhankelijk van wat jou het beste lijkt. (En natuurlijk zouden zowel de doorlopende tekst als de tekst van de speciale mededelingen enkelvoudige regelafstand hebben.)

Plaatsing van speciale mededelingen. Plaats speciale mededelingen net voordat of net na het punt waarop ze relevant zijn. Bijvoorbeeld, je kunt lezers waarschuwen om van alle gegevens een back-up te maken voor je vertelt hen dat ze hun harde schijf moeten formatteren. Echter, in de praktijk worden ernstige speciale waarschuwingen aan het allereerste begin van een procedure geplaatst wanneer er waarschijnlijk grote schade aan gegevens, apparatuur of mensen zal optreden.

Een techniek die door zeer voorzichtige schrijvers (misschien degenen die al eens 'verbrand' zijn) wordt gebruikt, is om alle ernstige mededelingen (waarschuwingen, voorzichtigheden en gevaren) ergens aan het begin van het document te plaatsen, en ze vervolgens afzonderlijk te herhalen waar ze van toepassing zijn. Een organisatie heeft waarschijnlijk een stijlgids die eisen stelt aan de plaatsing van mededelingen.

Grafiek van betekenissen van speciale mededelingen. Gebruikershandleidingen plaatsen vaak in het voorwoord een tabel met de betekenis van de verschillende typen mededelingen, zoals gedeeltelijk geïllustreerd onderaan deze figuur. Let op dat er in dit voorbeeld geen 'caution'-type mededeling is; dit illustreert slechts hoe mededelingen per branche kunnen variëren:

Chart of notice types
Let op de grafiek. Merk op dat er in dit voorbeeld geen waarschuwingsmeldingstype is, wat illustreert hoe meldingen tussen industrieën kunnen verschillen.

Meerdere speciale mededelingen. Je komt in situaties terecht waarin je drie of vier speciale mededelingen hebt, allemaal opeengehoopt in hetzelfde deel van de tekst, elk na elkaar. Dit is een probleem omdat het hele doel van de speciale opmaak van de mededelingen verloren gaat: iets is speciaal omdat het anders is dan de omringende tekst. De oplossing voor dit probleem is om één herkenbare kop te maken (bijvoorbeeld, "Notities en Waarschuwingen"), en dan de mededelingen daaronder op te

Gerelateerde informatie

ANSI-definities voor Danger-, Warning-, Caution- of Notice-borden. Inclusief downloadbare afbeeldingen.
1910.145 - Specificaties voor borden en labels ter preventie van ongevallen. OSHA
OSHA Categorieën van veiligheidsborden (50487). Veel downloadbare afbeeldingen.
Wat betekenen de verschillende kleuren van veiligheidsborden?. bevat downloadbare afbeeldingen. Creative Safty Supply Waarom het knipperende "12:00" het ultieme symbool van technologische frustratie uit de jaren '90 werd. Sydney Butler, howtogeek.com

Ik zou uw gedachten, reacties en kritiek met betrekking tot dit hoofdstuk op prijs stellen: uw antwoord—David McMurrey.