Entwicklungsmethodik Struktogramm Struktogramme sind grafische ...

Angaben über Durchführung und Voraussetzungen der Installation des Softwaresystems (z. B. benötigteDateien, technische Ressourcen) und seine Einbettung in das verwendete Betriebssystem,eine vollständige und leicht verständliche Beschreibung aller Systemfunktionen und der für ihreAusführung notwendigen Benutzeraktionen,typische Anwendungsbeispiele für alle Systemfunktionen,Angaben und Erläuterungen über die Eingabedaten,Darstellung und Erläuterung der Ergebnisse, am besten anhand von Beispielen,Zusammenstellung der Fehlermeldungen und Hinweise auf Fehlerursachen und Maßnahmen zurFehlerbeseitigung.Die Bedienungsanleitung sollte in zwei Teile gegliedert sein. Der erste Teil dient der Übersicht und soll sogeschrieben sein, daß er sequentiell gelesen werden kann. Der zweite Teil dient als Referenz und soll dietypischen Arbeiten und die dazu notwendigen Systemfunktionen und Benutzeraktionen beschreiben.Dieses Referenzhandbuch muß daher zum selektiven Lesen geeignet sein. Das heißt, die Gliederungmuß so sein, daß die gesuchte Information schnell zu finden ist. Zusätzlich empfiehlt es sich, eineReferenzkarte anzufertigen, die alle wesentlichen Informationen in Kurzform darstellt.Operator-Anleitung:Für Softwareprodukte, die für einen Host-Rechner, der von einem Operator bzw. Netzadministratorüberwacht wird, konzipiert wurden, muß die Benutzerdokumentation auch eine Operator-Anleitungenthalten. Die Operator-Anleitung beschreibt alle Nachrichten, die das zu dokumentierendeSoftwaresystem auf der Operator-Station ausgibt, welche Ursache die Nachricht ausgelöst hat undwelche Reaktionen darauf vom Operator erwartet werden.Die Dokumentation ist ein besonders wichtiger Bestandteil eines Softwareprodukts. DieBenutzerfreundlichkeit von Softwareprodukten wird nicht nur durch die softwaretechnische Ausgestaltungder Benutzerschnittstellen, sondern auch ganz wesentlich durch den Inhalt, den Aufbau und die Form derBenutzerdokumentation beeinflußt.Die Benutzerdokumentation soll knapp und präzise, aber mit Redundanz formuliert sein. Sie soll soaufgebaut sein, daß der Leser nicht gezwungen ist, das ganze Dokument zu lesen um herauszufinden,wie die einfachsten Funktionen ausgeführt werden. Sie soll so strukturiert sein, daß er vom Allgemeinenzum Besonderen fortschreiten und sich so langsam alle Feinheiten, die das System anzubieten hat,erschließen kann.Für Softwaresysteme, die mehrere Gruppen von Anwendern mit unterschiedlicher Benutzerschnittstelleunterstützen, ist es zweckmäßig, für jede Benutzergruppe eine separate Benutzerdokumentation zuerstellen oder das Dokument so zu gliedern, daß jede Benutzergruppe die für sie notwendigenInformationen ohne Bezug auf die Information für andere Gruppen in abgeschlossener Form präsentiertbekommt.Die Benutzerdokumentation ist ein Nachschlagewerk und soll daher ein ausführliches Inhalts- undStichwortverzeichnis enthalten.Besondere Bedeutung kommt der Lesbarkeit der Benutzerdokumentation zu - sie muß von denBenutzern verstanden werden können.Die Benutzerdokumentation ist im Idealfall sowohl auf Papier als auch in elektronischer Fonn alsBestandteil des Softwareprodukts verfügbar.Die Möglichkeit einer benutzergesteuerten Selektion von Informationen ist von großer Bedeutung, da inder Regel häufig der Fall eintritt, daß der Benutzer zwar das System im großen und ganzen beherrscht,aber in bestimmten Einzelfragen (z. B. bei der Ausführung selten gebrauchter Systemfunktionen) Hilfebenötigt.Online-Help-FunktionDie Informationsselektion wird am besten dadurch unterstützt, daß für die Benutzerdokumentation einausführlicher und gut durchdachter Index erstellt wird und die Möglichkeit einer sogenannten Online-Help-Funktion angeboten wird. Der Benutzer soll im Bedarfsfalle Informationen, z. B. zuBenutzerschnittstellenelementen wie Funktionsknöpfen und Datenelementen, auf dem Bildschirmeinblenden können. Das Bereitstellen und die Ausformulierung solcher Informationen ist ein aufwendigerProzeß, der in der Planung eines Softwareprojekts berücksichtigt werden muß.