Aufgabe der vorliegenden Diplomarbeit im Bereich Technische Dokumentation war das Erstellen eines EDV-Handbuches für die Zeiterfassungssoftware „leancom 4.0“ der Firma CTI GmbH Leipzig.
Aufbauend auf einer Analyse des vorhandenen Handbuches zur Vorgängerversion der Software erfolgte nach typographischen und didaktischen Richtlinien für die technische Dokumentation das Erarbeiten eines neuen EDV-Handbuches. Dieses gliedert sich in drei Teile: Montage, Installation der notwendigen Hardware sowie die Anleitung der dazugehörigen Software.
Inhaltsverzeichnis
1 Glossar
2 Grundlegende Aspekte der Aufgabenstellung
2.1 Fachliche Einordnung
2.2 Dokumentation als Marketinginstrument
2.3 Interne und externe Rahmenbedingungen
3 Erstellen technischer Dokumentationen
3.1 Die Schrift
3.2 Die Textverteilung
3.3 Gestalten von Überschriften
3.4 Texthervorhebungen
3.5 Bilder
3.6 Gestalten von EDV-Handbüchern
4 Entwurf und Konzeption
4.1 Analyse des vorhandenen Handbuches
4.2 Zielgruppenanalyse
4.3 Entwurf eines neuen Handbuches
4.4 Auswählen und Strukturieren von Inhalten
5 Realisation
5.1 Umsetzen der Layoutvorschläge
5.2 Erstellen der Bilder und Erfassen der Texte
5.3 Testphasen
6 Ergebnis und Beurteilung der Arbeit
Zielsetzung & Themen
Die vorliegende Diplomarbeit befasst sich mit der Erstellung eines praxisorientierten Anwenderhandbuchs für die Zeiterfassungs- und Zutrittskontrollsoftware „leancom 4.0“ der Firma CTI GmbH unter Anwendung aktueller technischer Dokumentationsstandards und typographischer Richtlinien.
- Analyse und Optimierung technischer Dokumentation für EDV-Software
- Anwendung typographischer Gestaltungsprinzipien in der Fachdokumentation
- Systematische Zielgruppenanalyse zur bedarfsgerechten Informationsvermittlung
- Methodische Entwicklung eines Handbuchkonzepts für komplexe Softwareprodukte
- Realisierung von Layout und Textstruktur unter Nutzung von MS Word
Auszug aus dem Buch
3.1 Die Schrift
Der Einfluß der mikrotypographischen Merkmale auf die Verständlichkeit eines Textes auf den Leser ist vielfach untersucht worden. Die wichtigsten Einflußgrößen für die Erkennbarkeit und Lesbarkeit eines Textes sind Schrifttyp, Schriftgrad, Schriftschnitt und deren Farbe (vgl. /1/).
Die Schrift muß in ihrer Gesamtheit gesehen werden. Sie soll sich in ihrer Gestaltung nach der gewollten Aussage richten, und ist nicht zu isolieren. Die Bedeutung der Schrift, hat sich auch nach der zu vermittelnden Information zu richten.
Man muß davon ausgehen, daß die Auswahlkriterien für Bedienungsanleitungen anders sind als zum Beispiel für umfangreiche Prospekte. Schriften sollten daher möglichst schnell und zweifelsfrei erfaßbar sein. Zu den wichtigsten Determinanten der schlechten Lesbarkeit gehören /1/:
- Schrifttyp,
- Schriftschnitt,
- Schriftgrad.
Zusammenfassung der Kapitel
1 Glossar: Definition zentraler Fachbegriffe aus den Bereichen Typographie und Satztechnik zur Sicherstellung des Grundverständnisses.
2 Grundlegende Aspekte der Aufgabenstellung: Einordnung der Arbeit in den Bereich der technischen Dokumentation und Betrachtung des Handbuchs als strategisches Marketinginstrument.
3 Erstellen technischer Dokumentationen: Darlegung der theoretischen Grundlagen zu Schriftwahl, Textverteilung, Überschriftengestaltung sowie der Rolle von Bildern und Hervorhebungen.
4 Entwurf und Konzeption: Analyse des bestehenden Vorgängerhandbuchs sowie systematische Entwicklung des neuen Konzepts basierend auf Zielgruppenbedürfnissen.
5 Realisation: Beschreibung der praktischen Umsetzung des Layouts, der Erstellung von Visualisierungen sowie der Durchführung von Anwendertests.
6 Ergebnis und Beurteilung der Arbeit: Kritische Reflexion der Projektergebnisse und Ausblick auf die zukünftige Integration automatisierter Dokumentationsprozesse.
Schlüsselwörter
Technische Dokumentation, Anwenderhandbuch, Typographie, leancom 4.0, Software-Dokumentation, Microsoft Word, Zielgruppenanalyse, Layoutgestaltung, Lesbarkeit, EDV-Handbuch, Visualisierung, Satzspiegel, Marketinginstrument, Zeiterfassungssoftware, Makroprogrammierung.
Häufig gestellte Fragen
Worum geht es in der Arbeit grundlegend?
Die Arbeit beschäftigt sich mit der professionellen Neuerstellung eines technischen Handbuchs für die Software „leancom 4.0“.
Was sind die zentralen Themenfelder?
Der Fokus liegt auf typographischen Richtlinien, technischer Dokumentation von Software und einer zielgruppenorientierten Strukturierung von Informationen.
Was ist das primäre Ziel der Arbeit?
Ziel war es, die Verständlichkeit und Benutzerfreundlichkeit der Dokumentation für Sekretärinnen als Hauptzielgruppe durch ein verbessertes, methodisch fundiertes Konzept zu steigern.
Welche wissenschaftliche Methode wurde verwendet?
Es wurde eine Kombination aus theoretischer Analyse typographischer Standards, Zielgruppenanalyse und empirischen Testphasen mit Anwendern durchgeführt.
Was wird im Hauptteil behandelt?
Der Hauptteil gliedert sich in die theoretische Fundierung der Dokumentationsgestaltung, die konkrete Konzeption des neuen Handbuchs und dessen praktische Realisierung.
Welche Schlüsselwörter charakterisieren die Arbeit?
Technische Dokumentation, Lesbarkeit, Typographie, Software-Anleitung und zielgruppengerechte Informationsaufbereitung.
Wie wurde das Problem der veralteten Dokumentation gelöst?
Durch eine vollständige Neugestaltung des Layouts und eine nutzerzentrierte Strukturierung, die sich stärker an den realen Arbeitsabläufen der Softwareanwender orientiert.
Welche Rolle spielten Makros bei der Erstellung?
Makros wurden eingesetzt, um Layoutanforderungen in Microsoft Word zu automatisieren, wie z.B. die Ausrichtung von Marginalien oder die Aktualisierung von Grafikpfaden.
- Citation du texte
- Heiko Schröder (Auteur), Peter Teich (Auteur), 1997, Erarbeiten eines Anwenderhandbuches für die Zeiterfassungs-, Zutrittskontroll- und Anwendersoftware "Leancom 4.0 für Windows", Munich, GRIN Verlag, https://www.grin.com/document/185223
