Besondere Hinweise

Besondere Hinweise sind ein wichtiges Merkmal professioneller technischer Dokumentation: Sie heben spezielle Informationen hervor, die Leser wissen müssen, um zu verstehen, was sie lesen, um das zu erreichen, was sie tun wollen, um Schäden an Geräten zu vermeiden und um zu verhindern, dass sie sich selbst oder andere verletzen.

Sehr besondere Hinweise. Hochmoderne Hinweise mit cleveren Kommentaren.

Richtlinien für bestimmte Arten von Benachrichtigungen

Dieses Kapitel präsentiert einen einen spezifischen Stil von Hinweisen. Seien Sie sich sehr bewusst, dass andere Stile und Formate existieren.

Verwenden Sie spezielle Hinweise, um wichtige Punkte hervorzuheben oder die Leser vor Schäden oder Verletzungen zu warnen oder zur Vorsicht zu ermahnen.
Sei vorsichtig damit, die Arten besonderer Hinweise präzise zu verwenden, für ihre definierten Zwecke. Verwende die vier Arten besonderer Hinweise auf die folgenden Weisen:

Hinweis—Um Punkte oder Erinnerungen hervorzuheben, oder um auf kleinere Probleme in einem Verfahren hinzuweisen.

Vorsicht—Um Leser vor möglichen Schäden an Geräten oder Daten, vor möglichen Problemen beim Ausgang dessen, was sie tun, oder vor möglichen negativen Erfahrungen (wie zum Beispiel Peinlichkeiten) zu warnen.

Warnung—Um Leser vor der Möglichkeit leichter Verletzungen an sich selbst oder anderen zu warnen.

Gefahr—Um die Leser vor der Möglichkeit schwerer oder tödlicher Verletzungen an sich selbst oder anderen zu warnen.

Hinweis: Schauen Sie sich in Ihrer Garage oder Küche um, und sehen Sie sich die speziellen Hinweise an, die Sie auf Produkten sehen. Sie werden viele Variationen sehen, die wahrscheinlich von bestimmten Branchen- oder Unternehmensstandards abhängen.

Die Entscheidung, welche Art von Hinweis verwendet werden soll, ist keine exakte Wissenschaft. Verwenden Sie einfach keinen Gefahrenhinweis, wenn ein Warnhinweis angemessener ist (das wäre wie "falschen Alarm schlagen"). Verwenden Sie Hinweise außerdem konsequent im gesamten Dokument. Tun Sie nicht Erstellen Sie Ihre eigenen Hinweise, z. B. indem Sie "Important:" anstelle von "Warning." setzen

Platzieren Sie besondere Hinweise an der Stelle im Text, an der sie benötigt werden. Zum Beispiel platzieren Sie einen Hinweis 'Vorsicht' oder 'Gefahr' kurz bevor oder kurz nach einen Schritt zu besprechen, bei dem sich Leser verletzen könnten.
Vermeiden Sie, an einer Stelle im Text zu viele besondere Hinweise zu haben. Andernfalls geht die Wirkung ihres speziellen Formats verloren. (Wenn Sie zu viele haben, fassen Sie sie zusammen.)
Bei Warnhinweisen, Vorsichtshinweisen und Gefahrenhinweisen, erklären Sie die Folgen, wenn der Hinweis nicht beachtet wird. Geben Sie an, was passieren wird, wenn der Leser den Hinweis nicht beachtet.
Die Beispiele in diesem Abschnitt verwenden Fettschrift. Vermeiden Sie durchgehende Großschreibung für den Text eines Sonderhinweises.

Hinweis: In einem richtig eingerichteten Veröffentlichungsbereich müssten technische Redakteure nicht entscheiden, welche Art von Hinweis zu verwenden ist oder gar den Hinweistext verfassen. Das sollte die Aufgabe der Unternehmensjuristen sein. Dennoch könnten diese Juristen zu beschäftigt sein, um Ihre Hinweise zu prüfen, und so könnte die Last weiterhin bei Ihnen, dem technischen Redakteur oder Lektor, liegen.

Format für besondere Hinweise

