Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 2 - Abstract

Die Anforderungen an Benutzer-Dokumentationen für betriebswirtschaftliche Anwenderprogramme sind sehr vielfältig, kommen aus den verschiedensten Bereich und sind oft interdependent. Ziel dieser Diplomarbeit ist es, diese verschiedenen Anforderungen vor zu stellen und zwar in einer möglichst strukturierten, allgemeingültigen und übersichtlichen Form.

Dazu habe ich zunächst die wichtigsten Anforderungen gesammelt und einzelnen Themenbereichen zugeordnet. Denn neben einer einfachen Auflistung dieser An-forderungen soll hier auch das dazu notwendige jeweilige Hintergrundwissen grob vermittelt werden, um die Wichtigkeit und Umsetzbarkeit dieser Anforderungen in der Praxis besser einschätzen und bewerten zu können. Aufbauend auf diesen Anforderungen werden verschiedene Möglichkeiten vorgestellt, wie man Benutzer-Dokumentation im weitesten Sinne in der Praxis realisieren kann und was man bei der Einführung eines neuen betriebswirtschaftlichen Anwenderprogramms und dessen Benutzer-Dokumentation alles beachten sollte. Darüber hinaus gibt diese Diplomarbeit einen Überblick über einige Methoden, Benutzer-Dokumentationen in der Praxis prüfen und hinsichtlich ihrer Qualität beurteilen zu können.

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 3 -

Inhaltsverzeichnis

Abstract   2

Abk  ürzungsverzeichnis.  6

Abbildungsverzeichnis   7

Tabellenverzeichnis   9

Vorwort   10

1.  Einführung.  13

1.1  WEGWEISER DURCH DIE DIPLOMARBEIT  14

1.2  BEGRIFFE UND ORGANISATIONSUMFELD DER  BENUTZER-DOKUMENTATION16

1.2.1  Grundlegende Begriffe, Definitionen und Abgrenzungen  17

1.2.1.1  Benutzer-Dokumentation  17

1.2.1.2  Betriebswirtschaftliche Anwenderprogramme  17

1.2.1.3  Anforderungen  18

1.2.2  Organisationsumfeld der Benutzer-Dokumentation.  20

1.2.2.1  Auftraggeber  20

1.2.2.2  Auftragnehmer  20

1.2.2.3  Normungsorganisationen  23

1.2.2.4  Benutzer und Verbraucherschutzverbände  24

1.2.2.5  Rechtsprechung.  25

1.3  CHECKLISTE FÜR DOKUMENTATIONSANFORDERUNGEN  27

2.  Welche Arten von Dokumentation gibt es?  28

2.1  PROJEKT-DOKUMENTATION  31

2.2  TECHNISCHE DOKUMENTATION.  32

2.2.1  Entwicklungs-Dokumentation  32

2.2.2  Programm-Dokumentation.  34

2.2.2.2  Benutzer-Dokumentation  36

2.2.2.3  Gegenüberstellung DV-Handbuch und Benutzer-Dokumentation  37

3.  Allgemeine Anforderungen an Benutzer-Dokumentationen  39

3.1.  AUFBAU EINER BENUTZER-DOKUMENTATION.  39

3.1.1  Äußere Gestaltung.  40

3.1.2  Gliederung.  41

3.1.3  Version.  45

3.1.4  Innere Gestaltung.  45

3.1.5  Terminologie  46

3.2  KONKRETE ANFORDERUNGEN.  46

4.  Anforderung der Normungsorganisationen.  48

4.1  ISO UND IEC.  50

4.2  IEEE  51

4.3  CEN UND CENELEC  53

4.4  DIN.  54

5.  Anforderung aus Recht und Rechtsprechung.  58

5.1  ALLGEMEINES  59

5.2  RECHTSRAHMEN.  60

5.3  HAFTUNG MIT VERSCHULDEN NACH BGB  61

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 4 -

5.4  HAFTUNG OHNE VERSCHULDEN NACH PRODHAFTG.  63

5.5  RECHTSPRECHUNG  65

5.6  RECHTSFOLGEN  66

6.  Anforderungen aus Kommunikations- und Motivationslehren.  68

6.1  DER KOMMUNIKATIONSPROZESS  69

6.2  STÖRFAKTOREN IM KOMMUNIKATIONSPROZESS  72

6.3  FOLGEN DER KOMMUNIKATIONSSTÖRUNGEN.  74

6.4  MÖGLICHKEITEN DER KOMMUNIKATIONSVERBESSERUNG  74

6.5  DIE VIER SEITEN EINER BOTSCHAFT.  76

6.6  DAS HAMBURGER VERSTÄNDLICHKEITSKONZEPT  78

6.7  DER MOTIVATIONSPROZESS  80

6.8  DER LERNPROZESS  86

6.9  DIDAKTISCHE ASPEKTE  93

7.  Anforderungen des Marketings  95

7.1  ZIELE UND AUFGABEN DES MARKETINGS.  96

7.2  MARKTFORSCHUNG  97

7.3  MARKETINGPOLITISCHE INSTRUMENTE  98

7.3.1  Produktpolitik.  99

7.3.2  Kontrahierungspolitik.  102

7.3.3  Distributionspolitik.  102

7.3.4  Kommunikationspolitik.  102

7.3.4.1  Werbung.  103

7.3.4.2  Verkaufsförderung und persönlicher Verkauf  104

7.3.4.3  Öffentlichkeitsarbeit  105

7.4  KRITISCHE UND PRAKTISCHE WÜRDIGUNG.  108

8.  Anforderungen aus Entwicklung und Technik  111

8.1  ANFORDERUNGEN DES TECHNISCHEN PRODUKTS.  112

8.2  ANFORDERUNGEN AN DIE TECHNISCHE UMSETZUNG  113

8.2.1  Content-Management-Systeme.  115

8.2.1.1  Grundlagen und Begriffe.  115

8.2.1.2  Anforderungen an Content Management Systeme.  117

8.2.2  XML.  120

8.2.3  Zusammenfassung und Ausblick  121

9.  Umsetzung in der Praxis.  122

