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
- Einleitung
- Was sind Technische Dokumentationen?
- Begriffsklärung
- Einordnung der TD in das linguistische Modell nach Göpferich
- Der Technische Redakteur
- Arbeitsfeld des Technischen Redakteurs
- Probleme bei der Erstellung von Technischen Dokumentationen
- Hilfen zu Problemsituationen bei der TD (Leitfaden für TR)
- Qualifikation Technischer Redakteure
- Weitere Anforderungen an den TR
- Ausbildungsmöglichkeiten
- Fragebogen zu Software- Dokumentationen
- Analysemethode zur Überprüfung einer Software- Dokumentation (SWD)
- Praktische Analysebeispiele
- Zusammenfassung
Zielsetzung und Themenschwerpunkte
Die vorliegende Hausarbeit zum Thema „Technische Dokumentationen“ beschäftigt sich mit der Frage, was Technische Dokumentationen im Einzelnen sind und wieso oft Verständnisschwierigkeiten auftreten können. Darüber hinaus wird das Berufsbild eines Technischen Redakteurs beleuchtet, insbesondere die typischen Problemsituationen und Hilfestellungen bei der Erstellung technischer Dokumentationen. Schließlich werden Methoden vorgestellt, wie man Technische Dokumentationen auf Fehler untersuchen kann.
- Definition und Einordnung von Technischen Dokumentationen
- Das Berufsbild des Technischen Redakteurs
- Probleme und Hilfestellungen bei der Erstellung technischer Dokumentationen
- Methoden zur Analyse von Software-Dokumentationen
- Praktische Analysebeispiele
Zusammenfassung der Kapitel
- Einleitung: Die Einleitung führt in das Thema „Technische Dokumentationen“ ein und skizziert die Fragestellungen und Ziele der Hausarbeit.
- Was sind Technische Dokumentationen?: Dieses Kapitel beschäftigt sich mit der Definition von Technischen Dokumentationen und ordnet sie in ein linguistisches Modell ein. Hierzu werden verschiedene Definitionen und Beispiele vorgestellt.
- Der Technische Redakteur: Dieses Kapitel beleuchtet das Berufsbild des Technischen Redakteurs, sein Arbeitsfeld, die typischen Probleme bei der Erstellung von Dokumentationen und die entsprechenden Hilfestellungen. Es werden auch die Qualifikationen und Ausbildungsmöglichkeiten von Technischen Redakteuren erläutert.
- Fragebogen zu Software- Dokumentationen: Dieses Kapitel stellt einen Fragebogen vor, der aufzeigt, warum bei Benutzern von Software-Dokumentationen häufig Anwendungsschwierigkeiten auftreten.
- Analysemethode zur Überprüfung einer Software- Dokumentation (SWD): Dieses Kapitel präsentiert eine Analysemethode, die zur Überprüfung von Software-Dokumentationen auf Fehler eingesetzt werden kann.
- Praktische Analysebeispiele: In diesem Kapitel werden die vorgestellten Analysemethoden anhand von praktischen Beispielen illustriert.
Schlüsselwörter
Technische Dokumentation, Fachsprache, Textsorte, Technischer Redakteur, Software-Dokumentation, Analysemethode, Fehleranalyse, Benutzerschwierigkeiten.
- Quote paper
- Stefan Scherer (Author), 2005, Technische Dokumentationen, Munich, GRIN Verlag, https://www.grin.com/document/70060
