Hervorhebung und Betonung

Sag uns, wo du dich befindest!

Inhalt dieses Kapitels

Grundlagen hervorheben
Spezifische Betonungstechniken

Häufige Probleme beim Hervorheben
Weitere Erkundungen
Hervorhebungsschema

Ihre Kommentare zu diesem Kapitel

Suchen!

Hauptverzeichnis

Hervorhebung, wie der Begriff hier verwendet wird, ist der Einsatz typografischer Effekte, um Aufmerksamkeit auf Text zu lenken. Diese Effekte können Kursivschrift, Fettdruck, Versalien, Anführungszeichen, Farbe usw. umfassen. Hervorhebungen ziehen die Aufmerksamkeit der Leser auf—oder "weisen"—auf Handlungen hin, die sie ergreifen müssen, oder auf Informationen, die sie sorgfältig berücksichtigen sollten.

Eines der Probleme im technischen Schreiben—insbesondere im technischen Schreiben über Computer—betrifft die Verwendung der verschiedenen Techniken zur Betonung. Leider gehen einige technische Texte bei der Verwendung der hier besprochenen verschiedenen Betontechniken über das Ziel hinaus.

Grundlagen des Hervorhebens

Betrachten Sie einige grundlegende Prinzipien der Betonung:

• Nahezu jeder spezielle Texteffekt, der sich vom regulären Fließtext unterscheidet, kann als Hervorhebungs-Technik fungieren. Dinge wie Kursivschrift, Fett, Unterstreichungen, Großbuchstaben, unterschiedliche Schriftgrößen, alternative Schriftarten, Farben und verschiedene grafische Einfälle (Hervorhebung, umgekehrte Farben, Konturenschriften) können als Hervorhebungs-Techniken wirken.
• Bei übermäßigem Gebrauch kann jede Betonungstechnik oder Kombination von Betonungstechniken ihre Fähigkeit zur Betonung verlieren und unruhig und ablenkend werden. Bei übermäßigem Gebrauch kann jede Betonungstechnik oder Kombination von Betonungstechniken dazu führen, dass Leser zögern, einen Text zu lesen, wenn sie ihn nicht ganz meiden. Beachten Sie, wie unleserlich die übermäßig hervorgehobene Version der Mitteilung in diesem Popup; beachten Sie auch, dass es nicht den empfohlenen Hinweistyp verwendet in Hinweise.
• Wenn längerer Text betont werden muss, verwenden Sie das Sonderhinweis-Format (statt zum Beispiel alles in fetter Schrift oder in Großbuchstaben zu schreiben).
• Eine sorgfältig geplante funktionale Beziehung muss zwischen dem betonten Text und der verwendeten Betonungstechnik bestehen.
• Betonungstechniken müssen konsequent verwendet werden, um zu verhindern, dass die Leser verwirrt werden.
• Um Konsistenz zu fördern, müssen Sie einen Style Guide oder ein Stylesheet verwenden, das alle Ihre Entscheidungen darüber festhält und dann vorschreibt, wie Sie Hervorhebungstechniken anwenden werden.
• Um Ihren Lesern zu helfen, Ihr Hervorhebungsschema zu verstehen, können Sie einen kurzen Abschnitt irgendwo in Ihrem Dokument (in der Regel im Vorwort) einfügen, in dem erklärt wird, wie Sie die Hervorhebungstechniken verwenden werden.

In der folgenden Diskussion werden Sie feststellen, dass jedes System von Hervorhebungstechniken ziemlich kompliziert und schwer für Schriftsteller und Redakteure zu merken sein kann. Sie werden bemerken, dass es viele gleichwertige Möglichkeiten gibt, Hervorhebungstechniken zu verwenden: In einigen Fällen ist es beispielsweise willkürlich, ob Sie Fettdruck oder Kursivschrift für einfache Hervorhebung verwenden. Um dieses Problem zu lösen, müssen Sie Ihre Richtlinien zur Hervorhebung in einem Stilhandbuch dokumentieren, auf das Schriftsteller und Redakteure (oder nur Sie) zurückgreifen können. Ein Styleleitfaden ist einfach eine Aufzeichnung der Entscheidungen, die Sie und Ihr Dokumentationsteam darüber getroffen haben, wie Sie möchten, dass Ihre Dokumente aussehen.

