Abbildungsverzeichnis   4

1  Einleitung.  5

2  Technische Dokumentationen  7

2.1  Was ist eine Technische Dokumentation  7

2.2  Dokumentationsarten.  7

2.2.1  Produktdokumentation  8

2.2.2  Benutzerdokumentation  8

2.2.3  Entwicklungsdokumentation.  10

2.2.4  Projektdokumentation  10

2.3  Zweck einer Dokumentation  11

2.4  Dokumentation als Marketinginstrument.  12

2.5  Anforderungen an die Dokumentation  13

2.5.1  Allgemeine Anforderungen.  13

2.5.2  Anforderungen an eine „gute Dokumentation“  14

2.5.2.1  Klarheit  15

2.5.2.2  Kürze.  16

2.5.2.3  Klang  16

2.5.2.4  Schrift  16

2.5.2.5  Strukturierung.  17

2.6  Normen und Richtlinien.  17

2.6.1  Grundlagen  17

2.6.2  Normen für Dokumentationen  18

2.6.2.1  DIN EN 62079  19

2.6.2.2  VDI 4500  20

2.7  Notwendige Arbeitsschritte  21

2.7.1  Zielgruppenanalyse.  21

2.7.2  Informationsbeschaffung.  22

2.7.3  Medienauswahl  23

2.7.3.1  Gedruckte Dokumentation  23

2.7.3.2  Elektronische Dokumentation  24

3  Dokumentation des BA-Managers.  26

3.1  Was ist der BA-Manager.  26

3.2  Konzept de BA-Managers  26

3.3  Datenschutz  27

3.4  Dokumentationsinhalte  28

3.4.1  Datenmodell  28

3.4.2  Attributliste  29

2

3.4.3  Installationsanleitung.  30

4  Fazit.  31

Literaturverzeichnis.   32

Anhangverzeichnis   34

Ehrenw  örtliche Erklärung.  35

3

Abbildungsverzeichnis   

Abbildung  1 Hypertexthilfe.  25

4

1 Einleitung

Die Berufsakademie Gera verwendet zur Speicherung aller betriebsrelevanten Daten eine als „BA-Manager“ bezeichnete Software. Die Basis dieses Systems wurde in Rahmen von mehreren Studienarbeiten an der Berufsakademie Glauchau entwickelt. Im Laufe der Zeit wurde die Basis weiter verbessert und um zusätzliche Komponenten ergänzt. So existieren eine Komponente zur Unterrichtsplanung und zur webgestützten Notenauskunft, die an den BA-Manager angebunden sind. Auch diese Entwicklungen waren Teil der Studienarbeiten von Studenten. Der Fokus der Arbeiten lag dabei nur auf den eigenen Entwicklungen und der BA-Manager wurde nicht als Gesamtsystem betrachtet. Die zuletzt angefertigte Dokumentation des BA-Managers stammt von 1999. Die Änderungen, die an dem System vorgenommen wurden, sind in die Dokumentation nicht übernommen worden. Für BA-Studenten, welche die Änderungen vornehmen, ist es jedoch wichtig, dass diese über die technischen Details informiert sind. Nur so können sie das System verstehen und ihre Komponenten systemkonform integrieren. Diese Studienarbeit soll den Dokumentationsstand aktualisieren und auf die technischen Eigenheiten hinweisen. Im ersten Teil wird der Begriff der technischen Dokumentation erläutert und die verschiedenen Arten der Dokumentation beschrieben. Im Anschluss daran wird erörtert, welchen Zweck eine Dokumentation besitzt und angemerkt, dass eine Dokumentation in einem Unternehmen auch als Marketinginstrument verwendet werden kann, um seine Produkte besser zu verkaufen. Darauf folgend werden die Anforderungen an eine Dokumentation ermittelt. Diese sind die Grundlage dafür, dass die Dokumentation von dem Leser akzeptiert und der Inhalt verstanden wird. Im Weiteren werden die relevanten Normen recherchiert. Normen sind wichtig, damit die Dokumentation rechtskonform wird, Schäden, die aufgrund falscher Bedienung entstehen vermieden werden und der Produkthersteller vor den daraus resultierenden Schadensersatzansprüchen geschützt wird. Daran anschließend werden die Arbeitsschritte erläutert, die bei der Dokumentationserstellung besonders zu beachten sind.

Nach der theoretischen Erörterung wird auf die Dokumentation des BA-Managers eingegangen. Zunächst wird erläutert worum es sich bei dem BA-Manager handelt und wie er konzeptionell aufgebaut ist. Im Weiteren kommt es zu einem Exkurs darüber, wie der Datenschutz in dem System realisiert wird. Studienrichtungsbezogene Daten sollen nur den Mitarbeitern aus der jeweiligen Studienrichtung zugänglich sein und nur die Daten angezeigt werden, welche für zur Bearbeitung der tägliche Aufgaben der Mitarbeiter benötigt

5

werden. Daran anschließend werden die einzelnen Dokumentationsinhalte aufgegriffen und näher erläutert. Es wird beschrieben warum diese nötig sind und warum sie in der vorliegenden Form erstellt wurden.

Ein Fazit fasst noch einmal alle Punkte zusammen und rundet die Arbeit ab.

6

2 Technische Dokumentationen

2.1 Was ist eine Technische Dokumentation

Technische Dokumentationen sind eine Form der Kommunikation über Technik, welche den massenmedialen Bereich betrifft. Es werden zwei Bereiche unterschieden: ¹ Zum einen in dem Bereich der Massenmedien und zwar vor allem in der Wissenschaftsberichterstattung. Diese äußert sich in Form von wissenschaftlichen Berichten über die Technik und deren Entwicklung und trägt einen wesentlichen Anteil zur Akzeptanz der Technik in der Bevölkerung bei.

Zum andern als Kommunikationsform im Bereich der Technik, die mit Hilfe von technischen Dokumentationen erfolgt. In diesem Fall stellt die Dokumentation einen Sammelbegriff für Unterlagen zu technischen Geräten dar.

„Die Technische Dokumentation muss in übersichtlicher und logischer Form sachlich richtig alle Informationen bereitstellen, die zweckentsprechend von ihr erwartet werden, z.B. für […] Montage, Betrieb und Instandhaltung.“ ² Um diese Anforderungen zu erfüllen kann die Dokumentation aus mehreren einzelnen Dokumenten bestehen. Diese können in Form von Handbüchern, Betriebsanleitungen, Gebrauchsanleitungen, Produktbeschreibungen,

Wartungshandbüchern, technischen Tabellen, usw. erstellt werden. Die Auswahl der Dokumente und deren Aufbau wird durch die Zielgruppe vorgegeben, für welche die Dokumentation erstellt wird.

Die Ersteller solcher Dokumentationen werden als technische Redakteure bezeichnet. Dieser zweite Bereich soll hier in dieser Studienarbeit behandelt werden.

2.2 Dokumentationsarten

Dokumentationen werden für verschiedene Phasen des Produktlebenszyklus erstellt und erfüllen jeweils einen anderen Zweck. Davon und von der jeweiligen Zielgruppe hängt ab, welche Dokumentationsart verwendet wird. Folgende vier Arten lassen sich unterscheiden. • Produktdokumentation

¹ Vgl. [HJF96], S. 7

² Vgl. VDI 4500, S. 29

7

• Projektdokumentation

• Benutzerdokumentation

• Entwicklungsdokumentation

2.2.1 Produktdokumentation

Die Produktdokumentation ist eine Beschreibung der Systemeigenschaften eines Produktes, die Informationen zum Aufbau und zur Implementierung des Gerätes enthält. Der Umfang der Dokumentation hängt von der Komplexität des Produktes und vom Einsatzzweck ab. Der Zweck kann zum einen darin bestehen als werbewirksame Beschreibung des Produktes an Kunden oder Händler verteilt zu werden. In diesem Falle werden die Funktionen und Vorteile des Produktes hervorgehoben und relativ oberflächlich beschrieben. Zum andern kann die Produktdokumentation als umfangreiche und detaillierte Beschreibung des gesamten Systems auftreten, um Fachpersonal einen detaillierten Einblick in die technischen Eigenschaften des Produktes zu ermöglichen. In diesem Fall kann die Produktdokumentation auch als Systemdokumentation bezeichnet werden. Die Systemdokumentation muss unterschiedliche Anforderungen erfüllen. Sie sollte ausreichend abstrakt sein, um Teammitgliedern schnell und effizient einen Überblick über das System und dessen Architektur zu bieten. Jedoch muss sie auch die Bestandteile des Produktes ausreichend detailliert beschreiben. Die Beschreibung eines Softwaresystems beispielsweise müsste sowohl das Zusammenwirken der Klassen untereinander beschreiben, um einen Blick über das gesamt System zu erhalten, als auch die einzelnen Klassen, um deren Funktion zu vermitteln.