9.1  VOR EINFÜHRUNG EINES NEUEN ANWENDERPROGRAMMS  123

9.2  MULTIMEDIALE BENUTZER-DOKUMENTATION UND -EINWEISUNG  126

9.2.1  Computergestützte Benutzer-Dokumentation.  126

9.2.2  Tutorial  130

9.2.3  Masken- und Dialoggestaltung  132

9.2.4  Hilfefunktion und Hilfetexte  136

9.2.5  Schulungsunterlagen und Kurzanleitung  136

9.3  SOFTWARE-ERGONOMIE  138

9.4  DIE EINFÜHRUNG EINES NEUEN ANWENDERPROGRAMMS.  139

9.5  NACH DER EINFÜHRUNG EINES NEUEN ANWENDERPROGRAMMS  141

10.  Test- und Beurteilungsmethoden für Dokumentationen  142

10.1  BEURTEILUNG NACH DER PENTAQUEST-METHODE  143

10.1.1  Wer? - Sender.  145

10.1.2  Wem? - Zielgruppe.  145

10.1.3  Warum? - Nutzenkategorien.  146

10.1.4  Was? - Notwendige Informationen  146

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 5 -

10.1.5  Wie? - Zielgruppengerecht  147

10.2  CHECKLISTE ZUR BEURTEILUNG VON ANWENDERHANDBÜCHERN.  147

10.3  PRÜFUNG VON DOKUMENTATIONEN DURCH DEN TÜV  147

10.4  PRÜFUNG DURCH WIRTSCHAFTSPRÜFER.  150

10.5  PRÜFUNG ANHAND DER DIN-NORM EN 62079.  151

10.6  PRAKTISCHE TESTS  152

11.  Fazit  153

Anhang A   156

Anhang B. 159   

Anhang C   165

Literaturverzeichnis   169

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 6 - Abkürzungsverzeichnis

ANSI American National Standards Institute AG Amtsgericht BGB Bürgerliches Gesetzbuch BGH Bundesgerichtshof CD-ROM Compact Disk - Read Only Memory CEN Comité Européen de Normalisation CENELEC Comité Européen de Normalisation Electrotechnique CI Corporate Identity CM Content Management CMS Content Management System CPU Central Processing Unit DIN Deutsches Institut für Normung e. V. DKE Deutsche Kommission für Elektrotechnik DV Datenverarbeitung EDV Elektronische Datenverarbeitung ERP Enterprise Ressource Planning etc. Et cetera (und so weiter) evtl. eventuell ggf. gegebenenfalls GoB Grundsätze ordnungsgemäßer Buchführung HGB Handelsgesetzbuch IEC International Electrotechnical Comission IEEE Institute of Electrical und Electronics Engineers ISO International Organization for Standardization LAN Local Area Network LG Landgericht OLG Oberlandesgericht PC Personal Computer ProdHaftG Produkthaftungsgesetz RAM Random Access Memory ROM Read Only Memory u. a. unter anderem z. B. zum Beispiel

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 7 -

Abbildungsverzeichnis   

Abbildung  1: Wegweiser durch die Diplomarbeit  

Abbildung  2: Übersicht der Anforderungen an Benutzerdokumentationen  

Abbildung  3: Schnittstellen zu anderen Organisationseinheiten  

Abbildung  4: Checkliste für Dokumentationsanforderungen  

Abbildung  5: Software-Fabrik  

Abbildung  6: Einteilung der EDV-Dokumentation in Teilbereiche  

Abbildung  7: Phasenkonzept eines EDV-Anwendungssystems  

Abbildung  8: Unterteilung Technische Dokumentation  

Abbildung  9: Unterteilung Programmdokumentation  

Abbildung  10: DV-Handbuch und Benutzer-Dokumentation  

Abbildung  11: Allgemeine Anforderungen  

Abbildung  12: Aufbau einer Benutzer-Dokumentation  

Abbildung  13: Anforderungen der Normenorganisationen  

Abbildung  14: Internationale und nationale Normungsorganisationen  

Abbildung  15: Anforderungen aus Recht und Rechtsprechung  

Abbildung  16: Übersicht Recht  

Abbildung  17: Anforderungen aus Kommunikations- und Motivationslehren  

Abbildung  18: „Man kann nicht nicht kommunizieren “  

Abbildung  19: Modell der Kommunikationsstörungen  

Abbildung  20: Die vier Seiten einer Botschaft  

Abbildung  21: Vier Dimensionen der Verständlichkeit  

Abbildung  22: Die einzelnen Phasen des Motivationsprozesses  

Abbildung  23: Motivation und Motivierung  

Abbildung  24: Lernerfolg  

Abbildung  25: Die Hierarchie der Bedürfnisse nach Maslow (1954)  

Abbildung  26: Die Halbwertzeit des Wissens  

Abbildung  27: Das HDI-Modell  

Abbildung  28: Anforderungen des Marketings  

Abbildung  29: Kreislauf Unternehmensinformation - Konsum  

Abbildung  30: Produkteigenschaften und Darbietung  

Abbildung  31: Anforderung aus Technik und Entwicklung  

Abbildung  32: Technische Einflüsse auf die Benutzer-Dokumentation  

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 8 -

Abbildung  33: Eingabemaske von Norton SystemWorks 2003  

Abbildung  34: Startmenü von Windows XP Professional.  

Abbildung  35: Beispiel für die Hilfefunktion in Norton SystemWorks 2003.  

Abbildung  36: Die PentaQuest-Methode im Überblick  

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 9 -

Tabellenverzeichnis   

Tabelle 1:  Normenorganisationen  23

Tabelle 2:  Beispiele für Anleitungstexte  25

Tabelle 3:  Dokumentationsbereiche  30

Tabelle 4:  Schnittstellen zwischen den Entwicklungsabschnitten  34

Tabelle 5:  Gliederung DV-Handbuchs und Benutzer-Dokumentation  38

Tabelle 6:  Components of software user documentation  52

Tabelle 7:  DIN-Normen  55

Tabelle 8:  Störfaktoren in der Kommunikation  73

Tabelle 9:  Beispiele für einen eindeutigen Stil  76