Verwenden Sie Folgendes für spezifische Angaben zur Groß- und Kleinschreibung, Typografie (Fett, Unterstreichung, verschiedene Schriftarten, verschiedene Schriftgrößen) und zum Abstand für jede Art von Sonderhinweis.

Hinweis

Verwende das folgende Format für einfache Notizen:

Gib das Label "Note" ein, gefolgt von einem Doppelpunkt. (Obwohl einige der folgenden Beispiele Fettdruck verwenden, verwende vorzugsweise Kursivschrift, um visuelle Verwechslungen mit Überschriften zu vermeiden.)
Beginnen Sie, den Text der Notiz ein Leerzeichen hinter dem Doppelpunkt zu tippen. (Aber formatieren Sie den Text der Notiz nicht fett oder kursiv.)
Innerhalb des Textes der Notiz einfachzeilig; eine Zeile oberhalb und eine Zeile unterhalb der Notiz überspringen.
Beginne umgebrochene Zeilen am normalen linken Rand.
Richten Sie die Anmerkung am Text aus, auf den sie sich bezieht (wie im zweiten Beispiel veranschaulicht).

Example of a simple note
Beispiel einer einfachen Notiz

Example of a note within a bulleted list
Beispiel einer Anmerkung innerhalb einer Aufzählung (kein regulärer Fließtext). Dasselbe Prinzip (dass besondere Hinweise an den Text, auf den sie sich beziehen, ausgerichtet sind) gilt auch für die anderen Arten von besonderen Hinweisen.

Notizen

Verwenden Sie das folgende Format für mehrere Notizen:

Verwende dieses Format, wenn du so viele Notizen hast, dass es ablenkend wäre, sie einzeln zu präsentieren.
Tippe das Label "Notes" gefolgt von einem Doppelpunkt. (Obwohl einige der folgenden Beispiele Fettdruck verwenden, ziehe Kursivschrift vor, um visuelle Verwechslungen mit Überschriften zu vermeiden.)
Verwende eine nummerierte Liste für die einzelnen Notizen; darin befolge die Regeln für nummerierte Listen. (Verwende für die einzelnen Notizen keine Fettschrift oder Kursivschrift.)
Richten Sie die Anmerkungen am Text aus, auf den sie sich beziehen; überspringen Sie jeweils eine Zeile oberhalb und unterhalb der Anmerkungen.

Example of a multiple note
Beispiel einer mehrfachen Notiz. Verwende dieses Format, wenn du viele Notizen hast und sie alle an einem Ort sammeln möchtest, um Ablenkungen zu vermeiden.

Vorsicht

Verwenden Sie das folgende Format für Warnhinweise:

Gib das Label "Caution" ein, gefolgt von einem Doppelpunkt, und markiere sowohl das Label als auch den Doppelpunkt fett.
Lassen Sie eine Zeile frei und beginnen Sie den Text der Warnung an der Stelle, an der das Warnhinweis-Etikett beginnt.
Den Text des Warnhinweises einfachzeilig setzen; lasse eine Leerzeile über und unter dem Hinweis.
Bringe den Vorsichtshinweis in Übereinstimmung mit dem Text, auf den er sich bezieht (im Vorstehenden befindet sich der Warnhinweis innerhalb einer nummerierten Liste und ist entsprechend eingerückt).

Example of a caution notice
Beispiel eines Warnhinweises. Verwenden Sie dieses, um die Leser auf mögliche Schäden an der Ausrüstung oder auf Probleme mit dem Verfahren aufmerksam zu machen.

Warnung

Verwenden Sie das folgende Format für Warnungen:

Geben Sie das Label "Warning," ein, machen Sie es kursiv, und fügen Sie einen Doppelpunkt hinzu.
Entweder per Tabulator zum Beginn des Warntextes springen, oder das Format mit hängendem Einzug verwenden (was viel besser ist). Das Format mit hängendem Einzug für die Warnung im folgenden Beispiel verwendet 0,63 Zoll sowohl für den Tabulator als auch für den hängenden Einzug, aber die Schriftgrößen können diesen Wert verändern.
Hinweis: Sehen Erstellen Sie einen hängenden Einzug für ein Video über das Erstellen des Formats für einen hängenden Einzug in Microsoft Word.
Verwenden Sie die normale Schrift des Fließtexts für den Text des Warnhinweises (kein Fettdruck, keine Kursivschrift, keine durchgehenden Großbuchstaben, keine Farbe).
Bringen Sie den Warnhinweis mit dem Text, auf den er sich bezieht, in Einklang.
Überspringen Sie das Äquivalent einer Zeile oberhalb und unterhalb des Warnhinweises.