Die Beschreibung des Aufbaus sowie der Implementierung des Softwaresystems erfüllen unterschiedliche Aufgaben. Eine dieser Aufgaben ist die Bildung einer Grundlage für die Kommunikation zwischen den Projektbeteiligten. Ferner soll die Systemdokumentation die Einarbeitung in das Softwaresystem vereinfachen und dessen Weiterentwicklung und Wartung unterstützen. Auch die Systemanalytiker und die Tester benutzen sie als Grundlage ihrer Tätigkeiten.

2.2.2 Benutzerdokumentation

Die Benutzerdokumentation soll dem Anwender den Umgang mit dem Produkt ermöglichen. Der Begriff des „Benutzers“ ist in diesem Fall sehr weit gefasst. Er umfasst alle Personen, die nach der Fertigstellung des Produktes mit ihm in Berührung kommen. Dies sind sowohl die normalen Endnutzer als auch Fachpersonal wie Installateure, Wartungstechniker,

8

Administratoren, usw. Entsprechend der Benutzergruppe muss die Dokumentation inhaltlich gestaltet werden. Um die unterschiedlichen Erwartungen der jeweiligen Zielgruppe erfüllen zu können, kann es auch nötig sein mehrere Benutzerdokumentationen zu erstellen. Dies soll jedoch unter dem Punkt Zielgruppenanalyse weiter ausgeführt werde. Mögliche Dokumente einer Benutzerdokumentation sind:

• Einführungshandbuch

• Betriebsanleitung

• Bedienungsanleitung

• Gebrauchsanleitung

• Übungshandbuch (Tutorial)

• Kurzreferenz

• Liste mit häufig gestellten Fragen (FAQ)

Die Benutzerdokumentation dient der Unterstützung der Benutzer. Sie gibt Hinweise zur Handhabung, eine Beschreibung der Funktionen und die zu ihrer Ausführung notwendigen Aktionen. Um den Benutzern den Umgang mit dem Gerät zu ermöglichen, sollten folgende Fragen beantwortet werden:

• „Was ist mit dem Programm möglich?“

• „Wie muss ich dabei vorgehen?“

• „Was passiert dabei?“

Bei der Beantwortung dieser Fragen muss Schritt für Schritt vorgegangen werden und großer Wert auf die Verständlichkeit gelegt werden. Im besonderen Maße gilt dies für die Zielgruppe der Endbenutzer, da bei diesen die Vorkenntnisse und das Verständnisvermögen am aller wenigsten eingeschätzt werden können.

Die Notwendigkeit für eine Dokumentation ergibt sich daraus, dass die Produkte meist zu komplex sind, als dass sie sich von jedem Anwender intuitiv bedienen lassen. Ein weiterer Grund für eine Benutzerdokumentation ergibt sich aus der Verantwortlichkeit, die der Hersteller für seine Produkte übernimmt. Durch falsche Bedienung des Produktes können je nach Produktart materielle oder sogar menschliche Schäden entstehen. Die Benutzerdokumentation hat die Aufgabe auf solches Fehlverhalten hinzuweisen und befreit somit den Hersteller von seiner Verantwortlichkeit für Schäden, die aus diesem

9

Fehlverhalten resultieren. Es ist jedoch zu beachten, dass dies nicht für Schäden durch Fehler am Produkt selbst gilt.

2.2.3 Entwicklungsdokumentation

Das Wissen darüber wie ein Produkt hergestellt wird macht seinen größten Wert aus. Eine Entwicklungsdokumentation soll dieses Wissen festhalten, um die Schritte reproduzierbar zu machen. Außerdem ist sie ein wichtiges Werkzeug für die Produktentwicklung. ³ Während eines Entwicklungsprojektes müssen die Beteiligten über den Stand des Projektes informiert sein und auf die Ergebnisse der anderen Entwickler Zugriff haben. So lässt sich zum einen die Arbeitsteilung koordinieren. Zum andern ist dieses Wissen notwendig, um die eigenen Entwicklungen systemkonform und integrierbar zu machen. Nur wenn alle Entwicklungsteile nach den gleichen Anforderungen erstellt wurden lassen sie sich in das Gesamtsystem mit einfügen. In einem Softwareprojekt beispielsweise müsste ein Programmierer über Informationen der Schnittstellenspezifikationen verfügen, um die Übergabe der Variablen zu ermöglichen. Weiterhin müssten die Arbeitsweise und Funktionalität der Softwaremodule dokumentiert werden. Die Funktionalität wird beschrieben, um Doppelprogrammierungen zu vermeiden und so „das Rad nicht immer wieder neu zu erfinden“. Die Arbeitsweise soll späteren Programmierern die Anpassung an geänderte Anforderungen ermöglichen.

Besonders im Softwarebereich ist eine sorgfältige Dokumentation notwendig, denn schließlich wird hier das Produkt versionsweise geliefert und bestehender Programmcode immer wieder neu verwendet.

2.2.4 Projektdokumentation

Die Projektdokumentation zählt nicht direkt zu dem Bereich der technischen Dokumentationen, da sie nicht das technische Gerät beschreiben sondern lediglich den Verlauf des Projektes. Da sie jedoch den technischen Dokumentationen sehr ähnlich ist und an sie die gleichen Anforderungen gestellt werden, soll sie hier zur Vollständigkeit mit aufgeführt werden.

Projektdokumentationen sollen die einzelnen Phasen des Projektes dokumentieren, um den Projekterfolg sichtbar zu machen und um auf die erreichten Ergebnisse zurückgreifen zu können. Außerdem sollen Fehler und Misserfolge aufgezeigt werden, um diese in späteren Projekten zu vermeiden und einen effizienteren Arbeitsablauf zu ermöglichen.

³ Vgl. [BJ95], S. 153

10

Ihre Aufgabe ist die Gestaltung, Kennzeichnung und Archivierung aller angefallenen Dokumente und die Eingliederung in ein bestimmtes Ordnungssystem. Dies können Listen, Pläne, Berichte, Vorschriften, Spezifikationen und vieles mehr sein. ⁴ Die Dokumentation kann sowohl statisch als auch dynamisch erfolgen.

An einer statischen Dokumentation, die auch als Abwicklungsdokumentation bezeichnet wird, wird nach Fertigstellung des Projektes keine Änderung mehr vorgenommen. Sie dokumentiert den Verlauf des Projektes um dem Auftraggeber Einblick in das Projektgeschehen zu ermöglichen und um Vergleiche zu früheren bzw. späteren Projekten zu ermöglichen.

Die dynamische Projektdokumentation wird nach Fertigstellung des Projektes weiter verändert, um das Wissen über ein sich weiter entwickelndes System auf dem aktuellen Stand zu halten. Die Dokumente werden zum Betrieb des Systems und als Wissensbasis für die Entwickler benötigt.

2.3 Zweck einer Dokumentation

Der Zweck einer Dokumentation hängt davon ab, für welche Zielgruppe sie bestimmt ist und in welchem Bereich sie eingesetzt wird. Wird ein fertiges Produkt dokumentiert, so müsste beispielsweise für den Vertrieb dokumentiert werden, welchen Leistungsumfang das Produkt besitzt. Der Endbenutzer möchte dagegen erfahren, wie er das Gerät bedienen muss, um sich die Leistungen zugänglich zu machen. Handelt es sich um eine betriebsinterne Dokumentation so werden dagegen ganz andere Eigenschaften verlangt. Diese Aspekte sollen jedoch später unter dem Punkt Zielgruppenanalyse weiter ausgeführt werden. Die Norm DIN EN 61082 definiert den Zweck einer Dokumentation wie folgt: „Der Zweck der Dokumentation ist die Informationsbereitstellung in möglichst einfacher Form. Die technische Dokumentation ist für Erstellung, Inbetriebnahme, Betrieb, Instandhaltung und Verschrottung einer Anlage oder eines Systems wichtig.“ ⁵ Die Dokumentation soll also Informationen für jede Phase des Produktlebenszyklus bereitstellen. Diesen Phasen lassen sich auch die bereits erläuterten Dokumentationsarten zuordnen.

