Erarbeiten eines Anwenderhandbuches für die Zeiterfassungs-, Zutrittskontroll- und Anwendersoftware "Leancom 4.0 für Windows"

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

7 Literaturverzeichnis

Dokumentationsblatt

Bibliographische Beschreibung

Schröder, Heiko / Teich, Peter: Erarbeiten eines Anwenderhandbuches für die Zeiterfassungs-, Zutrittskontroll- und Anwendersoftware „leancom 4.0 für Windows“

Leipzig, Fachhochschule der Deutschen Telekom AG

Diplomarbeit, SS 1997

Kurzfassung

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.

bestätigt:

Gutachter

„Der Ingenieur Kenneth Olsen, Gründer und ehemaliger Vorstandsvorsitzender der Digital Equipment Corp., gestand, daß er nicht fähig sei, nach der Gebrauchsanweisung im Mikrowellenherd der Firma eine Tasse Kaffee warm zu machen.“

Wall Street Journal (1986)

1 Glossar

Abbildung in dieser Leseprobe nicht enthalten

2 Grundlegende Aspekte der Aufgabenstellung

2.1 Fachliche Einordnung

Die vorliegende Arbeit entstand im Zusammenhang mit der Erstellung eines EDV-Handbuches für die Software CTI leancom 4.0 als Diplom­arbeit im achten Semester an der Fachhochschule Leipzig der Deutschen Telekom AG. Dabei handelt es sich um eine Arbeit im Bereich Technische Dokumentation.

Ein EDV-Handbuch läßt sich im weitesten Sinne als Gebrauchsanleitung bezeichnen. Jedoch existieren hier einige Besonderheiten, die es zu beachten gilt. Diese Arbeit wird sich daher mit dem Erstellen von Gebrauchsanleitungen unter besonderer Berücksichtigung der Anforderungen an ein EDV-Handbuch beschäftigen.

Dargestellt wird dies anhand der einzelnen zeitlich hintereinander angeordneten Phasen im Prozeß der Dokumentationserstellung. Am Ende wird kein allgemeingültiger Ablaufplan stehen, sondern eine speziell auf diese eine Aufgabenstellung ausgerichtete Dokumentation.

Eine weitere Teilaufgabe der Diplomarbeit bestand darin, ein Konzept zur automatischen Generierung von HTML- und Windows-Hilfe-Dateien aus Microsoft-Winword-Dokumenten zu erstellen. Aufgrund des Umfanges der zu erstellenden Anleitung, die drei Handbücher umfaßt, wurde im Einvernehmen mit der Firma CTI GmbH auf die Realisierung dieser Teilaufgabe verzichtet.

2.2 Dokumentation als Marketinginstrument

Lange Zeit wurden Gebrauchsanleitungen und damit Dokumentationen in den Unternehmen eher als zweitrangig betrachtet. Heute besitzt die Dokumentation jedoch einen nicht zu unterschätzenden Stellenwert in einem modernen Unternehmen. Als wesentlicher Bestandteil der Unternehmenskommunikation ist sie Ausdruck der Verbundenheit mit den Kunden geworden, vermittelt das Corporate Design und ist wichtiges Marketinginstrument.

In den Richtlinien für das Corporate Design wird festgelegt, wie eine einheitliche Firmenkommunikation aussehen soll. Diese Regeln sind vor allem für sehr große, möglicherweise weltweit agierende Unternehmen von Bedeutung, um einen einheitlichen Auftritt in der Öffentlichkeit zu garantieren. Für die mittelständige Firma CTI GmbH existieren keine Vorgaben für das Corporate Design, die das Handbuch erfüllen muß. Viel wichtiger ist in diesem Fall die Funktion des Handbuches als Marketinginstrument.

In vielen Konsum- und Investitionsgütermärkten werden Produkte, Komponenten, Maschinen und Anlagen verschiedener Anbieter Schritt für Schritt ähnlicher. Sowohl deren technische Leistungsfähigkeit als auch ihre technisch-funktionale Qualität nähern sich einander an. Das Gleiche gilt natürlich ebenfalls für den Markt der Zeiterfassungssoftware, auf dem das Produkt leancom 4.0 der CTI GmbH angesiedelt ist. Mit einem neuen Handbuch will die Firma sich dabei einen relativen Konkurrenzvorteil verschaffen.

