Saar­brü­cker Stan­dard 1999

Saar­brü­cker Stan­dard 1999 für Soft­ware­do­ku­men­ta­tion ver­ab­schie­det

Der Deut­sche EDV-Gerichtstag befaßt sich seit eini­gen Jah­ren in einem Arbeits­kreis[1] mit dem Thema Hand­buch und Doku­men­ta­tion. Nach­dem 1998 eine Prüf­liste[2] mit Anfor­de­run­gen an die Rich­tig­keit und Voll­stän­dig­keit[3]ver­ab­schie­det wor­den war [4], erör­terte der EDV-Gerichtstag 1999 gestal­te­ri­sche Anfor­de­run­gen an die Über­sicht­lich­keit und Ver­ständ­lich­keit der Doku­men­ta­tion für die jewei­li­gen Benut­zer. [5]

  1. Recht­li­che Grund­la­gen

Die Recht­spre­chung des Bun­des­ge­richts­hofs sieht wei­ter­hin die Lie­fe­rung eines regel­mä­ßig in deut­scher Spra­che abzu­fas­sen­den Hand­buchs als Hauptleistungs-pflicht des Soft­ware­lie­fe­ran­ten an, deren Nicht­ein­hal­tung den Ver­trag ins­ge­samt schei­tern läßt.[6]

Aber auch wenn man mit zuneh­men­der Ver­brei­tung der Com­pu­ter­nut­zung statt der Nicht­er­fül­lung bei Feh­len der Doku­men­ta­tion in Zukunft Gewähr­leis­tungs­recht anwen­den wollte, stellt das Feh­len einer Doku­men­ta­tion einen Man­gel dar. Nach dem der­zei­ti­gen Stand der Tech­nik und der Markt­üb­lich­keit bedarf Soft­ware näm­lich nach wie vor einer Doku­men­ta­tion. Dies gilt für alle Arten von Soft­ware­me­dien; ledig­lich der Aus­füh­rungs­grad kann unter­schied­lich sein.

Min­dest­an­for­de­run­gen an eine Benut­zer­do­ku­men­ta­tion sind eine Instal­la­ti­ons­an­lei­tung, eine Über­sicht über den Auf­bau des Pro­gramms sowie die Dar­stel­lung des Pro­gramm­ein­stiegs und der Behand­lung von Feh­lern. Bezüg­lich derForm der Doku­men­ta­tion die Recht­spre­chung zuneh­mend nicht nur die gedruckte Form, son­dern auch die für jeder­mann aus­druck­bare geson­derte Datei zu. Der Her­stel­ler trägt hier­bei die Beweis­last für die Aus­druck­bar­keit der not­wen­di­gen Anga­ben.

Die Doku­men­ta­tion ist jeweils dann anzu­pas­sen, wenn Ände­run­gen bei der Anwen­dung der Soft­ware erfor­der­lich sind, die für einen durch­schnittl­lich befä­hig­ten Nut­zer der Ziel­gruppe nicht unmit­tel­bar aus der Soft­ware her­aus ver­ständ­lich sind. Bei Pro­gram­men, die stän­dig wei­ter­ent­wi­ckelt wer­den, genügt eine etwa jähr­li­che Aktua­li­sie­rung.

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

Die Gestal­tung der Doku­men­ta­tion hat sich an den Bedürf­nis­sen und Fähig­kei­ten der vom Her­stel­ler ins Auge gefaß­tenZiel­gruppe zu ori­en­tie­ren und muß für diese ver­ständ­lich sein. Die von der Recht­spre­chung für Benut­zer­an­lei­tun­gen im Rah­men der Pro­dukt­haf­tung ent­wi­ckel­ten Grund­sätze sind auf Soft­ware­an­lei­tun­gen ent­spre­chend anzu­wen­den.[7]Für die Gestal­tung tech­ni­scher Doku­men­ta­tion bestehen im übri­gen eine Viel­zahl tech­ni­scher Nor­men, die auch bei Soft­war­an­lei­tun­gen Gel­tung bean­spru­chen, z.B. für Benut­zer­in­for­ma­tio­nen all­ge­mein[8], für die druck­tech­ni­sche Gestal­tung[9] und die Dar­stel­lung tech­ni­scher Gra­fi­ken [10].