Tabelle 10:  Begriffliches und bildliches Denken  91

Tabelle 11:  Didaktische Grundprinzipien  94

Tabelle 12:  Quantitative und qualitative Marketingziele  97

Tabelle 13:  Marketingpolitische Instrumente  98

Tabelle 14:  Kommunikationspolitik  103

Tabelle 15:  Kurzübersicht über Corporate-Identity  106

Tabelle 16:  Aussagen in der Unternehmenswerbung  107

Tabelle 17:  Vor- und Nachteile computergestützter Dokumentation  129

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 10 - Vorwort

Der Siegeszug der Personal Computer (PC) und seiner Anwendungen setzt sich fort - nicht nur in unserer Arbeitswelt, sondern auch in unserem Privatleben ist der Umgang mit dem Computer alltäglich geworden. Wir schreiben Briefe mit dem PC, erstellen aufwendige Tabellen, surfen im Internet, empfangen und versenden Emails und benutzen den PC zur Erledigung unserer Bankgeschäfte über Online-Banking. Dabei wird die Fülle der Möglichkeiten, die uns der Computer zur Bewältigung der verschiedensten Aufgaben bietet, immer größer und die einzelnen Programme immer komplexer.

Ein Beispiel hierfür ist ein Textverarbeitungsprogramm, das allerdings mehr kann als nur Briefe erstellen - die Möglichkeiten, die es bietet, übersteigen dabei weit die Grenzen der Textverarbeitung. Alleine das Handbuch zu Microsoft Word hat 864 Seiten. Neben diesem umfassenden Original-Handbuch von Microsoft füllen allerdings noch etliche andere Handbücher und Anleitungen zu Microsoft Word die Regale der großen Buchhandlungen. Daraus lässt sich schließen, dass die Nachfrage der Benutzer nach Anleitungen und Erklärungen entsprechend hoch ist. Was schon für ein überschaubares Arbeitsgebiet wie die Textverarbeitung gilt, das kann man ebenfalls auf weitaus größere betriebswirtschaftliche Anwendungen übertragen. Anwendersoftware im allgemeinen wird immer umfangreicher und somit auch der Umfang der erklärenden und beschreibenden Texte hierzu wie z.B. Installationsanleitungen, Benutzer-Dokumentationen, Online-Hilfen und Schulungsunterlagen.

Auf der Seite der Softwareentwickler und -hersteller hat diese Entwicklung bereits ein Umdenken eingeleitet: die Bestrebungen führen dahin, Anwendersoftware intuitiv bedienbar zu gestalten. An allen denkbaren Stellen sollen Online- Hilfen und -texte dem Benutzer die Bedienung erleichtern.

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 11 -

Fürdie Anwender ist allerdings die schriftliche Benutzer-Dokumentation in den letzten Jahren immer wichtiger geworden und immer mehr in der Vordergrund gerückt. Es beschäftigen sich immer mehr Menschen mit immer komplexer werdenden Programmen. Durch die sich rasant verändernde Technologie und die erhöhten Anforderungen an die Anpassungsfähigkeiten der Benutzer, steigt auch deren Bedürfnis nach Erklärungen, Transparenz und Beherrschbarkeit der Programme.

Auf schriftliche Benutzer-Dokumentationen kann also nicht verzichtet werden. Das hat auch die Rechtsprechung erkannt, die die Dokumentation als rechtlichen Hauptbestandteil jeder Anwendersoftware definiert. 1

Darüber hinaus ist jede Benutzer-Dokumentation aber auch als ein zusätzliches, von der Konkurrenz abgrenzendes Marketinginstrument zu betrachten. Die Benutzer-Dokumentation ist ein wesentlicher Bestandteil der Unternehmenskommunikation und hat somit einen oft unterschätzten Stellenwert. Die Benutzer-Dokumentation im speziellen hat die Aufgabe, Softwareprodukte für den Benutzer so zu erläutern, dass ihm die vorgesehene Nutzung des Systems ermöglicht wird. Die Komplexität dieser Aufgabe wächst mit der Funktionalität der benutzten Softwareprodukte. 2

Die Entwicklung von Benutzer-Dokumentationen hat einen interdisziplinären Charakter, da sie Kenntnisse auf verschiedenen Fachgebieten erfordert. Diese Fachgebiete betreffen u. a. neben dem Gegenstandsbereich der Dokumentation und der Arbeitsgebiete der potentiellen Benutzer auch psychologische Theorien über die Verarbeitung und das Verstehen von Texten sowie pädagogische Fragestellungen. 3

¹ vgl. BGH, Urteil vom 04.11.1992, BGH CR 1993, S. 203 ff.

² vgl. Rupietta, W., Benutzer-Dokumentation für Softwareprodukte, Angewandte Informatik, Bd. 3, Zürich,

1987, S. 5

³ vgl. Rupietta, a. a. O. Seite 6

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 12 -

Umdiesen interdisziplinären Anforderungen gewachsen zu sein, entwickelte sich das Berufsbild des Technischen Autors. In Deutschland wurde der erste akademische Ausbildungsgang 1990 an der Fachhochschule Hannover aufgebaut, ⁴ wohingegen in Großbritannien und den USA der Beruf auf eine mindestens 50-jährige Geschichte zurückblicken kann. 5

Anwenderprobleme, für die eine Benutzer-Dokumentation keine Lösung anbietet, zerstören das Vertrauen der Benutzer nicht nur in das Produkt, sondern in das ganze Unternehmen. Eine gute Benutzer-Dokumentation dagegen verhindert Negativerlebnisse und hilft damit den Unternehmen, Geld zu sparen - bei Reklamationen, bei Reparaturen, beim Kundendienst, beim Service, in der Werbung und in der Öffentlichkeitsarbeit.

Diese Diplomarbeit gibt einen umfassenden Überblick über alle Anforderungen und Einflussgrößen, die sich auf Benutzer-Dokumentationen beziehen.

⁴ vgl. Obert, A., Qualifikation Technischer Redakteur, http://www.techwriter.de/thema/qualifik.htm vom

10.04.03

