Technische Dokumentationen

Inhaltsverzeichnis

1. Einleitung

2. Was sind Technische Dokumentationen?
2.1. Begriffsklärung
2.2 Einordnung der TD in das linguistische Modell nach Göpferich

3. Der Technische Redakteur
3.1. Arbeitsfeld des Technischen Redakteurs
3.2. Probleme bei der Erstellung von Technischen Dokumentationen:
3.3. Hilfen zu Problemsituationen bei der TD (Leitfaden für TR)
3.4. Qualifikation Technischer Redakteure:
3.4.1. Weitere Anforderungen an den TR
3.4.2. Ausbildungsmöglichkeiten

4. Fragebogen zu Software- Dokumentationen

5. Analysemethode zur Überprüfung einer Software- Dokumentation (SWD)

6. Praktische Analysebeispiele

7. Zusammenfassung

8. Literaturverzeichnis

1. Einleitung

Die vorliegende Hausarbeit zum Thema „Technische Dokumentationen“ in dem Hauptseminar „Fachsprachen“ soll sich zuerst mit der Frage beschäftigen, was Technische Dokumentationen im Einzelnen sind und wieso oftmals Verständnisprobleme beim Lesen und Arbeiten auftreten können. Zur Begriffsklärung erfolgen hierzu einige Definitionen und die Einordnung der Textsorte in ein linguistisches Modell. Weiterhin wird das Berufsbild eines Technischen Redakteurs genauer untersucht. Dabei wird zunächst das Arbeitsfeld genauer beleuchtet, um dann auf typische Problemsituationen bei der Erstellung technischer Dokumentationen einzugehen. Hierzu werden dann auch Hilfestellungen für den technischen Redakteur aufgezeigt. Den Abschluss der Thematik des Technischen Redakteurs bildet ein Aus- und Überblick auf die benötigten Qualifikationen und die Ausbildungsmöglichkeiten in diesem Arbeitsfeld. Danach soll anhand eines Fragebogens die Problematik aufgezeigt werden, warum häufig bei den Benutzern von Handbüchern, in diesem Fall Softwaredokumentationen, Schwierigkeiten bei der Anwendung auftreten. Dazu sollen dann schließlich auch neuere Untersuchungs- und Analysemethoden vorgestellt werden, wie eine Technische Dokumentation auf Fehler untersucht werden kann. Anhand von praktischen Beispielen, einer kurzen eigenen Analyse, sollen diese Methoden exemplarisch verdeutlicht werden.

2. Was sind Technische Dokumentationen?

2.1. Begriffsklärung

Bevor man genauer in die Thematik einsteigt, muss zunächst der Versuch einer Begriffsklärung erfolgen. Denn als allererstes stellt sich natürlich die Frage: Was genau sind Technische Dokumentationen (im folgenden „TD“)? Zur Beantwortung dieser Frage eine Definition nach Heinrich Schmalen (1994):

„Zur Technischen Dokumentation zählen sämtliche Unterlagen, die den Lebenszyklus eines technischen Produktes begleiten, also nicht nur Bedienungsanweisungen, sondern ebenso (…) Produktankündigungen, technische Beschreibungen, Wartungshinweise oder auch Hinweise zur umweltfreundlichen Entsorgung.“

Eine andere Definition nach Rust / Noack (1994) lautet wie folgt:

„Unter Technischer Dokumentation versteht man so unterschiedliche Dinge wie z. B. die Gebrauchsanweisung für einen Elektroherd oder einen Videorecorder, das Benutzerhandbuch für ein Textverarbeitungsprogramm oder die Bedienungs- und Wartungsanleitung für ein Passagierflugzeug.“

Wie man sieht, werden in beiden Definitionen ganz unterschiedliche Arten von Texten aufgezählt, die alle unter dem Oberbegriff „Technische Dokumentation“ geführt werden. Das heißt, dass eine Technische Dokumentation also auch zu unterschiedlichen Zwecken benutzt werden kann, z.B. für die Bedienung, die Wartung, oder die Entsorgung eines beliebigen Produkts oder Geräts. Da die Technische Dokumentation den gesamten „Lebenszyklus“ des Produkts begleitet, kann gesagt werden, dass es sich um eine besonders komplexe Art der Textgestaltung handeln muss.