Ihre Leser müssen auch über das Hervorhebungsschema informiert werden, das Sie verwenden möchten. Dies kann im Vorwort behandelt werden: Fügen Sie einen Abschnitt mit dem Titel "Hervorhebung" oder "Typografische Konventionen" hinzu, in dem Sie auflisten, wie Sie Kursivschrift, Fettdruck, Schriftarten und andere derartige Effekte verwenden. Ein Beispiel finden Sie in der Diskussion über Vorworte im Kapitel über Standardkomponenten technischer Bücher

Spezifische Betonungstechniken

Dieser nächste Abschnitt behandelt nacheinander die verschiedenen Betonungstechniken und erklärt die gängigen Praktiken.

Hinweis: Um die Dinge einfach zu halten, Probleme hervorzuheben für Tische, Figuren, Überschriften, Listen, und Hinweise sind in diesen Abschnitten dargestellt.

Fett

Im Verlagswesen, insbesondere im technischen Verlagswesen, ist die Verwendung von fett oder kursiv für grundlegende Hervorhebung gemischt. Wenn man beispielsweise betonen möchte, dass die Leser den Computer nicht ausschalten sollen, ohne ihn vorher herunterzufahren, kann das "nicht" fett oder kursiv sein. Traditionell wurde kursiv verwendet, aber vielleicht aufgrund von Computern wird auch fett häufig verwendet.

Egal welche Technik Sie verwenden, wenden Sie sie konsequent in Ihrem Text oder in Ihrer Sammlung verwandter Texte an. Übrigens werden Leser wahrscheinlich nicht zwischen den verschiedenen Betonungsgraden unterscheiden können: Zum Beispiel wird die Verwendung von Kursivschrift für wichtigen Text und Fettdruck für sehr wichtigen Text den meisten Lesern wahrscheinlich entgehen.

Wenn Sie versucht sind, einen gesamten Absatz fett zu formatieren, denken Sie an eines der Prinzipien der Betonung, die oben besprochen wurden: Zu viel Einsatz einer Betonungstechnik führt dazu, dass die Wirkung der Technik verloren geht. Nicht nur das, sondern zu viel Betonung macht Leser weniger geneigt, zu lesen. Anstatt einen vollständig fetten Absatz sorgfältig zu lesen, ignorieren die Leser ihn vielleicht einfach ganz!

Statt einen vollständig fetten Absatz zu erstellen, verwenden Sie die Sonderhinweis-Format. Darin ist ein Schlüsselwort (z. B. Wichtig, Hinweis, Gefahr, Vorsicht, Warnung) fettgedruckt, während der restliche Text in normalen Buchstaben (d. h. derselben Schriftart und dem gleichen Stil wie der reguläre Fließtext) belassen wird.

Die legitime Verwendung von Fettdruck in technischen Texten variiert erheblich. Solange Sie ein Schema entwickeln, das direkt mit den Bedürfnissen des Lesers und den Merkmalen des Textes (oder der Technologie) zusammenhängt und nicht zu übertriebenem Einsatz führt, sollte Ihre Verwendung von Fettdruck gut funktionieren.

Hier sind einige gängige, standardmäßige Verwendungen von Fettgedrucktem:

• Einfache Betonung. Wie im Vorangegangenen besprochen, verwenden einige technische Texte Fett für einfache Hervorhebung statt der traditionellen Kursivschrift. Zum Beispiel, "Tun nicht "Schalte den Computer aus, bevor du ihn herunterfährst."
• Befehle. Computertexte verwenden häufig Fettformatierung für Befehle, zum Beispiel: "Verwenden Sie das bewegen Befehl zum Umbenennen von UNIX-Dateien." Siehe den Abschnitt über das Hervorheben von Computertext für eine Übersicht über die vollständige Reihe von Betonungstechniken.
• Tasten, die Befehle auslösen. In einer grafischen Benutzeroberfläche initiieren einige der Schaltflächen Befehle. Zum Beispiel "drücke die Ausgang Schaltfläche, um die Anwendung zu beenden.
• Feldbezeichnungen. Während einige Computertexte Feldbezeichnungen fett drucken, ist dies nicht allgemeine Praxis, da es zu einer Überbetonung führt. Zum Beispiel: "In der Einrückung Bereich des Dialogfelds, klicken Sie auf Links." Häufiger ist es, den auf dem Bildschirm verwendeten Schriftstil zu verwenden. Es ist bevorzugt, dies zu schreiben: "Im Einrückungsbereich des Dialogfelds klicken Sie auf Links."
• Symbole oder Tastatur- oder Maustasten. Obwohl nicht allgemein verwendet, ist eine weitere hervorhebende Technik, die diesem System logisch folgt, die Schriftart des Namens einer Tastaturtaste oder Maustaste fett zu drucken. Zum Beispiel: „Drücken Sie die Q Schlüssel oder der links Maustaste." Im Einklang mit diesem System ist es auch, fett für Icons zu verwenden: "Klicken Sie auf die Start Icon."
• Beschriftungen auf Hardware. Eine weitere gängige Praxis im Bereich der Computerveröffentlichung ist es, den Namen eines Hardware-Labels fett zu drucken. Zum Beispiel: "Drücken Sie die Zurücksetzen "Schaltfläche, um den Computer neu zu starten."

Sie werden feststellen, dass die vorhergehende Diskussion keine absoluten Regeln aufstellte. So ist es—die technische Publikationspraxis ist ziemlich vielfältig. Die Hauptidee besteht darin, ein logisches, kontrolliertes System zur Hervorhebung zu entwickeln, es konsequent zu verwenden und es in einem Stilhandbuch zu dokumentieren, damit Sie und Ihre Teammitglieder im Dokumentationsteam darauf verweisen können.

Kursivschrift

Hier sind einige der Standardverwendungen für Kursivschrift:

• Einfache Betonung. Wie bereits erwähnt, ist die Verwendung gemischt, ob man fett oder kursiv für einfache Betonung verwenden sollte, obwohl kursiv traditionell war: zum Beispiel, "Tu nicht "Schalte den Computer aus, bevor du ihn herunterfährst." Welches du auch verwendest, sei damit konsistent und dokumentiere es in deinem Style Guide oder Style Sheet, damit jeder in deinem Dokumentationsteam es sehen kann. Wenn du dir unsicher bist, welchen Stil du verwenden sollst, benutze Kursivschrift für einfache Betonung: es ist weniger unruhig.
• Variablen . In der Computerverlag, eine der häufigsten Anwendungen von Kursivschrift ist für Variablen. Zum Beispiel:
  
  Kopie alteDatei neueDatei
  
  Benutzer wissen, dass sie nicht tippen sollen. alteDatei oder neueDatei aber stattdessen ihre eigenen Dateinamen zu verwenden.
• Definitionen in Definition (Zwei-Spalten) Listen. Während Fettdruck in der linken Spalte einer zweispaltigen Liste häufiger verwendet wird, wird auch kursiv verwendet. (Siehe die Diskussion über zweispaltige Listen im vorhergehenden Abschnitt über Fettdruck.)
• Bedingungen, unter denen der Begriff definiert ist. Ein schöner Akzent ist es, ein Wort zu kursivieren, wenn es im regulären Fließtext definiert wird.

Unterstriche

Es gibt fast keinen Grund, Unterstriche in technischen Texten zu verwenden. In der Zeit der maschinenschriftlichen Texte gab es diesen sicherlich. In diesen Zeiten, in denen Fett-, Kursivschrift und andere typografische Effekte problemlos zur Verfügung stehen, wirken Unterstriche veraltet. Wenn Sie etwas betonen möchten, verwenden Sie Ihre Standardrichtlinien—zum Beispiel, verwenden Sie Kursiv- oder Fettdruck. Versuchen Sie nicht, Abstufungen der Betonung zu schaffen: Eine Skala zunehmender Wichtigkeit von Kursivschrift über Fettdruck bis hin zu Unterstrichen wird von Ihren Lesern nicht erfasst.