⁵ vgl. O. V.: tekom-Leitlinie Aus- und Weiterbildung, http://www.tekom.de/pdf/leit_auw.pdf, S. 6, vom

10.04.03

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 13 -

1.Einführung

Für eine ernsthafte Auseinandersetzung mit dem Thema „Anforderungen an Benutzer-Dokumentationen für betriebswirtschaftliche Anwenderprogramme“ zählen folgende Gründe:

• die kritische Haltung der Verbrauchervereinigungen, der Stiftung Warentest und der Presse gegenüber schlampiger Produktaufklärung,

• die verschärfte Auslegung der Produkthaftung,

• die zunehmende Qualitäts- und Kundenorientierung im Marketing sowie die Einflüsse der Corporate Identity-Strategen,

• die hohen Kosten im Kundendienst, in der Reklamationsbearbeitung und in der Garantieabwicklung,

• die nachlassende Beratungsqualität nachgelagerter Absatzmittler (z. B. „Aldi-Computer“) 6

Diese Diplomarbeit soll die tatsächliche Bedeutung des Themas hervorheben und die rechtlichen, wirtschaftlichen und strategischen Vor- und Nachteile einer intensiven Beachtung bzw. Vernachlässigung dieses Themas aufzeigen.

⁶ vgl. o.V., Bevor die Fetzen fliegen, Absatzwirtschaft 10/88, S. 102

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 14 -

1.1Wegweiser durch die Diplomarbeit

In Kapitel 1 erfolgt neben der Einführung in das Thema eine Klärung der grundlegenden Begriffe dieser Diplomarbeit und deren Zusammenhang. Wichtige Begriffe wie z. B. Benutzer-Dokumentation und Anwenderprogramme werden definiert und das organisatorische Umfeld der Benutzer-Dokumentation wird betrachtet. In diesem Zusammenhang werden auch schon erste Einflussgrößen auf die Benutzer-Dokumentation und Anforderungen an diese herausgearbeitet. Das Kapitel 1 schließt sodann mit der Zusammenstellung von Anforderungen an Benutzer-Dokumentationen in Form einer Checkliste. Die Punkte dieser Checkliste werden in den nachfolgenden Kapiteln noch einmal aufgegriffen und vertieft. Kapitel 2 soll einen Überblick geben über die verschiedenen Arten von Dokumentationen. Ziel dieses Kapitels ist ein besseres Verständnis des Gesamtzusammenhangs und damit die Eingrenzung dieses Themas.

Kapitel 3 beginnt sodann mit der Betrachtung erster allgemeiner Anforderungen an Benutzer-Dokumentationen. Hier wird zunächst einmal auf die äußere und innere Gestaltung von Benutzer-Dokumentationen eingegangen. Wie sollte die Benutzer-Dokumentation aussehen und wie sollte sie gegliedert sein? Darüber hin-

⁷ eigene

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 15 -

ausstellt das Kapitel 3.2 schon erste konkrete Anforderungen vor und erläutert sie. Diese Anforderungen an die Benutzer-Dokumentation sind allgemein gültig. Sie werden auch in den folgenden Kapiteln jeweils noch einmal angesprochen und vertieft.

Kapitel 4 ist den Normenorganisationen und deren Anforderungen an Benutzer-Dokumentationen gewidmet. Die wichtigsten Normenorganisationen sowie deren wichtigste Normen bezüglich Benutzer-Dokumentationen werden vorgestellt und erklärt.

Welche Gesetze Einfluss auf die Benutzer-Dokumentation haben, wird in Kapitel 5 dargestellt. Hier wird insbesondere auf den Schuldrechtsteil des BGB, auf das Produkthaftungsgesetz sowie auf die aktuelle Rechtsprechung eingegangen. Es soll explizit dargelegt werden, warum die Beachtung dieser Gesetze für Benutzer-Dokumentationen wichtig ist und welche Folgen die Nicht-Beachtung bzw. mangelnde Umsetzung dieser Anforderungen in der Praxis hat. Kapitel 6 gibt eine Einführung in drei besonders wichtige und interessante Einflussbereiche auf Benutzer-Dokumentationen. Zuerst werden verschiedene Kom-munikationstheorien betrachtet, die wichtig sind für die verständliche und emp-fängerorientierte Mitteilung der Benutzerinformationen. Die Motivationstheorien sollen sodann dabei helfen, zu verstehen, mit welcher Motivation sich die Benutzer dem Anwenderprogramm und seiner Dokumentation stellen und wie man diese Motivation positiv beeinflussen kann. Abschließend werden Erkenntnisse aus der Lernpsychologie und Didaktik wiedergegeben, die als Hintergrundwissen bei der Erstellung von Benutzer-Dokumentationen nützlich sind. Kapitel 7 beschäftigt sich mit den Anforderungen des Marketings an Benutzer-Dokumentationen. Dazu werden neben den Aufgaben des Marketings auch die Marktforschung und die marketingpolitischen Instrumente betrachtet. Speziell im Marketing spielt die Benutzer-Dokumentation eine besondere Rolle.

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 16 -

Alsletzte Anforderungen an Benutzer-Dokumentationen behandelt Kapitel 8 die Anforderungen aus Entwicklung und Technik. Hier wird zum einen auf die An-forderungen des technischen Produkts selbst eingegangen als auch auf die Anforderungen der Realisierung und Umsetzung der Benutzer-Dokumentation in einem Content-Management-System.

In Kapitel 9 werden sodann die Möglichkeiten der Umsetzung der Benutzer-Dokumentation in der Praxis erläutert. Hier kommen auch die verschiedenen Formen und Ausprägungen der Benutzer-Dokumentation im weitesten Sinne zum Einsatz wie beispielsweise die computergestützte Benutzer-Dokumentation und Tutorials. Daneben werden auch psychologische Aspekte vor, während und nach der Einführung eines neuen Anwenderprogramms angesprochen sowie die Software-Ergonomie.