⁴ Vgl. [BJ95], S. 153

⁵ Vgl. [DIN 61082], S. 33

11

Allgemein lässt sich sagen, dass eine technische Dokumentation Informationen über ein technisches Gerät zu dessen Beschreibung sammeln soll. Folgende drei Hauptaufgaben werden von ihr erfüllt: ⁶ Wissenssicherung

Das Wissen (Know How) über ein System macht einen beträchtlichen Teil seines Wertes aus. Dazu muss das Wissen über das Gerät aus den Köpfen der Entwickler geholt werden. Somit wird zum einen die Erfahrung, die aus dem Projektverlauf gezogen werden kann, gesichert. Zum anderen wird die Grundlage für die Produkt- und Entwicklungsdokumentation geschaffen. Kommunikation

Eine geordnete Systementwicklung und Pflege ist nur aufgrund einer ausgereiften Kommunikation zwischen den Entwicklern möglich. Die Dokumentation dient dazu den Informationsaustausch und somit die Aufgabenteilung der einzelnen Entwickler zu realisieren. Zwischen der Informationserzeugung und der Informationsnutzung können unter Umständen Jahre vergehen. Um die Informationen dauerhaft zu erhalten, muss die Kommunikation in den wesentlichen Teilen schriftlich erfolgen. Dadurch wird die Arbeit an dem Projekt weniger personengebunden, so dass der Ausfall Einzelner nicht den Gesamterfolg gefährdet. Sichtbarmachen des Projektfortschritts

Mit der Dokumentation des Projektes wird der Abschluss der Phasen nachprüfbar. Erst wenn die dazugehörigen Dokumente freigegeben wurden, kann die Phase als beendet angesehen werden. Später kann auf die Resultate, welche daraus gezogen wurden, einfach und schnell zurückgegriffen werden. Der Projektfortschritt wird somit besser quantifizierbar und der Ablauf des Projektes nachvollziehbar.

2.4 Dokumentation als Marketinginstrument

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

⁶ Vgl. [MG99], S. 135

12

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. Ausschlaggebend für die Entscheidung des Kunden ist daher in vielen Fällen nicht das Produkt an sich, sondern der Preis und die zusätzlichen Leistungen des Unternehmens. Gerade mit einer guten Dokumentation lässt sich ein relativer Konkurrenzvorteil (im Marketing auch als komparativer Konkurrenzvorteil bezeichnet) schaffen. Die Hauptleistung wird nämlich erst durch die 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. Weiterführend ist es denkbar, dass eine Dokumentation, welche die Vorteile und Funktionalitäten beschreibt, als Werbeschrift verschickt wird. Sie würde dann nicht als Benutzer- sondern als Produktdokumentation (siehe oben) fungieren. Aus Marketingsicht ist es dann besonders wichtig, die für den Kunden beim Kauf relevanten Merkmale hervorzuheben.

Die optische Gestaltung des Handbuches bestimmt beim potentiellen Kunden den ersten Eindruck. Er hat in der Informationsphase häufig den direkten Vergleich zu den Handbüchern der anderen Hersteller. Daher muss sich die Gestaltung auf den ersten Blick positiv von den Konkurrenzprodukten abheben. Die Anforderungen, die an eine gute Dokumentation gestellt werden, werden im Folgenden vorgestellt.

2.5 Anforderungen an die Dokumentation 2.5.1 Allgemeine Anforderungen

Nachdem nun das Ziel einer Dokumentation klar gestellt wurde, müssen die Anforderungen definiert werden, die an eine Dokumentation gestellt werden. Unter diesem Gliederungspunkt werden die grundlegenden Punkte aufgelistet, die auf jeden Fall erfüllt sein müssen. Das Handbuch für technische Autoren und Redakteure fordert folgende Punkte: ⁷ • Sachliche Richtigkeit

Alle Aussagen müssen der Wahrheit entsprechen und dürfen sich nicht widersprechen.

⁷ Vgl. [HHT02], S. 27

13

• Verständlichkeit

Die zu vermittelnden Informationen müssen von der Zielgruppe, für welche die Dokumentation erstellt wurde, ohne fremde Hilfe und übermäßige Anstrengung verstanden werden können. Dazu gehört sowohl eine verständliche Ausdrucksweise als auch eine klare Gliederung. Um Arbeitsabläufe zu verdeutlichen bietet es sich an Bilder mit in die Dokumentation aufzunehmen.

• Vollständigkeit

Alle Informationen die für die Zielgruppe von Wichtigkeit sind, um die ihr zugedachten Aufgaben lösen zu können, müssen in der Dokumentation enthalten sein. Zur Vollständigkeit zählt aber auch, dass alle unnötigen und überflüssigen Informationen weggelassen werden.

• Aktualität

Die Dokumentation muss mit der Produktversion, für die sie bestimmt ist, übereinstimmen. Benutzer- und Produktdokumentationen werden häufig während der Produktentwicklung erstellt, um termingerecht zu erscheinen, so dass gerade hier die Gefahr der nicht vorhandenen Aktualität besteht. Bei Entwicklungsdokumentationen reicht es aus wenn sie in regelmäßigen Abständen aktualisiert werden.

2.5.2 Anforderungen an eine „gute Dokumentation“

Die Qualität einer Dokumentation trägt in entscheidendem Maße zum Image eines Produkts bei. Selbst technisch ausgereifte Produkte stellen den Nutzer vor ein Problem, wenn sie mit unvollständiger, unverständlicher oder falsch übersetzter Dokumentation ausgeliefert werden. Bei mangelhafter technischer Dokumentation neigen die Nutzer zu der Annahme, dass die Qualität des Produkts ebenfalls zu wünschen übrig lässt. Auf diese Weise erhält das Produkt einen schlechten Ruf.

Gute technische Dokumentation ist also ein wichtiges Marketinginstrument, das niemals unterschätzt werden sollte. Daher sollen hier einige Punkte erläutert werden, welche die Qualität einer Dokumentation verbessern und den Kunden zufrieden stellen. Um zu erläutern, welche Anforderungen an eine gute Dokumentation gestellt werden, muss geklärt werden, was eine gute Dokumentation eigentlich ist. Dazu ein Zitat von Bernado Wagner:

14

„Eine gute Dokumentation beschreibt den aktuellen Programmzustand. Sie stimmt mit dem Quellcode überein, und sie ist übersichtlich und verständlich gestaltet. Dabei ist sie eher knapp, aber präzise. Eine gute Dokumentation hilft die benötigten Informationen schnell zu finden. Sie wiederholt den Quellcode nicht nur in einer anderen Form. Sie beschreibt Hintergründe, Zusammenhänge und Entscheidungen, die nicht unmittelbar aus dem Programmtext entnommen werden können.“ 8

Was für mich aus diesem Zitat besonders hervor sticht, ist die Forderung, dass die Dokumentation übersichtlich, verständlich, knapp und präzise sein soll. Dies lässt sich unter dem Begriff der Lesbarkeit zusammenfassen. Texte lassen sich in unterschiedliche Schwierigkeitsstufen einteilen. 9

• Leicht lesbare Texte wie etwa Unterhaltungslektüre und einfache Zeitungsartikel.

• Normal lesbare Texte beinhalten lange Zeitungsartikel und Sachbücher.

• Texte bei denen sorgfältiges Lesen angebracht ist, da sie neue Informationen für den

Leser beinhalten.

• Und zuletzt schwer lesbare Texte, die eine Menge von Daten enthalten oder in einer

fremden Sprache verfasst sind. Zu diesen Texten zählen auch technische Dokumentationen.

Die Lesbarkeit eines Textes bezieht sich darauf, wie schnell der Leser den Text erfassen und sich verständlich machen kann. Da technische Dokumentationen als schwer lesbare Texte eingestuft werden, ist die Verständlichkeit der inhaltlichen Aussagen hier von besonderer Bedeutung. Diese lässt sich mit einigen Mitteln, die Peter Rechenberg als Klarheit, Kürze und Klang ¹⁰ bezeichnet, deutlich steigern.

2.5.2.1 Klarheit

