Text in Anleitungen formatieren
Version: 2.0 · Stand: 2026-07-04 · Struktureller Bezug: Microsoft Writing Style Guide – Formatting text in instructions (CC BY 4.0) · Normative Grundlage: Duden; DIN 5008; etablierte Software-Terminologie DE
Einheitliche Formatierung hilft, UI-Elemente vom übrigen Text zu unterscheiden. Grundsatz: möglichst die Handlung beschreiben, nicht das UI-Element benennen. Ist eine Benennung nötig, gilt die folgende Tabelle.
Siehe auch Interaktionen mit der Oberfläche · Groß- und Kleinschreibung · Häufige Textelemente formatieren
| Element | Konvention | Beispiel |
|---|---|---|
| Schaltflächen, Kontrollkästchen, Optionen | Fett, Eigenschreibweise der Oberfläche. Doppelpunkt/Auslassungspunkte der Beschriftung in der Anleitung weglassen. Elementart (Schaltfläche, Kontrollkästchen) nur zur Klarheit nennen. | Wählen Sie Speichern unter (nicht Speichern unter …). |
| Menüs, Registerkarten, Bereiche, Dialoge | Fett, Eigenschreibweise. Menü, Registerkarte, Dialogfeld nur zur Klarheit. | Wählen Sie im Menü Entwurf die Option Farben. |
| Befehle | Fett. Befehl nur zur Klarheit. | Wechseln Sie zu Extras und wählen Sie Sprache ändern. |
| Kommandozeilenbefehle und -optionen | Code-Stil, Groß-/Kleinschreibung wie einzugeben. | openssl x509 · -days 365 |
| Tastennamen und -kombinationen | Deutsche Tastennamen, Großbuchstaben, fett; + ohne Leerzeichen. | Drücken Sie STRG+UMSCHALT+S. |
| Fehlermeldungen | Normale deutsche Schreibung; im Text in Anführungszeichen „…“. | Erscheint die Meldung „Zertifikat konnte nicht geprüft werden“, aktualisieren Sie die Vertrauensliste. |
| Datei- und Ordnernamen | Eigenschreibweise; fett, wenn die Kundschaft sie eingibt/auswählt; Code-Stil in Syntax. | Geben Sie backup-2026.pfx ein. |
| Dateinamenerweiterungen | Klein, mit Punkt. | .pem, .pfx, .log |
| Platzhalter | Kursiv (UI-Text) bzw. spitze Klammern in Code. | Geben Sie Kennwort ein. · –out <dateiname> |
| Zeichenfolgen (Strings) | In Anführungszeichen „…“ oder Code-Stil. | Wählen Sie „Jetzt ist es so weit.“ |
| Produkte, Dienste, Marken | Eigenschreibweise. | Data Gateway, PQ-Crypto-Bibliothek |
| URLs | Klein; Umbruch vor Schrägstrich, kein Bindestrich. Siehe URLs und Webadressen. | www.thewhiteknightlabs.de |
In der Oberfläche und in allgemeinen Inhalten
Direkt in der Oberfläche sowie in Blog- und Marketingtexten werden Fett- und Kursivschrift vermieden. Stattdessen eine der folgenden Methoden wählen und einheitlich beibehalten:
- die Handlung beschreiben, ohne die Beschriftung zu nennen;
- eine Formulierung wählen, die den Elementnamen klar heraushebt;
- Anführungszeichen „…“ – sparsam, nur zur Klarheit.
Redaktionsleitfaden von The White Knight Labs. Aufbau nach dem Microsoft Writing Style Guide (© Microsoft Corporation, CC BY 4.0); Inhalte für den deutschsprachigen Raum eigenständig erarbeitet. Sprachregeln nach amtlicher deutscher Rechtschreibung, Duden und DIN 5008.