Dokumentversion: 1.2 (13.02.03)
Autor: Erstautor:
U.Sacklowski
Zustand: in Bearbeitung
Diese Dokumentation ist bei Bedarf/Erkenntnis durch die Projektmitglieder fortzuschreiben (mit Autorenhinweis).
Änderungen:
- 12.02.01, Sacklowski
Szenarien -> Gesamtvorgänge
- 21.03.01, Sacklowski
in Pkt.1: Navigation nur über den Inhalt
- 13.02.03, Sacklowski
umfangreiche Überarbeitung
Gliederung
1 Benutzer-Handbücher nach Balzert
2 Benutzer-Handbücher in unserem XCTL-System
2.1 Installations-Handbücher
2.2 Benutzer-Leitfäden
2.2.1 Modular gegliederte Dokumenten-Sammlung
2.2.2 Hierarchisch gegliederte Dokumenten-Sammlung
2.2.3 Benutzer-Leitfäden und Links zu den Vorgaben
Anhang
Anpassung der allgemeinen Gliederung von Balzert
1. Benutzer-Handbücher nach Balzert
(H. Balzert: Lehrbuch der SW-Technik: SW-Entwicklung, 1996, S. 591 ff)
Balzert nenn an Benutzer-Handbüchernt:
- Trainings-Handbuch
- Referenz-Handbuch
- Referenzkarte
- Benutzer-Leitfaden
Weiterhin führt er eine allgemeine Gliederung an, die mehr oder weniger in jedes Benutzer-Handbuch gehört, insbesondere jedoch in Benutzer-Leitfäden:
- Vorwort
- Inhaltsverzeichnis
- Einführung
- Installation
- Benutzungsoberfläche (Allgemeine Bedienungshinweise)
- Produktstruktur
- Trainingsteil
- Referenzteil
- Literaturverzeichnis
- Abkürzungsverzeichnis
- Glossar
- Index/Register
2. Benutzer-Handbücher für unser XCTL-System
Aus Gründen
- des Aufwandes für die Erstellung der Benutzer-Handbücher und ihre
spätere Pflege,
- der weitgehenden Disponibilität hinsichtlich der meßplatzspezifischen
Bereitstellung von Benutzer-Leitfäden,
- der Herauslösung installationsspezifischer Angaben,
stellen wir bereit:
- mehrere Benutzer-Leitfäden
- zwei Installations-Handbücher
Abweichend von Balzert
- sind bei uns das Trainings-Handbuch und das Referenz-Handbuch Bestandteile
der Benutzer-Leitfäden für Basisanwendungen,
- es entfällt die Referenzkarte und
- Installationshandbücher werden herausgetrennt.
Siehe hierzu unter
> Projekt: Software-Sanierung > Projekt-Management
> Vorgaben > Hinweise zu den Benutzer-Handbüchern > Hinweise zum
Installationshandbuch
Die Benutzer-Leitfäden bilden bei uns eine modular und hierarchisch gegliederte Dokumenten-Sammlung.
2.2.1 Modular gegliederte Dokumenten-Sammlung
Aus den in Pkt. 2 genannten Gründen einer weitgehenden Disponibilität hinsichtlich der meßplatzspezifischen Bereitstellung von Benutzer-Leitfäden und einem möglichst geringen späteren Pflegeaufwand (nur immer kleine einzelne Dokumente sind zu aktualisieren und neu zu drucken) bietet sich eine modular gegliederte Dokumenten-Sammlung an.
Dabei entsteht i.allg. je Anwendungsfall ein Benutzer-Leitfaden.
Verwendung von 'Basisanwendung' statt 'Anwendungsfall':
Für den Benutzer scheint bei der Nutzung des Systems der Begriff 'Basisanwendung'
besser als der Begriff 'Anwendungsfall' zu sein. Beispiele für eine Basisanwendung
wären die Nutzung des Zählrohres oder die Manuelle Justage.
Basisanwendungen sind in einfache und zusammengesetzte zu unterteilen.
Beispiele für einfache Basisanwendungen:
- Counter (Zählerfenster)
- Manuelle Justage (Dialofenster 'Manuelle Justage')
Beispiele für zusammengesetzte Basisanwendungen:
- Motoren mit den Dialogfenstern:
Grundstellung anfahren
Motor-Parameter einstellen
Verfahren nach Encoder-Position
Optimieren
- Topographie mit den Dialogfenstern:
Einstellen der Parameter
Start und Kontrolle
Für jede Basisanwendung entsteht ein Benutzer-Leitfaden.
2.2.2 Hierarchisch gegliederte Dokumenten-Sammlung
Die Dokumenten-Sammlung der Benutzer-Leitfäden bildet zwei Hierarchieebenen:
- untere Ebene: die sich aus den Basisanwendungen ergebenen Dokumente
(siehe Pkt. 2.2.1)
- obere Ebene: die sich aus den Gesamtvorgängen
ergebenen Dokumente
Gesamtvorgänge setzen sich aus Basisanwendungen des Systems und manuellen Teilaufgaben außerhalb des Systems zusammen. Solche Gesamtvorgänge sind in unserer Entwicklerdokumentation unter Analyse und Definition, Gesamtvorgänge und Spezifikationen der Anwendungsfälle beschrieben.
Beispiel für einen Gesamtvorgang: Gesamtvorgang der Topographie, beginnend bei dem Auflegen der Probe auf den Probenteller und endend bei der Auswertung des Fotos.
Für jeden Gesamtvorgang entsteht ein Benutzer-Leitfaden.
2.2.3 Benutzer-Leitfäden und Links zu den Vorgaben
Zu erstellen sind Benutzer-Leitfäden für Basisanwendungen und für Gesamtvorgänge. Vorgaben hierfür sind zu finden unter:
Anhang
Anpassung der allgemeinen Gliederung von Balzert
Bezugspunkt sollen hier nur die Benutzer-Leitfäden sein.
Nach Auswertung der Beispiellösungen der Studenten (siehe X. Benutzer-Handbücher, Benutzer-Leitfäden zu den Anwendungsfällen , Manuelle Justage, Beispiellösungen von Studenten) erfolgt folgende Anpassung:
- Vorwort und Einführung werden vereinigt
- Abkürzungsverzeichnis und Glossar werden vereinigt
- Installation wird in das Installations-Handbuch verlagert
- Referenzteil wird gegliedert in:
-- Überblick über die Funktionalität
-- Benutzungsoberfläche und Funktionalität
-- Benutzungsoberfläche im Detail
-- Dateien
- ein Trainingsteil wird aufgenommen
Darüber hinaus für die Gesamtvorgangs-Benutzer-Leitfäden:
- der Trainigsteil wird durch einen typischen Vorgang ersetzt
- der Referenzteil entfällt
Bemerkung: Gesamtvorgänge werden bei Balzert nicht erwähnt.