Damit der Leser der Dokumentation die darin enthaltenden Aussagen versteht und richtig interpretiert, müssen die Sätze klar und eindeutig formuliert werden. Die muss dazu Sprachlogik unbedingt eingehalten werden. Gerade bei langen Sätzen mit vielen Kommata schleichen sich Fehler ein, die den Sinn der Aussage verfälschen. Weiterhin dürfen Wörter, bei denen es auf deren spezifische Bedeutung ankommt, nicht durch andere Wörter ersetzt werden, da der Leser ansonsten davon ausgehen könnte, dass

⁸ Vgl. [BW92], S. 152

⁹ Vgl. [HJF96], S. 29

¹⁰ Vgl. [PR03], S. 15ff

15

verschiedene Dinge gemeint sind. Dagegen sollte es bei Allerweltswörtern natürlich vermieden werden, immer wieder den gleichen Ausdruck zu verwenden, um Abwechselung in den Text zu bringen. Begriffe, von denen zu erwarten ist, dass sie dem Wissensstand der angesprochenen Zielgruppe fremd sind, müssen sorgfältig erklärt werden und sollten zum nachschlagen zusätzlich in einem Glossar aufgelistet werden.

2.5.2.2 Kürze

Sätze müssen kurz gehalten werden, um die darin enthaltende Aussage einfach zu vermitteln. Gerade jedoch die deutsche Literatur ermöglicht eine starke Schachtelung in Haupt- und Nebensätze. Jeder Teil stellt einen Gedanken des Autors dar. Zu viele Gedanken in einen Satz gezwängt strapaziert das Auffassungsvermögen des Lesers. Dies zwingt zum mehrfachen Lesen des Satzes und beeinträchtigt somit die Lesbarkeit der Dokumentation. Einzelne Gedanken sollten, insofern sie nicht in unmittelbaren Zusammenhang stehen, auf mehrere Sätze aufgeteilt werden.

Weiterhin soll sich eine Dokumentation auf das Wesentliche, nämlich die Vermittlung von Handlungsweisen beschränken. Die Sätze müssen von unnötigem Ballast, also von nichts sagenden und selbstverständlichen Wörter und Satzteile befreit werden. Sich kurz zu halten ist eine Kunst die als Qualitätsmerkmal von Dokumentationen gilt. 11

2.5.2.3 Klang

Der Klang eines Textes passt auf den ersten Blick nicht in die Liste der Anforderungen an eine gute Dokumentation. Damit jedoch eine Dokumentation vom Leser akzeptiert wird und zum Weiterlesen motiviert, muss sie sich auch angenehm lesen lassen. Sachlichkeit in der Dokumentation ist notwendig, sie darf den Text jedoch nicht zäh und unleserlich machen. Schließlich soll nicht nur Wissen weitergegeben werden, sondern die Argumente auch überzeugend vermittelt werden. ¹² Die Verbesserung des Klangs führt außerdem oft zu Verkürzungen und Klarheit des Textes.

2.5.2.4 Schrift

Die Lesbarkeit der Texte ist wichtige Vorraussetzung für das schnelle und effiziente Lesen und für das Verstehen der gedruckten Wortzeichen. Ein weiterer wichtiger Punkt der dazu beiträgt ist die Gestaltung des Textes. Darunter zählen der Schrifttyp, der Schriftschnitt, die

¹¹ Vgl. [PR03], S. 49

¹² Vgl. [SB94], S. 45

16

Schriftgröße und die Farbe des Textes. ¹³ Diese müssen so gestaltet werden, dass der Leser den Text mühelos erkennen kann. Um die Lesbarkeit zu erhalten, sollte der Schriftgrad in Texten nicht kleiner als 2mm (Schriftgröße 10) sein und der Zeilenabstand das 1,2 fache der Schriftgröße betragen. Als Schriftart wird „Times New Roman“ bzw. „Arial“ empfohlen. 14

2.5.2.5 Strukturierung

Weiterhin wird gefordert, dass Informationen in Dokumentation schnell und einfach gefunden werden sollen. Dies wird mit Hilfe einer guten Strukturierung des Textes erreicht. Die Strukturierung soll die Handlungsorientierung der Dokumentation unterstützen. Am Anfang soll mit allgemeinen Grundtätigkeiten begonnen werden, die dann immer weiter differenziert werden.

Werden Handlungsanweisungen gegeben, so muss darauf geachtet werden, dass innerhalb der einzelnen Gliederungspunkte nicht zu viele Informationseinheiten enthalten sind. Dies würde andernfalls das Auffassungsvermögen des Lesers strapazieren. Es wird empfohlen nicht mehr als vier bis fünf Bedeutungseinheiten (so genannte Chunks) zu einer nächst größeren Einheit zusammenzufassen. ¹⁵ Dies stellt ein gutes Maß dar, um in Gebrauchsanleitungen das gleichzeitige Bedienen und Lesen zu ermöglichen.

2.6 Normen und Richtlinien 2.6.1 Grundlagen

Normen sind technische Beschreibungen oder andere Dokumente die Handlungsweisen im Bereich der Industrie empfehlen. Sie besitzen keinen rechtsbindenden Charakter, da sie nicht von Institutionen des öffentlichen Rechts erlassen werden, sondern in Einvernehmen aller interessierten Kreise. Jedoch können sie Gegenstand eines Vertrages werden und auf diesem Weg für den Auftragnehmer verbindlich werden.

Normen dienen der Vereinheitlichung von Produkten und Dienstleistungen. Durch sie wird die Verwendbarkeit von Erzeugnissen und jeglicher Art von Dokumentationen erhöht. Sie schränken die vielfältigen Möglichkeiten der Produkterstellung ein und bilden somit die Grundlage für die Kompatibilität und Austauschbarkeit. ¹⁶ Für die Durchführung der Normarbeit ist das Deutsche Institut für Normung (DIN) zuständig.

¹³ Vgl. [AK81], S. 114

¹⁴ Vgl. [SK01], S. 2

¹⁵ Vgl. [HJF96], S. 32

¹⁶ Vgl. [AWL99], S. 2425

17

2.6.2 Normen für Dokumentationen

Normen sind, wie oben bereits angemerkt, nicht rechtsverbindlich. Man entgeht mit dem peniblen Einhalten von Normungsvorschriften in der Dokumentation also auch nicht der Verantwortung für die Folgen von Produktfehlern.

Beispiel: ¹⁷ Der Hersteller eines Gummiballs für Kleinkinder brachte auf der Verpackung den

Hinweise auf Fehler im Produkt schützen also nicht vor rechtlichen Konsequenzen. Andererseits repräsentieren Normen den aktuellen Stand des Wissens und setzen damit Mindeststandards, die von einem Produkthersteller nicht unterschritten werden sollten. ¹⁸ Gerade Hinweise die auf Gefahren im Umgang des Produktes hinweisen, dürfen nicht vernachlässigt werden. Darunter zählen nicht nur Gefahren für Leib und Leben sondern auch Risiken, die einen wirtschaftlichen Schaden hervorrufen können. Besonders im Bereich der Software sind erstere wohl kaum zu erwarten. Der wirtschaftliche Schaden kann dagegen beträchtlich sein, wenn ein System ausfällt oder Daten gelöscht werden, nur weil der falsche Knopf gedrückt wurde.

Es gibt eine ganze Reihe von Normen die den Bereich der Dokumentation betreffen. Sie lassen sich in drei Kategorien unterscheiden: 19

• A-Normen sind Grundnormen, die Begriffe und Gestaltungsgrundsätze klären.

• B-Normen sind Gruppennormen, die bestimmte Produktgruppen gleichermaßen

betreffen

• C-Normen sind Produktnormen, die sich auf einzelne Produkte beziehen

¹⁷ Vgl. [RFL04], S. 15

¹⁸ Vgl. [HHT02], S. 49

¹⁹ Vgl. [GG03], S. 16

18

In dieser Studienarbeit soll allgemein über die Erstellung von technischen Dokumentationen informiert werden. Eine Recherche nach den Normen für die Dokumentation eines speziellen Produktes muss von Fall zu Fall erfolgen. Ich beschränke mich daher auf die Normen der Klasse A, von denen die zwei wichtigsten im Folgenden vorgestellt werden.

2.6.2.1 DIN EN 62079

Die DIN EN 62079 ist eine europaweit gültige Norm über das Erstellen von Anleitungen und ist seit November 2001 in Kraft. Sie ist in den Sprachen deutsch, französisch und englisch erhältlich. Aufgrund ihrer Internationalität wird auf nationale Erfordernisse kaum eingegangen. Daher empfiehlt es sich darüber hinaus über die nationalen Gesetzen und Vorschriften zu informieren.