Ziel die­ser Regeln ist ein kla­rer, für den Leser erkenn­ba­rer Auf­bau der Doku­men­ta­tion, eine ein­heit­li­che Begriffs­ver­wen­dung und eine Glie­de­rung in über­schau­bare Infor­ma­ti­ons­pa­kete. Hand­lungs­an­wei­sun­gen müs­sen auch sprach­lich klar von erklä­ren­den Tei­len getrennt sein. Dem heu­ti­gen Stan­dard ent­spre­chen wei­ter sog. Lese­li­nien, die einen Schnell­durch­gang durch die Infor­ma­tion für den geüb­ten Nut­zer und ein­ge­hen­dere Erläu­te­run­gen für den uner­fah­re­nen vor­se­hen. Ver­bote und War­nun­gen müs­sen klar aus­ge­spro­chen und begrün­det wer­den.[11]

Bei der gra­fi­schen Gestal­tung dür­fen nicht zu viele Details auf ein­mal ange­bo­ten wer­den und ist eine Erläu­te­rung von Mas­ken­dar­stel­lun­gen z.B. mit Hilfe von Pfei­len und Erläu­te­run­gen erfor­der­lich, die dem Leser die Bild­aus­sage erschließt. Die Ver­wen­dung gebräuch­li­cher Schrifft­ty­pen und For­ma­tie­run­gen und eine ein­wand­freie Zuord­nung von Text- und Bild­aus­sa­gen sind wei­tere Anfor­de­run­gen an die Ver­ständ­lich­keit der Doku­men­ta­tion.

Der fol­gende nach ein­ge­hen­der Dis­kus­sion als Saar­brü­cker Stan­dard ver­ab­schie­dete Kri­te­ri­en­ka­ta­log faßt die Ergeb­nisse der bis­he­ri­gen Beschäf­ti­gung mit dem Thema zusam­men. Er soll den Her­stel­lern von Soft­ware als Ori­en­tie­rungs­maß­stab die­nen und die recht­li­chen Anfor­de­run­gen an eine ord­nungs­ge­mäße Doku­men­ta­tion defi­nie­ren.

III. Saar­brü­cker Stan­dard für Software- Anwen­der­hand­bü­cher 1999

  1. Rich­tig­keit (Dr. Streitz)[12]
  2. a)Identifizierende Anga­ben

- Pro­gramm­be­zeich­nung

- Programmversions-Nr.

- ggfs. Lizenz-Nr., Vertrags-Nr.

- Handbuch-Versions-Nr.

  1. b)Programmkonforme Dar­stel­lung

- des Pro­gramm­auf­baus

- der Pro­gramm­funk­tio­nen

- der Feld­be­zeich­nun­gen

- der mög­li­chen Feld­in­halte

  1. Voll­stän­dig­keit (Dr. Streitz)
  2. a)Installationsbeschreibung

- Auf­lis­tung der gelie­fer­ten Unter­la­gen

- Sys­tem­vor­aus­set­zun­gen (Hardware/Software)

- Qua­li­fi­ka­tion des Anwen­ders

- Sicher­heits­hin­weise

- tech­ni­sche Beschrei­bungs­merk­male des Pro­gramms

- Instal­la­ti­ons­an­lei­tung

- Stan­dard und Son­der­for­men

- Erklä­rung der Installations-Parameter,

- typi­sche Sys­tem­ver­hal­tens­kenn­zah­len

- Opti­mie­rungs­vor­schläge

- benut­zer­spe­zi­fi­sche Anpas­sun­gen

- Registrations- und Garan­tie­un­ter­la­gen

  1. b)Beschreibung der Programm-Funktionalitäten

Auf­ga­ben­stel­lung und Ein­satz­ge­biet des Pro­gramms

- Menü­struk­tur (Funk­ti­ons­ab­lauf)

- Pro­gramm­ab­lauf der jewei­li­gen Ein­zel­auf­ga­ben

- zugrun­de­lie­gende Nor­men und Kon­ven­tio­nen

- Grund­la­gen und Berech­nungs­me­tho­den

- Befehls-Kurz-Übersicht (Refe­rence Card)

- Mus­ter­bei­spiele für Stan­dard­auf­ga­ben

- Tips und Tricks (Expert-Modus)

  1. c)Benutzer-Daten

- Struk­tur

- Spei­che­rung

  1. d)Verhalten in Aus­nah­me­si­tua­tio­nen

- Erläu­te­rung jeder ein­zel­nen Feh­ler­mel­dung

- Hin­weise auf zu ergrei­fende Maß­nah­men

- Maß­nah­men bei Abwei­chun­gen zwi­schen erwar­te­tem und

tat­säch­li­chem Ergeb­nis

  1. e)Unterstützung durch den Programmlieferanten/-hersteller

- Kon­takt­adresse für den Benut­zer

