Konventionen und Symbole in der Dokumentation
Tabelle 1
Konventionen in der Dokumentation
Konvention
Mittelblauer Text:
Mittelblauer, unterstrichener Text
http://www.hp.com
(
Fettschrift
Kursivschrift
Festbreitenschrift
Festbreitenschrift,
kursiv
Festbreitenschrift, fett
VORSICHT!
oder zum Tod führen kann.
ACHTUNG:
an den Geräten oder zu Datenverlust führen kann.
WICHTIG:
Enthält erläuternde Informationen oder spezielle Anleitungen.
!
HINWEIS:
Enthält zusätzliche Informationen.
TIPP:
Enthält hilfreiche Tipps und Verknüpfungen.
12
Abbildung 1
)
Weist darauf hin, dass die Nichtbeachtung der Anleitungen zu Verletzungen
Weist darauf hin, dass die Nichtbeachtung der Anleitungen zu Schäden
Element
Querverweise und E-Mail-Adressen
Website-Adressen
•
Tastenbezeichnungen
•
In ein GUI-Element, z. B. ein Feld, eingegebener Text
•
GUI-Elemente, die angeklickt oder ausgewählt werden,
wie etwa Menüpunkte und Listenelemente, Schaltflächen
oder Kontrollkästchen.
Hervorhebung von Text
•
Datei- und Verzeichnisnamen
•
Systemausgabe
•
Code
•
Auf der Befehlszeile eingegebener Text
•
Codevariablen
•
Befehlszeilenvariablen
Hervorhebung von Datei- und Verzeichnisnamen,
Systemausgaben, Code und auf der Befehlszeile
eingegebenem Text