Gute Topics erstellen

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Das Topic ist in DITA die zentrale Informationsstruktur, in der Inhalte erfasst werden. Für einen Technischen Redakteur, der mit DITA arbeiten will, ist es daher unerlässlich zu wissen, wie er gute Topics, das heißt; für den Nutzer von Technischer Dokumentation nützliche Topics erstellen kann.

Insbesondere stellen sich immer wieder die folgenden Fragen, wenn es um die Erstellung von Topics geht:

• Was ist die „richtige“ Größe von Topics?
• Welche Informationen neben dem eigentlichen Inhalt gehören noch in ein Topic?
• Welche Möglichkeiten der Navigation gibt es für Topics?
• Wie erfolgt der Zugriff auf Topics?

Die folgenden Abschnitte untersuchen die aufgeführten Fragen im Detail.

Die Informationsmenge in einem Topic

Die Regel, dass ein Topic die Antwort auf eine Frage liefern soll, ist leicht formuliert, jedoch nicht immer so geradewegs in der Praxis anzuwenden. Manchmal sind die Fragen nicht so ohne Weiteres zu formulieren und oft ist nicht sofort zu erkennen, wie umfangreich die Antwort ausfallen muss. Tipps wie „Entfernen Sie alle unnötigen Informationen“ oder „Schreiben Sie nichts ins Topic, was der Nutzer bereits weiß“ geben wenig Unterstützung, wenn es darum geht herauszufinden, welcher und wie viel Inhalt in ein Topic gehören. Oftmals scheinen die Antworten auch so umfangreich zu sein, dass sie unmöglich in ein Topic passen wollen.

Um die Menge an Informationen zu bestimmen, die in ein Topic dürfen, werden oft quantitative Angaben gemacht. Dabei reicht das Spektrum von zwei gedruckten Seiten pro Topic bei der Strukturierungsmethode STOP (Sequentual Themtaic Organization of Proposals) bis hin zu maximal einer Bildschirmseite bei Online-Hilfen. Gerade bei Online-Hilfen ist daher ein Technischer Redakteur oftmals verzweifelt, wenn das Topic über eine Bildschirmseite hinausgeht und der Nutzer scrollen muss.

Um die Länge von Topics in einem überschaubaren Maß zu halten, wird daher oftmals auch empfohlen, weiterführende Informationen in zusätzliche Topics zu verlagern und dann auf diese Topics zu verweisen, das heißt zu verlinken. Auch hier ist im Einzelfall zu klären, was unter „weiterführenden Informationen“ zu verstehen ist. Werden dem Nutzer nicht alle Informationen in einem Topic geboten, die er für die Beantwortung seiner Frage benötigt, so führt das entweder zu einem wilden Blättern im Handbuch oder zu einem ebenso wilden Herumklicken in einer Online-Hilfe. In diesem Falle nützt dem Nutzer die Kürze eines Topics recht wenig.

Quantitative Angaben zur Größe eines Topics oder Strategien, wie die Größe eines Topics reduziert werden kann, können allenfalls eine grobe Richtlinie für die Größe von Topics bieten. Tatsächlich kann nur der Anwender der Technischen Dokumentation, das heißt der Nutzer des Topics, Auskunft darüber geben, ob die Informationsmenge für ihn ausreichend ist. Um die „richtige“ Größe von Topics zu bestimmen, ist daher bei der anvisierten Zielgruppe zu testen, ob die Inhalte der Topics für deren Informationsbedürfnis ausreichend sind. Weder DITA noch sonst eine Strukturierungsmethode kann die Größe eines Topics liefern. Erst wenn Sie das Wissen darüber erlangt haben, welche Informationen Ihre Zielgruppe in den Topics benötigt, sind Sie in der Lage zu entscheiden, was die „richtige“ Größe eines Topics ist.

Meta-Daten in einem Topic