Mit der DIN EN 62079 wird eine Reihe von Forderungen und methodischen Regeln zum Erstellen von Anleitungen zusammengestellt und die Beschaffenheit von Anleitungen definiert. Sie beinhaltet die wichtigsten typographischen, strukturellen und sprachlichen Prinzipien der technischen Dokumentation. Damit soll erreicht werden, dass das Erstellen von Anleitungen vereinheitlicht wird. Dies führt zu einer besseren Verständlichkeit von technischen Dokumentationen und sorgt für einen internationalen Mindeststandard, der an technische Dokumentationen gestellt wird.

Diese Norm kann zudem als Instrument zur Qualitätssicherung in technischen Dokumentationen verwendet werden. ²⁰ Mit den im Anhang beiliegenden Checklisten können die technische Richtigkeit und die Darstellungsformen von Anleitungen überprüft und bewertet werden. Allerdings liegen nur die Bewertungskriterien einer Dokumentation vor. Wie gut die Dokumentation in den einzelnen Punkten abschneidet liegt immer in dem Ermessen des Lesers.

Alle Punkte, die bei der Erstellung einer Anleitung von Bedeutung sind, werden in der DIN EN 62079 aufgeführt. Allerdings bilden sie nur einen gewissen Rahmen und werden nicht ausführlich besprochen. Die Norm kann also nur einen Anhaltspunkt bieten, den technischen Redakteur ersetzen kann sie nicht. Folgende Punkte sind Teil des Inhaltes:

• Die Anleitung als Bestandteil des Produktes

• Die Anleitung als Bestandteil der Sicherheitskonzeption

• Allgemeine Überlegungen zum Wesen der Anleitung

• Sprache, Aktualität und Zielgruppe bei der Erstellung

²⁰ Vgl. [JF03]

19

• Elemente die eine Anleitung enthalten soll

• Kommunikationsprinzipien und Darstellungsaspekte des Textes und der Abbildungen

2.6.2.2 VDI 4500

Die VDI 4500 ist eine umfassende Richtlinie, welche Anforderungen an Dokumentationen aus der Sicht des Vereins der deutschen Ingenieure stellt. In Teilbereichen finden sich ähnliche Forderungen der DIN EN 62079 wieder. Dies ist aber ehr die Ausnahme und im Großen und Ganzen kann sie als Ergänzung und Erweiterung angesehen werden. Sie unterscheidet sich durch ihren ganzheitlichen Ansatz, der sowohl gesetzliche als auch normative Vorschriften bei der Erstellung von Dokumentationen berücksichtigt und die technische Dokumentation in die innerbetrieblichen Informationsflüsse und Marketing Aktivitäten mit einbezieht. 21

Die VDI 4500 strukturiert sich in drei große Teilbereiche, die als Blätter bezeichnet werden. Blatt 1 befasst sich vorwiegend mit dem Aufbau und der Erstellung von Benutzerinformationen und dies vorwiegend produktneutral. Es werden Grundsätze der Gestaltung, zielgruppenbezogene Aufbaukriterien, organisatorische Vorraussetzungen und betriebswirtschaftliche Aspekte behandelt. Dabei unterscheidet sich die Richtlinie von anderen Normen durch ihren ganzheitlichen Ansatz. Es werden sowohl normative Vorschriften als auch Aspekte des Marketing mit einbezogen.

Blatt 2 widmet sich der unternehmensinternen Dokumentation. Besonders intensiv werden die rechtlichen Anforderungen untersucht, um im Schadensfall rechtliche Untersuchungen zu bestehen und Schadensersatzansprüche auszuschließen. Dazu werden Forderungen an die unternehmensinterne technische Dokumentation aufgestellt, die Sorgfaltspflicht von natürlichen und juristischen Personen erläutert und die Pflichten aus dem Produktsicherheitsgesetz untersucht. Ein weiter Schwerpunkt liegt auf der Archivierung und Klassifizierung von Dokumenten im Produktlebenszyklus und wie dies betriebswirtschaftlich effizient umgesetzt werden kann.

Blatt 3 beschäftigt sich hauptsächlich mit der Standardisierung von Austauschformaten von Unternehmensdokumentationen und mit den Instrumenten zur Umsetzung. Weiterhin werden Schnittstellen zwischen Kunden, Lieferanten und Serviceorganisationen beschrieben, um den Informationsfluss im Ersatzteilwesen zu gewährleisten.

²¹ Vgl. [HHT02], S. 51

20

2.7 Notwendige Arbeitsschritte 2.7.1 Zielgruppenanalyse

Eine gute technische Dokumentation spricht die Nutzer in angemessener Weise an und berücksichtigt deren Anforderungen. Ohne eine detaillierte Zielgruppenanalyse kann und darf die Arbeit an der Dokumentation nicht aufgenommen werden. Im Rahmen dieser Analyse wird ermittelt, wer die Nutzer sind und welche Informationen sie benötigen, um ein Produkt ordnungsgemäß zu verwenden, ohne sich zu verletzen oder Schäden zu verursachen. Die Zielgruppenanalyse beschreibt: 22

• die Vorkenntnisse und Erfahrungen des Benutzers

• die Homogenität der Benutzergruppe bezüglich des Wissensstandes

• das typische Anwenderverhalten der Benutzer

• die Lerngewohnheiten

• das Tätigkeitsumfeld

• die Lesefähigkeit

• das Verständnis für Fachbegriffe

Zunächst findet nun eine Auswahl der Dokumentationsart zur groben Klassifizierung statt. Weiterhin lassen sich aus den gewonnenen Informationen Schlüsse über die Gestaltung, die Formulierungsweise und die Instruktionstiefe der Dokumentation ziehen. So lässt sich z.B. für eine Benutzerdokumentation sagen ob eine Kurzanleitung, Schritt-für-Schritt-Anleitung oder eine Anleitung mit Beispielen angebracht ist. Weiterhin ergibt die Bestimmung der Zielgruppe Forderungen nach der Anzahl und Art der Sicherheitshinweise, zur Verwendbarkeit von Fachbegriffen und zur Erscheinungsform der Dokumentation. In vielen Fällen ist der betrachtete Personenkreis so differenziert, dass er sich nicht einer einzelnen Zielgruppe zuordnen lässt. In diesem Fall ist für jede Benutzergruppe eine eigene Zielgruppenanalyse auszuarbeiten und jeweils eine eigene Dokumentation anzufertigen. Folgende Zielgruppen lassen sich nach ihrem Tätigkeitsfeld unterscheiden: 23

• Unternehmensleitung

• Entwickler

²² Vgl. [HHT02], S. 148

²³ Vgl. [HS85], S. 21f

21

• Installateure

• Wartungstechniker

• Betreiber

• Händler und Verkäufer

• Benutzer

Aus dieser Einteilung heraus werden die inhaltlichen Aspekte der Dokumentation bestimmt. So wird die Unternehmensleitung wohl nicht an technischen Details des Produktes interessiert sein, sondern ehr Informationen über die einzelnen Projektphasen verlangen. Die Benutzer sind dagegen an einer umfassenden Funktionsbeschreibung interessiert und wollen erfahren, wie sie diese Funktionen nutzen können. Ist die Zielgruppe in ausreichenden Maße beschrieben kann damit begonnen werden die Informationen für die Dokumentation zu beschaffen.

2.7.2 Informationsbeschaffung

Die meisten Informationen für die Dokumentation sind in dem Unternehmen bereits vorhanden. Die wichtigste Informationsquelle stellen dabei die Entwickler des Produktes dar. Sie besitzen Informationen, die als Grundlage für alle vier Dokumentationsarten verwendet werden. Dies beinhaltet Funktionsbeschreibungen des Produktes (Benutzerdokumentation), Daten über die einzelnen Entwicklungsphasen (Projektdokumentation), technische Spezifikationen (Entwicklungsdokumentation und Produktdokumentation) und vieles mehr. Allerdings sind alle diese Informationen für die Zwecke der Entwickler erstellt worden und müssen für die Zwecke der Zielgruppe umgeschrieben und aufbereitet werden. Dies ist, so lange es sich nicht um eine Entwicklungsdokumentation handelt, die Aufgabe des technischen Redakteurs. Dieser hat zwar in der Regel ein ausgeprägtes technisches Verständnis, besitzt aber nicht immer das nötige Wissen um alle Entwicklungsinformationen zu verstehen. Weiterhin stehen nicht alle benötigten Informationen zur Verfügung. Daher sollte der Basis dieser Daten weitere gezielte Gespräche mit den Konstrukteuren geführt werden, um die letzte Möglichkeit eines Missverständnisses auszuschließen. ²⁴ Von großem Vorteil sind in diesem Zusammenhang Kenntnisse über die Gesprächsführung und den Aufbau eines Interviews.