2.2 Einordnung der TD in das linguistische Modell
nach Göpferich

Um den Begriff der Technischen Dokumentation noch genauer einzugrenzen, soll nun eine kurze Einordnung dieser speziellen Fachtextsorte in das linguistische Modell nach Susanne Göpferich (1995) vorgenommen werden.

Diese „fachbezogene systematisch- historische Textsortengliederung“ (Roelke, S. 47) berücksichtigt nur schriftliche Textsorten der Naturwissenschaft und der Technik. Das hierarchisch gegliederte Modell^[1] unterscheidet auf der ersten seiner fünf Ebenen je nach Art und Zweck der Information die Fachtexttypen. Bei den didaktisch- instruktiven Texten – also den Texten, die zur intellektuellen Bereicherung oder zum Zweck der praktischen Anwendung dienen – sollen nun auf der nächsten Hierarchiestufe vor allem die Mensch / Technik- interaktionsorientierten Texte betrachtet werden. Der Zweck dieser Texte liegt darin, den Adressaten in die Lage zu versetzen, direkt mit einem Gegenstand umzugehen. Im Vordergrund stehen dabei nicht das theoretische Wissen, sondern die Informationen, die zur praktischen Nutzung wichtig sind. Somit lässt sich auf der nächsten Stufe, der Primärtextsorten, auch die Technische Dokumentation nun genau einordnen, denn auch Bedienungsanleitungen, oder Software- Manuals werden hier als Beispiele genannt (siehe Tabelle in Roelke, S. 48).

3. Der Technische Redakteur

In diesem Kapitel soll nun auf den Beruf des Technischen Redakteurs^[2] (im folgenden „TR“) eingegangen werden. Einfach ausgedrückt ist ein Technischer Redakteur ein Spezialist, der Technische Dokumentationen erstellt. Was Technische Dokumentationen sind, wurde in Kapitel 2 bereits ausgeführt. Seine Aufgaben beschränken sich allerdings nicht nur auf das Schreiben der TD, sondern zuerst ist noch eine Reihe von Vorarbeiten nötig: Mit der Recherche muss sich der TR Informationen über das zu beschreibende Produkt beschaffen, in Erfahrung bringen, auf welche Zielgruppe es ausgerichtet ist und über welche Vorkenntnisse sie verfügt. Außerdem muss er die zeitlichen und finanziellen Rahmenbedingungen abklären, unter denen die Dokumentation fertig gestellt werden muss.

Nach diesen Rahmenbedingungen kann der TR mit der Erstellung des Manuskripts beginnen, wobei vor dem eigentlichen Schreiben zunächst die Gliederung festgelegt werden muss. Auch nach dem Schreiben sind noch Arbeiten auszuführen, wie die Betreuung des Satzes und die Produktion, gegebenenfalls die Vorbereitung und Betreuung der Übersetzung und die Archivierung des Manuskripts für spätere Neuauflagen.

Im Folgenden sollen einige Aufgaben innerhalb eines Dokumentationsprojektes genauer beschrieben und anschließend auch problematisiert werden:

3.1. Arbeitsfeld des Technischen Redakteurs

Als ersten Schritt muss sich der TR mit der Adressatenanalyse befassen. Hier ist besonders darauf zu achten, dass die TD den Vorkenntnissen und Erwartungen des Adressatenkreises entspricht. Hierzu muss zunächst die Zielgruppe der Dokumentation bestimmt werden. Der TR kann sich z. B. von Vertriebs- oder Marketinggruppen wichtige Hinweise über die potentielle Zielgruppe einholen. Ein Problem ist oftmals die heterogen zusammengesetzte Zielgruppe.

Der TR muss die Dokumentation dann so gestalten, dass sie sowohl von Experten mit umfangreichem Vorwissen, als auch von Anfängern mit geringem Vorwissen optimal genutzt werden kann.

Die Hauptinformationsquelle bei der Recherche sind in der Regel die Konstrukteure und Entwickler des Produkts und ihre Produktbeschreibungen. Darüber hinaus dienen Vertriebs- und Marketingschriften, Erfahrungen der Test-, Service- und Schulungsabteilung sowie Fachbücher oder Fachzeitschriften zu den weiteren Informationsquellen. Die Informationsbeschaffung findet während der Produktentwicklung statt, damit die Dokumentation zur Markteinführung des Produkts gedruckt vorliegt.