Das 10. Kapitel beschäftigt sich ebenfalls mit der Praxis und zwar mit den Möglichkeiten zur Beurteilung von Benutzer-Dokumentationen. Hier gibt es verschiedene Methoden von verschiedenen Institutionen und Ansätzen her beispielsweise die PentaQuest-Methode oder die Prüfung durch Wirtschaftsprüfer. Diese Diplomarbeit schließt ab mit einer Zusammenfassung und einem Fazit in Kapitel 11.

1.2 Begriffe und Organisationsumfeld der Benutzer-Dokumentation

Diese Diplomarbeit beschäftigt sich mit allen Arten von Anforderungen, die an Benutzer-Dokumentationen für betriebswirtschaftliche Anwenderprogramme gestellt werden.

Um das Thema genauer einzugrenzen und verständlicher zu machen, möchte ich schon vorweg einige der für diese Diplomarbeit elementaren Begriffe näher erläu- tern.

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 17 -

1.2.1Grundlegende Begriffe, Definitionen und Abgrenzungen

1.2.1.1 Benutzer-Dokumentation

„Unter Benutzer-Dokumentation versteht man den Teil der Dokumentation des Programms, der für den Endanwender, den sogenannten Benutzer, bestimmt ist. Dazu gehört insbesondere das Handbuch, das erläutert, wie man mit der jeweiligen Software arbeitet.“ 8

1.2.1.2 Betriebswirtschaftliche Anwenderprogramme

Unter betriebswirtschaftlichen Anwenderprogrammen versteht man alle Arten von Software, die zur Lösung betriebswirtschaftlicher Aufgabenstellungen beitragen sollen. Synonym dazu werden auch die Begriffe Anwendersoftware oder Anwendungssoftware benutzt. Das Spektrum dieser Anwenderprogramme reicht von kleineren Insellösungen wie z. B. einer einzelnen Buchhaltungssoftware bis zu Komplett-Lösungen wie z. B. das Enterprise Ressource Planning (ERP) System SAP R/3. In dieser Definition sind nicht enthalten Betriebssysteme, Programmiersoftware und alle Arten reiner „Vergnügungs-Software“. Diese Abgrenzung der Anwenderprogramme ist meiner Meinung nach sinnvoll aus folgenden Gründen:

a) Die Zielgruppen der Anwender sind sehr unterschiedlich: z. B. die Programmierer, die sich beruflich mit Betriebssystemen befassen; die Jugendlichen, die sich in ihrer Freizeit gerne mit Computerspielen beschäftigen oder die Büroangestellten, die sich beruflich mit Buchhaltungs- und Textverarbeitungsprogrammen auseinandersetzen müssen.

⁸ Redeker, H., Der EDV-Prozeß, München, 1992, S. 255

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 18 -

b)Ebenso unterscheidet sich der Verwendungszweck der Software: Betriebssysteme haben den Zweck, eine Schnittstelle zwischen der Maschine und dem Benutzer herzustellen. Sie bilden lediglich die Plattform, um andere Anwendungen betreiben zu können. Während man sich mit Computerspielen in seiner Freizeit zum reinen Vergnügen beschäftigt, werden dagegen Anwenderprogramme hauptsächlich zum beruflichen Einsatz gebraucht.

c) Demzufolge ist auch die Motivation der Benutzer der Software sehr unterschiedlich: Der Spieler wird nur freiwillig und mit Spaß an seine Software herangehen (das Programm selbst ist motivierend è siehe Kapitel 3.4.5), während Anwender eines betriebswirtschaftlichen Programms eher beruflich mit der Software in Kontakt kommen und sie wohl eher von außen dazu motiviert werden, sich mit dem Programm zu beschäftigen (siehe Kapitel 3.4.5). Betriebssysteme, Vergnügungssoftware und Anwenderprogramme besitzen somit verschiedene Voraussetzungen zur Erstellung von Benutzer-Dokumentation. Es sind jeweils andere Gesichtspunkte und Anforderungen zu beachten. Dennoch können auch die im Folgenden herausgearbeiteten Anforderungen analog zur Geltung kommen.

1.2.1.3 Anforderungen

Die Anforderungen, die an Benutzer-Dokumentationen gestellt werden, sind sehr vielfältig und kommen aus den verschiedensten Bereichen. Dies soll die folgende Übersicht veranschaulichen:

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 19 -

Abbildung2: Übersicht der Anforderungen an Benutzerdokumentationen 9

Alle Personen oder Organisationseinheiten, die mit der Benutzer-Dokumentation in Berührung kommen, stellen Anforderungen an diese. In vielen Punkten sind diese Anforderungen identisch, aber oft kommen auch immer wieder neue Aspekte hinzu. Diese unterschiedlichen Anforderungen stehen in Wechselwirkung mit-einander und gelegentlich auch im Widerspruch zueinander. Walter Rupietta berichtet aus der Praxis als Handbuch-Autor folgendes: „Es ist in der Praxis nicht die Regel, dass eine Dokumentationsanforderung im hier beschriebenen Sinne tatsächlich explizit formuliert und schriftlich fixiert wird. Häufig besteht die gesamte Anforderung in einem Satz wie ‚Zu dem neuen Produkt XYZ brauchen wir noch eine Benutzer-Dokumentation’.“ ¹⁰ Eine genaue Festlegung und Fixierung der Anforderungen ist jedoch zwingend erforderlich, um ein genaues Konzept zur Erstellung einer Benutzer-Dokumentation festzulegen und spätere Entwürfe dahingehend prüfen zu können, ob sie dem Konzept genügen. 11

⁹ eigene

¹⁰ Rupietta, W., Benutzerdokumentation für Softwareprodukte, Angewandte Informatik, Bd. 3, Zürich, 1987,

S. 27

¹¹ vgl. Rupietta, W., Benutzerdokumentation für Softwareprodukte, Angewandte Informatik, Bd. 3, Zürich,

1987, S. 27

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 20 -

1.2.2Organisationsumfeld der Benutzer-Dokumentation

