Home Previous Zeitschrift 2003/12 Next Index
 
  Inhalt:
 
 
 
Rechtliche Grundlagen
Gestaltung der Dokumentation
Saarbrücker Standard

 

Saarbrücker Standard für Softwaredokumentation 
 

Der Deutsche EDV-Gerichtstag befaßte sich in einem Arbeitskreis[1] mit dem Thema Handbuch und Dokumentation. Nachdem 1998 eine
Prüfliste[2] mit Anforderungen an die Richtigkeit und Vollständigkeit[3] verabschiedet worden war [4], erörterte der EDV-Gerichtstag 1999 gestalterische
Anforderungen an die Übersichtlichkeit und Verständlichkeit der Dokumentation für die jeweiligen Benutzer. [5]
 

I. Rechtliche Grundlagen

Die Rechtsprechung des Bundesgerichtshofs sieht weiterhin die Lieferung eines regelmäßig in deutscher Sprache abzufassenden Handbuchs als Hauptleistungs-pflicht des Softwarelieferanten an, deren Nichteinhaltung den Vertrag insgesamt scheitern läßt.[6]

Aber auch wenn man mit zunehmender Verbreitung der Computernutzung statt der  Nichterfüllung bei Fehlen der Dokumentation in Zukunft Gewährleistungsrecht
anwenden wollte, stellt das Fehlen einer Dokumentation einen Mangel dar. Nach dem  derzeitigen Stand der Technik und der Marktüblichkeit bedarf Software nämlich nach wie vor einer Dokumentation. Dies gilt für alle Arten von Softwaremedien; lediglich der Ausführungsgrad kann unterschiedlich sein.

Mindestanforderungen an eine Benutzerdokumentation sind eine Installationsanleitung, eine Übersicht über den Aufbau des Programms sowie die Darstellung des Programmeinstiegs und der Behandlung von Fehlern. Bezüglich der Form der Dokumentation die Rechtsprechung zunehmend nicht nur die gedruckte Form,
sondern auch die für jedermann ausdruckbare gesonderte Datei zu. Der Hersteller trägt hierbei die Beweislast für die Ausdruckbarkeit der notwendigen Angaben.

Die Dokumentation ist jeweils dann anzupassen, wenn Änderungen bei der Anwendung der Software erforderlich sind, die für einen durchschnittllich befähigten Nutzer der Zielgruppe nicht unmittelbar aus der Software heraus verständlich sind. Bei Programmen, die ständig weiterentwickelt werden, genügt eine etwa jährliche Aktualisierung.
 

II. Gestaltung der Dokumentation

Die Gestaltung der Dokumentation hat sich an den Bedürfnissen und Fähigkeiten der vom Hersteller ins Auge gefaßten Zielgruppe zu orientieren und muß für diese
verständlich sein. Die von der Rechtsprechung für Benutzeranleitungen im Rahmen der Produkthaftung entwickelten Grundsätze sind auf Softwareanleitungen
entsprechend anzuwenden.[7] Für die Gestaltung technischer Dokumentation bestehen im übrigen eine Vielzahl technischer Normen, die auch bei
Softwaranleitungen Geltung beanspruchen, z.B. für Benutzerinformationen allgemein[8], für die drucktechnische Gestaltung[9] und die Darstellung technischer
Grafiken [10].

Ziel dieser Regeln ist ein klarer, für den Leser erkennbarer Aufbau der Dokumentation, eine einheitliche Begriffsverwendung und eine Gliederung in überschaubare
Informationspakete. Handlungsanweisungen müssen auch sprachlich klar von erklärenden Teilen getrennt sein. Dem heutigen Standard entsprechen weiter sog.
Leselinien, die einen Schnelldurchgang durch die Information für den geübten Nutzer und eingehendere Erläuterungen für den unerfahrenen vorsehen. Verbote und
Warnungen müssen klar ausgesprochen und begründet werden.[11] 

Bei der grafischen Gestaltung dürfen nicht zu viele Details auf einmal angeboten werden und ist eine Erläuterung von Maskendarstellungen z.B. mit Hilfe von
Pfeilen und Erläuterungen erforderlich, die dem Leser die Bildaussage erschließt. Die Verwendung gebräuchlicher Schriffttypen und Formatierungen und eine
einwandfreie Zuordnung von Text- und Bildaussagen sind weitere Anforderungen an die  Verständlichkeit der Dokumentation.

Der folgende nach eingehender Diskussion als Saarbrücker Standard verabschiedete Kriterienkatalog faßt die Ergebnisse der bisherigen Beschäftigung mit dem
Thema zusammen. Er soll den Herstellern von Software als Orientierungsmaßstab dienen und die rechtlichen Anforderungen an eine ordnungsgemäße
Dokumentation definieren.
 

III. Saarbrücker Standard für 
      Software- Anwenderhandbücher
 
 

1. Richtigkeit (Dr. Streitz)[12]

a)   Identifizierende Angaben

                        Programmbezeichnung

                        Programmversions-Nr.

                        ggfs. Lizenz-Nr., Vertrags-Nr.

                        Handbuch-Versions-Nr.

b)   Programmkonforme Darstellung

                        des Programmaufbaus

                        der Programmfunktionen

                        der Feldbezeichnungen

                        der möglichen Feldinhalte
 

2. Vollständigkeit (Dr. Streitz)