Wenn Sie eine gute Verwendung von Unterstrichen in technischem Text sehen, wird dies wahrscheinlich im Design von Überschriften auftreten.

Großschreibung

In der technischen Veröffentlichung scheint es einen dauernden Konflikt zwischen technischen Redakteuren und technischen Experten über die Großschreibung zu geben. Technische Experten verwenden gerne Großbuchstaben für praktisch jede Komponente und jeden Prozess in einem System. Außerdem verwenden technische Experten (und das Management) typischerweise Großbuchstaben für Text, den sie als wichtig erachten und auf den sie die Leser aufmerksam machen möchten. Inzwischen bestehen technische Redakteure und Lektoren (zu Recht) darauf, Großbuchstaben nur für Eigennamen zu verwenden.

Als technischer Redakteur sollte man bei der Großschreibung konsequent bleiben. Großbuchstaben sind ablenkend; Text in Großbuchstaben ist unangenehm zu lesen. Großbuchstaben erzeugen einen unruhigen Text, der viele unnötige Signale sendet. Großbuchstaben sind traditionell für Eigennamen wie Microsoft, Netscape, Gateway, Dell Computer, WordPerfect und so weiter gedacht. Die klassische Richtlinie im technischen Verlagswesen besagt, dass die Namen von einzeln bestellbare Produkte nur. Die Politik von Organisationen biegt diese Richtlinie erheblich. Wenn ein Unternehmen stolz auf ein bestimmtes Merkmal in seinem neuen Release ist, zum Beispiel EnergyMiser, wird es es großschreiben, auch wenn man es nicht separat bestellen kann.

Hier sind einige typische Richtlinien für die Großschreibung:

• Verwenden Sie den exakten Großschreibstil von Nachrichten, die auf dem Computerbildschirm angezeigt werden, sowie von Menüs oder Bildschirmnamen, Feldnamen, Hardwarebeschriftungen usw. (In älteren Benutzeroberflächen wurde Großbuchstaben für Dinge wie Felder, Menüs und Bildschirmnamen verwendet. Eine gängige Praxis in diesen Fällen ist die Verwendung von Anfangsbuchstaben für Verweise auf diese Dinge im normalen Text. Das Prinzip hier ist, dass unnötige Großbuchstaben im normalen Text ablenkend sind.)
• Mach nicht Verwende stattdessen *kursiv* oder **fett**.
• Verwenden Sie keine Großbuchstaben für längere Texte; verwenden Sie die Sonderhinweis-Format stattdessen.
• Die Namen der Komponenten oder Prozesse eines Produkts sollten nicht großgeschrieben werden. Nur die Namen von Produkten, das heißt, Komponenten, die separat bestellbar sind, sollten großgeschrieben werden.
  
  Zum Beispiel könnte Ihr Produkt WordStuff heißen und es muss natürlich gemäß dem Stil, der von den Marketing- und Produktplanern vorgegeben ist, großgeschrieben werden. Eine der Funktionen von WordStuff, die "Rechtschreibprüfer" heißt, sollte jedoch nicht großgeschrieben werden—fast jeder hat so etwas. WordStuff könnte jedoch eine Funktion namens "ZippyFormat" und eine weitere namens "Image Worker" haben. Obwohl diese nicht separat bestellbar sind, möchten Sie den Initialgroßbuchstaben-Stil verwenden, aufgrund ihres speziellen Stils und ihres Marketingwerts. "Image Worker" ist offensichtlich etwas, das WordStuff, Inc., zur Schau stellen möchte—deshalb die Großbuchstaben.
  
  Aber wenn man Regeln wie diese brechen muss, müssen die Ausnahmen im Style-Guide oder im Stylesheet vermerkt werden.

