Saarbrücker Standard 1999 für Softwaredokumentation verabschiedet

Saar­brück­er Stan­dard 1999 für Soft­ware­doku­men­ta­tion ver­ab­schiedet

Der Deutsche EDV-Gericht­stag befaßt sich seit eini­gen Jahren in einem Arbeit­skreis[1] mit dem The­ma Hand­buch und Doku­men­ta­tion. Nach­dem 1998 eine Prüfliste[2] mit Anforderun­gen an die Richtigkeit und Voll­ständigkeit[3] ver­ab­schiedet wor­den war [4], erörterte der EDV-Gericht­stag 1999 gestal­ter­ische Anforderun­gen an die Über­sichtlichkeit und Ver­ständlichkeit der Doku­men­ta­tion für die jew­eili­gen Benutzer. [5]

I. Rechtliche Grund­la­gen

Die Recht­sprechung des Bun­des­gericht­shofs sieht weit­er­hin die Liefer­ung eines regelmäßig in deutsch­er Sprache abz­u­fassenden Hand­buchs als Hauptleis­tungs-pflicht des Soft­ware­liefer­an­ten an, deren Nichtein­hal­tung den Ver­trag ins­ge­samt scheit­ern läßt.[6]

Aber auch wenn man mit zunehmender Ver­bre­itung der Com­put­er­nutzung statt der Nichter­fül­lung bei Fehlen der Doku­men­ta­tion in Zukun­ftGewährleis­tungsrecht anwen­den wollte, stellt das Fehlen ein­er Doku­men­ta­tion einen Man­gel dar. Nach dem derzeit­i­gen Stand der Tech­nik und der Mark­tüblichkeit bedarf Soft­ware näm­lich nach wie vor ein­er Doku­men­ta­tion. Dies gilt für alle Arten von Soft­wareme­di­en; lediglich der Aus­führungs­grad kann unter­schiedlich sein.

Min­destanforderun­gen an eine Benutzer­doku­men­ta­tion sind eine Instal­la­tion­san­leitung, eine Über­sicht über den Auf­bau des Pro­gramms sowie die Darstel­lung des Pro­gram­me­in­stiegs und der Behand­lung von Fehlern. Bezüglich der Form der Doku­men­ta­tion die Recht­sprechung zunehmend nicht nur die gedruck­te Form, son­dern auch die für jed­er­mann aus­druck­bare geson­derte Datei zu. Der Her­steller trägt hier­bei die Beweis­last für die Aus­druck­barkeit der notwendi­gen Angaben.

Die Doku­men­ta­tion ist jew­eils dann anzu­passen, wenn Änderun­gen bei der Anwen­dung der Soft­ware erforder­lich sind, die für einen durch­schnit­tl­lich befähigten Nutzer der Ziel­gruppe nicht unmit­tel­bar aus der Soft­ware her­aus ver­ständlich sind. Bei Pro­gram­men, die ständig weit­er­en­twick­elt wer­den, genügt eine etwa jährliche Aktu­al­isierung.

II. Gestal­tung der Doku­men­ta­tion

Die Gestal­tung der Doku­men­ta­tion hat sich an den Bedürfnis­sen und Fähigkeit­en der vom Her­steller ins Auge gefaßten Ziel­gruppe zu ori­en­tieren und muß für diese ver­ständlich sein. Die von der Recht­sprechung für Benutzer­an­leitun­gen im Rah­men der Pro­duk­thaf­tung entwick­el­ten Grund­sätze sind auf Soft­ware­an­leitun­gen entsprechend anzuwen­den.[7] Für die Gestal­tung tech­nis­ch­er Doku­men­ta­tion beste­hen im übri­gen eine Vielzahl tech­nis­ch­er Nor­men, die auch bei Soft­waran­leitun­gen Gel­tung beanspruchen, z.B. für Benutzer­in­for­ma­tio­nen all­ge­mein[8], für die druck­tech­nis­che Gestal­tung[9] und die Darstel­lung tech­nis­ch­er Grafiken [10].

