Die vorliegende Arbeit 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.
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
Zielsetzung & Themen
Die vorliegende Hausarbeit untersucht das Wesen Technischer Dokumentationen (TD) und identifiziert Ursachen für häufige Verständnisprobleme bei der Nutzung. Ziel ist es, das Berufsbild des Technischen Redakteurs sowie effektive Methoden zur Qualitätsprüfung von Dokumentationen aufzuzeigen, um die Anwenderzufriedenheit zu steigern.
- Definition und linguistische Einordnung Technischer Dokumentationen
- Anforderungsprofil und Arbeitsfeld des Technischen Redakteurs
- Analyse der Fehlerquellen in Softwaredokumentationen
- Vorstellung systematischer Analysemethoden zur Textoptimierung
- Praktische Überprüfung einer Montageanleitung als Anwendungsbeispiel
Auszug aus dem Buch
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.
Zusammenfassung der Kapitel
1. Einleitung: Diese Einleitung führt in das Thema Technische Dokumentationen ein, skizziert die Problematik bei der Erstellung verständlicher Anleitungen und erläutert den Aufbau der Arbeit.
2. Was sind Technische Dokumentationen?: Hier erfolgt eine Begriffsklärung sowie eine Einordnung der Textsorte Technische Dokumentation in das linguistische Modell nach Göpferich.
3. Der Technische Redakteur: Dieses Kapitel behandelt das Berufsbild, das Arbeitsfeld, typische Probleme und die notwendige Qualifikation eines Technischen Redakteurs.
4. Fragebogen zu Software- Dokumentationen: Es wird eine Untersuchung präsentiert, die mittels eines Fragebogens die Akzeptanz und Schwierigkeiten bei der Nutzung von Softwaredokumentationen linguistisch beleuchtet.
5. Analysemethode zur Überprüfung einer Software- Dokumentation (SWD): Hier wird ein systematisches Modell zur Fehleranalyse von Dokumentationen in sieben Segmentierungsebenen vorgestellt.
6. Praktische Analysebeispiele: Anhand einer exemplarischen Montageanleitung wird die in Kapitel 5 eingeführte Analysemethode praktisch angewandt und erprobt.
7. Zusammenfassung: Das Fazit resümiert die Bedeutung der linguistischen Qualität in Technischen Dokumentationen und den wachsenden Stellenwert des Berufsbildes des Technischen Redakteurs.
Schlüsselwörter
Technische Dokumentation, Technischer Redakteur, Software-Dokumentation, Benutzerfreundlichkeit, Adressatenanalyse, Linguistik, Montageanleitung, Qualitätssicherung, Fachsprache, Textsorte, Anwenderlogik, Produktlebenszyklus, Fehleranalyse.
Häufig gestellte Fragen
Worum geht es in dieser Arbeit grundsätzlich?
Die Arbeit befasst sich mit der linguistischen Gestaltung und der Qualität Technischer Dokumentationen sowie den Aufgabenbereichen von Technischen Redakteuren.
Was sind die zentralen Themenfelder?
Die Schwerpunkte liegen auf der Begriffsklärung, den Anforderungen an den TR, der Analyse von Benutzerproblemen bei Software-Handbüchern und der Anwendung systematischer Prüfmethoden.
Was ist das primäre Ziel der Arbeit?
Das Ziel ist aufzuzeigen, wie durch eine gezielte Adressatenorientierung und methodische Überprüfung Texte verständlicher gestaltet werden können, um die Effektivität von Anleitungen zu erhöhen.
Welche wissenschaftliche Methode wird verwendet?
Die Arbeit nutzt die von Labarta Postigo entwickelte Analysemethode zur Segmentierung und linguistischen Bewertung von Texten auf Wort-, Satz-, Absatz- und Handbuchebene.
Was wird im Hauptteil der Arbeit behandelt?
Der Hauptteil gliedert sich in die Untersuchung des Berufsbildes, eine Fragebogenstudie zur Nutzerzufriedenheit sowie die detaillierte Vorstellung und Anwendung einer Analysemethode.
Welche Schlüsselwörter charakterisieren die Arbeit?
Die Arbeit ist primär durch Begriffe wie Technische Dokumentation, Benutzerfreundlichkeit, Sprachliche Qualität, Fachsprachen und Analysemethode charakterisiert.
Wie unterscheidet sich die Bewertung durch Laien und Experten?
Die Untersuchung zeigt, dass DV-Laien Handbücher deutlich negativer bewerten als Experten, da sie häufiger Probleme mit Fachbegriffen und mangelnden Beispielen haben.
Warum wurde für den praktischen Teil eine ältere Montageanleitung gewählt?
Da moderne Dokumentationen heute meist so perfektioniert sind, dass kaum noch Fehler zu finden sind, wurde eine ältere Anleitung genutzt, um exemplarisch typische Problemfelder aufzeigen zu können.
- Quote paper
- Stefan Scherer (Author), 2005, Technische Dokumentationen, Munich, GRIN Verlag, https://www.grin.com/document/70060
