Benutzer-Leitfäden

Hinweise zu Benutzer-Leitfäden für Basisanwendungen

Dokumentversion: 1.1 (10.02.03)
Autor:           Erstautor: U.Sacklowski
Zustand:   in Bearbeitung

Diese Dokumentation ist bei Bedarf/Erkenntnis durch die Projektmitglieder fortzuschreiben (mit Autorenhinweis).

Änderungen:
- 14.03.00, Sacklowski
    Ergänzung um die Sprachregelung 'dt. / engl.' -> Anhang
- 10.02.03, Sacklowski
    Numerierung der Gliederungspunkte geändert
    Zahlreiche ergänzende Bemerkungen hinzugefügt

Gliederung

A. Benutzer-Leitfaden für eine Basisanwendung - Gliederung
B. Benutzer-Leitfaden für eine Basisanwendung - im Detail
    Dokumenten-Kopf
    Inhaltsverzeichnis
    1   Einführung
    2   Benutzungsoberfläche (Allgemeine Hinweise)
    3   Produktstruktur
    4   Trainingsteil  (Typische Anwendungen)
    5   Überblick über die Funktionalität
    6   Benutzungsoberfläche und Funktionalität
    7   Benutzungsoberfläche im Detail
    8   Dateien
    9   Literaturverzeichnis und Web-Adressen
   10   Glossar
   11   Register
   Anhang
        Dialog- und Meßfenster in englisch
 

A. Benutzer-Leitfaden für eine Basisanwendung - Gliederung

Der Begriff der Basisanwendung wurde in dem Dokument 'Projektmanagement > Vorgaben > Welche Benutzer-Handbücher' im Pkt. 2.2.1 eingeführt und an Hand von Beispielen erläutert. Dabei wurde zwischen einfachen und zusammengesetzten Basisanwendungen unterschieden. Die folgende Gliederung gilt für beide Arten von Basisanwendungen. Die Unterpunkte für 6. und 7. gelten nur für  zusammengesetzte Basisanwendungen. Auf weitere Unterschiede wird im Pkt. B dann jeweils hingewiesen.

Aufbau / Gliederung für einen Benutzer-Leitfaden für eine Basisanwendung

Dokumenten-Kopf
Inhaltsverzeichnis
1. Einführung
2. Benutzungsoberfläche (Allgemeine Hinweise)
3. Produktstruktur
4. Trainingsteil  (Typische Anwendungen)
5. Überblick über die Funktionalität
6. Benutzungsoberfläche und Funktionalität
6.1 Basisanwendung 1  (z.B. Topographie: Einstellen der Parameter)
6.2 Basisanwendung 2  (z.B. Topographie: Start und Kontrolle)
...
6.i Basisanwendung i
7. Benutzungsoberfläche im Detail
7.1 Basisanwendung 1  (z.B. Topographie: Einstellen der Parameter)
7.2 Basisanwendung 2  (z.B. Topographie: Start und Kontrolle)
...
7.i Basisanwendung i
8. Dateien
9. Literaturverzeichnis und Web-Adressen
10. Glossar
11. Register
Anhang
        Dialog- und Meßfenster in englisch

Es zeigt sich, daß fast alle Punkte (zumindest die umfangreichen) aus der Verhaltensspezifikation übernommen werden können!!!

Pkt. 5:     Verhaltensspezifikation: 1. Überblick
Pkt. 6:     Verhaltensspezifikation: 2. Funktionale Beschreibung
Pkt. 7:     Verhaltensspezifikation: 3. Daten, Benutzerschnittstelle
Pkt. 8:     Verhaltensspezifikation: 3. Daten, Dateien
Pkt. 9:     Verhaltensspezifikation: Verwandte Dokumente
Pkt. 10:   Verhaltensspezifikation: Glossar

Da die Verhaltensspezifikation eine Untermenge des Pflichtenheftes ist, trifft dies auch für das Pflichtenheft zu.
 

B. Benutzer-Leitfaden für eine Basisanwendung - im Detail

