BITE Homepage BITE-Zwischenbericht 1997
Prüfverfahren 2. Die Erhebungsinstrumente Stichwortverzeichnis
2.2.2 Die Prüfkataloge Benutzerdokumentation
Die
Benutzerdokumentation für
Softwareerzeugnisse ist nach
DIN 12 119,
Abs. 2.4 die Gesamtheit der
Dokumente, die für die
Anwendung des
Erzeugnisses vorgesehen und die zugleich
Bestandteil des
Produkts sind, unabhängig davon, ob sie in gedruckter oder nicht gedruckter Form vorliegen. Mit Benutzerdokumentation ist das gemeint, was auch mit
Bezeichnungen wie
Gebrauchsanweisung,
Gebrauchsbeschreibung,
Bedienanweisung,
Betriebsanleitung,
Benutzerhandbuch,
Benutzungsanweisung, Technische
Dokumentation und ähnlichem belegt ist. Wie in der
Terminologie des DIN soll im folgenden auch hier durchgehend die
Bezeichnung Benutzerdokumentation verwendet
1 werden.
Eine wesentliche
Rolle bei der
Bestimmung der
Anforderungen an die Benutzerdokumentation spielt dabei, daß diese sich im komplexen
Verwendungszusammenhang nach jeweils verschiedenen
Aspekten einordnen läßt. Sie ist unabhängig von den jeweils anderen Aspekten:
- eine
Benutzerinformation zur
Handhabung eines technischen Erzeugnisses
- eines von mehreren miteinander verzahnten
Bestandteilen eines
Software-Erzeugnisses
- ein
Arbeitsinstrument für einen speziellen
Anwenderkreis, und zwar für blinde bzw. sehbehinderte
Personen.
Zu jedem dieser Aspekt sind unterschiedliche Anforderungen zu berücksichtigen, die im folgenden vorgestellt werden.
Benutzerdokumentation als Benutzerinformation
Für den
Status des
Dokuments als Benutzerinformation gibt die DIN V 8418
Hinweise für die
Erstellung, die als
Kriterien, bzw.
Leitfaden für Kriterien zur
Beurteilung von vorhandenen
Dokumenten genutzt werden können. DIN V 8418 gibt im
Abschnitt 3. und 4 entsprechende
Empfehlungen für
Gestaltung und
Inhalt von
Benutzerinformationen.
Zur Gestaltung sagt die
Norm in Abs. 3: Benutzerinformationen sollen die notwendigen
Kenntnisse für den sachgerechten, ökonomischen und sicheren
Gebrauch vermitteln [...].. Innerhalb des Dokuments soll die Gestaltung vor allem die Verständlichkeit fördern, wobei DIN V 8418 folgende Anforderungen unterscheidet:
Anordnung der
Texte in der erforderlichen
Reihenfolge,
-
Erklären von
Fachausdrücken,
- einheitliche
Benennung von
Gegenständen und
Sachverhalten,
- Unterstützung von
Texten durch bildliche
Darstellungen,
- übersichtliches
Layout,
-
Inhalts- und
Stichwortverzeichnisse bei umfangreichen
Dokumentationen
2.
Zum Inhalt enthält DIN V 8418 Abs. 4
Angaben, die als
Indikatoren für eine möglichst vollständige
Behandlung aller erforderlichen Angaben zu einem
Produkt genutzt werden können. Hierzu gehören u.a. differenzierte Angaben
- zur
Identifikation des Produkts, seines
Anbieters, und der Dokumentation selbst
- zu
Leistung und
Belastbarkeit
- zu
Einsatz- und
Arbeitsbereichen
- zu
Beschreibungen der
Funktionen
- zu
Abmessungen und
Gewichten
- zu Nutzung,
Instandhaltung und
Kundendienst.
Nach der oben erwähnten tekom-Richtlinie sind darüber hinaus folgende weiteren Angaben relevant:
-
Berücksichtigung einschlägiger
Gesetze und
Normen
- Berücksichtigung anerkannter
Regeln der
Technik
- Angaben über
Sicherheitsbestimmungen
- Angaben über
Entsorgungsmaßnahmen.
Benutzerinformation als Bestandteil eines Software-Erzeugnisses
Bei technischen
Produkten - wozu auch
Software-
Programme für
Computer gehören - wird die Benutzerdokumentation zunehmend als regulärer Bestandteil eines Erzeugnisses betrachtet
3. Auch in diesem Sinne enthält die DIN 12 119 /
ISO/IEC 12 119 Software-Erzeugnisse -
Qualitätsanforderungen und
Prüfbestimmungen umfangreiche inhaltliche Anforderungen an das
System der
Produktdokumentation bzw. der Benutzerinformation. Anforderungen zu funktionellen
Merkmalen des eigentlichen
Software-
Programms werden dabei eher nachgeordnet aufgelistet.
DIN 12 119 fordert von der Benutzerdokumentation neben der vollständigen
Beschreibung und wiederholten
Auflistung der bereits in der
Produktbeschreibung aufgeführten Eigenschaften (DIN 12119, Abs. 3.2.1.) vor allem Folgendes: Richtigkeit, Eindeutigkeit und Fehlerfreiheit der Angaben (DIN 12119, Abs. 3.2.2.), Widerspruchsfreiheit aller Dokumente in sich, gegeneinander und auch gegenüber der Produktbeschreibung (DIN 12119, Abs. 3.2.3.), weiterhin auch Verständlichkeit (z.B. durch geeignete
Wahl von
Begriffen,
Erläuterungen; DIN 12119, Abs. 3.2.3.) und Übersichtlichkeit (z.B. durch
Inhaltsverzeichnis und
Stichwortverzeichnis; DIN 12119, Abs. 3.2.3.).
Natürlich fordert DIN 12 119 nicht nur, daß Produktbeschreibung und Benutzerdokumentation übereinstimmen, gefordert wird auch die Widerspruchsfreiheit der Benutzerdokumentation gegenüber den
Produkteigenschaften. Allerdings ist - im Unterschied zur Produktbeschreibung - die
Verpflichtung zur Widerspruchsfreiheit gegenüber dem eigentlichen
Software-
Programm auf die
Softwareprogramm-Seite verlagert worden (DIN 12 119, Abs. 3.3.1.). Diese muß so funktionieren, wie in der Benutzerdokumentation beschrieben und nicht etwa umgekehrt, daß etwa die Beschreibung in der Benutzerdokumentation den
Abläufen der
Programmfunktionen folgen muß. Damit gibt die DIN 12 119 eine bei der
Produktprüfung zu berücksichtigende Maßgeblichkeits-Hierarchie in der Reihenfolge Produktbeschreibung - Benutzerdokumentation - Softwareprogramm vor.
Die meisten Anforderungen an die Benutzerdokumentation in der DIN 12 119 befassen sich also mit
Themen, die sinngemäß einem Teil der in DIN V 8418, Abs. 3 (siehe oben) enthaltenen Empfehlungen zur Gestaltung entsprechen, wobei in der DIN 12 119 jedoch keine Empfehlungen zu
Lesbarkeit,
Typographie, Layout usw. gegeben werden.
Benutzerinformation als Arbeitsinstrument für blinde und sehbehinderte Personen.
Ein weiteres
Qualitätskriterium von
Benutzerdokumentationen ist die Berücksichtigung der besonderen Anforderungen sehbehinderter und blinder Personen. Das
Anwendergremium
Windows-
Anpassung für
Blinde hat hierfür differenzierte
Anforderungskriterien erarbeitet. Diese betreffen vor allem die Anpassung der
Software an die
Arbeitsaufgabe
Darbietung des
WINDOWS-Bildschirms für blinde und sehbehinderte
Anwender, weitere Anforderungen betreffen die
Kompatibilität des
Software-
Produktes mit marktgängigen
Hard- und
Softwarekomponenten, sowie mit speziellen blindenspezifischen
Geräten (z.B.
Braillezeilen). Von der Benutzerdokumentation wird gefordert, daß sie entsprechende Hinweise zu diesen
Produktanforderungen enthält. Somit ist die Vollständigkeit der
Beantwortung dieser
Fragen ein weiteres Qualitätskriterium der Benutzerdokumentation.
Die bereits angesprochenen
DIN-Normen enthalten erwartungsgemäß keine speziellen Hinweise zum
Thema Software für Blinde und
Sehbehinderte.
Inhalt und Strukturen der Prüfkataloge Benutzerdokumentation
Aus der
Umsetzung der oben dargestellten Anforderungen ergibt sich folgender
Prüfumfang zur Benutzerdokumentation:
- Vollständige und detaillierte
Aufführung aller notwendigen Angaben gemäß den
Anforderungsprofilen und gemäß der DIN 12119. Im einzelnen:
- Kompatibilität des Programms mit
Betriebssystemen und
Anwendungssoftware
- Kompatibilität mit
Hardware-
Arbeitsplatzkonfigurationen
- Kompatibilität mit speziellen
Hilfsmittel-
Komponenten
-
Aussagen zu
Grenzwerten/
Einschränkungen der
Betreibbarkeit
-
Installation,
Wartung, Unterstützung
- Anpassung an die
Bedürfnisse des
Benutzers.
- Übersichtlichkeit der Dokumentation durch strukturierende
Elemente wie
Kapitelanordnung, Inhalts- und Stichwortverzeichnisse
- Verständlichkeit der Dokumentation in
Textanordnung,
Textformulierung und
Begriffsverwendung
- Widerspruchsfreiheit in sich und gegenüber der Produktbeschreibung
Der
Prüfkatalog ist zur
Prüfung der
Schwarzschrift-Version der Benutzerdokumentation ausgelegt. Auf die vergleichende
Analyse der Benutzerdokumentation in blindengerechter Form, etwa als
Braille-
Dokument,
Tonträger-Dokument, sowie auch der Darbietung als
Hilfstext in der Software selbst wurde verzichtet.
An
Hand des
Prüfkatalogs wird durch eine
Prüfperson ermittelt, ob und in welcher Form in den
Benutzerhandbüchern die geforderten Angaben und Beschreibungen vorhanden sind.
Eine vollständige
Überprüfung ist bei dem großen
Umfang der Dokumente nicht möglich. Die Prüfung bleibt auf exemplarische Fälle beschränkt, deren
Ergebnisse als stellvertretend für die Gesamtheit des Dokuments gewertet werden. Eine Prüfung der
Programmfunktion auf Vollständigkeit der Beschreibungen wird nicht vorgenommen.
Bei der Prüfung auf Verständlichkeit werden bei allen
Prüfobjekten vier exemplarische
Prüfungen durchgeführt.
Gegenstand der Prüfung sind bei der
Produktgruppe
Windows-
Anpassungen für Blinde:
-
Auswählen und
Starten eines
Programmes im
Programmanager
- Installation
-
Definition unbenannter
Bitmaps (
Icons)
-
Umgang mit speziellen
Anwenderprogrammen, z.B.
Winword,
Excel.
Diese werden jeweils darauf untersucht, ob die zugehörigen
Textabschnitte durch geeignete Wahl von Begriffen,
Formulierungen, eine einheitliche Terminologie und korrekte
Schreibweise etc. hinreichend verständlich und nachvollziehbar erscheinen.
Zur Prüfung der Widerspruchsfreiheit werden ebenfalls vier exemplarische Prüfungen durchgeführt. Hierbei werden die zugehörigen Textabschnitte der Benutzerdokumentation darauf untersucht, ob ihre Aussagen sich mit den Aussagen zum gleichen
Objekt an anderen
Stellen des Dokuments sowie mit denen der Produktbeschreibung decken.
Gefordert ist keine durchgehende
Wortgleichheit und Vollständigkeit, sondern die
Übereinstimmung der Aussagen (z.B. zu Funktionsumfang,
Leistungen,
Daten der Kompatibilität etc.).
1 Siehe hierzu DIN 12 119, Abs. 2.4. Benutzerdokumentation, und DIN 8418 Benutzerinformation.
2 Eine differenzierte Ausarbeitung von Indikatoren zu diesen Kriterien findet sich beispielsweise in der tekom-Richtlinie, Technische Dokumentation beurteilen in den Abschnitten 1. bis 6. tekom-Richtlinie, tekom e.V., Markelstraße 34, 70193 Stuttgart.
3 Siehe hierzu auch DIN 8418 V, Abs. 3.
2.2.1 Die Prüfkataloge Produktbeschreibung
2.3 Praktische Prüfung
Erstellt: 31.10.1998 11:46 Aktualisiert: 14.12.1998 21:46
Autor: Brigitte Bornemann-Jeske et al.
Copyright © 1998 BIT GmbH - Mailto: 0402987340@t-online.de
Modellversuch im Auftrag des Bundesministeriums für Arbeit und Sozialordnung