Als technischer Schriftsteller müssen Sie in der Regel Indizes für die Druckbücher und für die Online-Hilfen erstellen, die Sie entwickeln. Der Typ von Index, den wir hier meinen, ist der klassische Index am Ende des Buches, der Seitenzahlen anzeigt, auf denen Themen und Unterthemen im Buch vorkommen. Ein Online-Index ist sehr ähnlich, außer dass Sie Hyperlinks anstelle von Seitenzahlen bereitstellen.

Index in einem Druckdokument

Index in einem Online-Hilfesystem (linke Seitenleiste)

Entwurf eines Indexes

Wie bei jedem Schreibprojekt gibt es auch für das Indizieren eine Entwurfsphase. Und natürlich müssen Sie über Ihr Publikum nachdenken—wer sie sind, wie sie das Register nutzen werden, warum sie es benutzen werden und mit welchen Begriffen sie möglicherweise vertraut sind. Danach folgen die nächsten Schritte:

  1. Konvertieren Sie jede Überschrift in mehrere Indexeinträge. Überschriften sind ein guter Ausgangspunkt: sie weisen auf Themen und Unterthemen hin — genau wie ein Index. Kopiere jedoch nicht einfach Überschriften direkt in einen Index und lass es dabei bewenden. Wie Sie weiter unten sehen werden, müssen Sie einträge, die auf Überschriften basieren, auf so viele Arten wie möglich quergelistet werden.
  2. Jeden Eintrag doppelt auflisten. Ändern der Bildschirmauflösung Bildschirmauflösung, ändern ändern der Bildschirmauflösung Auflösung, ändern der Bildschirm Bildschirm, Auflösung ändern

    Hier sind einige zusätzliche Beispiele:

    Überschrift Indexeinträge
    Optimierung der Videoanzeige Videodisplay, Optimierung
    Optimierung der Videodarstellung
    Anzeige, Videoclip optimieren
    Streaming-Multimedia abspielen Streamen von Multimedia, Abspielen
    streaming von Multimedia-Inhalten spielen
    Multimedia, Streaming abspielen
    Netzwerkgrundlagen Vernetzung
    Netzwerke
    Einführung in Streaming-Multimedia Streaming-Multimedia
    Multimedia, Streaming

    Beachten Sie, dass Sie nicht immer Indexeinträge für jedes Wort kreuzweise auflisten können. Zum Beispiel würde "Einführung von Streaming-Multimedia" in dem vorhergehenden Fall einfach nicht funktionieren. Würde ein Leser jemals nach diesem Thema suchen, beginnend mit "Einführung"?
  3. Erstellen Sie Synonym-Einträge. Leser verwenden möglicherweise nicht dieselbe Terminologie wie Sie in Ihrer Dokumentation. Sie könnten ein Diskettenlaufwerk als "Floppy Drive" bezeichnen. Sie könnten ein Display als "Monitor" bezeichnen. Als Indexierer müssen Sie diese häufigen Variationen in der Terminologie berücksichtigen. In den vorhergehenden Einträgen wäre es eine gute Idee, ein Synonym für "Video Display" wie "Monitor" zu verwenden. Aber anstatt die Seitenzahlen zu wiederholen, verwenden Sie eine Siehe Referenz. Auf diese Weise weisen Sie die Leser auf den bevorzugten Begriff hin. (Natürlich, wenn es nur eine Seitenzahl gibt, wiederholen Sie diese einfach mit dem Eintrag des Synonyms.)

    Hier sind einige weitere Beispiele:

    Indexeintrag Synonym-Einträge
    Lautstärke, Anpassung Lautstärke, einstellen
    Übertragungsrate Geschwindigkeit, Übertragung
    Video aufnehmen Video kopieren

  4. Überprüfen Sie den Text auf zusätzliche Indexeinträge. Es reicht normalerweise nicht aus, nur nach Überschriften zu indizieren. Man muss im Text nach Konzepten, Begriffen und Aufgaben suchen, die in den Überschriften nicht vertreten sind. Zum Beispiel könnten Sie unter der Überschrift „Erstellen eines Multimedia-Streams“ Definitionen von „Erfassung“ und „Kodierung“ sehen. Dies sind wichtige Begriffe, die jedoch nirgendwo in den Überschriften erscheinen—indizieren Sie sie auch! In diesem Fall möchten Sie diese zusätzlichen Indexeinträge erstellen: „Streams erfassen“ und „Streams kodieren“.
  5. Index Vorder- und Rückseite. Vergiss nicht, im Vorwort, in den Sicherheitshinweisen, Anhängen und anderen ähnlichen Zubehörteilen nach zusätzlichen Indexeinträgen zu suchen. In der Regel werden die technischen Supportnummern und Adressen im Vorwort angezeigt. Indiziere sie—und vergiss nicht, auch Querverweise und Synonyme für sie zu erstellen.

    Indexeintrag Klonierte und Synonym-Einträge
    Technischer Support Support, Technik
    Hilfetelefon
    Probleme

Überarbeitung und Verfeinerung eines Indexes