Die in der Abbildung 1 dargestellten Personen und Organisationseinheiten (Auftraggeber, Auftragnehmer, Benutzer, Verbraucherverbände, Normungsorganisationen, rechtliche Institutionen) sind nur Beispiele, die für bestimmte Rollen und Funktionen stehen. Von diesen Funktionen im Zusammenhang mit der Entwicklung von Benutzer-Dokumentationen gehen bestimmte Einflussfaktoren aus, die in jedem Fall wirksam sind - unabhängig davon, ob die oben genannten Personen und Organisationseinheiten tatsächlich vorhanden sind oder nicht. Im Extremfall sind alle Funktionen in einer Person vereinigt. 12

1.2.2.1 Auftraggeber

Auftraggeber einer Benutzer-Dokumentation ist in der Regel das Unternehmen, das die zu beschreibende Software auf den Markt bringt. Abhängig von der Art und der Größe dieser Unternehmensorganisation können unterschiedliche Organisationseinheiten als Auftraggeber in Betracht kommen. In einem kleinen bis mittelständigen Unternehmen wird es wahrscheinlich der Firmeninhaber oder Geschäftsführer sein, der den Auftrag vergibt. In größeren Unternehmen kann sowohl die Entwicklungsabteilung, die Marketingabteilung oder allgemein die Verwaltung dafür verantwortlich sein. Je nach verantwortlichem Abteilungsbereich können auch die dort gestellten Anforderungen an die Benutzer-Dokumentation unterschiedlich sein. Die Marketingabteilung legt eventuell einen besonders hohen Stellenwert auf die Werbewirksamkeit und Zielgruppengenauigkeit der Benutzer-Dokumentation, die Entwicklungsabteilung stellt vielleicht besonders die Komplexität des Programms und dessen Möglichkeiten in den Vordergrund während die Verwaltung auf möglichst geringe Kosten bei hoher Auflage achtet.

1.2.2.2 Auftragnehmer

Auftragnehmer sind häufig interne oder externe Technische Autoren, die auf die Erstellung von Benutzer-Dokumentationen spezialisiert sind. Ein interner technischer Redakteur kann direkt einer Softwaregruppe, die ein Softwareprodukt ent-

¹² vgl. Rupietta, a. a. O. Seite 18

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 21 -

wickeltoder einer Softwareentwicklungsabteilung angehören und ist damit in der Lage, aufgrund seiner unmittelbaren Beteiligung an der Produktentwicklung die Dokumentation parallel dazu zu entwickeln. Externe technische Autoren sind selbständig tätig und somit nicht in der Unternehmensorganisation des Auftraggebers verankert. Dadurch haben sie eventuell einen objektiveren und unverstellteren Blick auf das Produkt und seine Zielgruppe. Oft ist es auch ein Team von externen technischen Redakteuren, die sich auf unterschiedliche Aspekte der Benutzer-Dokumentation spezialisiert haben. 13

Darüber hinaus können die Auftragnehmer aber auch aus dem Marketing- oder Vertriebsbereich des Unternehmens kommen. Diese haben in der Regel bessere Kenntnisse über die Zielgruppen, die die Benutzer-Dokumentation ansprechen soll, aber auch andere Anforderungen an die Benutzer-Dokumentation als beispielsweise die Entwicklungsabteilung. 14

In kleineren Unternehmen erstellt häufig auch ein Softwareentwickler in einer Entwicklungsabteilung neben Softwaremodulen auch die Benutzer-Dokumentation. Das ist ein Beispiel, in dem mehrere oder alle der aufgezählten Funktionen in einer Person vereinigt sind. 15

In der Regel wird der Auftragnehmer die Benutzer-Dokumentation nicht isoliert, sondern in Zusammenarbeit mit anderen Organisationseinheiten erstellen. Hieraus ergeben sich Schnittstellen zu anderen U nternehmensbereichen, wie z. B. zur Entwicklungsabteilung oder zur Marketingabteilung. Welche Schnittstellen letztendlich eine Rolle spielen, hängt natürlich von der Art und der Größe des Unternehmens und der zu erstellenden Benutzer-Dokumentation ab. Einige mögliche Schnittstellen verdeutlicht die folgende Abbildung: 16

¹³ vgl. Rupietta, W., Benutzerdokumentation für Softwareprodukte, Angewandte Informatik, Bd. 3, Zürich,

1987, S. 18

¹⁴ vgl. Rupietta, a. a. O. Seite 18

¹⁵ vgl. Rupietta, a. a. O. Seite 18

¹⁶ vgl. Rupietta, a. a. O. Seite 18

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 22 -

• Ausder Softwareentwicklung kommen die technischen Informationen zu dem zu beschreibenden Produkt. Insbesondere bei neu entwickelten Produkten kommt aus dieser Abteilung der entscheidende Input.

• Die Marketingabteilung bzw. der Vertrieb gibt Informationen über den Markt für das Produkt und über die Zielgruppe der Dokumentation. Dies kann besonders wichtig sein bei überarbeiteten Dokumentationen zu bereits existierenden Produkten, die den Einsatzzweck oder die Zielgruppe der Anwendersoftware genauer und direkter ansprechen soll.

• Die Schulungsabteilung kann Hilfestellung leisten in Bezug auf didaktische Fragen beim Aufbau der Dokumentation. Darüber hinaus sollten weitere Schulungsmaßnahmen mit ihr abgestimmt werden.

¹⁷ Rupietta, W., Benutzerdokumentation für Softwareprodukte, Angewandte Informatik, Bd. 3, Zürich, 1987,

S. 19, Abb. 1-1

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 23 -

• Unterdie zentralen technischen Dienste fallen alle Dienstleistungen, die ein Autor bei der Erstellung der Benutzer-Dokumentation benötigt, z. B. Schreibdienst, Fotograf und Fotolabor, technische Zeichner und Druckerei. 18

1.2.2.3 Normungsorganisationen

Die wichtigsten Normungsorganisationen sind:

Diese Normungsorganisationen haben zur Vereinheitlichung der Dokumentationstechniken eine Reihe von Normen erarbeitet und veröffentlicht. Für den deutschsprachigen Raum sind die DIN-Normen am bedeutsamsten. Diese Normen sind nicht rechtlich zwingend (d.h. müssen nicht befolgt werden). Dennoch empfiehlt sich ihre Einhaltung, da einerseits die Wirtschaft insgesamt um Vergleichbarkeit und Standardisierung bemüht ist und andererseits die eigene Rechtsposition im Zweifelsfall gestärkt ist.