Wenn der TR das Produkt ausprobiert, kann er, in dem er in die Rolle des Anwenders schlüpft, sich nicht nur weitere Informationen beschaffen, sondern auch seine Produktkenntnisse vertiefen. Dadurch kann der TR vor allem einen Blick dafür erhalten, welche Informationen der Anwender benötigt. Der Weg von der Produktlogik zur Anwenderlogik ist also ein wichtiger Weg auf dem Weg zur verständlichen und zielgruppengerechten Beschreibung. Diese Beschreibung kann weiterhin auch durch Beispiele unterstützt werden, die der TR am besten findet, wenn er mit dem Produkt arbeitet.

Vor dem Schreiben des Manuskripts muss der TR die Gliederung, die die Ergebnisse der Adressatenanalyse berücksichtigt, mit den Produktentwicklern und Vertriebsleitern abstimmen. Beim Schreiben muss der TR folgende Kriterien beachten:

- Der Text muss vollständig sein, d. h. alle Informationen enthalten.
- Der Text muss sachlich richtig sein, d. h. dem beschriebenen Produkt entsprechen.
- Der Text muss verständlich sein, d. h. der Anwenderlogik entsprechen und zielgruppengerecht dargestellt sein (evtl. mit Beispielen).
- Fachterminologie muss einheitlich und durchgängig verwendet werden („variatio delectat“ gilt nicht für die TD).

Da eine TD nicht nur aus reinem Text besteht, sondern auch aus Abbildungen wie Grafiken, Fotos oder Zeichnungen, muss der TD überlegen, wo Sachverhalte entsprechend durch diese Hilfsmittel verdeutlicht werden können.

Dabei gilt es unter der Berücksichtigung der Wahrnehmungspsychologie auf sinnvolle Anordnung von Text und Bild zu achten.

Bei der Planung der Dokumentationserstellung muss der TR einerseits darauf achten, dass die Dokumentation gedruckt vorliegt, wenn das Produkt auf den Markt kommt, andererseits kann er auch erst mit der Arbeit beginnen, wenn das Produkt bis zu einem bestimmten Grad weit entwickelt ist. Um die termingerechte Planung für das Gesamtprojekt einzuhalten, muss er Zeit für Korrekturabläufe einplanen und Zeit für den Druck vorsehen. Neben diesem Zeitmanagement sollte die Dokumentationserstellung auch innerhalb eines wirtschaftlichen Rahmens bleiben. Hier muss der TR die Kosten für die Erstellung von Text, Grafiken, Satz- und Produktionskosten berücksichtigen.

3.2. Probleme bei der Erstellung von Technischen
Dokumentationen:

Nach der genaueren Darstellung des Arbeitsfeldes des TR sollen nun einige Problemfelder aufgezeigt werden, die die Erstellung einer TD so kompliziert machen. Zum ersten ist je nach Produkt eine zunehmend heterogene Zielgruppe zu erwähnen, also ein unterschiedlicher Kenntnisstand der Nutzer. Zum anderen werden technische Geräte heutzutage immer vielfältiger, entwickelter und komplexer, was auch zu einer zunehmenden Verbreitung nicht nur im beruflichen, sondern auch im privaten Alltag führt.

Dass TD’s häufig unter mangelnder Qualität leiden, liegt auch oft an der geringen Qualifikation der TR. TD werden häufig als „notwendiges Übel“ für Ingenieure, Produktentwickler, u.a. angesehen. Der TR ist als Berufsfeld in Deutschland noch wenig bekannt und verbreitet (Näheres zur Ausbildung siehe Kapitel 3.4.2).

Auf die Ausgangssituation für die Verständlichkeit von Software- Dokumentationen wird in Kapitel 4 noch ausführlicher eingegangen. Einleitend sollen hier aber schon einmal verständnishemmende Faktoren genannt werden, die die Arbeit mit technischen Texten erschweren können:

[...]

^[1] Auf eine detaillierte Beschreibung des Modells wird hier aus thematischen Gründen verzichtet. Vergleiche für ausführliche Erläuterungen Göpferich (1995, S. 119 – 135).

^[2] Es sind im Folgenden immer beide Geschlechter angesprochen.