Für eine Benutzerdokumentation ist es weiterhin sinnvoll, dass der technische Redakteur das Produkt selbst ausprobiert. Er schlüpft dabei in die Rolle des Anwenders und lernt das

²⁴ Vgl. [HS90], S. 50ff

22

Produkt aus dessen Augen zu beobachten und zu beurteilen. ²⁵ Diese Erfahrungen helfen das Produkt anwendungsnah zu beurteilen und zu beschreiben. Weitere Quellen für die Dokumentation können zudem eventuell bereits bestehende Dokumentationen sein. Teilweise decken sich Inhalte aus Dokumentationen für unterschiedliche Zielgruppen bzw. aus unterschiedlichen Dokumentationsarten. Diese müssen dann für die neu zu erstellende Dokumentation nur noch einmal aufbereitet werden.

2.7.3 Medienauswahl

Eine weitere Frage, die sich bei der Erstellung von Dokumentation stellt, ist die, auf welche Weise die Informationen festzuhalten sind. Dabei besteht die Wahl zwischen der traditionellen gedruckten Dokumentation und der Dokumentation auf elektronischen Datenträgern. Das wichtigste Kriterium ist die Aufbewahrungszeit. Die Dokumentation muss so lange aufbewahrt werden, wie sich das Produkt in Nutzung befindet. Die Nutzungszeit kann je nach Produkt- und den oben beschriebenen Dokumentationsarten zwischen einigen Tagen und mehreren Jahren liegen.

2.7.3.1 Gedruckte Dokumentation

Die überwiegende Zahl der Produkte, die im Handel erhältlich sind, wird mit einer Dokumentation auf Papier ausgeliefert. Das Format erstreckt sich vom Einzelblatt über die mehrseitige Broschüre bis zum gebundenen Buch. Welche Art zum Einsatz kommt, entscheiden unter anderem folgende Faktoren: 26

• Umfang der zu beschreibenden Materie

• Komplexität des Produktes

• Einsatzgebiet der Dokumentation

• Vorhandene finanzielle Mittel

• Gesetzliche Anforderungen

• Erwartungen des Benutzers

Die gedruckte Papierdokumentation ist der Regelfall und wird es in den meisten Bereichen auch noch längere Zeit bleiben. Bei längeren Aufbewahrungszeiten hat sie sowohl Vor- als auch Nachteile. Ein Vorteil ist, dass die technologische Weiterentwicklung keinen Einfluss

²⁵ Vgl. [HJF96], S. 43

²⁶ Vgl. [HHT02], S. 59

23

auf die Haltbarkeit hat. Ein Computer ist zum Lesen nicht notwendig. Nachteilig ist, dass das Papier Schaden nehmen kann und unleserlich wird. Zudem wird Platz beansprucht und häufig landet die Dokumentation im Müll oder geht verloren.

2.7.3.2 Elektronische Dokumentation

In allen Produktbereichen, die mit Computertechnik zu tun haben, wird vermehrt der PC als Medium für die Produktinformationen genutzt. Gedruckte Dokumentationen sind teilweise nur noch als Grundlagendokumentation oder gar nicht mehr beigelegt. ²⁷ Die elektronische Dokumentation hat den Vorteil, dass sie Platz sparend ist und im Bereich der Softwaredokumentationen während der Verwendung des Produktes sofort verfügbar ist. Suchwörter können schnell nachgeschlagen werden und der Medienbruch zwischen Software und Dokumentation wird beseitigt.

Weiterhin ist die elektronische Dokumentation leicht zu vervielfältigen und lässt sich schnell auf den aktuellen Stand bringen. Besonders im Softwarebereich in dem das Produkt laufenden Änderungen unterworfen ist, ist eine schnelle und kostengünstige Verbreitung der aktualisierten Dokumentation unverzichtbar. Die neue Version lässt sich dann bequem aus dem Internet von der Webseite des Herstellers herunterladen. Dabei ist jedoch zu beachten, dass in den meisten Fällen, abgesehen vom Softwarebereich, die elektronische Dokumentation äußerst ungeeignet ist. Besonders wenn es um Bedienungsanleitungen von Geräten geht ist meist kein Computer verfügbar.

Bei Benutzerdokumentationen für Software lassen sich verschiedene Arten der Bereitstellung unterscheiden. Zum einen als bloße elektronische Form der Papierdokumentation, wie sie auch bei anderen Dokumentationsarten einsetzbar ist. Zum anderen als Onlinedokumentation um schneller auf die Informationen zugreifen zu können. Sie tritt in verschiedenen Erscheinungsformen auf. 28

• Hypertext Hilfe

• Hilfeassistent

• Direkthilfe

²⁷ Vgl. [HHT02], S. 59

²⁸ Vgl. [HHT02], S. 72ff

24

Abbildung 1 Hypertexthilfe

Wie in Abbildung 1 zu sehen ist kann auf die Inhalte der Hypertexthilfe über ein Inhaltsverzeichnis, einen Index oder die Eingabe eines Suchbegriffes zugegriffen werden. Durch Hypertext-Verlinkung kann der Benutzer schnell zu den weiteren Themen wechseln, die zusätzlich in dem Hilfetext zu dem gerade ausgewählten Hilfethema enthalten sind. So kann schnell auf weiterführende Informationen zugegriffen werden. Wichtig bei solchen Hypertext-Hilfesystemen ist, dass dem Benutzer ausreichend Möglichkeiten zur Verfügung gestellt werden, um auf den Ausgangspunkt seiner Recherche zurückzukehren. Er läuft ansonsten Gefahr, sich zwischen all den Verlinkungen zu verlieren und die gesuchten Informationen nicht präzise anzeigen zu können.

Eine Möglichkeit, um den Benutzer bei seiner Arbeit mit der Software direkt zu unterstützen, bietet der aus Microsoft Anwendungen wohl bekannte Hilfeassistent. Diese Art der Online-Hilfe versucht an Hand des Verhalten des Benutzers Probleme zu erkennen und bietet ihm Vorschläge zur Lösung des Problems. Außerdem lassen sich auch beliebige Suchthemen eingeben, zu denen die passendsten Hilfetexte angeboten werden. Für Anfänger, die nur sehr wenig Erfahrung im Umgang mit dem Programm besitzen, kann diese Form der Hilfe sehr nützlich sein. Professionelle Benutzer fühlen sich dagegen ehr genervt. Die Direkthilfe soll die Funktionalitäten eines Programms näher erläutern, in dem kleine Hilfetexte zu den einzelnen Optionen angezeigt werden. Genau so wie der Hilfeassistent richtet sich die Direkthilfe an unerfahrene Benutzer und bietet eine gute Möglichkeit sich mit dem Programm vertraut zu machen.

25

3 Dokumentation des BA-Managers

3.1 Was ist der BA-Manager

In der Berufsakademie (im Folgenden BA genannt) Gera wird eine Software mit dem Namen BA-Manager eingesetzt, welche zur Verwaltung aller relevanten Daten dient, die zum Betrieb einer Berufsakademie notwendig sind. Es werden Daten über Studenten, Mitarbeiter, Firmen und den Unterricht gespeichert und den Mitarbeitern der BA für ihre tägliche Arbeit zur Verfügung gestellt.

Die Basis des BA-Managers wurde im Rahmen von Studienarbeiten angehender Wirtschaftsinformatiker an der Berufsakademie Glauchau entwickelt. Ziel dabei war es eine einheitliche Grundlage für die Verwaltungsmitarbeiter zu entwickeln, die

bereichsübergreifend genutzt werden kann. ²⁹ Studenten der BA Gera haben weitere Komponenten hinzugefügt und das Datenmodell ergänzt. So wurden unter anderem eine Unterrichtsplanungskomponente und ein elektronisches Notenauskunftssystem entwickelt und integriert. Weitere Ergänzungen sind zur Zeit nicht geplant.