Ziel dieser Regeln ist ein klar­er, für den Leser erkennbar­er Auf­bau der Doku­men­ta­tion, eine ein­heitliche Begriffsver­wen­dung und eine Gliederung in über­schaubare Infor­ma­tion­spakete. Hand­lungsan­weisun­gen müssen auch sprach­lich klar von erk­lären­den Teilen getren­nt sein. Dem heuti­gen Stan­dard entsprechen weit­er sog. Leselin­ien, die einen Schnell­durch­gang durch die Infor­ma­tion für den geübten Nutzer und einge­hen­dere Erläuterun­gen für den uner­fahre­nen vorse­hen. Ver­bote und War­nun­gen müssen klar aus­ge­sprochen und begrün­det wer­den.[11]

Bei der grafis­chen Gestal­tung dür­fen nicht zu viele Details auf ein­mal ange­boten wer­den und ist eine Erläuterung von Mask­endarstel­lun­gen z.B. mit Hil­fe von Pfeilen und Erläuterun­gen erforder­lich, die dem Leser die Bil­daus­sage erschließt. Die Ver­wen­dung gebräuch­lich­er Schrifft­typen und For­matierun­gen und eine ein­wand­freie Zuord­nung von Text- und Bil­daus­sagen sind weit­ere Anforderun­gen an die Ver­ständlichkeit der Doku­men­ta­tion.

Der fol­gende nach einge­hen­der Diskus­sion als Saar­brück­er Stan­dard ver­ab­schiedete Kri­te­rienkat­a­log faßt die Ergeb­nisse der bish­eri­gen Beschäf­ti­gung mit dem The­ma zusam­men. Er soll den Her­stellern von Soft­ware als Ori­en­tierungs­maßstab dienen und die rechtlichen Anforderun­gen an eine ord­nungs­gemäße Doku­men­ta­tion definieren.

III. Saar­brück­er Stan­dard für Soft­ware- Anwen­der­hand­büch­er 1999

  1. Richtigkeit (Dr. Stre­itz)[12]

a) Iden­ti­fizierende Angaben

  • Pro­gramm­beze­ich­nung
  • Pro­gram­mver­sions-Nr.
  • ggfs. Lizenz-Nr., Ver­trags-Nr.
  • Hand­buch-Ver­sions-Nr.

b) Pro­grammkon­forme Darstel­lung

  • des Pro­gram­mauf­baus
  • der Pro­gramm­funk­tio­nen
  • der Feld­beze­ich­nun­gen
  • der möglichen Feld­in­halte
  1. Voll­ständigkeit (Dr. Stre­itz)

a) Instal­la­tions­beschrei­bung

  • Auflis­tung der geliefer­ten Unter­la­gen
  • Sys­temvo­raus­set­zun­gen (Hardware/Software)
  • Qual­i­fika­tion des Anwen­ders
  • Sicher­heit­shin­weise
  • tech­nis­che Beschrei­bungsmerk­male des Pro­gramms
  • Instal­la­tion­san­leitung
  • Stan­dard und Son­der­for­men
  • Erk­lärung der Instal­la­tions-Para­me­ter,
  • typ­is­che Sys­temver­hal­tenskenn­zahlen
  • Opti­mierungsvorschläge
  • benutzer­spez­i­fis­che Anpas­sun­gen
  • Reg­is­tra­tions- und Garantie­un­ter­la­gen

b) Beschrei­bung der Pro­gramm-Funk­tion­al­itäten

Auf­gaben­stel­lung und Ein­satzge­bi­et des Pro­gramms

  • Menüstruk­tur (Funk­tion­s­ablauf)
  • Pro­gram­ma­blauf der jew­eili­gen Einze­lauf­gaben
  • zugrun­deliegende Nor­men und Kon­ven­tio­nen
  • Grund­la­gen und Berech­nungsmeth­o­d­en
  • Befehls-Kurz-Über­sicht (Ref­er­ence Card)
  • Muster­beispiele für Stan­dar­d­auf­gaben
  • Tips und Tricks (Expert-Modus)

c) Benutzer-Dat­en

  • Struk­tur
  • Spe­icherung

d) Ver­hal­ten in Aus­nahme­si­t­u­a­tio­nen

  • Erläuterung jed­er einzel­nen Fehler­mel­dung
  • Hin­weise auf zu ergreifende Maß­nah­men
  • Maß­nah­men bei Abwe­ichun­gen zwis­chen erwartetem und tat­säch­lichem Ergeb­nis

