Handbuch und Dokumentation

Zeit: Don­ner­stag, 2. April 1998, 14.00 Uhr
Ort: HS 117
Mod­er­a­tion: Frau Rich­terin am Amts­gericht Bergmann
Ref­er­enten: Herr Richter am Ober­lan­des­gericht Beck­mann
Herr EDV-Sachver­ständi­ger Brandt
Herr Walk­er

Nach ein­er ein­lei­t­en­den Erörterung der von der neueren Recht­sprechung aufgestell­ten rechtlichen Anforderun­gen (Hein­er Beck­mann, Richter am OLG Hamm) sollen aus sachver­ständi­ger Sicht tech­nis­che Kri­te­rien für Soft­ware­hand­büch­er vorgestellt wer­den (Jochen C. Brandt, EDV-Sachver­ständi­ger, Brühl). Eine Darstel­lung konkreter Gestal­tungsmöglichkeit­en am Beispiel des Hand­buchs für JURIS-Win­dows wird sich anschließen (Rein­hard Walk­er, Abteilungsleit­er Doku­men­ta­tion und Pro­duk­ten­twick­lung, JURIS-GmbH).Der Arbeit­skreis set­zt die 1997 begonnene Erar­beitung der Anforderun­gen an Benutzer­doku­men­ta­tio­nen fort. In diesem Jahr ste­ht die Gestal­tung von Anwen­der­hand­büch­ern für Soft­ware­pro­gramme im Vorder­grund.

Ziel der darauf fol­gen­den Diskus­sion im Arbeit­skreis ist es, einen Empfehlungskat­a­log zu ver­ab­schieden, der Fir­men und Soft­ware­herstellern als Richtschnur dienen kann.


PRÜFLISTE FÜR DIE GESTALTUNG VON ANWENDERDOKUMENTATION

1. Richtigkeit

1.1 Zuord­nung zum Pro­gramm (= Hand­buch-Iden­ti­fizierung):

  • Pro­gramm­beze­ich­nung
  • Pro­gramm-Iden­ti­fi­fak­tions-Nr.
  • Pro­gramm-Ver­sions-Nr.
  • Pro­gramm-Freiga­be-Datum
  • ggfs. Lizenz-Nr., Ver­trags-Nr. etc.
  • Hand­buch-Ver­sions-Nr.
  • Hand­buch-Erstell-Datum
  • Hand­buch-Let­ztes-Änderungs­da­tum
  • Hand­buch-Ver­sions-Pro­tokoll (Change Log)

1.2 Pro­grammkon­forme Darstel­lung

  • des Pro­gram­mauf­baus
  • der Pro­gramm­funk­tio­nen
  • der Masken­folge
  • der Einzel­masken
  • der Masken­funk­tio­nen, ‑teil­funk­tio­nen
  • der Feld­beze­ich­nun­gen
  • der möglichen Feld­in­halte
  • der benutzbaren Para­me­ter
  • der Lis­ten, Reports, Sta­tis­tiken etc.

1.3 fachliche/sachliche Richtigkeit

  • der Funk­tio­nen
  • der ver­wen­de­ten Grund­la­gen
  • der einge­set­zten Meth­o­d­en
  • von Formeln etc.

1.4 sprach­liche Richtigkeit

  • Rechtschrei­bung
  • Gram­matik
  • Aus­druck

2. Voll­ständigkeit

2.1 Instal­la­tions­beschrei­bung

  • Auflis­tung der geliefer­ten Unter­la­gen
  • Sys­temvo­raus­set­zun­gen (Hardware/Software)
  • tech­nis­che Beschrei­bungsmerk­male des Pro­gramms
  • Instal­la­tion­sproze­dur
  • Stan­dard und Son­der­for­men
  • Erk­lärung der Instal­la­tions-Para­me­ter, deren Zusäm­men­hänge
  • 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

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

  • Sinn, Zweck, Auf­gaben­stel­lung und Ein­satzge­bi­et des Pro­gramms
  • Pro­gramm-Auf­bau
  • Haupt­funk­tio­nen des Pro­gramms
  • Menue-Struk­tur (Funk­tion­s­ablauf)
  • Logis­ch­er Pro­gram­ma­blauf zur jew­eili­gen (Einzel-)Aufgabe
  • Beschrei­bung der Einzel­funk­tio­nen
  • Zugrun­deliegende Vorschriften
  • son­stige Grund­la­gen
  • The­o­retis­che Grund­la­gen
  • Berech­nungsmeth­o­d­en
  • Formeln
  • Funk­tionale Para­me­ter und deren Wirkungsweise
  • Ver­wen­dete Nor­men und Normierun­gen (z.B. Ergonomie, Tas­ten­bele­gung (Short Keys), GUI = Graph­i­cal User Inter­face = Stan­dard-Masken-Lay­out)
  • Befehls-Kurz-Über­sicht (Ref­er­ence Card)
  • Muster­an­wen­dun­gen
  • Tips und Tricks (Expert-Modus)