Topics sind eigenständige Informationseinheiten, deren Inhalte im idealen Fall keinen Bezug zu einem Kontext aufweisen. Da Informationen zum Kontext nicht im eigentlichen Inhalt des Topics vorhanden sind, besteht die Gefahr, dass Topics nicht im ausreichenden Maße identifiziert werden können, wenn nach ihnen gesucht wird. Was auf der „sichtbaren“ Seite der Topics, das heißt im eigentlichen Inhalt, nicht an Informationen zum Kontext vorhanden ist, muss auf der „unsichtbaren“ Seite der Topics, das heißt in den Meta-Daten, zur Verfügung stehen. Ansonsten fehlen dem Topic Informationen, was sich schmerzlich bemerkbar macht, sobald aus einer großen Menge von Topics ein bestimmtes einzelnes Topic gefunden werden muss.

Fehlt zum Beispiel in den Meta-Daten die Information dazu, zu welcher Version eines Produkts das Topics gehört, gestaltet sich die Zusammenstellung von Topics zur Produktion eines Dokuments einer bestimmten Produktversion als äußerst schwierig. Denn aufgrund des eigentliches Inhalts kann dies unter Umständen nicht mehr möglich sein.

Technische Redakteure, die erstmals mit Topics arbeiten, unterschätzen oftmals die Notwendigkeit, Topics mit Meta-Daten auszustatten. Sie sind zu sehr darauf konzentriert, den Inhalt von überflüssigem Kontext zu befreien, sodass das Hinzufügen von Meta-Informationen eher als eine Kür denn als eine Pflicht empfunden wird. Oftmals ist der Technische Redakteur davon überzeugt, dass er „sein“ Topic schon finden wird, wenn er es wieder benötigt.

Dieser Ansatz funktioniert bei einem Team von Technischen Redakteuren, die möglicherweise an verschiedenen Standorten arbeiten, nicht mehr. Hier sind Meta-Informationen zwingend notwendig, damit ein Topic auch von denjenigen Technischen Redakteuren gefunden werden kann, die nicht Autoren des Topics ist.

Das Erfassen der Meta-Daten kann durch unterschiedliche Methoden unterstützt werden, wie beispielsweise:

• Durch einen Redaktionsleitfaden, der festlegt, welche Meta-Daten in ein Topic aufgenommen werden müssen.
• Durch Anpassung der DTDs, die Elemente für Meta-Daten zu Pflichtfeldern erklärt.
• Über die Unterstützung durch ein externes System wie ein Dokumenten-Management- oder Content-Management-System. Beispielsweise könnte das System das Abspeichern von neuen Topics nicht erlauben, solange für dieses nicht die entsprechenden Meta-Daten eingegeben worden sind.

DITA unterstützt die Erfassung zahlreicher Meta-Daten. In „Meta-Daten“ erfahren Sie, wie Sie Meta-Daten für Topics erfassen können. „Meta-Daten in Maps“ befasst sich damit, welche Meta-Daten in Maps zur Verfügung stehen.

Navigation mit Topics

Die Navigation in einem Buch ist ganz einfach: Seite folgt auf Seite. Die Seiten sind durchnummeriert, sodass bei Bedarf direkt auf eine einzelne Seite zugegriffen werden kann.

Bei Topics hingegen ist ein solcher „natürlicher“ Mechanismus nicht gegeben. Sie stehen als unabhängige Informationsstrukturen zunächst einmal ohne jegliche Verbindung miteinander im Raum. Eine Beziehung der Topics untereinander muss erst geschaffen werden, das heißt, die Topics müssen in eine Navigationsstruktur eingebunden werden.

Um Topics miteinander zu verbinden, werden Links verwendet. Von der technischen Seite betrachtet, ist das Setzen eines Links ganz einfach. Weit mehr Schwierigkeiten bereitet es, die richtige Art von Links an der richtigen Stelle zu setzen. Das WWW liefert täglich neue Beispiele dafür, dass das Setzen von Links alles andere als eine triviale Angelegenheit darstellt.

Bei dem Setzen von Links stehen Sie vor drei Aufgaben:

• festlegen, welche Wörter verlinkt werden sollen,
• festlegen, wohin der Link führt,
• festlegen, wann ein Link gesetzt werden soll.