3.2 Konzept de BA-Managers

Der BA-Manager besteht aus einer Datenbank auf Basis eines Microsoft SQL Servers. Die Datenbank ist über eine ODBC (Open Database Connectivity) Verbindung mit einem Benutzer Front End verbunden, über das die Daten von dem User eingegeben und abgerufen werden können. Dieses Front End besteht aus einer Reihe von Funktionen und Sichten auf Basis von Microsoft Access. Diese müssen auf jedem Client installiert werden. Das Front End stellt einen benutzerfreundlichen Ersatz für die Datenbanksprache SQL dar. Der User kann die Daten erstellen und abrufen ohne jegliche Kenntnisse von SQL haben zu müssen. Die graphische Oberfläche lässt sich intuitiv bedienen und ermöglicht so auch ungeübten Mitarbeitern die Arbeit mit dem System.

Es werden alle Datenmanipulationsfunktionen wie Eingabe, Änderung und Löschung von Daten, sowie die Formulierung von Anfragen unterstützt. Nicht unterstützt wird die Datendefinition. Das Ändern, Löschen und Erstellen von Tabellen und Datenbanken ist nach wie vor nur über die Direkteingabe von SQL Befehlen auf dem Server möglich und damit dem Datenbankadministrator vorbehalten.

²⁹ Vgl. [RE99], S. 2

26

3.3 Datenschutz

In dem BA-Manager werden zum Teil sehr sensible Daten gespeichert, die nur den Mitarbeitern zur Verfügung stehen sollen, welche die Daten für ihre tägliche Arbeit benötigen. Darunter fallen z.B. die Noten der Studenten. Kein Student würde es gerne sehen, wenn seine Notenübersicht frei zugänglich wäre und sich jeder Dozent darüber informieren könnte wie der Student denn in anderen Fächern abgeschnitten hat. Die oben beschriebene Architektur des BA-Managers eignet sich hervorragend den Datenschutz zu implementieren. Wie schon beschrieben muss auf jedem Client das Microsoft Access Front End implementiert werden. Dieses besteht aus einer Reihe von Sichten, welche die Daten aus dem BA-Manager anzeigen. Da dies für jeden Client individuell gemacht wird und jedem Mitarbeiter sein eigener PC zur Verfügung steht, bietet sich nun die Möglichkeit die Sichten an die jeweiligen Rechte der User anzupassen und nur die Daten anzuzeigen, die für ihn bestimmt sind. Diese zum Datenschutz verwendeten Sichten werden als personenbezogene Sichten bezeichnet und für folgende Tabellen implementiert:

•

Ausbildungsplätze

•

Basis_Stundenprotokoll

•

Absender

•

Firmen

•

Kommissionen

•

Noten

•

Personen

•

Seminargruppen

•

Studenten

•

Studieninfos

Weiterhin gibt es eine Reihe von x-Views, die für jede Seminargruppe (Studienrichtungen unterteilt nach Jahrgang) einzeln existieren und die Studenten der jeweiligen Seminargruppe auflisten. Auf dem Client werden nur die x-Views installiert, auf dessen Daten der Mitarbeiter zugreifen darf. In den anderen personenbezogenen Sichten wird eine interne Abfrage durchgeführt, die dafür sorgt, dass die richtigen Daten angezeigt werden. Mit der Eingrenzung der Daten wird nicht nur der Schutz der Daten gewährleistet, sondern es findet auch eine Entlastung der Mitarbeiter statt. Sie sehen nur jene Daten, mit denen sie

27

auch arbeiten und müssen sich nicht darum kümmern nach den Daten zu suchen. So behält der Mitarbeiter den Überblick und Arbeitszeit wird gespart.

3.4 Dokumentationsinhalte

Von der Berufsakademie wurden zwei wesentliche Punkte für die Dokumentation gefordert. Die Dokumentation des BA-Managers soll erstens die Grundlage für zukünftige Weiterentwicklungen an dem System darstellen. Mit der Studienarbeit „Dokumentation der SQL-Datenbank BA-Manager für die Berufsakademie in Glauchau“ von Recarda Eidam wurde 1999 bereits ein Datenmodell erstellt. In der Zeit von 1999 bis heute sind jedoch eine Reihe von Änderungen an dem BA-Manager vorgenommen worden, so dass diese Dokumentation nicht mehr auf dem neuesten Stand ist und aktualisiert werden muss. Ergänzt wird dieses Datenmodell durch eine Auflistung aller Tabellen der Datenbank und einer Beschreibung der einzelnen Attribute. Mit diesen Informationen soll es zukünftigen BA Studenten ermöglicht werden sich schnell und ohne fremde Hilfe in das Datenmodell einzuarbeiten.

Zweitens wurde eine Installationsanleitung gefordert, welche die einzelnen Schritte der Installation des BA-Managers auf dem Server und auf dem Client erläutert.

3.4.1 Datenmodell

Eine Darstellung eines Datenmodells ist notwendig, um dem Programmierer eine Gesamtübersicht der Datenbank zu bieten, in der die Beziehungen zwischen den einzelnen Tabellen aufgezeigt werden. So kann der Programmierer die Funktionalitäten der Datenbank erkennen und behält den Überblick über das System.

Wie bereits unter dem Gliederungspunkt „Anforderungen an die Dokumentation“ erläutert, wird vor allem Vollständigkeit und Aktualität der Dokumente gefordert. Diese Forderungen werden aufgrund der bereits erwähnten Änderungen an der Datenbank in der Dokumentation von Recarda Eidam nicht mehr erfüllt, so dass ein neues Datenmodell (siehe Anhang A) entwickelt wurde. Das Datenmodell wurde unter Verwendung der Software Microsoft Visio erstellt. Visio bietet die Möglichkeit Datenbank zu analysieren und die Tabellen und deren Attribute automatisch zu erkennen und darzustellen. So können weitere Änderungen an der Datenbank automatisch in das Datenmodell eingepflegt werden. Ein aufwendiger manueller Vergleich der Tabellen und Attribute des Datenmodells mit dem Ist-Zustand wird damit vermieden.

28

Visio ist zudem ein weit verbreitetes Produkt und wird aufgrund der komfortablen Bedienung und übersichtlichen Darstellung sehr häufig zur Visualisierung von Datenmodellen

eingesetzt. Somit wird durch die Verwendung von Visio die in der VDI Norm 4500 Blatt 3 besonders betonte Forderung nach Standardisierung von Dokumentationen erfüllt. Datenmodelle werden üblicher Weise unter Verwendung des Entity Relationship Diagramm (ERD) dargestellt. In dieser Dokumentation wurde eine vereinfachte Form des ERD verwendet, welche die Datenbank aus der objektorientierten Sicht veranschaulicht. Es werden alle Objekte dargestellt, die auch in der Datenbank vorhanden sind. Neben den Tabellen werden daher auch die Sichten mit abgebildet. Diese sind zur Kennzeichnung in dem Datenmodell grau hinterlegt. Die Attribute werden tabellarisch aufgezählt, was angesichts der hohen Anzahl von Attributen wesentlich zur Übersichtlichkeit des Datenmodells beiträgt.

Die Kardinalitäten der Tabellen werden unter der Verwendung von verschiedenen Pfeilarten dargestellt.

Einige Tabellen lassen sich in das Datenmodell nicht integrieren und stehen für sich alleine. Die Tabelle PLZB9803_2 ist eine Auflistung von achtstelligen Schlüsseldaten des Landesamtes für Statistik, welche zur eindeutigen Identifizierung der Orte und Gemeinden dient. Die Tabelle Schl3ort enthält ebenfalls Daten des Landesamtes für Statistik. Dieser Schlüssel ist fünfstellig und dient zur Identifizierung der Landkreise. Die Tabelle Login enthält die Logindaten der Mitarbeiter zu dem System. Die Tabelle Keys ist eine Auflistung aller Stammdaten-Tabellen, deren Inhalte mit dem Administratortool BA-Manager-Admin geändert werden können. Sie dient alleine dazu diese Tabellen zu dokumentieren.

3.4.2 Attributliste

Für die Entwicklungsarbeit des Programmierers ist es sinnvoll eine alphabetische Übersicht über alle Tabellen, deren Attribute und die Eigenschaften der Attribute einer Datenbank zur Verfügung zu haben, wie sie in Anhang B beigefügt wurde. Der Zweck vieler Attribute ist nicht selbsterklärend, so dass eine Beschreibung der Funktion notwendig ist. Weiterhin muss der Programmierer den Datentyp kennen und wissen ob die Eingabe beim Anlegen eines