Einfache oder doppelte Anführungszeichen

Anführungszeichen werden oft fälschlicherweise als Betonungstechniken in technischen Texten verwendet. Als technischer Autor sollten Sie Anführungszeichen auf die traditionelle Verwendung beschränken, die zitiertes Sprechen sowie Zahlen, Buchstaben oder Worte umfasst, die als solche bezeichnet werden. Anführungszeichen neigen, wie Großbuchstaben, dazu, einen geschäftigen, ablenkenden Text zu erzeugen und sollten daher vermieden werden.

Eine legitime Verwendung von doppelten Anführungszeichen ist die seltsame, eigenwillige, nichtstandardisierte Verwendung von Wörtern (die von „Angst-Anführungszeichen“ genannt wird) Chicago Handbuch für Schriftsteller). Zum Beispiel:

In einem Core-Dump spuckt der Computer alle Daten in eine einzige Datei aus.

Gut gestaltete Computertexte vermeiden Anführungszeichen recht entschieden. Einer der Hauptgründe ist, dass einige Leser fälschlicherweise annehmen könnten, dass sie die Anführungszeichen in die Befehle, die sie eingeben, aufnehmen müssen.

Hinweis: Während einige technische Texte gut definierte Verwendungen für einfache Anführungszeichen haben, gibt es im Allgemeinen keinen standardisierten Gebrauch für einfache Anführungszeichen, abgesehen von der traditionellen Regel für Zitate innerhalb von Zitaten und der Regel für außergewöhnliche Verwendungen. Wenn Sie einfache Anführungszeichen innerhalb technischer Texte sehen, gibt es normalerweise nicht mehr eine Begründung für ihre Verwendung als für doppelte Anführungszeichen.

Alternative Schriftarten

Einer der häufigsten Stile, die alternative Schriftarten verwenden, ist die Verwendung von Courier oder einer ähnlichen, monospaced, alt-typografischen Schriftart im Gegensatz zur Standardkörperschrift (wie Times New Roman oder Helvetica). Sie können diesen Effekt auf einer Webseite erzielen, indem Sie einen CSS-Stil wie <span class="example_text"> verwenden. Zum Beispiel, "Schrift installieren um das Programm zu installieren."

Hier ist eine Übersicht über die gängigen Verwendungen alternativer Schriftarten:

• Beispieltext. Um anzuzeigen, dass ein Beispiel gezeigt wird und kein erforderlicher Eintrag, wird oft eine alternative Schriftart wie Courier verwendet:

Zum Beispiel, wenn Sie eine Datei kopieren möchten, geben Sie ein kopiere deineDatei.txt myfile.txt. Eine Datei mit dem Namen myfile.txt wird erstellt, und sein Inhalt wird der gleiche sein wie deineDatei.txt.

• Angezeigter Text. Computer und andere Geräte zeigen typischerweise Dinge wie Warnungen, Statuscodes oder Fehlermeldungen an. Diese erscheinen auf Monitoren oder in LCD-Panels und ähnlichem. Wenn Sie sich auf diesen angezeigten Text beziehen, können Sie eine alternative Schriftart wie Courier verwenden. Zum Beispiel: „Wenn das Verzeichnis nicht existiert, wird das System mit Keine solche Datei oder Verzeichnis." Oder: "Wenn der Computer hochfährt, wird das digitale Anzeige-Fenster anzeigen 8888."
• Erweiterte Codebeispiele. In Computerprogrammierungstexten werden erweiterte Programmbeispiele häufig in Courier angezeigt, zum Beispiel:

#überprüfen Sie auf durchschnittliche Hacker if ($address1 eq "" & $address2 eq "") { &wicked_address (500, "Suchfehler", "Bitte geben Sie einen Namen ein."); } elsif ($address1 =~ /[;<>&\*`\|]/ | $address2 =~ /[;<>&\*`\|]/) { &wicked_address (500, "Suchfehler", "Fehlerhafte E-Mail-Adresse. Bitte zerstören Sie nicht unsere arme, bescheidene, virtuelle Schulklasse!."); }