Die Hauptleistung, in diesem Fall die Software, wird durch eine gute Dokumentation vervollständigt. Es ergibt sich ein verändertes Gesamtangebot. Bietet der Konkurrent nun ähnliche Kernleistungen, jedoch eine weniger gute Dokumentation, so ist die Basis für einen Wettbewerbsvorteil gelegt.

Dem Wunsch der CTI GmbH entsprechend, soll das neue Handbuch als Informationsdokumentation vor dem Kauf an potentielle Kunden verschickt werden. Es übernimmt in diesem Fall vollständig die Rolle einer Werbeschrift. Aus Marketingsicht ist es daher besonders wichtig, die für den Kunden beim Kauf relevanten Merkmale hervorzuheben.

Die optische Gestaltung des Handbuches bestimmt beim potentiellen Kunden den ersten Eindruck, denn er hat in der Informationsphase meist den direkten Vergleich zu den Handbüchern der anderen Hersteller. Daher muß sich die Gestaltung auf den ersten Blick von den Konkurrenzprodukten abheben.

2.3 Interne und externe Rahmenbedingungen

Die Arbeit erfolgte in Form einer Projektarbeit, da diese Vorgehensweise für eine effektive Teamarbeit prädestiniert ist. Eine erfolgreiche Projektarbeit wird von einige Rahmenbedingungen – externen und internen – geprägt, die die Arbeit beeinflussen.

Zu den externen Rahmenbedingungen zählten die Auflagen, die zu erfüllen waren. Dazu gehörte grundsätzlich die Notwendigkeit der Bildung eines Teams, bedingt durch den Umfang der Aufgabenstellung. Eine weitere – wahrscheinlich die wichtigste Auflage – war der Abgabetermin 03.06.1997. Darauf aufbauend ließ sich der Zeitplan für die Projektarbeit und der Redaktionsschluß für das Handbuch erarbeiten.

Eine der wichtigsten internen Rahmenbedingungen für die Projektgruppe war die Aufteilung der Arbeiten. Für ein relativ kleines Projektteam, wie in diesem Fall, war das Aufteilen der Arbeiten nicht ganz so schwierig.

Die Aufteilung der Arbeiten für das Handbuch und die theoretische Abhandlung erfolgte folgendermaßen:

Abbildung in dieser Leseprobe nicht enthalten

Je mehr Informationen zu verarbeiten sind, um so komplexere Aufgaben ergeben sich für die Mitglieder des Teams. Darin resultiert eine ressortübergreifende Zusammenarbeit, die nicht vollständig getrennt werden kann, wie auch in diesem Fall.

Für die Dauer der Diplomarbeit bildete sich ein temporäres Projektmanagement. Dies bedeutet, die Zusammenarbeit dauert nur solange, wie das Projekt (die Diplomarbeit) lief. Danach erfolgte die Auflösung der Projektorganisation.

Abbildung in dieser Leseprobe nicht enthalten

Dem Projektleiter Herrn H. Scharf oblag dabei die Kontrolle des Projektablaufes. Er hatte keine Weisungsmöglichkeit und nur beschränkte Reaktionsmöglichkeiten, da er keine Entscheidungen fällen konnte.

Nicht unmittelbar in das Projektteam integriert waren Berater und Testpersonen. Als Ansprechpartner fungierte Frau H. Schindler. Sie erfüllte beratende Funktionen, besaß jedoch keine Möglichkeiten des Eingreifens während der Erstellung des Handbuches.

Der Mitarbeitereinsatz während der Projektphase war hoch. Es erfolgte daher eine Freistellung von anderen Aufgaben.

3 Erstellen technischer Dokumentationen

Der wichtigste Grundsatz beim Erstellen technischer Dokumentationen ist die Verständlichkeit. Um diese zu erreichen, existieren eine Reihe von Regeln, die sowohl den Text als solchen betreffen als auch die typographische Gestaltung und Anordnung der Texte und Bilder.