29

Datensatzes erforderlich ist. Die Attributliste der Dokumentation von Recarda Eidam ist aufgrund der bereits erwähnten Änderungen an der Datenbank unvollständig und musste daher aktualisiert werden.

Durch die tabellarische Auflistung und der Wahl des Excel Formates werden die beiden Forderungen der DIN EN 62079 nach Übersichtlichkeit und Austauschbarkeit erfüllt. Neben den Tabellen der Datenbank wurden in der Attributliste auch die internen Sichten (nicht zu verwechseln mit den personengebundenen Sichten) der Datenbank erfasst. Diese Sichten werden auf dem SQL Server ausgeführt und entlasten das Microsoft Access Front End. Der SQL Server kann die Abfragen wesentlich performanter verarbeiten und steigert somit die Antwortzeiten des Systems. Diese Sichten sind in der Attributliste durch graue Hinterlegung gekennzeichnet.

3.4.3 Installationsanleitung

Die Installationsanleitung teilt sich in zwei Abschnitte.

Erstens die Installation des BA-Managers auf dem Datenbankserver. Voraussetzung dazu ist, dass der Microsoft SQL Server ab Version 7.0 installiert ist, auf dem die Datenbank erstellt wird. Ein SQL Skript, welches dem BA-Manager beiliegt, erstellt die Tabellen und Sichten auf dem Server. Die Schlüsseldaten werden aus einer Accessdatenbank importiert. In dem zweiten Teil wird die Installation auf dem Client beschrieben. Diese muss für jeden Computer, der auf die Datenbank zugreifen soll, wiederholt werden. Der BA-Manager wird in Form eines Access Front End eingerichtet, in dem die Sichten an die Rechte der Mitarbeiter angepasst sind, um den Datenschutz zu gewährleisten.

Bei der Erstellung der Installationsanleitung wurden die im theoretischen Teil erarbeiteten Anforderungen mit berücksichtigt. Die Anleitung wurde in Form einer Schritt für Schritt Anweisung realisiert. Um dem Anwender zu ermöglichen die Anweisung gleich umzusetzen, wurden nicht mehr als 5 Chucks in einem Absatz zusammengefasst. Die Sätze sind so kurz wie möglich gehalten worden und zur Verbesserung der Verständlichkeit wurden Screenshots mit integriert. Als Medium der Dokumentation wurde das relativ zukunftssichere und weit verbreitete PDF Format gewählt.

30

4 Fazit

Die Erstellung einer Dokumentation zu einem Produkt ist unverzichtbar, um eine angemessene Akzeptanz der Käufer zu erreichen. Durch die immer mehr zunehmende Standardisierung und Vergleichbarkeit der Produkte kann eine gute Dokumentation die Kaufentscheidung stark beeinflussen.

Bevor mit der Dokumentation begonnen werden kann muss sich der technische Redakteur über das Ziel und den Zweck im Klaren sein. Stehen diese fest kann die Dokumentationsart ausgewählt werden. Um den Anwender zufrieden zu stellen müssen eine Reihe von Anforderungen berücksichtigt werden. Dabei ist eine Zielgruppenanalyse unverzichtbar, um den Anwender in angemessener Weise anzusprechen und den Inhalt der Dokumentation festzulegen. Bei einer sehr weit gefassten Zielgruppe muss so stark detailliert werden, dass jeder die Anweisungen nachvollziehen kann. Geübteren Anwendern muss durch eine entsprechende Strukturierung die Möglichkeit gegeben werden stark detaillierte Inhalte zu überspringen. Um die Dokumentation den aktuellen Anforderungen entsprechend zu gestalten und zu standardisieren müssen die entsprechenden Normen recherchiert werden. Dies hilft zudem die Dokumentation rechtssicher zu gestalten und

Schadensersatzforderungen zu entgehen.

Bei der Erstellung der Dokumentation war es schwierig sich als außenstehende Person in das System einzuarbeiten und alle gewünschten Aspekte zu berücksichtigen. Die erforderlichen Informationen wurden durch ein Interview mit dem Systemadministrator und durch eigene Arbeit an dem System ermittelt. Dabei ließ sich der BA-Manager selbst relativ intuitiv bedienen. Einige Funktionen bzw. die Bedeutung von Dateninhalten waren jedoch unklar und konnten nur durch entsprechenden Zeitaufwand herausgefunden werden. Um die Dokumentation zu vervollständigen wäre es daher angebracht in einem nächsten Schritt ein Benutzerhandbuch zu erstellen, welches diese Funktionen naher erläutert. Dadurch könnten neue Mitarbeiter mit dem System vertraut gemacht werden und sich die Einarbeitungszeit ließe sich verkürzen.

31

Literaturverzeichnis

[AK81] A. Krautmann. Zur Analyse von Verständlichkeitsproblemen bei der Gestaltung von Gebrauchsanleitungen. Copy Star Verlag, Köln, 1981 [AWL99] U. Arentzen, E. Winter, U. Lörcher. Gabler Wirtschaftslexikon. 13. Auflage. Gabler Verlag, Wiesbaden, 1999 [BJ95] B. Jenny. Projektmanagement in der Wirtschaftsinformatik. VDF Verlag, Zürich, 1995 [BW92] B. Wagner. Reverse Engineering. Expert Verlag, Ehningen bei Böblingen, 1992 [DIN 61082] Deutsche Elektronische Kommission im DIN und VDE. DIN EN 61082-1 -Dokumente der Elektrotechnik. Beuth Verlag, 1995 [DJ02] D. Juhl. Technische Dokumentation - Praktische Anleitung und Beispiele. Springer Verlag, Berlin Heidelberg, 2002 [GG03] G. Gindi. Normen zu Norma - Wandel von Risiken zu Chancen und Gewinn

[HHT02] B. Hölscher, U. Thiele, W. Hoffmann. Handbuch für technische Autoren und Redakteure. VDE Verlag, München Alzenau, 2002 [HJF96] H. J. Friske. Technische Dokumentation - Grundlage zum Verfassen von Anleitungstexten. LIT Verlag, Münster, 1996 [HS85] H. J. Scheibl. Wie dokumentiere ich ein DV-Projekt. Expert Verlag, Sindelfingen, 1985 [HS90] W. Hoffmann, W. Schlummer. Erfolgreich beschreiben - Praxis des

[JF03] J. Fischer. DIN EN 62079 - Instrument der Qualitätssicherung. [Stand: 2003. Zugriff: 09.03.2005, 14:22 Uhr MESZ] [MG99] M. Glinz. Softwareengineering I. [PR03] P. Rechenberg. Technisches Schreiben - (nicht nur) für Informatiker. Hanser Verlag, München Wien, 2003 [RE99] R. Eidam. Dokumentation der SQL-Datenbank „BA-Manager“ für die

[RFL04] A. Roy, A. Fisk, A. Langhans. Nutzbare und sichere Gebrauchsanleitungen für Verbrauchsgüter - Eine Leitlinie. TC Europe Secure Doc Verlag, 2004 [SB94] S. Ballstaedt. Lerntexte und Teilnehmerunterlagen. 2. Auflage. Beltz Verlag, Weinheim und Basel, 1994 [SK01] S. Knal. Erstellung eines Konzeptes zur effektiven Pflege von

Anhangverzeichnis

Anhang A Datenmodell des BA-Managers Anhang B Attributliste Anhang C Installationsanleitung

34

Ehrenwörtliche Erklärung

„Ich erkläre hiermit ehrenwörtlich“,

1. dass ich meine Studienarbeit mit dem Thema

„Erstellung einer technischen Dokumentation zur BA-Verwaltungslösung BA-Manager“ ohne fremde Hilfe angefertigt habe,

2. dass ich die Übernahme wörtlicher Zitate aus der Literatur sowie die Verwendung der Gedanken anderer Autoren an den entsprechenden Stellen innerhalb der Arbeit gekennzeichnet habe und

3. dass ich meine Studienarbeit bei keiner anderen Prüfung vorgelegt habe.

Ich bin mir bewusst, dass eine falsche Erklärung rechtliche Folgen haben muss.

.......................................... ............................................ Ort, Datum Unterschrift

35