¹⁸ vgl. Rupietta a. a. O Seite 19/20

¹⁹ eigene

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 24 -

Aufdie Normungsorganisationen gehe ich in Kapitel 4 noch näher ein.

1.2.2.4 Benutzer und Verbraucherschutzverbände

Weitere Anforderungen an die Benutzer-Dokumentation stellen natürlich auch die Benutzer und für diese stellvertretend auch die Verbraucherschutzverbände. Denn was nutzt einem Benutzer die ausführlichste Dokumentation, wenn sie ihn nicht zum Gebrauch der Software befähigt?

Manche Verbraucherzeitschriften räumen sogar jeden Monat unverständlichen Gebrauchsanleitungen eine eigene Spalte ein.

Hier einige anschauliche Beispiele aus Zeitschriften zum Thema Benutzer- Dokumentation (bzw. Gebrauchsanweisung):

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 25 -

1.2.2.5Rechtsprechung

Als sozusagen letzte Instanz stellt die Rechtsprechung ebenfalls Anforderungen an Benutzer-Dokumentationen. Bei gerichtlichen Auseinandersetzungen über die Vollständigkeit und Richtigkeit von Softwareprodukten und ihrer Dokumentation muss die Rechtsprechung abschließend darüber entscheiden, ob die an eine Benutzer-Dokumentation (zu Recht) gestellten Erwartungen und A nforderungen auch tatsächlich erfüllt sind. Dazu greift sie oft genug auf die DIN-Vorschriften zurück (siehe Kapitel 5).

²⁰ Schmidt, W., Nix verstehen - Gebrauchsanweisungen, Capital, 9/2001, S. 112-114

²¹ o. V., Gebrauchsanleitungen: Text vom Techniker, Wirtschaftswoche, Nr. 42, 1987, S. 77-80

²² eigene

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 26 -

Inder folgenden „Checkliste“ möchte ich noch einmal alle bisher kennengelernten Anforderungen an Benutzer-Dokumentationen zusammenfassend festhalten. In den weiteren Kapiteln wird diese Checkliste abgearbeitet: d.h. die einzelnen Punk- ten werden angesprochen, weitergehend erklärt und spezifiziert.

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 27 -

1.3Checkliste für Dokumentationsanforderungen

²³ eigene

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 28 -

2.Welche Arten von Dokumentation gibt es?

Der Erfolg jeder Anwendersoftware hängt von den folgenden drei dargestellten Säulen ab. Dieses Bild zeigt, dass die Dokumentation ein integraler Bestandteil des Gesamtsystems ist.

Gemäß einer Definition von Schulze ist Dokumentation die Tätigkeit der „Beschreibung und Aufbewahrung aller Unterlagen, die bei der Erstellung eines Programms entstanden sind.“ Aber nicht nur die Tätigkeit der Dokumentation selbst, sondern auch das Ergebnis dieser Tätigkeit (nämlich die entstandenen Unterlagen und Dokumente) wird üblicherweise als Dokumentation bezeichnet. 25

²⁴ Scheibl, H., Wie dokumentiere ich ein DV-Projekt?, Kontakt & Studium, Bd. 169, Sindelfingen, 1985, S.

48

²⁵ vgl. Schulze, H., Lexikon zur Datenverarbeitung, Reinbek, 1978

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 29 -

Abbildung6: Einteilung der EDV-Dokumentation in Teilbereiche 26

Grundsätzlich teilt man die Gesamtdokumentation eines Software-Projektes in zwei große Bereiche

- Projekt-Dokumentation

- Technische Dokumentation

ein. Die Projekt-Dokumentation nimmt dabei eine gewisse Sonderstellung ein, da sie zwar für den Ablauf der Projektabwicklung wichtig ist, nach Abschluss des Projektes aber nur noch geringe Bedeutung hat (z. B. für die Nachkontrolle der Aufwandsabschätzungen usw.). 27

Die Technische Dokumentation kann man wiederum in zwei Untergruppen unterteilen:

- Entwicklungs-Dokumentation

- Programm-Dokumentation

Die folgende Tabelle 1 zeigt eine Übersicht über diese drei Dokumentationsgruppen.

²⁶ eigene

²⁷ vgl. Scheibl, H., Wie dokumentiere ich ein DV-Projekt?, Kontakt & Studium, Bd. 169, Sindelfingen, 1985,

S. 15

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 30 -

Währendeiner Software-Entwicklung ist die Dokumentation in den Ablauf eines Phasenkonzepts eingebettet. Die folgende Übersicht veranschaulicht die parallele Entwicklung der Software und der Dokumentation und zeigt beispielsweise ein solches Phasenkonzept. In der Fachliteratur der EDV-Dokumentation sind auch andere Bezeichnungen, Untergliederungen und Abgrenzungen anzutreffen. 29

²⁸ vgl. Biewald, J., Dokumentation von Automatisierungs-Software, Regelungs-technische Praxis, 1983, S.

238

²⁹ vgl. Grupp, B., EDV-Projekte richtig dokumentieren, Köln, 1991, S. 10

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 31 -

2.1Projekt-Dokumentation

Die Projekt-Dokumentation umfasst alle Unterlagen zur Auslösung, Planung und Steuerung des Softwareprojekts. Gleichbedeutend ist der Ausdruck Projektablaufdokumentation oder Projektmanagementdokumentation. Hierzu zählen beispielsweise folgende wesentliche Unterlagen:

• der Projektauftrag

• Schriftwechsel über den Projektablauf

• Wirtschaftlichkeitsberechnungen

• Arbeitsaufträge

• Zeitüberwachungsblätter

• Wichtige Sitzungsprotokolle

³⁰ vgl. Grupp, B., EDV-Projekte richtig dokumentieren, Köln, 1991, S. 10, Bild 1-2

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 32 -