Nachfolgend nun Ausführungen zu den einzelnen Gliederungspunkten.

Allgemein sei darauf hingewiesen, daß innerhalb der Punkte nur auf die deutschen Dialog- und Meß-Fenster Bezug genommen wird. Die englischen Entsprechungen stehen im Anhang. (Link: Deutsche oder englische Dialog- und Meß-Fenster? )

Dokumenten-Kopf

Dokumenten-Köpfe unterscheiden sich geringfügig für einfache und zusammengesetzte Basisanwendungen.

Bsp. für einfache Basisanwendung (.html)
Bsp. für zusammengesetzte Basisanwendung (1)  (.html)
Bsp. für zusammengesetzte Basisanwendung (2)  (.html)

Inhaltsverzeichnis

Vorgegebene Gliederung in Pkt. A

1 Einführung

-   Erläuterung zum Aufbau und dem Umgang mit dem Benutzer-Leitfaden, - damit eine Art Gebrauchsanleitung.
-   Adressatenkreis (Studenten im Praktikum, techn. und wiss. Mitarbeiter)
-   Einbettung in Gesamtheit der Benutzer-Handbücher. Z.B. Bei der 'Manuellen Justage' hinweisen auf das Dokument 'Gesamtvorgang Topograhie', in dem ja der Vorgang der manuellen Justage eingebettet ist und damit dort auch beschrieben wird.

2 Benutzungsoberfläche (Allgemeine Hinweise)

-> Wahrscheinlich einmal erarbeiten und dann für alle (mehr oder weniger) unveränderlich verwendbar?!
Dieser Punkt soll Lücken bei den Benutzern schließen und damit das Dokument verständlich machen. So sind bspw. nicht durchweg die in diesem Dokument verwendeten Bezeichnungen für Oberflächen-Elemente bekannt.

a) Bedienung

Allgemeine Hinweise zum Windows-Standard.

• Menüs:Hierüber sind Funktionen aufrufbar.
  • Pull Down -Menüs: Aufruf , wo und wie  (Titelzeile, li. Maustaste)
  • Pop Up - Menüs:   Aufruf , wo und wie  (Fenster-Arbeitsfläche, re. Maustaste)
    Besonderer Hinweis auf die Pop Up - Menüs, da nicht bei allen bekannt.
• Fenster:
  • Schließen:   x - Button
    ...

b) Oberflächen-Elemente

Hier ist darauf hinzuweisen, daß nachfolgend die in diesem Dokument verwendeten Oberflächen-Elemente mit ihren deutschen und englischen Bezeichnungen aufgeführt werden.
Dies könnte in Form einer Tabelle erfolgen.
 
 

Element	deutsche Bezeichnung	englische Bezeichnung
	Schaltfläche	Button
	Textfeld (Ein-/Ausgabe)	Textfield (Input/Output)
	Bildlaufleiste	Scrollbar
	Schaltfeld	Radiobutton
	Markierungsfeld	Checkbutton
	Kombinationsfeld	Combobox

3 Produktstruktur

Hier werden in Form eines Blockschaltbildes die Beziehungen zwischen der Basisanwendung einerseits und den Oberflächenobjekten, externen Objekten und den Dateien dargestellt.

Beispiel für die Manuelle Justage(Alt):
 

 Erläuterungen zum Blockschaltbild:

• Fenster
  ihre Aufrufmöglichkeit angeben (Menü: ...)
• Externe Objekte
  - sind nur verfügbar, wenn zu jedem Gerät ein Eintrag im ini-File existiert, und die Geräte physisch auch angeschlossen sind.
  - kurz die möglichen externen Geräte erläutern
• Dateien
  - ini- und Makrodateien werden aus Sicherheitsgründen hier nicht weiter beschrieben (-> Installations-Handbuch)
  - andere Dateien: hier kurz ihre Funktion erklärt. Außerdem Verweis auf Pkt. 8: Dateien.

Zu den nachfolgenden Punkten 4 - 7:

• Problem: In den Punkten 4, 6 und 7 wäre es für den Benutzer bestimmt hilfreich, wenn immer dann, wenn auf eine Dialogbox Bezug genommen wird, diese (bzw. Teile von ihr) auch abgebildet wird. Wem dies zu viel erscheint, sollte (mit Vorsicht) reduzieren und jeweils nur auf die entsprechende Abbildung verweisen. Vollständig abgebildet werden muß aber alles in Pkt. 7.
  Alternative: Dialogboxen auf einem extra Blatt und zum Herausklappen, - z.B. auf DIN A3 und im Anhang einfügen.
  
• Bezugsdokument: Nachfolgend wird sich häufig auf das Dokument Entwicklertabelle > Analyse und Definition > Diff./Refl. > Pflichtenheft > LineScan > ContinousScan bezogen.
   

4 Trainingsteil  (Typische Anwendungen)

Beschreibung einiger weniger wichtiger/typischer Anwendungen. Hierüber soll ein erster Zugang ermöglicht werden, vergleichbar manchem Online-Tutorial. Hier werden mitunter ein oder zwei typische Abläufe vermittelt. Die volle Funktionalität wird an anderer Stelle beschrieben (Pkte. 5 und 6).

Als Beispiel Anwendungen zur Dialogbox 'Manuelle Justage Neu':

• Anzeige der aktuellen Motorposition von Tilt innerhalb eines Teilbereiches
  •  Auswahl des Motors 'Tilt' im Kombinationsfenster (akt. Antrieb)
  •  Damit automatische Anzeige der aktuellen Position im Textfeld der Istposition
• Bewegen des Motors Tilt nach 0,34 Minuten im Direktbetrieb
  • ...
• Messen der HW-Breite
  • ...
• Setzen eines Tilt- und eines Psd-Offsets
  • ...

5   Überblick über die Funktionalität

Kurze Erläuterung und Nennung aller Hauptfunktionen. Sie sollten in der Reihenfolge genannt werden, wie sie im nachfolgenden Punkt 6 behandelt werden.
Orientierung: Entwicklertabelle > Analyse und Definition > Diff./Refl. > Pflichtenheft > LineScan > ContinousScan, hier Pkt. 1.

6   Benutzungsoberfläche und Funktionalität

Detaillierte Beschreibung der zuvor genannten Funktionen. Orientierung: Entwicklertabelle > Analyse und Definition > Diff./Refl. > Pflichtenheft > LineScan > ContinousScan, hier Pkt. 2.

7   Benutzungsoberfläche im Detail

Detaillierte Beschreibung der Benutzungsoberfläche. Orientierung: Entwicklertabelle > Analyse und Definition > Diff./Refl. > Pflichtenheft > LineScan > ContinousScan, hier Pkt. 3.1.

Damit sind zu jedem Dialogelement anzugeben:

• Bezeichnung in der Dialogbox (Falls diese nicht ausreichend verständlich ist, z.B. Abkürzung, ist diese zu erläutern.)
• Vorgabewerte und Priorität
• Wert aus .ini-Datei
• (Default-) Wert aus dem Programm
• Prüfbedingungen
• Einzelfeldprüfung
• zulässiger Werteberich:  [-n, schrittweite, +n]
• zulässige Einzelwerte

z.B. implementiert als Aufzählung im Programm oder über getrennter Schlüsseldatei
• Mehrfeldprüfung
• Abhängigkeit von anderem Feld bzw. Feldern (Integritätsbedingungen)

8   Dateien

Detaillierte Beschreibung der Dateien. Orientierung: Entwicklertabelle > Analyse und Definition > Diff./Refl. > Pflichtenheft > LineScan > ContinousScan, hier Pkt. 3.2.

9   Literaturverzeichnis und Web-Adressen

10   Glossar

Begriffsdefinitionen, Abkürzungen, Einheiten

11   Register

Stichwortverzeichnis

Anhang
        Dialog- und Meßfenster in englisch

Hier werden nur die Fenster ohne Beschreibung der Felder dokumentiert. Link: Deutsche oder englische Dialog- und Meß-Fenster?