2.3 Beschrei­bung der Fehler­be­hand­lung

  • Lis­ten der Fehler­mel­dun­gen
  • Erläuterung jed­er einzel­nen Fehler­mel­dung
  • Hin­weise auf zu ergreifende Maß­nah­men
  • Hin­weise auf die Ver­mei­dung von Fehlern

2.4 Daten­sicherung, ‑reor­gan­i­sa­tion

  • Hin­weise: wann, wie oft, in welchem Umfang, mit welch­er Meth­ode, mit welchen Funk­tio­nen bzw. (speziellen) Pro­gram­men etc.

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

  • Sys­temab­bruch
  • Neustart (Kalt‑, Warm­start)
  • Abwe­ichun­gen zwis­chem erwartetem und tat­säch­lichem Ergeb­nis

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

  • Kon­tak­tadresse für den Benutzer
  • Hot­line
  • Helpdesk
  • Schu­lung, Train­ing, Benutzer­fo­rum, Inter­net etc.
  • Garantie etc.

3. Über­sichtlichkeit

3.1 Auf­bau und Gliederung

(zum Gesam­tum­fang siehe auch Kapi­tel Voll­ständigkeit)

  • Ein­führung
  • Kurzbeschrei­bung des Pro­gramms

- Auf­gabe
— Auf­bau, Mod­ule, Funk­tio­nen
— Zusam­men­hang der Mod­ule
— Kurzbeschrei­bung der Mod­ule

  • Beschrei­bung je Mod­ul

- Funk­tio­nen und deren Zusam­men­hang
— Arbeitsweise je Funk­tion /Teilfunktion

  • Bear­beitung­sh­in­weise

- je Funk­tion, Teil­funk­tion, Maske, Feld

  • Bear­beitungsleit­faden je Auf­gabe (Screen-Nav­i­ga­tion)
  • Ver­weise auf Muster- und Beispielfälle
  • Son­der­fälle und Aus­nah­men
  • Auflis­tung von nicht-mach­baren Auf­gaben
  • Anhang (tech­nis­che Infor­ma­tio­nen, ver­wen­dete Kon­ven­tio­nen, Nor­men etc.)

3.2 Ori­en­tierung­shil­fen

  • Inhaltsverze­ich­nis (ein­heitlich und über­greifend)
  • Stich­wortverze­ich­nis:

- alpha­betisch
— funk­tion­al geord­net
— Her­vorhe­bung von Bas­is­fund­stellen
— Ver­weis auf Muster­fälle/-beispiele

  • Glos­sar (Verze­ich­nis der Abkürzun­gen und Fachaus­drucke)
  • Querver­weise im Text
  • Hin­weise im Text auf Nach­barthe­men
  • sep­a­rate Schnell-Infor­ma­tion = Befehls-Kurz-Über­sicht (Ref­er­ence Card)

3.3 For­mat, Form und Gestal­tung

  • Nor­males Buch­for­mat (ca. 23 x 16 cm)
  • kein Folianten- oder Lexikon­for­mat
  • durchge­hende Seiten­nu­merierung
  • Reg­is­tere­in­teilung (Griff- und/oder Far­breg­is­ter)
  • hand­buch-ein­heitliche Seit­e­naufteilung

- Kapi­tel-/Ab­schnittshin­weis im Seit­enkopf
— geregelte Schrift-Font-Ver­wen­dung
— Randbe­merkun­gen
— Fußzeilen
— deut­lich erkennbare Querver­weise

  • Ein­satz von Farbe als Organ­i­sa­tion­shil­fe

4. Ver­ständlichkeit

4.1 Fach­lich­er Inhalt des Pro­gramms

  • Qual­i­fika­tion des Hand­buchau­tors

- Sachken­nt­nis
— Erfahrung
— Darstel­lungs­fähigkeit

4.2 Sprache und Sprach­stil
  • Deutschsprach­lich (EG: jew­eilig gültige Nation­al­sprache)
  • Satza­uf­bau, Wort­wahl etc.
  • ein­heitlich durchgängige Begrif­flichkeit
  • Ver­mei­dung von Fremd­wörtern bzw. sofor­tige Erk­lärung oder Hin­weis auf Glos­sar
  • Ver­mei­dung von nicht­gängi­gen Abkürzun­gen

4.3 Auf­bere­itung des fach­lichen Inhaltes

  • Kom­bi­na­tion von Text und Grafik
  • grafis­che Darstel­lung für zeitliche und/oder sach­liche Arbeitsse­quen­zen
  • Mask­endarstel­lun­gen in der Form, wie der Benutzer sie tat­säch­lich auch sieht, auch far­big (Ima­go-Darstel­lung)
  • Masken, Funk­tio­nen und Teil­funk­tion als grafis­che Einzelschrittdarstel­lung
  • Auf­gaben­be­zo­gene Darstel­lung
  • Anwen­dungs­beispiele

- Beschrei­bung des Beispiel-Sce­nar­ios
— Aus­druck der Masken je Einzelschritt

4.4 For­male Gestal­tungsmerk­male

(siehe auch Kap. Über­sichtlichkeit)