DieProjekt-Dokumentation soll jederzeit Auskunft geben können über wichtige Ergebnisse und Fortschritte sowie den Status des Projekts. Das Projektbudget weist dabei die Höhe der Projektinvestitionen aus und Kosten-/Nutzenrechnungen geben Auskunft über die Wirtschaftlichkeit. 31

2.2 Technische Dokumentation

Der Projekt-Dokumentation steht die Technische Dokumentation gegenüber. Sie hat die Dokumentation aller Entwicklungs- und Implementierungsphasen eines Software-Projekts zum Inhalt. Sie wird in der Fachliteratur auch Systemdokumentation, Anwendungsdokumentation oder Verfahrensdokumentation genannt. 32

Die technische Dokumentation wird unterteilt in die Entwicklungs-Dokumentation und in die Programm-Dokumentation.

2.2.1 Entwicklungs-Dokumentation

Was die Entwicklungs-Dokumentation alles enthalten und beschreiben sollte, legt die DIN-Norm 66 231 vom Oktober 1982 fest. Diese Norm ist als Hilfsmittel gedacht für jeden, der sich im weiteren Sinne mit der Entwicklung von Software beschäftigen muß. Sie soll der Kommunikation zwischen allen an der Programmentwicklung beteiligten Personen dienen.

³¹ vgl. Grupp, B., EDV-Projekte richtig dokumentieren, Köln, 1991, S. 35

³² vgl. Grupp, B., EDV-Projekte richtig dokumentieren, Köln, 1991, S. 61

³³ eigene

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 33 -

DieNorm setzt sich folgende Ziele:

- Festlegung der sachlichen Voraussetzungen bei der Zusammenarbeit verschiedener Aufgabenträger an einer Programmentwicklung

- Erleichterung einer Weiter- oder Neuentwicklung eines Programms

- Möglichkeit der Überprüfung der Programmentwicklung ³⁴ Allerdings hat das Deutsche Institut für Normung e. V. dieser DIN-Norm kein einheitliches Phasenkonzept vorgeschrieben, da dies aufgrund der vielfältigen Anwendungsgebiete im kaufmännischen, technischen oder wissenschaftlichen Bereich sowie der jeweils verschiedenen organisatorischen Rahmenbedingungen kaum möglich ist. Deshalb muss der Anwender der Norm selbst die für den jeweiligen Entwicklungsprozess relevanten Schnittstellen bestimmen und festlegen. Die Schnittstellen ergeben sich jeweils an zwei aufeinanderfolgenden Entwicklungsabschnitten. 35

An diesen selbst bestimmten Schnittstellen fordert die Norm die Bereitstellung der folgenden Angaben:

- Angabe der sachlichen Grundlagen für die Programmentwicklung bis zur nächsten Schnittstelle (Entwicklungsabschnitt)

- „Begründung für die während der Programmentwicklung getroffenen Sachentscheidungen, z. B. über die Auswahl von Verfahren und Festlegung des Leistungsumfangs.“ 36

Im Anhang B der Norm findet sich auch ein Beispiel für die Erstellung eines Planes für eine Programmentwicklungsdokumentation. Anhand der nachfolgenden Tabelle kann man sodann schon erahnen, was diese Dokumentation im Einzelnen alles umfasst:

³⁴ vgl. DIN 66231, Programmentwicklungsdokumentation, 1982, S. 1

³⁵ vgl. DIN 66231, Programmentwicklungsdokumentation, 1982, S. 27

³⁶ DIN 66231, Programmentwicklungsdokumentation, 1982, S. 1

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 34 -

DieDIN-Norm 66231 zur Programmentwicklungsdokumentation stellt auch die Grundlage dar für eine darauf aufbauende Programmdokumentation nach DIN 66230. 38

2.2.2 Programm-Dokumentation

Die Deutsche Industrie-Norm DIN 66230 vom Januar 1981 bezeichnet die Programm-Dokumentation als die Gesamtheit der zur Anwendung von Software er-forderlichen Angaben.

„Die Programmdokumentation ist notwendige Voraussetzung für die Anwendung eines Programms. Sie dient als Grundlage für die Entscheidung über den Einsatz eines Programms sowie als Hilfsmittel bei der zweckentsprechenden und wirtschaftlichen Installierung, Benutzung, Fehlerbeseitigung, Aktualisierung und Schulung.“ 39

³⁷ DIN 66231, Programmentwicklungsdokumentation, 1982, S. 25, Bild B 1

³⁸ vgl. DIN 66231, Programmentwicklungsdokumentation, 1982, S. 27

³⁹ DIN 66230, Programmdokumentation, 1981, S. 1

Michaela Brülls: Anforderungen an Benutzer-Dokumentationen - 35 -

DieDIN-Norm 66230 legt den Inhalt der Programm-Dokumentation fest. Eine vollständige Programm-Dokumentation muss Aussagen zu allen vorgegebenen Teilen machen, kann aber dazu auf andere Dokumentationswerke verweisen. Wenn bestimmte Angaben nicht zutreffen oder aus wirtschaftlichen Gründen nicht weitergegeben werden sollen, muss angegeben werden, dass diese entfallen. Die Nutzung der Software darf dadurch aber nicht beeinträchtigt werden. ⁴⁰ Die Dokumentation von Betriebssystemen (einschließlich betriebssystem-nahen Steuerprogrammen) wird durch die DIN 66230 nicht abgedeckt.

Die DIN 66230 gliedert die Programmdokumentation in zwei Teile. Dabei geht sie davon aus, dass für die Anwendung des Programms (z. B. im Fachbereich) und für die Installierung, Betrieb und Pflege des Programms (im Datenverarbeitungsbereich) unterschiedliche Informationen benötigt werden. Demnach werden alle der Norm nach erforderlichen Angaben entweder der Benutzer-Dokumentation (Anwendungshandbuch) oder der Datenverarbeitungstechnischen Dokumentation (DV-Handbuch) zugeordnet. Dabei versucht die Norm Wiederholungen und Überschneidungen weitgehend zu vermeiden. 42

⁴⁰ vgl. DIN 66230, Programmdokumentation, 1981, S. 1

⁴¹ eigene

⁴² vgl. DIN 66230, Programmdokumentation, 1981, S. 13