Wenn es um die Auswahl von Wörtern geht, die verlinkt werden sollen, gibt es eine einfache Regel: Verwenden Sie ein Wort oder mehrere Wörter, die thematisch darauf hinweisen, welche Inhalte im verlinkten Topic zu finden sind. Die Wikipedia liefert dazu gute Beispiele.

Diese Regel wird leider nur allzu oft verletzt. Die bekanntesten Beispiele von Wörtern, die keinen Hinweis auf die zu erwartenden Inhalte liefern, sind „hier“ und „zurück“. Sucht man bei Google nach der exakten Wortkombination „Klicken Sie hier“, so werden etwa 25 Millionen deutsche Webseiten gefunden. Und es werden täglich mehr.

Mit dem Wort „zurück“ verhält es sich ähnlich. Nicht nur, dass es keinen Hinweis gibt, welche Inhalte auf der verlinkten Seite zu finden gibt, auch führt der Link in nur wenigen Fällen tatsächlich auf die zuletzt besuchte Seite. Auch hier besteht viel Optimierungspotenzial (Anmerkung der data2type-Redaktion: Wir stehen jedoch zu unseren << zurück- und vor >>-Links am Ende jeder Seite, da es die Navigation für die Leser erleichtert).

Als Nächstes gilt es zu bestimmen, wohin ein Link führen soll. Denn „Link“ ist nicht gleich „Link“. Ein Link kann:

• zu einer Marke innerhalb eines Topics führen,
• zu einem neuen Topic führen,
• zu einem Pop-Up-Fenster führen, in dem beispielsweise eine Begriffsdefinition angezeigt wird,
• zu einer Datei oder einem Multimedia-Objekt führen,
• zu einem Topic in einer anderen Online-Hilfe führen.

Jede dieser Linkarten verhält sich unterschiedlich, jedoch sind in Online-Hilfen oder Webseiten bei der Darstellung der Links so gut wie keine Unterschiede auszumachen. Das führt dazu, dass Nutzer oftmals überrascht werden, wenn sie einen Link anklicken. Dies führt aber nicht zu einer freudigen Erwartung, wenn der Nutzer auf den nächsten Link stößt, sondern eher zu einer Linkverdrossenheit.

Daher ist ein Konzept zu empfehlen, welches eine konsistente Regelung formuliert, wie Links in Topics gesetzt werden sollen. Zudem sollten Sie definieren, wie ein Link gekennzeichnet werden soll, wenn er kein „normales“ Verhalten aufweist, das heißt, wenn er beispielsweise statt auf ein Topic auf eine PDF-Datei verweist.

Als Letztes gilt es festzulegen, wann überhaupt Links gesetzt werden sollen. Sind zahlreiche Topics erstellt worden, so ist die Versuchung sehr groß, möglichst viel miteinander zu verlinken, um ja sicherzugehen, dass alle Topics „irgendwie“ miteinander verbunden sind. Betrachtet man Links jedoch von der Seite der Nutzer, so erfordert jeder Link eine Entscheidung, ob dem Link gefolgt werden soll oder nicht. Damit lenken Links den Nutzer von der eigentlichen Aufnahme der Informationen ab.

In der Technischen Dokumentation sollten Links daher nach Möglichkeit nicht im beschreibenden Text oder in Handlungsanweisungen eingefügt werden. Links zu anderen Topics sind entweder am Anfang oder am Ende des Topics in einer Liste oder Tabelle aufzuführen. Entwickeln Sie eine Systematik, die bestimmt, welche Links zum Beispiel am Ende eines Topics aufgenommen werden sollen.

DITA bietet die Verwendung von normalen Links und verwandten Links (related links) an. In Maps können Beziehungstabellen (relationship tables) erstellt werden, in denen Beziehungen der Topics zueinander definiert werden können. „Navigation in Topics“ zeigt Ihnen, wie Sie diese Links erstellen können.

Zugriff auf Topics

Wie der Zugriff auf Informationen erfolgt, auch in Topics, ist heute immer noch stark von den Konzepten geprägt, wie sie aus der Welt der Bücher her bekannt sind. Dabei steht der sequenzielle Zugriff auf Informationen immer noch an erster Stelle.