Beim Lesen und Analysieren der Texte wird jeder Satz unbewußt vom Leser in Grundeinheiten zerlegt, um den Bedeutungsinhalt zu ermitteln. Um diese Analyse zu beschleunigen, ist es wichtig, daß die Grundeinheiten gut sichtbar sind. Es ist nun Aufgabe der Typographie, in der technischen Dokumentation diesen Prozeß zu unterstützen. Im folgenden sollen Hinweise bezüglich Typographie und Textgestaltung bei der technischen Dokumentation gegeben werden.

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.
- Schrifttyp

Beim Lesen von Gebrauchsanleitungen kommt es kaum auf die Erkennbarkeit einzelner Wörter und Buchstaben an. Die Lesbarkeit der Texte und das schnelle und effiziente Lesen sind wichtige Voraussetzungen für das Verstehen der gedruckten Wortzeichen. Die Lesbarkeit der Schrift wird schlechter, je mehr der Verzerrungstyp wechselt.

Beim Lesen stellt man sich schnell auf einen bestimmten Schrift- oder Verzerrungstyp ein und hat danach geringe Schwierigkeiten beim Erkennen der Typen.

Untersuchungen haben gezeigt, daß sich das optische System bereits nach Aufnahme der ersten 2-3 Symbole auf einen bestimmten Typ einstellt (vgl. /2/).

Viele Firmen verwenden sogenannte „Hausschriften“. Sie benutzen einen einheitlichen Schrifttyp für alle Drucksachen der Firma. Dadurch wird die Einheitlichkeit der Informationsgestaltung verbessert.

Als Beispiel sei die Firma AEG angeführt. Unter dem Punkt „Die Schrift“ ihrer Richtlinien für die visuelle Gestaltung von Werbe-, Informations- und hausinternen Schriften schreibt sie sinngemäß: Hausschrift ist die Helvetica in den Grundschriften „Helvetica leicht“ oder „normal“. Für Auszeichnungen kommen die Schriftschnitte „halbfett“ und „fett“ hinzu (vgl. /3/).

Bei konsequenter Anwendung wird die Firma mit einem bestimmten Schrifttyp identifiziert, da dieser ein Teil des einheitlichen Firmenbildes ist.

- Schriftschnitt

Diverse Untersuchungen haben ergeben, daß Fließtexte mit fettem Schnitt schwerer zu lesen sind als mit normalem oder halbfettem Schnitt.

Demzufolge ist für Fließtexte ein normaler Schriftschnitt anzuwenden. Fette oder kursive Schnitte dienen zur Auszeichnung von Schriftteilen und sollten nur für besondere Hervorhebungen angewendet werden.

- Schriftgrad

Die Lesbarkeit von Schriften hängt nicht zuletzt von dem Schriftgrad, also der Größe der Schrift ab. Die optimale Größe wird von verschiedenen Faktoren bestimmt:

- Betrachtungsabstand,
- Schriftschnitt,
- Informationsträger,
- Verwendungszweck.

Bei der Betrachtung eines geeigneten Schriftgrades für Gebrauchsanleitungen kann man von einem normalen Leseabstand ausgehen. Das bedeutet einen ungefähren Abstand des Lesers zum Gedruckten von ca. 30 cm.

Das übliche Format wird DIN A4 nicht überschreiten. Geht man von einem normalem Schriftschnitt aus, so sind für die einzelnen Seitenformate folgende Schriftgrade nicht zu unterschreiten:

Abbildung in dieser Leseprobe nicht enthalten

Wenn von Schriftgrößen die Rede ist, so sind auch Maße zu nennen, mit denen deren Größe bestimmt werden kann: Man unterscheidet zwischen den Maßeinheiten Millimeter, typographischer Punkt (Didot­‑Punkt) und Pica-Point. Laut Rechtsverordnung der EG zum Meßwesen wurde festgelegt, daß ab 1. Januar 1978 nur noch das metrische Maß verwendet werden darf. Das galt auch für die Druckindustrie, die nach dem typographischen Maßsystem arbeitete. An diese Entscheidung hat sich allerdings niemand wirklich gehalten, so daß auch heute noch nach dem typographischen Maßsystem gearbeitet wird:

[...]