- Hot­line, soweit vor­han­den

  1. Übersichtlichkeit/Verständlichkeit (Pöt­ter)
  2. a)Zielgruppenbezug

- Fach­kennt­nisse

- All­ge­mein­bil­dung

- Erwar­tungs­sche­mata und Wahr­neh­mungs­fil­ter

  1. b)Aufbau

- pro­duk­t­ori­en­tiert (Rei­hen­folge der Funk­tio­nen)

benut­zer­ori­en­tiert (nach typi­schem Arbeits­ab­lauf) Mas­ken­funk­tio­nen

- über­sicht­li­che hier­ar­chi­sche Glie­de­rung

- Infor­ma­ti­ons­menge je nach men­ta­ler Ver­ar­bei­tungs­ka­pa­zi­tät

  1. c)Orientierungshilfen

- struk­tu­rier­tes Inhalts­ver­zeich­nis

- alpha­be­ti­sches Stich­worte­ver­zeich­nis

- ggf. Glos­sar (Ver­zeich­nis der Abkür­zun­gen und Fach­aus­drü­cke)

  1. d)Textverständlichkeit

- jewei­lige Lan­des­spra­che

- sprach­li­che Rich­tig­keit

  1. e)Wortwahl

- ein­heit­lich durch­gän­gige Begriff­lich­keit

- Ver­mei­dung oder sofor­tige Erklä­rung von Fremd­wör­tern

- Ver­mei­dung nicht­gän­gi­ger Worte und Abkür­zun­gen

- genormte Signal­wör­ter bei War­nun­gen

  1. f)Satzkonstruktion

- kurze voll­stän­dige Sätze

- Vor­an­stel­lung der wesent­li­chen Aus­sage

- unter­schied­li­cher Sprach­stil für beschrei­bende

und hand­lungs­ori­en­tierte Teile

  1. g)Motivationssteuerung

- opti­sche Tren­nung von Haupt- und Zusatz­in­for­ma­tio­nen

(Lese­füh­rung)

- Text­ab­schnitte mit jeweils voll­stän­di­gen Infor­ma­tio­nen

im Hin­blick auf Quer­ein­stei­ger

  1. h)Bildgestaltung

- Ver­wen­dung von Stan­dard­far­ben

- Loka­li­sie­rung und Iden­ti­fi­zie­rung durch Bild­aus­sa­gen

- rea­lis­ti­sche Mas­ken­dar­stel­lung mit kon­kre­ter Blick–

len­kung

- Vormach-/Nachmachtechnik für Hand­lungs­an­wei­sun­gen

  1. i)Typografie und Lay­out

- Text/Bildzuordnung

- gebräuch­li­che Schrift­ty­pen und –grö­ßen

- erkenn­bare Schrift­grad­un­ter­schiede

- opti­male Zei­len­län­gen und –abstände

- Buch­for­mat mit Bin­dung zweck­mä­ßig

Fuß­no­ten:

[1] Lei­te­rin: Rich­te­rin am Amts­ge­richt Mar­ga­re­the Berg­mann, Köln.

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

[3] Diese beruht auf Vor­schlä­gen der Sach­ver­stän­di­gen­so­cie­tät Dr. Sieg­fried Streitz in Brühl.

[4] vgl. auch die Erläu­te­run­gen von Brandt, CR 1998, 571 und Berg­mann, CR 1998, 455.

[5] Die Vor­schlags­liste für diese Merk­male ist vom Sach­ver­stän­di­gen­büro Gode­hard Pöt­ter in Reck­ling­hau­sen erstellt wor­den.

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

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

[8] z.B. DIN V 8418 – Benut­zer­in­for­ma­tio­nen; DIN V 766055- Gebrauchs­an­wei­sun­gen

[9] Z.B. DIN 1422- Typo­gra­fi­sche Gestal­tung; DIN 1450- Schrif­ten, Leser­lich­keit; DIN 1451 – Schrif­ten, DIN 16507 Typo­gra­fi­sche Maße

[10] z.B. DIN 4844 – Sicher­heits­kenn­zeich­nung, DIN 30600 Gra­fi­sche Sym­bole, DIN 32830 Gestaltungs- regeln für gra­fi­sche Sym­bole in der tech­ni­schen Pro­dukt­do­ku­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 Bezeich­nung in Klam­mern gibt jeweils das Sach­ver­stän­di­gen­büro wie­der, auf des­sen Vor­schlag die nach­fol­gen­den Kri­te­rien auf­ge­nom­men wur­den.

Seite Drucken