In dieser Arbeit wird die Vorgehensweise bei der Überarbeitung einer Bedienungsanleitung beschrieben. Als Beispiel dient die Bedienungsanleitung für das AFC der Firma LiquosystemS. Die Firma LiquosystemS bedient einen Nischenmarkt im Bereich Gärtemperaturregelung und das AFC ist Teil einer
modular aufgebauten Temperatur-Regelanlage.
Diese Arbeit richtet sich auch an die Mitarbeiter der Firma LiquosystemS die sich unter Umständen bei der Gestaltung weiterer Bedienungsanleitungen hieran orientieren können.
Im vorliegenden Fall lautete die Aufgabe, eine völlig neue Bedienungsanleitung zu gestalten und dafür eine bereits bestehende als Ausgangsmaterial zu nutzen.
Im Folgenden werden zunächst die theoretischen Grundlagen und Anforderungen an qualitativ hochwertige Bedienungsanleitungen behandelt. Es werden die
angewandten Methoden vorgestellt und erläutert. Im zweiten Teil wird die praktische Anwendung im vorliegenden Fall aufgezeigt und es werden einige Beispiele zur Verdeutlichung angeführt. Im dritten Teil wird ein Ausblick auf mögliche Verbesserungen des Prozesses bei der Erstellung zukünftiger Betriebsanleitungen gegeben.
Dieser Arbeit liegen Auszüge des Ausgangsmaterials (DIN A4) und Auszüge der neugestalteten Bedienungsanleitung (DIN A5) bei.
Inhaltsverzeichnis
Einleitung
1 Begriffsbestimmung und Anforderungen der technischen Dokumentation
1.1 Begriffsvielfalt der technischen Dokumentation
1.2 Anforderungen an qualitativ hochwertige Betriebsanleitungen
2 Angewandte Methoden während dem Prozess der Überarbeitung
2.1 Benutzerorientiertes iteratives Design
2.2 Methode des strukturierten Schreibens: Information Mapping®
2.3 Konzept nach Dietrich Juhl
2.3.1 Leistungsbeschreibung
2.3.2 Gerätebeschreibung
2.3.3 Tätigkeitsbeschreibung
2.3.4 Beschreibung der Funktionsweise
2.3.5 Technische Details
3 Anwendung in der Praxis
3.1 Beschreibung des AFC
3.2 Rahmenbedingungen der Aufgabe
3.3 Schritte der Überarbeitung
3.3.1 Analyse der Schnittstelle (Interface)
3.3.2 Analyse der vorhergehenden Betriebsanleitung
3.3.3 Analyse der Benutzer
3.3.4 Analyse des Nutzungskontextes
3.3.5 Durchgeführte Gestaltungsmaßnahmen
3.3.6 Qualitätssicherung
4 Zeitgemäße Dokumentation
4.1 Prinzip des Single Source Publishing/Authoring
4.2 Werkzeuge für Single Source Publishing
4.2.1 DocToHelp der Firma Wextech
4.2.2 DocBook XML (OpenSource)
4.2.3 TC-Toolbox der Firma Arakanga
4.2.4 Technische Dokumentation mit dem Schema-DokuManager
Schlusswort
Zielsetzung & Themen
Die Arbeit befasst sich mit der Vorgehensweise bei der Überarbeitung einer Bedienungsanleitung für einen Gärtemperaturregler. Ziel ist es, die Qualität der Dokumentation durch benutzerorientierte Methoden und eine strukturierte Informationsaufbereitung signifikant zu verbessern, um eine höhere Effizienz und Verständlichkeit für den Anwender zu gewährleisten.
- Benutzerzentriertes Design und iterative Gestaltungsprozesse
- Strukturiertes Schreiben nach der Information Mapping® Methode
- Optimierung von Handlungsanweisungen durch visuelle Hilfsmittel
- Analyse und Verbesserung von Bedienungsanleitungen in der Praxis
- Einführung in Single Source Publishing und entsprechende Werkzeuge
Auszug aus dem Buch
3.3.2.1 ALLGEMEINE TEXTVERSTÄNDLICHKEIT
Auf der Textebene wurden verwirrende Bezeichnungen und Titel gefunden. Die Begriffe „Funktionsübersicht“, „Betriebszustände“ und „Betriebsarten“ werden mißverständlich benutzt. Es werden häufig lange, verschachtelte Sätze verwendet, die das Verstehen der Information erschweren.
Ein Beispiel:
„Der Regler [arbeitet] normalerweise im Impulsbetrieb, das heißt, das Kühl- oder Heizventil wird für eine Einschaltperiode geöffnet und danach wieder für eine Abschaltperiode geschlossen. Weicht die gemessene Temperatur von der Vorgabetemperatur nur gering ab, so ist die Abschaltperiode lang, sie wird jedoch umso kürzer, je größer die Temperaturabweichung ist. Sie kann sogar ganz verschwinden, so daß das Ventil ständig geöffnet bleibt. Die Einschaltperiode ist hingegen immer gleich lang und dauert mindestens 30 Sekunden.“10
Während der Überarbeitung wurden am obigen Beispiel folgende Änderungen vorgenommen:
„Der Regler arbeitet im Impulsbetrieb. Das Kühl- oder Heizventil wird für eine Einschaltperiode geöffnet und danach wieder für eine Abschaltperiode geschlossen.
Die Einschaltperiode ist immer gleich lang und dauert mindestens 30 Sekunden. Auf Wunsch können auch längere Einschaltperioden programmiert werden (siehe Kundenspezifische Konfiguration auf S.72)
Die Abschaltperiode hängt von der Abweichung zwischen der gemessenen Temperatur und der Vorgabetemperatur ab.
• Geringe Abweichung = lange Abschaltperiode
• Große Abweichung = kurze Abschaltperiode
• Sehr große Abweichung = keine Abschaltperiode (das Ventil bleibt permanent geöffnet)“11
Diese Änderungen gewährleisten eine größere Übersichtlichkeit und verbessern das Verständnis der komplexen Zusammenhänge. Im vorliegenden Beispiel wurde auch das dazugehörende Bild überarbeitet und näher an die Aussage gesetzt (siehe Abb. 4 und Abb. 5).
Zusammenfassung der Kapitel
Einleitung: Diese Einleitung beschreibt die Zielsetzung der Arbeit, eine bestehende Bedienungsanleitung für ein spezifisches technisches Gerät zu überarbeiten und dabei Methoden zur Prozessverbesserung zu etablieren.
1 Begriffsbestimmung und Anforderungen der technischen Dokumentation: Dieses Kapitel definiert die Vielfalt der Begriffe im Bereich technischer Dokumentation und legt die Anforderungen an qualitativ hochwertige Betriebsanleitungen fest.
2 Angewandte Methoden während dem Prozess der Überarbeitung: Es werden der benutzerzentrierte Designansatz, die Information Mapping®-Methode sowie ein gliederungsspezifisches Konzept vorgestellt, um eine strukturierte Überarbeitung zu ermöglichen.
3 Anwendung in der Praxis: Die praktische Anwendung der zuvor erläuterten Methoden wird anhand der Überarbeitung der Bedienungsanleitung für den Gärtemperaturregler AFC der Firma LiquosystemS dokumentiert.
4 Zeitgemäße Dokumentation: Dieses Kapitel behandelt die Anforderungen an moderne Dokumentationsformen und stellt Werkzeuge für Single Source Publishing vor, um Inhalte effizient für verschiedene Medien aufzubereiten.
Schlüsselwörter
Technische Dokumentation, Betriebsanleitung, Benutzerorientierung, Information Mapping, Single Source Publishing, Usability, Gärtemperaturregler, Interaktives Design, Strukturierung, Anwender, Prozessanalyse, Dokumentationsqualität, Informationsdesign, Handlungsanweisungen, Medienformen.
Häufig gestellte Fragen
Worum geht es in dieser Arbeit grundsätzlich?
Die Arbeit beschreibt die methodische Überarbeitung und Optimierung einer bestehenden technischen Bedienungsanleitung am konkreten Beispiel eines Gärtemperaturreglers der Firma LiquosystemS.
Was sind die zentralen Themenfelder der Publikation?
Die Arbeit verbindet theoretische Grundlagen der technischen Dokumentation, wie das strukturierte Schreiben und benutzerzentrierte Design, mit praktischer Anwendung und modernen Publikationsstrategien.
Was ist das primäre Ziel der Untersuchung?
Das primäre Ziel ist die Verbesserung der Verständlichkeit, Übersichtlichkeit und Benutzbarkeit der Dokumentation durch die Anwendung wissenschaftlich fundierter Gliederungs- und Gestaltungsmethoden.
Welche wissenschaftlichen Methoden werden verwendet?
Es wird primär der benutzerzentrierte iterative Designprozess nach DIN EN ISO 13407 sowie die Methode des strukturierten Schreibens, bekannt als Information Mapping®, eingesetzt.
Was wird im Hauptteil der Arbeit behandelt?
Der Hauptteil widmet sich der detaillierten Analyse des IST-Zustands, der Identifikation von Schwächen in Struktur und Textverständlichkeit sowie der praktischen Umsetzung von Gestaltungs- und Strukturierungsmaßnahmen.
Welche Schlüsselwörter charakterisieren die Arbeit?
Kernbegriffe sind technische Dokumentation, Benutzerorientierung, Information Mapping, Usability und Single Source Publishing.
Warum spielt das "takile Feedback" der Tasterfolie eine Rolle für die Dokumentation?
Da das taktile Feedback am Gerät als unzureichend empfunden wird, muss die Dokumentation diese Lücke durch präzise Anweisungen und eine klare Systematik kompensieren, um dem Benutzer Sicherheit über seine Eingaben zu geben.
Welche Bedeutung hat das Single Source Publishing für das Unternehmen?
Es ermöglicht eine konsequente Trennung von Inhalt und Layout, wodurch Inhalte medienneutral verwaltet und effizient für verschiedene Ausgabeformate wie Online-Hilfen oder Handbücher genutzt werden können.
- Quote paper
- Bachelor of Arts Jürgen Schiel (Author), 2003, Benutzerorientierte Betriebsanleitungen am Beispiel des Gärtemperaturreglers AFC der Fa. LiquosystemS GmbH, Munich, GRIN Verlag, https://www.grin.com/document/53384