Example of a warning notice
Beispiel für einen Warnhinweis. Verwenden Sie dieses, um Leser auf die Möglichkeit leichter Verletzungen aufmerksam zu machen.

Gefahr

Verwenden Sie das folgende Format für Gefahrenhinweise:

Schreibe das Label "DANGER" in fetten Großbuchstaben.
Richten Sie den Gefahrenhinweis am Text aus, auf den er sich bezieht.
Formatiere den Text des Gefahrenhinweises einzeilig; lasse eine Leerzeile oberhalb und unterhalb des Gefahrenhinweises.
Setzen Sie den Text des Gefahrenhinweises fett, falls Sie ihn haben (aber niemals in Großbuchstaben).
Wenn Sie grafische Fähigkeiten haben, zeichnen Sie ein Kästchen um den Gefahrenhinweis (einschließlich des Etiketts).

Gefahrenhinweis.

Hinweisbilder (Symbole)

Bitte sehen Sie Allgemeine Hinweisbilder.

Andere Formatierungsprobleme

Hier sind einige zusätzliche Punkte, die Sie im Zusammenhang mit besonderen Hinweisen berücksichtigen sollten:

Spezielle Ausrichtung. Besondere Hinweise müssen an den Text ausgerichtet sein, auf den sie sich beziehen. Zum Beispiel, wenn Sie eine Anmerkung haben, die ein besonderes Detail zu etwas in einem Aufzählungspunkt hinzufügt, müssen Sie diese Anmerkung an den Text des Aufzählungspunkts. Natürlich, wenn die Anmerkung einer Aufzählung folgt, sich aber auf die gesamte Liste bezieht, dann kann man den normalen linken Rand verwenden.

Text mit einfachem Zeilenabstand. Alle Beispiele und Diskussionen in dieser Einheit basieren auf einzeiligem Text. Lassen Sie entweder eine Leerzeile zwischen Fließtext und besonderen Hinweisen—je nachdem, was Ihnen am besten erscheint. (Und natürlich wären sowohl der Fließtext als auch der Text der besonderen Hinweise einzeilig.)

Platzierung besonderer Hinweise. Platzieren Sie besondere Hinweise kurz vor oder kurz nach den Punkt, an dem sie relevant sind. Zum Beispiel können Sie Leser warnen, alle Daten zu sichern vor Sie fordern sie auf, ihre Festplatte neu zu formatieren. In der Praxis werden ernsthafte Sonderhinweise jedoch ganz am Anfang eines Verfahrens angebracht, wenn dort mit großem Schaden an Daten, Geräten oder Personen zu rechnen ist.

Eine Technik, die von sehr vorsichtigen Autoren (vielleicht solchen, die schlechte Erfahrungen gemacht haben) verwendet wird, besteht darin, alle ernsthaften Hinweise (Warnungen, Vorsichtshinweise und Gefahren) irgendwo am Anfang des Dokuments zu platzieren, und sie dann einzeln dort zu wiederholen, wo sie gelten. Eine Organisation hat wahrscheinlich einen Stilleitfaden, der Anforderungen an die Platzierung von Hinweisen festlegt.

Tabelle der Bedeutungen von Sonderhinweisen. Benutzerhandbücher platzieren oft eine Tabelle mit den Bedeutungen der verschiedenen Arten von Hinweisen im Vorwort, wie teilweise am unteren Rand dieser Abbildung dargestellt. Beachten Sie, dass in diesem Beispiel kein Vorsichtshinweis-Typ vorhanden ist; dies veranschaulicht lediglich, wie Hinweise je nach Branche variieren:

Chart of notice types
Beachte das Diagramm. In diesem Beispiel gibt es keinen Warnhinweistyp, was veranschaulicht, wie Hinweise je nach Branche variieren.

Mehrere besondere Hinweise.