Farbe

Farbe wird in technischen Texten verwendet, ist jedoch teuer und schwer im Publikationszyklus zu verwalten.

Allerdings ist Farbe einfach in Online-Informationen zu verwenden. Es ist üblich, hypertextliche Links, zum Beispiel, mit Farbe zu sehen. Online-Hilfen verwenden typischerweise grün, während Webseiten typischerweise blau für neue Links und lila für Links verwenden, die der Benutzer bereits erkundet hat.

Die Neigung, Farben ohne Rücksicht auf die Online-Informationen zu verwenden, ist sehr ähnlich der Neigung, in gedruckten Informationen wild mit Fettdruck, Kursivschrift, Schriftgrößen und alternativen Schriftarten umzugehen. Das Gefühl muss etwa so sein: „Es ist da, es ist cool, also lass es uns nutzen!“

Wenn Sie Farbe verwenden möchten, planen Sie dies sorgfältig. Erwarten Sie nicht, dass die Leser sich merken, dass Rot eine Idee signalisiert, Blau eine andere und Grün eine weitere Idee. Halten Sie sich einfach an eine Farbe. Im Allgemeinen sollten Sie es vermeiden, Farbe für längere Texte zu verwenden. Anstatt eine gesamte Warnhinweismeldung rot zu machen, machen Sie einfach das Warnlabel rot und lassen Sie den Warntext im regulären Schriftstil (Text wie der reguläre Fließtext).

Noch besser, lesen Sie einige der Standardliteratur zum Thema Farbe im Bereich der technischen Kommunikation. Es gibt allgemeine Gestaltungsfragen und internationale Fragen:

• Farbe verwenden. Bereitgestellt vom U.S. Web Design System (USWDS).
• Ein Internationaler Leitfaden zur Verwendung von Farbe im Marketing und in der Werbung. Unterschiedliche Bedeutungen, die Rot zum Beispiel international hat. Schauen Sie sich dessen an Internationales Farbsymbolik-Diagramm. Quelle: Six Degrees, LLC
• Erinnere dich daran, dass laut einem Artikel In Wikipedia heißt es: "Etwa 8 % der Männer und 0,4 % der Frauen sind in irgendeiner Form rot–grün farbenblind, sei es eine Farbe, eine Farbkombination oder eine andere Mutation."

Kombinationen der Vorangegangenen

Im Allgemeinen ist es eine schlechte Idee, Betonungstechniken zu kombinieren, zum Beispiel Fettdruck und kursiv. In nichtprofessionellen technischen Texten sieht man solche grellen Kombinationen wie durchgehend fett-kursiv in Großbuchstaben oder durchgehend fett-kursiv in Großbuchstaben mit Anführungszeichen. Vermeide diese!

Eine legitime Kombination besteht darin, Kursivschrift mit alternativen Schriftarten zu verwenden. Zum Beispiel, wenn Sie die Syntax eines Befehls zeigen, möchten Sie, dass der gesamte Text in Courier ist, aber Sie möchten auch, dass die Variablen kursiv sind:

kopieren AlterDateiname NeuerDateiname

Funktionale Namen für Zeichnungsstile und Tags

Wenn Sie jemals in der Verlagsbranche waren, haben Sie möglicherweise etwas namens semantische Auszeichnung. Das bedeutet, Abschnitte von Texten gemäß der strukturellen Rolle, die sie im Dokument spielen, zu benennen — zum Beispiel, Überschrift. Der Leser sieht diese Namen nicht, aber sie spielen eine wichtige Rolle dafür, wie das Dokument formatiert ist und wie es wiederverwendet werden kann.

Diese gleiche Idee gilt für Wörter in Phrasen innerhalb von Text. Zum Beispiel kann man im HTML einer Webseite die verwenden <b>fettgedrucktes Wort</b> Tags, um ein Wort fett zu machen. Aber fett zeigt nicht die Funktion des Wortes oder Satzes an. Stattdessen, Befehl würde oder Schnittstellenbezeichnung würden. Daher ist bei semantischer Auszeichnung mit HTML CSS alles funktionaler, wenn es so aussieht: <span class="command">fettgedrucktes Wort</span>.