a)   Installationsbeschreibung

                        Auflistung der gelieferten Unterlagen

                        Systemvoraussetzungen (Hardware/Software)

                        Qualifikation des Anwenders

                        Sicherheitshinweise

                        technische Beschreibungsmerkmale des 
                         Programms

                        Installationsanleitung

                        Standard und Sonderformen

                        Erklärung der Installations-Parameter,

                        typische Systemverhaltenskennzahlen

                        Optimierungsvorschläge

                        benutzerspezifische Anpassungen

                        Registrations- und Garantieunterlagen

b)   Beschreibung der Programm-Funktionalitäten

                        Aufgabenstellung und Einsatzgebiet des
                        Programms

                        Menüstruktur (Funktionsablauf)

                        Programmablauf der jeweiligen Einzelaufgaben

                        zugrundeliegende Normen und Konventionen

                        Grundlagen und Berechnungsmethoden

                        Befehls-Kurz-Übersicht (Reference Card)

                        Musterbeispiele für Standardaufgaben

                        Tips und Tricks (Expert-Modus)

c)   Benutzer-Daten

                        Struktur

                        Speicherung

d)   Verhalten in Ausnahmesituationen

                       Erläuterung jeder einzelnen Fehlermeldung

                       Hinweise auf zu ergreifende Maßnahmen

                       Maßnahmen bei Abweichungen zwischen
                       erwartetem und tatsächlichem Ergebnis   

e)    Unterstützung durch den Programmlieferanten/-hersteller

                       Kontaktadresse für den Benutzer

                       Hotline, soweit vorhanden

3. Übersichtlichkeit/ Verständlichkeit (Pötter)

a)          Zielgruppenbezug

                       Fachkenntnisse

                       Allgemeinbildung

                       Erwartungsschemata und Wahrnehmungsfilter

b)         Aufbau

                       produktorientiert (Reihenfolge der Funktionen) 

                       benutzerorientiert (nach typischem Arbeitsablauf)
                        

                       Maskenfunktionen

                       übersichtliche hierarchische Gliederung

                       Informationsmenge je nach mentaler 
                       Verarbeitungskapazität

c)            Orientierungshilfen

                       strukturiertes Inhaltsverzeichnis

                       alphabetisches Stichworteverzeichnis

                       ggf. Glossar (Verzeichnis der Abkürzungen 
                       und Fachausdrücke)

d)            Textverständlichkeit

                       jeweilige Landessprache

                       sprachliche Richtigkeit

e)            Wortwahl

                       einheitlich durchgängige Begrifflichkeit

                       Vermeidung oder sofortige Erklärung von 
                       Fremdwörtern

                       Vermeidung nichtgängiger Worte und
                       Abkürzungen

                       genormte Signalwörter bei Warnungen

f)            Satzkonstruktion

                       kurze vollständige Sätze

                       Voranstellung der wesentlichen Aussage

                       unterschiedlicher Sprachstil für beschreibende 
                       und handlungsorientierte Teile

g)            Motivationssteuerung

                       optische Trennung von Haupt- und 
                       Zusatzinformationen 

                        (Leseführung)

                       Textabschnitte mit jeweils vollständigen 
                       Informationen 

                        im Hinblick auf Quereinsteiger

h)            Bildgestaltung

                       Verwendung von Standardfarben

                       Lokalisierung und Identifizierung durch 
                       Bildaussagen

                       realistische Maskendarstellung mit konkreter 
                       Blicklenkung

                       Vormach-/Nachmachtechnik für 
                       Handlungsanweisungen

i)            Typografie und Layout

                       Text/Bildzuordnung

                       gebräuchliche Schrifttypen und -größen

                       erkennbare Schriftgradunterschiede

                       optimale Zeilenlängen und -abstände

                       Buchformat mit Bindung zweckmäßig
 

Fußnoten

[1] Leiterin: Richterin am Amtsgericht Margarethe Bergmann, Köln.

[2] Abgedruckt in CR 1998, 573.

[3] Diese beruht auf Vorschlägen der Sachverständigensocietät Dr. Siegfried Streitz in Brühl.

[4] vgl. auch die Erläuterungen von Brandt, CR 1998, 571 und Bergmann, CR 1998, 455.

[5] Die Vorschlagsliste für diese Merkmale ist vom Sachverständigenbüro Godehard Pötter in  Recklinghausen erstellt worden. 

[6] Vgl. die Nachweise bei Beckmann,CR 1998, 519.

[7] Vgl. z.B. BGH NJW 1992, 560 ( Kindertee-Urteil )

[8] z.B. DIN V 8418 - Benutzerinformationen; DIN V 766055- Gebrauchsanweisungen

[9] Z.B. DIN 1422- Typografische Gestaltung; DIN 1450- Schriften, Leserlichkeit; DIN 1451 - Schriften,  DIN 16507 Typografische Maße 

[10] z.B. DIN 4844 - Sicherheitskennzeichnung, DIN 30600 Grafische Symbole, DIN 32830 Gestaltungs-    regeln für grafische Symbole in der technischen
Produktdokumentation 

[11] vgl. z.B. VDI 4500, Pkt. 2.4 Satz 12, DIN V 66055, Pkt. 7.2, vgl. dazu auch OLG Düsseldorf NJW- RR 1995, 25 

[12] Die Bezeichnung in Klammern gibt jeweils das Sachverständigenbüro wieder, auf dessen Vorschlag die nachfolgenden Kriterien aufgenommen wurden.  

  

Zum Seitenanfang
 

© ADOLPH Verlag GmbH - Letztes Update 03.05.2004