e) Unter­stützung durch den Pro­gramm­liefer­an­ten/-her­steller

  • Kon­tak­tadresse für den Benutzer
  • Hot­line, soweit vorhan­den
  1. Übersichtlichkeit/Verständlichkeit (Pöt­ter)

a) Ziel­grup­pen­bezug

  • Fachken­nt­nisse
  • All­ge­mein­bil­dung
  • Erwartungss­chema­ta und Wahrnehmungs­fil­ter

b) Auf­bau

  • pro­duk­to­ri­en­tiert (Rei­hen­folge der Funk­tio­nen) benutze­ror­i­en­tiert (nach typ­is­chem Arbeitsablauf) Masken­funk­tio­nen
  • über­sichtliche hier­ar­chis­che Gliederung
  • Infor­ma­tion­s­menge je nach men­taler Ver­ar­beitungska­paz­ität

c) Ori­en­tierung­shil­fen

  • struk­turi­ertes Inhaltsverze­ich­nis
  • alpha­betis­ches Stich­wortev­erze­ich­nis
  • ggf. Glos­sar (Verze­ich­nis der Abkürzun­gen und Fachaus­drücke)

d) Textver­ständlichkeit

  • jew­eilige Lan­dessprache
  • sprach­liche Richtigkeit

e) Wort­wahl

  • ein­heitlich durchgängige Begrif­flichkeit
  • Ver­mei­dung oder sofor­tige Erk­lärung von Fremd­wörtern
  • Ver­mei­dung nicht­gängiger Worte und Abkürzun­gen
  • genormte Sig­nal­wörter bei War­nun­gen

f) Satzkon­struk­tion

  • kurze voll­ständi­ge Sätze
  • Voranstel­lung der wesentlichen Aus­sage
  • unter­schiedlich­er Sprach­stil für beschreibende und hand­lung­sori­en­tierte Teile

g) Moti­va­tion­ss­teuerung

  • optis­che Tren­nung von Haupt- und Zusatz­in­for­ma­tio­nen (Lese­führung)
  • Textab­schnitte mit jew­eils voll­ständi­gen Infor­ma­tio­nen im Hin­blick auf Quere­in­steiger

h) Bildgestal­tung

  • Ver­wen­dung von Stan­dard­far­ben
  • Lokalisierung und Iden­ti­fizierung durch Bil­daus­sagen
  • real­is­tis­che Mask­endarstel­lung mit konkreter Blick­lenkung
  • Vor­ma­ch-/Nach­machtech­nik für Hand­lungsan­weisun­gen

i) Typografie und Lay­out

  • Text/Bildzuordnung
  • gebräuch­liche Schrift­typen und ‑größen
  • erkennbare Schrift­gradun­ter­schiede
  • opti­male Zeilen­län­gen und ‑abstände
  • Buch­for­mat mit Bindung zweck­mäßig

Fußnoten:

[1] Lei­t­erin: Rich­terin am Amts­gericht Mar­garethe Bergmann, Köln.

[2] Abge­druckt in CR 1998, 573.

[3] Diese beruht auf Vorschlä­gen der Sachver­ständi­genso­ci­etät Dr. Siegfried Stre­itz in Brühl.

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

[5] Die Vorschlagsliste für diese Merk­male ist vom Sachver­ständi­gen­büro Gode­hard Pöt­ter in Reck­ling­hausen erstellt wor­den.

[6] Vgl. die Nach­weise bei Beck­mann,CR 1998, 519.

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

[8] z.B. DIN V 8418 — Benutzer­in­for­ma­tio­nen; DIN V 766055- Gebrauch­san­weisun­gen

[9] Z.B. DIN 1422- Typografis­che Gestal­tung; DIN 1450- Schriften, Leser­lichkeit; DIN 1451 — Schriften, DIN 16507 Typografis­che Maße

[10] z.B. DIN 4844 — Sicher­heitskennze­ich­nung, DIN 30600 Grafis­che Sym­bole, DIN 32830 Gestal­tungs- regeln für grafis­che Sym­bole in der tech­nis­chen Pro­duk­t­doku­men­ta­tion

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

[12] Die Beze­ich­nung in Klam­mern gibt jew­eils das Sachver­ständi­gen­büro wieder, auf dessen Vorschlag die nach­fol­gen­den Kri­te­rien aufgenom­men wur­den.