Dateien, die HTML und CSS verwenden, werden typischerweise in andere Medien wie PDF oder sogar zwischen XML umgewandelt. Verwendung von funktional Benannte Hervorhebungsstile, wie oben beschrieben, können den Konvertierungsprozess erheblich erleichtern.

Weiterführende Erkundungen

Sobald Sie das Vorangegangene gelesen haben, ist es eine gute Idee, technische Veröffentlichungen zu erkunden, um zu sehen, welche Hervorhebungsschemata sie verwenden. Achten Sie darauf, wie Dinge wie Fett, Kursivschrift, Großbuchstaben, alternative Schriftarten und andere solche Effekte eingesetzt werden. Höchstwahrscheinlich werden Sie eine sehr unterschiedliche Verwendung sehen als das, was Sie hier gelesen haben. Während Sie erkunden, denken Sie über die Logik der Betonungstechniken nach, die Sie sehen; versuchen Sie, die Regeln zu formulieren, die die Autoren zu verwenden scheinen; achten Sie auf Inkonsistenzen in der Hervorhebung; und denken Sie kritisch über die Verwendung nach, die Sie sehen—ist sie logisch? Übertreibung? "Untertreibung?"

Nachdem Sie so etwas erkundet haben, ist der nächste logische Schritt, das Kapitel über Stilrichtlinien, falls du das noch nicht getan hast. Hervorhebungspläne müssen in Styleguides dokumentiert werden, damit du sie nicht vergisst und damit deine Teamkollegen in der Dokumentation darauf zugreifen können.

Hervorhebungschema

Wenn alle zuvor diskutierten Optionen und Alternativen Sie überwältigen, ziehen Sie in Betracht, das folgende Hervorhebungschema zu verwenden. Es basiert auf Hervorhebungen, die Sie in vielen UNIX-, Windows- und Linux-Dokumenten finden.

Notizen:

1. Regulär roman bezieht sich auf die Schriftart und Schriftgröße, die für den Fließtext verwendet wird.
2. Während diese Vorschläge "Kapitalstil auf dem Bildschirm" empfehlen, neigen Entwickler manchmal leider dazu, alles in Großbuchstaben zu schreiben. Da ein Großbuchstabenstil die Lesbarkeit verringert, verwenden Sie trotzdem Großbuchstaben am Anfang (Titelstil).
3. Wenn Sie den Benutzern zeigen, wie sie einen Befehl eingeben können, einschließlich Beispieltext, setzen Sie den Befehl, der im Beispieltext vorkommt, nicht in Fettdruck:

Verwenden Sie die mv Befehl zum Ändern des Namens oder des Standorts einer Datei, zum Beispiel:
mv dieseDatei.txt jeneDatei.txt.

4. Wenn Sie den Benutzern zeigen, wie sie einen Befehl eingeben können, einschließlich Beispieltext, und Variablen im Beispieltext enthalten sind, verwenden Sie kursiv für die Variablen.

Benutze die mv Befehl zum Ändern des Namens des Standorts einer Datei:
mv mein_datei.txt Bitte geben Sie den Text an, den Sie übersetzen möchten..

5. Wenn Sie einfach auf den Namen eines Bildschirms oder Menüs verweisen, das nicht angeklickt oder kein Ereignis auslöst, verwenden Sie Großbuchstaben für den Bildschirm und reguläres Roman.
6. Einige Stile betonen die Handlung, die die Benutzer ausführen sollen (zum Beispiel, drucke, eingeben, löschenDas ist certainly eine Option, aber für mich ist es zu viel Hervorhebung.

Benutzerhandbücher platzieren oft eine Tabelle mit den Bedeutungen von Hervorhebungs-Schriftarten, Farben und Typografie im Vorwort:

Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: deine Antwort.