Das größte Augenmerk wird nach wie vor von den Technischen Redakteuren auf das Inhaltsverzeichnis als Zugriffsmethode für den sequentiellen Zugriff gerichtet. Das gilt sowohl für die Print- als auch für die Online-Dokumentation. Dennoch wird vom Nutzer der Technischen Dokumentation in beiden Fällen das Inhaltsverzeichnis bestenfalls dazu genutzt, sich einen groben Überblick über die dargebotenen Themen zu verschaffen. In Online-Hilfen, wo beispielsweise häufig das Inhaltsverzeichnis mit mehreren Klicks aufgeklappt werden muss, ist dieser Weg zu mühsam, um an die gewünschte Information zu kommen.

Abbildung: Das Inhaltsverzeichnis der OpenOffice Online-Hilfe.

Auch das Internet, das alles andere als ein sequenzielles Medium darstellt, hat bei den Erstellern von Websites noch nicht viel an der Vorstellung ändern können, dass der Zugriff auf Informationen nicht sequenziell erfolgt. Immer noch werden Webseiten, die man als einzelne Topics betrachten kann, so konzipiert, als ob sie vom Nutzer in einer bestimmten Reihenfolge besucht werden müssten. Überlegungen wie: „Erst wird die Seite ‚Unternehmen‘ aufgerufen, dann die Seite ‚Leistungen‘ und dann die Seite ‚Referenzen‘“ sind noch gängige Praxis. Gerade an Links wie „Zurück“ zeigt sich, wie tief die sequenzielle Betrachtungsweise noch verwurzelt ist.

Da die sequenzielle Zugriffsmethode sowohl für Online-Medien als auch für die Print-Dokumentation sehr langsam ist, um an die gewünschte Information zu gelangen, sind schnellere Zugriffsmöglichkeiten erforderlich. Folgende Möglichkeiten bieten sich an:

• Indexverzeichnis
• Volltextsuche

Der am häufigste genutzte Zugriffsmechanismus auf Informationen in der Print-Dokumentation stellt das Indexverzeichnis dar. Darum erstaunt es umso mehr, dass man immer noch Handbücher findet, die bei einem Handbuchvolumen von 800 Seiten nur ein vierseitiges Indexverzeichnis enthalten.

Wie wichtig ein Indexverzeichnis für ein Buch ist, kann man beobachten, wenn ein Interessent nach einem passenden Fachbuch in einer Buchhandlung Ausschau hält. Um zu überprüfen, ob das Buch die gewünschten Inhalte einschließt, wird in einem Indexverzeichnis nach einem Stichwort gesucht, dessen Bedeutung der Interessent kennt. Findet er das Stichwort, so schlägt er die entsprechende Seite auf und liest den Text. Entspricht der Text zu dem Stichwort seinen Erwartungen, ist die Kaufentscheidung ein ganzes Stück nähergerückt. Erst wenn dem Indexverzeichnis „vertraut“ wurde, wird das Inhaltsverzeichnis aufgeschlagen, um sich einen Überblick über den Inhalt zu verschaffen. Ein guter Fachbuchautor sollte daher ebenso wie ein Technischer Redakteur sehr großen Wert auf die Qualität seines Index legen.

Für Topics, ob sie nun in der Print-Dokumentation oder in der Online-Dokumentation verwendet werden, sind Indexeinträge von zentraler Bedeutung. Da es zum Zeitpunkt der Erstellung eines Topics noch kein Inhaltsverzeichnis geben muss, müssen andere Zugriffsmechanismen maximal unterstützt werden.

Bei Topics ist auf einen hohen Grad an Konsistenz bei der Erstellung des Index zu achten, insbesondere dann, wenn mehrere Technische Redakteure Topics erstellen. Zwar mag die Forderung an eine Konsistenz bei der Erstellung eines Index als selbstverständlich angesehen werden, doch zeigt die Praxis, dass nur in wenigen Fällen in Redaktionsleitfäden festgelegt wird, wie ein Index zu erstellen ist.