Sobald Sie alle Indexeinträge, an die Sie denken können, gesammelt haben, ist es Zeit zu sehen, wie der Index aussieht und mit der Überarbeitung zu beginnen. Um einen Rohentwurf-Index zu überarbeiten:

  1. Erstelle ein Erstentwurf-Inhaltsverzeichnis. Sobald Sie so viele Indexeinträge, Querverweise und Synonyme erstellt haben, wie Sie können, ist es an der Zeit, einen ersten Entwurf des Index zu "bauen". Es sei denn, Sie arbeiten auf altmodische Weise mit Karteikarten, können Sie Ihre Softwareanwendung dies für Sie erledigen lassen. Wenn Sie beispielsweise in einem Desktop-Publishing-System arbeiten, haben Sie Ihren Text durchgesehen und Indexeinträge eingefügt. Der gleiche Prozess gilt für Autorentools. Wenn Sie den ersten Entwurf des Index erstellen, lassen Sie sich nicht entmutigen. Es ist nur ein grober Entwurf, auf den Sie mehrere Arten von Überarbeitungen anwenden müssen.
  2. Werte nutzlose Einträge aus. In den vorhergehenden Schritten hast du einen Rohentwurf des Verzeichnisses erstellt. In dieser Phase solltest du dich nicht mit der genauen Formulierung der Einträge oder der Wahrscheinlichkeit, dass jemand sie jemals verwenden würde, aufhalten. Aber jetzt ist es Zeit, die Einträge auszusortieren, die kein Leser jemals verwenden würde. Zum Beispiel sind erste Einträge, die mit „Einführung“, „Verwendung“, „Über“ beginnen, wahrscheinlich nicht nützlich. Lösche sie! Aber lösche sie nicht aus dem erstellten Verzeichnis. Gehe zurück in dein Dokument und entferne den ursprünglichen Verzeichniseintrag.
  3. Einträge mit ähnlicher Formulierung konsolidieren. Sie werden auch viele Einträge finden, die nur geringfügige Unterschiede in der Formulierung aufweisen. Zum Beispiel:

    Rohentwürfe Überarbeitete Einträge
    Technologie, Streaming-Multimedia
    Technologien, Streaming-Multimedia    		 Technologien, Streaming-Multimedia
    Videoanzeige
    Videoanzeigen    		 Videodisplays
    Bildschirmauflösung ändern
    Ändern der Bildschirmauflösung    		 Bildschirmauflösung ändern

    Wie Sie in diesen Beispielen sehen können, sind Singular-/Plural-Einträge und Verbvariationen die häufigsten Ursachen für ähnliche Formulierungen in den Indexeinträgen. Ihr Hausstil kann vorschreiben, Singularformen anstelle von Pluralformen zu verwenden. Ganz gleich, wie Sie damit umgehen, seien Sie einfach konsistent.
  4. Gruppiere ähnliche Einträge. Sie werden auch Einträge sehen, die gruppiert und untergeordnet werden müssen. Zum Beispiel können sie alle mit demselben Wort beginnen, aber unterschiedliche Modifizierer haben. Hier ist ein Beispiel:

    Ähnliche Einträge Gruppierte und untergeordnete Einträge
    Projektor, definiert
    Projektoren, kompilieren
    Projektoren, Überlegungen
    Projektoren, die erstellen
    Projektoren, Fehlersuche

    		Projektoren

    kompilieren

    Überlegungen

    erstellen

    definiert

    Fehlerbehebung

  5. Überarbeiten Sie Einträge mit übermäßigen Seiteninhalten. Einige Organisationen haben tatsächliche Regeln für Stilrichtlinien, die festlegen, wie viele Seitenverweise nach einem Indexeintrag zulässig sind. Drei ist eine übliche Höchstzahl; zwei ist aggressiv, ehrgeizig. Zum Beispiel: "Programmiersyntax, 12, 45, 74, 122, 219, 222." Eine Reihe anonymer Seitenverweise wie diese hilft niemandem. Stattdessen sollten die Unterthemen für diese Seitenverweise identifiziert werden. Hier ist ein Beispiel:

    Zu viele nicht identifizierte Seitenverweise Untergeordnete und gekennzeichnete Einträge
    Projektoren, 124, 136, 154-155, 156 157 Projektoren

    kompilieren, 154-155

    Überlegungen, 156

    Steuerungen, 136

    definiert, 124, 136, 157


    Eine sehr gute Ergänzung, die man in Inhaltsverzeichnissen nicht oft sieht, ist der Seitenbereich, auf dem ein Thema behandelt wird—, selbst wenn es keine Untereinträge gibt. Wenn es genau wäre, könnte man einen Eintrag wie diesen haben: "Projektoren, 126–137"
  6. Suchen Sie nach Eingangsgruppierungen. Ein nützlicher Aspekt in Indizes ist, nach Möglichkeiten zu suchen, Einträge zu gruppieren. Stellen Sie sich beispielsweise ein Benutzerhandbuch vor, das die verschiedenen Dialogfenster erklärt, die in der Anwendung erscheinen. Da gibt es das Passwort-Dialogfeld, das Neu Benutzer-Dialogfeld, das Benutzer löschen-Dialogfeld und so weiter. Wie wäre es, all diese Einträge unter "Dialogfenster" zu wiederholen?

  7. Suche nach Aufwärtsverschiebungen. In Ihrer Indexierungsarbeit haben Sie möglicherweise einige Untereinträge, die als Haupteinträge kopiert werden müssen.

    8. Einträge Gruppierte Einträge
    (Einträge sind im gesamten Index verteilt)
    Benutzerdialogfeld hinzufügen
    ...
    Benutzer löschen Dialogfeld
    ...
    Neues Benutzer-Dialogfeld
    ...
    Passwort-Dialogfeld     		Benutzerdialogfeld hinzufügen
    ...
    Benutzer löschen Dialogfeld
    ...
    Dialogfenster

    Benutzer hinzufügen

    Benutzer löschen

    Neuer Benutzer

    Passwort

    ...
    Neues Benutzer-Dialogfeld
    ...
    Passwort-Dialogfeld

    Einträge Verschobene Einträge
    (Der Einträge sind im gesamten Index verstreut)
    Batterien

    entsorgen, 33

    Explosion Warnung, 34

    Herstellerempfehlung, 34

    Polarität, 33-34

    einkaufen, 33

    ersetzen, 33-34

    Tabs, 33(illustriert)

    		Batterien

    entsorgen, 33

    Explosionwarnung, 34

    Herstellerempfehlung, 34

    Polarität, 33-34

    Einkauf, 33

    ersetzen, 33-34

    Tabs, 33(illus)

    Entsorgung, Batterien, 33
    ...
    Polarität, Batterien, 33-34
    ...
    Warnung, Batterien, 34
    ...

    In diesem Beispiel dachte der Indexierer, dass einige (wahrscheinlich nicht viele) Leser zuerst nach "Polarisierung" anstatt nach "Batterien, Polarisierung" suchen würden. Ebenso dachte der Indexierer, dass die Leute zuerst nach "Entsorgung" suchen könnten. Auch wenn solche Möglichkeiten gering sind, sollten sie trotzdem im Index aufgeführt werden.
  8. Suchen nach Siehe auch und zusätzlich Siehe Referenzen. Gegen Ende Ihrer Überarbeitungsphase sollten Sie Ihr Index auf die Möglichkeit von betrachten Siehe auch Referenzen. Siehe auch Referenzen sind für eng verwandte Begriffe gedacht, die Leser versehentlich wählen könnten. Zum Beispiel gab es in den alten DOS-Systemen die kopieren Befehl und das xcopy Befehl. Die beiden Befehle sind in Name und Funktion so eng miteinander verbunden, dass man sie zusammenführen möchte. Siehe auch Referenzen zueinander. Und vergiss nicht die Siehe Referenzen: Diese verweisen Leser von Synonymbegriffen auf die Begriffe, die Sie in Ihrem Buch bevorzugen zu verwenden und zu indexieren.
  9. Überprüfen Sie den Stil und die Mechanik der Indexeinträge. Die Organisation, für die Sie arbeiten, hat möglicherweise ihren eigenen Hausstil oder verweist Sie auf einen Standardstil wie den Chicago Handbuch der Stilrichtung. Achten Sie sehr genau darauf, wie sie Ihnen sagen, Indexeinträge zu kapitalisieren und zu punktuieren. Indizes verwenden üblicherweise Kleinbuchstaben für alle nicht Eigennamen-Einträge, aber ein gewisser Prozentsatz verwendet Großbuchstaben für die Einträge der ersten Ebene. Die meisten Stile verlangen, dass Sie ein Komma direkt nach dem Indexbegriff und vor den Seitenzahlen setzen; aber einige tun dies nicht. Einige Stile verlangen, dass Sie dieselbe Formatierung im Index verwenden wie im Haupttext. Wenn etwas im Haupttext fettgedruckt ist, möchten sie es auch im Index fettgedruckt haben.

    Hinweis: Dieses Kapitel verwendet eine Vielzahl von Satzzeichen und Großschreibung—nicht um dich zu verwirren, sondern um dir die stilistische Variabilität bewusst zu machen.

    Ein gängiger Index-Stil Ein weiterer gängiger Indexstil
    Projektoren, 123

    kompilieren, 154-155

    Überlegungen, 156

    Steuerungen, 136

    definiert, 124, 136, 157

    Projektprofile, 451-461

    		Projektoren

    kompilieren 154-155

    Überlegungen 156

    Steuerungen 136

    definierte 124, 136, 157

    Projektprofile 451-461


    Beachten Sie im rechten Beispiel, dass zwischen dem Indexbegriff und den Seitenverweisen kein Komma steht. Außerdem werden einige Indexierungsstandards und -stile nicht damit einverstanden sein, einen Seitenverweis in einem Indexeintrag zu haben, der Untereinträge hat: Zum Beispiel "Projektoren, 123" im linken Beispiel. Warum befindet sich der Seitenverweis 123 nicht unter den Untereinträgen? Was ist das Unterthema auf Seite 123?

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