# Regeln für die Strukturierung von Listen in der technischen Dokumentation
Listen bieten ein gutes Gleichgewicht zwischen linearer Prosa und Tabellen zur Organisation von Informationen. Verwenden Sie nummerierte Listen für sequenzielle Aktionen, bei denen die Reihenfolge wichtig ist: Installationsschritte, Algorithmen. Verwenden Sie Aufzählungslisten für Sammlungen von Elementen ohne strenge Reihenfolge: Parameter, Komponenten.
Halten Sie Listen auf eine angemessene Länge. Listen, die Hunderte von Zeilen umfassen, sind schwer zu überfliegen – teilen Sie sie in Unterabschnitte oder Tabellen auf.
Einleitender Satz als Leitfaden
Verwenden Sie immer einen einleitenden Satz vor einer Liste, um ihren Inhalt zu definieren. Er liefert Kontext und verbindet die Elemente miteinander.
Beispiele für einleitende Sätze:
- Führen Sie die folgenden Aktionen zur Initialisierung aus:
- Parameter der Hauptfunktion:
- Erforderliche Systemkomponenten:
Regeln zur Bildung:
- Platzieren Sie einen einheitlichen Begriff (Aktionen, Parameter, Schritte) nahe am Ende.
- Vermeiden Sie die Angabe der Anzahl der Elemente – sie kann bei Änderungen veralten.
- Wenn kein spezifischer Begriff passt, verwenden Sie Generika: Element, Teil, Schritt.
Das gewährleistet Konsistenz und erleichtert das Überfliegen des Textes.
Nominalphrasen für Konsistenz
Formulieren Sie Listenelemente als Nominalphrasen. Das schafft eine einheitliche Struktur und verbessert die Lesbarkeit. Beispieltransformation:
Falsch: Der Prozess besteht aus: Blankung, Vorbereitung, Versand.
Richtig: Der Prozess besteht aus den folgenden Schritten: Blankung, Vorbereitung, Versand.
Alle Zeilen sollten grammatikalisch konsistent sein, ohne Vermischung von Satzteilen und vollständigen Sätzen.
Wiederholungen in Elementen vermeiden
Wiederholte Wörter am Anfang von Listenelementen erzeugen einen papageienhaften Effekt. Verschieben Sie das gemeinsame Wort in den einleitenden Satz.
Beispiel:
Falsch:
- Bibliothek A
- Bibliothek B
- Bibliothek C
Richtig: Installieren Sie die folgenden Bibliotheken:
- A
- B
- C
Das kürzt den Text und schärft den Fokus auf die wesentlichen Details.
Listen mit einem einzigen Element
Freistehende Listen mit nur einem Element stören die Einheitlichkeit und deuten auf Formatierungsfehler hin. Integrieren Sie das Element in den einleitenden Satz.
Beispiel: Statt einer Liste mit „Eingabeparameter: user_id“ schreiben Sie: „Der Eingabeparameter user_id ist die Benutzerkennung“.
Interpunktion in Listen
Konsistenz wahren:
- Zeilen, die mit einem Großbuchstaben beginnen, enden mit einem Punkt.
- Zeilen, die kleingeschrieben beginnen, enden mit einem Semikolon.
Bei mehrabsätzigen Elementen die erste Variante verwenden. Das folgt den Standards der technischen Dokumentation.
Regeln für verschachtelte Listen
Verschachtelung vereinfacht hierarchische Strukturen, erfordert aber Disziplin.
Nummerierungsstufen:
- Stufe 1: 1, 2, 3
- Stufe 2: 1.1, 1.2
- Stufe 3: 1.1.1, 1.1.2
Buchstaben und römische Zahlen vermeiden – sie erschweren die Navigation.
Verschachtelungstiefe: Nicht mehr als 5 Stufen. Bei Bedarf in Unterabschnitte aufteilen. Vier Stufen werden für optimale Lesbarkeit empfohlen.
Nach Aufzählungslisten: Nummerierung nicht fortsetzen. Das vermeidet Unklarheiten bei der Nummerierung.
Beispiel für eine problematische Struktur:
- Stufe 1
1.1. Stufe 2
- Aufzählung
1.1.1? // Unklar
Wichtige Punkte
- Nummerierte Listen nur für Sequenzen verwenden; Aufzählungslisten für Mengen.
- Einleitender Satz mit einheitlichem Begriff obligatorisch – keine Anzahl angeben.
- Nominalphrasen und keine Wiederholungen in Elementen.
- Maximal 5 Verschachtelungsebenen; Nummerierung setzt nach Aufzählungspunkten nicht fort.
- Interpunktion: Punkt bei großgeschriebenen Zeilen, Semikolon bei kleingeschriebenen.
Listen erhöhen die Überfliegbarkeit in technischen Texten wie Dokumentationen, Anleitungen und Artikeln. Das Befolgen dieser Regeln minimiert die kognitive Belastung für Mid-/Senior-Entwickler und technische Spezialisten.
— Editorial Team
Noch keine Kommentare.