Werden Topics von mehreren Technischen Redakteuren erstellt, so ist genau festzulegen, was in einem Topic indiziert und wie es indiziert werden muss. Zudem ist zu definieren, wann Untereinträge und wann „Siehe auch“-Einträge zu erstellen sind. Die Art und Weise, wie Einträge in einem Topic indiziert werden, bestimmt zum einen, was der Nutzer findet, und zum anderen, was der Nutzer von dem Index erwartet, wenn er ihn bereits einmal benutzt hat. Gerade bei Dokumenten, deren Grundlage Topics darstellen, muss das Topic sozusagen für sich selbst sorgen, dass es gefunden wird. Dabei sind Indexeinträge unerlässlich.

In der DITA Version 1.0 waren die Möglichkeiten für die Erstellung eines Index noch sehr eingeschränkt. Bei der DITA Version 1.1 wurde der Bedeutung des Index Rechnung getragen und eine indexing-Domain hinzugefügt, die die Elemente zur Erstellung von Indexeintägen enthält.

In der Online-Dokumentation hat sich die Volltextsuche als die schnellste Möglichkeit etabliert, um Informationen zu finden und danach auf sie zuzugreifen. Ob es sich um PDF-Dateien, Microsoft Help-Dateien oder internetbasierte Hilfesysteme handelt, überall steht eine Volltextsuche zur Verfügung. Suchmaschinen wie Google haben zudem gezeigt, wie effektiv eine Volltextsuche sein kann, was auch bedeutet, dass Nutzer inzwischen erwarten, über eine Volltextsuche die gewünschten Ergebnisse finden zu können.

Abbildung: Volltextsuche bei der Microsoft Office Hilfe.

Neben dem eigentlichen Inhalt eines Topics sind die beiden wichtigsten Komponenten für die Qualität der Trefferliste bei einer Volltextsuche der Algorithmus, der dafür sorgt, dass die Suchergebnisse nach ihrer Relevanz in der Trefferliste angezeigt, und die Texte, die in einer Trefferliste angezeigt werden. Während die Algorithmen, die die Relevanz der Treffer bestimmen, für den Technischen Redakteur meistens nicht zugänglich sind, können die Texte in der Trefferliste dagegen sehr wohl beeinflusst werden. Die beiden wichtigsten Elemente sind dabei der Titel und die Kurzbeschreibung des Topics. Auch im Internet gehören der Seitentitel und eine Kurzbeschreibung (hier aber meistens die Kurzbeschreibung der ganzen Website) zu den beiden Elementen, die in den Trefferlisten von Suchmaschinen angezeigt werden.

Der Titel eines Topics sollte in Form einer Überschrift möglichst genau beschreiben, was der Inhalt eines Topics ist. Der Titel eines Topics wird in der Trefferliste als Link zu dem betreffenden Topic verwendet. Die Kurzbeschreibung wird als Text für die Link-Vorschau herangezogen.

Neben dem Titel für ein Topic spielt für den Zugriff auf das Topic auch dessen Navigationstitel eine Rolle. Wenn der Titel eines Topics zu lang ist, kann anstelle des Titels ein kurzer Navigationstitel dazu verwendet werden, um in der Navigation der Online-Hilfe angezeigt werden.

Auf Webseiten sind der Titel und der Navigationstitel häufig identisch. Wer sich jedoch intensiver mit Suchmaschinenoptimierung befasst, das heißt, mit der Methodik, wie Webseiten und damit Topics, am besten im World Wide Web gefunden werden können, wird feststellen, dass ein aussagekräftiger Titel, passend zum Inhalt des Topics, eine wesentliche Voraussetzung dafür ist, dass ein Topic einen guten Platz in der Trefferliste erhält.

DITA bietet zahlreiche Elemente an, die es ermöglichen, Topics für Suchmaschinen leichter suchbar und damit für den Nutzer schneller und leichter auffindbar zu machen. So kann neben einem Titel ein Navigationstitel definiert werden. Auch stellt DITA Elemente zur Verfügung, deren Inhalt beispielsweise in einer Trefferliste einer Suchmaschine angezeigt werden können. Weitere Informationen dazu erhalten Sie in Titel und Informationen zum Inhalt.

  

<< zurück

vor >>