Reihe Lösungen zur Technischen Dokumentation

Reihe Lösungen zur Technischen Dokumentation - Marc Achtelig

Selbst die besten Informationen sind wertlos, wenn Benutzer sie nicht finden. Eine benutzerfreundliche Struktur und Navigation zu schaffen, ist mindestens ebenso wichtig, wie gut geschriebene Inhalte. Allerdings ist die Strukturierung einer Technischen Dokumentation nicht so einfach, wie es auf den ersten Blick erscheint: Wenn Sie denken, dass die Struktur Ihres Dokuments der Struktur der Komponenten und Funktionen Ihres Produkts folgen sollte, liegen Sie falsch. Wenn Sie denken, dass die Dokumentform, die Sie selbst bevorzugen, auch das ist, was Ihre Kunden bevorzugen, liegen Sie falsch. Wenn Sie denken, dass alle Ihre Informationen wichtig sind, liegen Sie auch falsch. Dieses Buch zeigt Ihnen, wie Sie Ihre Dokumente so strukturieren, indexieren und verlinken, dass Leser die enthaltenen Informationen auch tatsächlich finden. Das Buch ist zweisprachig: Englisch + Deutsch. Alle global relevanten Themen werden in englischer Sprache behandelt. Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben. Inhalt: Allgemeine Strukturierungs-Prinzipien, die allen Gliederungsentscheidungen zugrunde liegen. Medien auswählen: Sollten Sie ein gedrucktes oder druckbares Benutzerhandbuch (PDF) bevorzugen, eine Online-Hilfe oder beides? Welche Informationen kommen ins Handbuch, welche in die Hilfe? Welches Hilfe-Format sollten Sie verwenden? Sind kontextsensitive Hilfeaufrufe möglich? Sollten Sie interaktive Funktionen einbauen? Ist es sinnvoll, „Social Features" zur Beteiligung und Vernetzung der Benutzer vorzusehen? Dokumente planen: Sollten Sie alle Informationen in ein einziges Dokument aufnehmen oder lieber mehrere Handbücher für unterschiedliche Anwendungszwecke und Benutzergruppen erstellen? Wie sollten Sie Ihre Dokumente nennen? Hauptabschnitte innerhalb der Dokumente planen: Aus welchen Hauptabschnitten sollte Ihr Dokument bestehen? Gibt es bestimmte Standardabschnitte, die Sie nicht vergessen dürfen? Einzelthemen planen: Welche Informationstypen benötigt Ihre Zielgruppe? Wie sollten Sie die einzelnen Kapitel oder Hilfe-Topics in Ihren Dokumenten aufbauen und benennen? Reihenfolge der Abschnitte und Themen planen: Wie sollten Sie die Abschnitte, Kapitel und Themen in Ihren Dokumenten anordnen? Was kommt zuerst, was kommt später? Navigation planen: Welche Navigationsmittel sollten Sie in gedruckten Dokumenten vorsehen, welche Navigationsmittel in Online-Hilfen? Wo sollten Sie Links und Querverweise anbieten, und wo nicht? Zielgruppe: Technische Redakteure, Entwickler, Marketing-Verantwortliche, Produktmanager